Skip to content

Commit

Permalink
pre-flight CRAN check
Browse files Browse the repository at this point in the history
  • Loading branch information
hrbrmstr committed Aug 28, 2017
1 parent 0b8574b commit d6aa675
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 4 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@
^appveyor\.yml$
^codecov\.yml$
^docs$
^cran-comments\.md$
8 changes: 4 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: splashr
Type: Package
Title: Tools to Work with the 'Splash' 'JavaScript' Rendering Service
Title: Tools to Work with the 'Splash' 'JavaScript' Rendering and Scraping Service
Version: 0.4.0
Date: 2017-08-26
Encoding: UTF-8
Expand All @@ -9,10 +9,10 @@ Authors@R: c(
)
Maintainer: Bob Rudis <bob@rud.is>
Description: 'Splash' <https://github.com/scrapinghub/splash> is a 'JavaScript' rendering service.
It’s a lightweight web browser with an 'HTTP' API, implemented in 'Python' using 'Twisted'
It is a lightweight web browser with an 'HTTP' API, implemented in 'Python' using 'Twisted'
and 'QT' and provides some of the core functionality of the 'RSelenium' or 'seleniumPipes'
R pacakges in a lightweight footprint. Some of 'Splash' features include the ability to process
multiple webpages in parallel; retrieving 'HTML' results and/or take screenshots; disabling
R packages in a lightweight footprint. Some of 'Splash' features include the ability to process
multiple web pages in parallel; retrieving 'HTML' results and/or take screen shots; disabling
images or use 'Adblock Plus' rules to make rendering faster; executing custom 'JavaScript' in
page context; getting detailed rendering info in 'HAR' format.
URL: http://github.com/hrbrmstr/splashr
Expand Down
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* moved to 'docker' pacakge since it's on CRAN
* temporarily removed `render_file()` support
* added code coverage
* CRAN release

0.3.0

Expand Down
61 changes: 61 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## Test environments

* local OS X install, R 3.4.1 on both 10.12 and 10.13 Beta 6
* local ubuntu 3.4.1 and r-devel
* ubuntu on travis-ci, R oldrel, 3.4.1 and r-devel
* win-builder (devel and release)

## R CMD check results

0 errors | 0 warnings | 1 note

* This is a new release.

## Reverse dependencies

This is a new release, so there are no reverse dependencies.

---

Hey folks,

The tests skip on CRAN and the examples are \dontrun{} because
they require an active Splash server running for the most
accurate results (mocking would not exercise the interaction with
the Splash API server). The core functionality is much the same
as RSelenium, but Splash is more designed for scraping
than Selenium which is more geared towards web site automated
testing. This will hopefully be a nice addition to the R web
scraping world.

It is fully tested on Travis: https://travis-ci.org/hrbrmstr/splashr
with 2 different Python configurations across all three R versions.
It's an active test that spins up a local Docker container and runs
on push and weekly. (It imports the 'docker' package, hence my
mentioning the diverse python configs).

Neither Appveyor (and, all other free Windows CI systems) nor
rhub nor WinBuilder support co-runbninbg Docker linux containers
so the tests are not run there, but the package is built regularly
on WinBuilder and rhub's Windows and "CRAN" environments to
catch any other platform-related package errors.

There are many Imports because this works with a diverse amount
of web content and also tries to play well with 'httr' and 'rvest'
as well as the 'hartools' package.

There are three vignettes and I tried to reduce the image sizes
for the figures in them as much as possible. I'll glady do some
cropping if you would like the total size to be even smaller. I
fully understand wanting to keep pacakges as small as possible.

The package is also well-documented and has 44% code coverage:
https://codecov.io/gh/hrbrmstr/splashr/tree/master/R
I'm going to get that up closer to 80% for the next release which will
extend the "DSL" functions.

Thx for your time & efforts!

-boB

P.S. Hope you folks had a great summer!

0 comments on commit d6aa675

Please sign in to comment.