minor changes for release, including version bump to 1.2.0

Author: mtmorgan

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rjsoncons
 Title: 'C++' Header-Only 'jsoncons' Library for 'JSON' Queries
-Version: 1.1.0.9500
+Version: 1.2.0
 Authors@R: c(
     person(
         "Martin", "Morgan", role = c("aut", "cre"),
@@ -20,10 +20,12 @@ Description: The 'jsoncons'
     <https://danielaparker.github.io/jsoncons/> 'C++' header-only
     library constructs representations from a 'JSON' character vector,
     and provides extensions for flexible queries and other operations
-    on 'JSON' objects. This package has simple 'R' wrappers to support
-    'JSONpath' and 'JMESpath' queries into 'JSON' strings or 'R'
-    objects. The 'jsoncons' library is also be easily linked to other
-    packages for direct access to 'C++' functionality.
+    on 'JSON' objects. This package provides 'R' functions to query
+    (filter or transform) and pivot (convert from array-of-objects to
+    object-of-arrays, for easy import into 'R') 'JSON' or 'NDJSON'
+    strings or files using 'JSONpointer', 'JSONpath' or 'JMESpath'
+    expression. The 'jsoncons' library is also be easily linked to
+    other packages for direct access to 'C++' functionality.
 Imports: utils
 Suggests: jsonlite, tibble, cli, tinytest, BiocStyle, knitr, rmarkdown
 LinkingTo: cpp11

NEWS.md

@@ -34,7 +34,7 @@
 - (0.0.3) support object names ordering 'asis' or 'sort'
 - (0.0.3) DESCRIPTION file updates: correct 'Title:' capitalization;
   avoid warnings about most misspellings
-- (0.0.3) Add github action to rebuild README.md from
+- (0.0.3) Add GitHub action to rebuild README.md from
   vignettes/rjsoncons.Rmd
 - (0.0.2) jsoncons library update
 - (0.0.2) support for R object query in addition to JSON string

R/j_data_type.R

@@ -36,7 +36,7 @@
 #' @title Detect JSON / NDJSON data and path types
 #'
 #' @description `j_data_type()` uses simple rules to determine whether
-#'     'data' is json, ndjson, file, url, or R.
+#'     'data' is JSON, NDJSON, file, url, or R.
 #'
 #' @inheritParams j_query
 #'

R/paths_and_pointer.R

@@ -3,7 +3,7 @@
 #' @title JSONpath, JMESpath, or JSONpointer query of JSON / NDJSON documents
 #'
 #' @description `jsonpath()` executes a query against a JSON string or
-#'     vector NDJSON entries using the 'jsonpath' specification.
+#'     vector NDJSON entries using the 'JSONpath' specification.
 #'
 #' @param data a character() JSON string or NDJSON records, or an *R*
 #'     object parsed to a JSON string using `jsonlite::toJSON()`.
@@ -88,7 +88,7 @@ jsonpath <-
 #' @rdname paths_and_pointer
 #'
 #' @description `jmespath()` executes a query against a JSON string
-#'     using the 'jmespath' specification.
+#'     using the 'JMESpath' specification.
 #'
 #' @examples
 #' path <- "locations[?state == 'WA'].name | sort(@)"

README.md

@@ -7,11 +7,13 @@
 
 The [jsoncons][] C++ header-only library constructs representations
 from a JSON character vector, and provides extensions for flexible
-queries and other operations on JSON objects. This package has simple
-'R' wrappers to support [JSONpath][], [JMESpath][], and
-[JSONpointer][] queries into JSON strings or 'R' objects. The
-'jsoncons' library is also easily linked to other packages for direct
-access to 'C++' functionality.
+queries and other operations on JSON objects. This package provides
+'R' functions to query (filter or transform) and pivot (convert from
+array-of-objects to object-of-arrays, for easy import into 'R') 'JSON'
+or 'NDJSON' strings or files using [JSONpath][], [JMESpath][], and
+[JSONpointer][] expressions. The package also makes it easy to use C++
+'jsoncons' in other *R* packages for direct access to 'C++'
+functionality.
 
 [JSONpath]: https://goessner.net/articles/JsonPath/
 [JMESpath]: https://jmespath.org/
@@ -22,7 +24,7 @@ access to 'C++' functionality.
 Install the released package version from CRAN
 
 ``` r
-install.pacakges("rjsoncons", repos = "https://CRAN.R-project.org")
+install.packages("rjsoncons", repos = "https://CRAN.R-project.org")
 ```
 
 Install the development version with

cran-comments.md

@@ -1,6 +1,3 @@
-# Release 1.1.0
+# Release 1.2.0
 
-- updates 'jsoncons' third party library to 0.172.1 to address
-  segfault on 'fedora' CRAN builder
-- upstream bug report at
-  <https://github.com/danielaparker/jsoncons/issues/471>
+- updates R functionality as described in NEWS.md

man/j_data_type.Rd

@@ -219,15 +219,10 @@ cpp11::sexp j_as(Json j, rjsoncons::as as)
     switch(as) {
     case as::string: return as_sexp( j.template as<std::string>() );
     case as::R: return as_r<Json>(j);
+    default: cpp11::stop("`as_r()` unknown `as = `");
     }
 }
 
-template<class Json>
-cpp11::sexp j_as(Json j, std::string as)
-{
-    j_as(j, enum_index(as_map, as));
-}
-
 template<class Json>
 sexp as_r_impl(const std::string data)
 {

man/paths_and_pointer.Rd

@@ -167,6 +167,7 @@ class r_json
                 return jsonpointer::get<Json>(j, jsonpointer_);
             case path_type::JSONpath: return jsonpath_.evaluate(j);
             case path_type::JMESpath: return jmespath_.evaluate(j);
+            default: cpp11::stop("`j_query()` unknown 'path_type'");
             }
         }
 

src/j_as.h

@@ -35,7 +35,7 @@ the package for direct access to the 'jsoncons' C++ library.
 Install the released package version from CRAN
 
 ```{r install, eval = FALSE}
-install.pacakges("rjsoncons", repos = "https://CRAN.R-project.org")
+install.packages("rjsoncons", repos = "https://CRAN.R-project.org")
 ```
 
 Install the development version with
@@ -72,7 +72,7 @@ json <- '{
 ```
 
 There are several common use cases. Use [rjsoncons][] to query the
-JSON string using [JSONpath][], [JMESPath][] or [JSONpointer][]
+JSON string using [JSONpath][], [JMESpath][] or [JSONpointer][]
 syntax to filter larger documents to records of interest, e.g., only
 cities in New York state, using 'JMESpath' syntax.
 
@@ -192,19 +192,19 @@ j_query(ndjson_file, "{id: id, type: type}", n_records = 5)
 `j_pivot()` transforms an NDJSON file or character vector of objects
 into a format convenient for input in *R*. `j_pivot()` with NDJSON
 files and JMESpath paths work particularly well together, because
-JMESpath provides flexiblity in creating JSON objects to be pivotted.
+JMESpath provides flexibility in creating JSON objects to be pivoted.
 
 ```{r ndjson_j_pivot}
 j_pivot(ndjson_file, "{id: id, type: type}", as = "data.frame")
 ```
 
 Filtering NDJSON files can require relatively more complicated paths,
-e.g., to filt 'PushEvent' types from organizations, construct a query
-that acts on each NDJSON record to return an array of a single object,
-then apply a filter to replace uninteresting elements with 0-length
-arrays (using `as = "tibble"` often transforms the *R* list-of-vectors
-to a tibble in a more pleasing and robust manner compared to `as =
-"data.frame"`).
+e.g., to filter 'PushEvent' types from organizations, construct a
+query that acts on each NDJSON record to return an array of a single
+object, then apply a filter to replace uninteresting elements with
+0-length arrays (using `as = "tibble"` often transforms the *R*
+list-of-vectors to a tibble in a more pleasing and robust manner
+compared to `as = "data.frame"`).
 
 ```{r ndjson_j_pivot_filter}
 path <-
@@ -218,7 +218,7 @@ vignette][ndjson-extended]
 
 [NDJSON]: https://ndjson.org/
 [GitHub Archive]: https://www.gharchive.org/
-[ndjson-extended]: https://mtmrogan.github.io/rjsoncons/articles/b_ndjson.html
+[ndjson-extended]: https://mtmorgan.github.io/rjsoncons/articles/b_ndjson_extended.html
 [cli]: https://CRAN.R-project.org/package=cli
 
 # The JSON parser

src/r_json.h

@@ -330,7 +330,7 @@ adopted to achieve reasonable performance.
 [duckdb-json]: https://duckdb.org/2023/03/03/json.html#github-archive-examples
 [blog post]: https://mtmorgan.github.io/software/update/2024/01/25/rjsoncons-ndjson-performance.html
 
-# Session inforation {.unnumbered}
+# Session information {.unnumbered}
 
 ```{r}
 sessionInfo()