Java Archive Wrapper Supporting the ‘htmlunit’ Package
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
boB Rudis 9eb623873b
README/NEWS
2 months ago
R example 11 months ago
docs initial commit 11 months ago
inst/java 2.36.0 + README 2 months ago
java/htmlunit 2.36.0 + README 2 months ago
man stuff 11 months ago
tests initial commit 11 months ago
.Rbuildignore 2.34.0 update 8 months ago
.codecov.yml R package repo initialization complete 11 months ago
.gitignore R package repo initialization complete 11 months ago
.travis.yml R package repo initialization complete 11 months ago
DESCRIPTION README/NEWS 2 months ago
LICENSE stuff 11 months ago
NAMESPACE initial commit 11 months ago
NEWS.md README/NEWS 2 months ago
README.Rmd 2.36.0 + README 2 months ago
README.md README/NEWS 2 months ago
htmlunitjars.Rproj R package repo initialization complete 11 months ago

README.md

Signed
by Linux build
Status Coverage
Status Minimal R
Version License

htmlunitjars

Java Archive Wrapper Supporting the ‘htmlunit’ Package

Description

Contents of the ‘HtmlUnit’ & supporting Java archives (https://htmlunit.sourceforge.net/). Version number reflects the version number of the included ‘JAR’ file.

HtmlUnit is a “GUI-Less browser for Java programs”. It models HTML documents and provides an API that allows you to invoke pages, fill out forms, click links, etc… just like you do in your “normal” browser.

It has fairly good JavaScript support (which is constantly improving) and is able to work even with quite complex AJAX libraries, simulating Chrome, Firefox or Internet Explorer depending on the configuration used.

It is typically used for testing purposes or to retrieve information from web sites.

HtmlUnit is not a generic unit testing framework. It is specifically a way to simulate a browser.

What’s Inside The Tin

Everything necessary to use the HtmlUnit library directly via rJava.

HtmlUnit Library JavaDoc: https://htmlunit.sourceforge.net/apidocs/index.html

Installation

install.packages("htmlunitjars", repos = "https://cinc.rud.is")
# or
remotes::install_git("https://git.rud.is/hrbrmstr/htmlunitjars.git")
# or
remotes::install_git("https://git.sr.ht/~hrbrmstr/htmlunitjars")
# or
remotes::install_gitlab("hrbrmstr/htmlunitjars")
# or
remotes::install_bitbucket("hrbrmstr/htmlunitjars")
# or
remotes::install_github("hrbrmstr/htmlunitjars")

NOTE: To use the ‘remotes’ install options you will need to have the {remotes} package installed.

Usage

library(htmlunitjars)

# current verison
packageVersion("htmlunitjars")
## [1] '2.36.0'

Give It A Go

xml2::read_html() cannot execute javascript so the traditional approach won’t work:

library(rvest)

test_url <- "https://hrbrmstr.github.io/htmlunitjars/index.html"

doc <- read_html(test_url)

html_table(doc)
## list()

☹️

We can do this with the classes from HtmlUnit proivided by this JAR wrapper package:

library(htmlunitjars)

Tell HtmlUnit to work like FireFox:

browsers <- J("com.gargoylesoftware.htmlunit.BrowserVersion")

wc <- new(J("com.gargoylesoftware.htmlunit.WebClient"), browsers$CHROME)

Tell it to wait for javascript to execute and not throw exceptions on page resource errors:

invisible(wc$waitForBackgroundJavaScriptStartingBefore(.jlong(2000L)))

wc_opts <- wc$getOptions()
wc_opts$setThrowExceptionOnFailingStatusCode(FALSE)
wc_opts$setThrowExceptionOnScriptError(FALSE)

Now, acccess the site again and get the table:

pg <- wc$getPage(test_url)

doc <- read_html(pg$asXml())

html_table(doc)
## [[1]]
##      X1   X2
## 1   One  Two
## 2 Three Four
## 3  Five  Six

No need for Selenium or Splash!

The ultimate goal is to have an htmlunit package that provides a nicer API than needing to know how to work with rJava directly.

htmlunitjars Metrics

Lang # Files (%) LoC (%) Blank lines (%) # Lines (%)
Java 2 0.2 28 0.30 5 0.11 18 0.17
Rmd 1 0.1 21 0.22 35 0.76 50 0.48
Maven 1 0.1 17 0.18 0 0.00 1 0.01
R 5 0.5 15 0.16 1 0.02 36 0.34
make 1 0.1 13 0.14 5 0.11 0 0.00