json_data_extractor 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd75c436a18caa753cb6c35536852852b8d876b44684de7f45d66678d012c6b
-  data.tar.gz: 612d1cb976811a479e6e3f6c377186d90bd7d8fe900def4009dfeb7e2d63c81d
+  metadata.gz: aeef2dddd8e11795c682d9db785b955164fbab87e4dc1c63843ba02a76b65905
+  data.tar.gz: e17a062f72e0ae56bc09b42ccaa237c12149b667b63dfb0e58a60dd3ea8e5830
 SHA512:
-  metadata.gz: 3137a8b5ecbf8850bbc8f96b46cb9c24688760e1d9c634a0735611a4beadafdf24fb6f1baa66de4f486157a31fbde3b36d1c489e887c1f27c1281225b944748e
-  data.tar.gz: 1bdf6749d6c7ba7a86f7c076f0f22a113731938456b801084cbfbd9cb6bd8e15f12a3748a521d4c267a6ad59cacbf40e22ad86d78cb62cc9c09fc0f534ef3076
+  metadata.gz: b574bc9f7c79a4405d7b86739e1bf50e0ccbc82f1016befedf3e5bbb0da040db263492ee8978cd3d83957546d47338980bcfba80770a620a9c637937675bad46
+  data.tar.gz: 2a83cf29049a8c4205851a83e12e0867f42ae684564c6bc7ae9e183b4399f9a2390f9be36724f137064bf8e76f74b30d977539fdb1c620972c05a949f19883f2

data/README.md

@@ -3,13 +3,15 @@
 NOTE: This is still a very early beta.
 
 Transform JSON data structures with the help of a simple schema and JsonPath expressions.
-Use the JsonDataExtractor gem to extract and modify data from complex JSON structures using a straightforward syntax
+Use the JsonDataExtractor gem to extract and modify data from complex JSON structures using a
+straightforward syntax
 and a range of built-in or custom modifiers.
 
 _Another try to make something for JSON that is XSLT for XML.
 We transform one JSON into another JSON with the help of a third JSON!!!111!!eleventy!!_
 
-Remap one JSON structure into another with some basic rules and [jsonpath](https://github.com/joshbuddy/jsonpath).
+Remap one JSON structure into another with some basic rules
+and [jsonpath](https://github.com/joshbuddy/jsonpath).
 
 Heavily inspired by [xml_data_extractor](https://github.com/monde-sistemas/xml_data_extractor).
 
@@ -32,8 +34,8 @@ Or install it yourself as:
 ## Usage
 
 JsonDataExtractor allows you to remap one JSON structure into another with some basic rules
-and [JSONPath](https://goessner.net/articles/JsonPath/) expressions. The process involves defining a schema that maps
-the input JSON structure to the desired output structure.
+and [JSONPath](https://goessner.net/articles/JsonPath/) expressions. The process involves defining a
+schema that maps the input JSON structure to the desired output structure.
 
 We'll base our examples on the following source:
 
@@ -78,22 +80,24 @@ We'll base our examples on the following source:
 
 ### Defining a Schema
 
-A schema consists of one or more mappings that specify how to extract data from the input JSON and where to place it in
-the output JSON.
+A schema consists of one or more mappings that specify how to extract data from the input JSON and
+where to place it in the output JSON.
 
-Each mapping has a path field that specifies the JsonPath expression to use for data extraction, and an optional
-modifier field that specifies one or more modifiers to apply to the extracted data. Modifiers are used to transform the
-data in some way before placing it in the output JSON.
+Each mapping has a path field that specifies the JsonPath expression to use for data extraction, and
+an optional modifier field that specifies one or more modifiers to apply to the extracted data.
+Modifiers are used to transform the data in some way before placing it in the output JSON.
 
-Here's an example schema that extracts the authors and categories from a JSON structure similar to the one used in the
-previous example (here it's in YAML just for readability):
+Here's an example schema that extracts the authors and categories from a JSON structure similar to
+the one used in the previous example:
 
-```yaml
-schemas:
-  authors:
-    path: $.store.book[*].author
-    modifier: downcase
-  categories: $..category
+```json
+{
+  "authors": {
+    "path": "$.store.book[*].author",
+    "modifier": "downcase"
+  },
+  "categories": "$..category"
+}
 ```
 
 The resulting json will be:
@@ -116,23 +120,67 @@ The resulting json will be:
 
 ```
 
-Modifiers can be supplied on object creation and/or added later by calling `#add_modifier` method. Please see specs for
-examples.
+### Modifiers
+
+Modifiers can be supplied on object creation and/or added later by calling `#add_modifier` method.
+Please see specs for examples.
+Modifiers allow you to perform transformations on the extracted data before it is returned. You can
+use modifiers to clean up the data, format it, or apply any custom logic you need.
+
+Modifiers can be defined in two ways: by providing a symbol corresponding to the name of the method
+or lambda that should be called on each extracted value, or by providing an anonymous lambda. Here's
+an example schema that uses both types of modifiers:
+
+```ruby
+schema = {
+  name:  '$.name',
+  age:   { path: '$.age', modifier: :to_i },
+  email: { path: '$.contact.email', modifiers: [:downcase, lambda { |email| email.gsub(/\s/, '') }] }
+}
+
+```
+
+In this schema, the name value is simply extracted as-is. The age value is extracted from the JSON,
+but it is modified with the `to_i` method, which converts the value to an integer. The email value
+is extracted from a nested object, and then passed through two modifiers: first `downcase` is called
+to convert the email address to all lowercase letters, and then an anonymous lambda is called to
+remove any whitespace in the email address.
+
+You can also define custom modifiers by passing a lambda to the `add_modifier` method on a
+JsonDataExtractor instance:
+
+```ruby
+extractor = JsonDataExtractor.new(json_data)
+extractor.add_modifier(:remove_newlines) { |value| value.gsub("\n", '') }
+
+schema = {
+  name: 'name',
+  bio:  { path: 'bio', modifiers: [:remove_newlines] }
+}
+
+results = extractor.extract(schema)
+
+```
+
+Modifiers are called in the order in which they are defined, so keep that in mind when defining your
+schema. By default JDE raises an ArgumentError if a modifier is not applicable, but this behaviour 
+can be configured to ignore missing modifiers. See Configuration options for details
 
 ### Nested schemas
 
-JDE supports nested schemas. Just provide your element with a type of `array` and add a `schema` key for its data.
+JDE supports nested schemas. Just provide your element with a type of `array` and add a `schema` key
+for its data.
 
 E.g. this is a valid real-life schema with nested data:
 
 ```json
 {
-  "name":      "$.Name",
-  "code":      "$.Code",
-  "services":  "$.Services[*].Code",
+  "name": "$.Name",
+  "code": "$.Code",
+  "services": "$.Services[*].Code",
   "locations": {
-    "path":   "$.Locations[*]",
-    "type":   "array",
+    "path": "$.Locations[*]",
+    "type": "array",
     "schema": {
       "name": "$.Name",
       "type": "$.Type",
@@ -141,6 +189,26 @@ E.g. this is a valid real-life schema with nested data:
   }
 }
 ```
+Nested schema can be also applied to objects, not arrays. See specs for more examples.
+
+## Configuration Options
+The JsonDataExtractor gem provides a configuration option to control the behavior when encountering invalid modifiers.
+
+### Strict Modifiers
+By default, the gem operates in strict mode, which means that if an invalid modifier is encountered, an `ArgumentError` will be raised. This ensures that only valid modifiers are applied to the extracted data.
+
+To change this behavior and allow the use of invalid modifiers without raising an error, you can configure the gem to operate in non-strict mode.
+
+```ruby
+JsonDataExtractor.configure do |config|
+  config.strict_modifiers = false
+end
+```
+When `strict_modifiers` is set to `false`, any invalid modifiers will be ignored, and the original value will be returned without applying any modification.
+
+It is important to note that enabling non-strict mode should be done with caution, as it can lead to unexpected behavior if there are typos or incorrect modifiers specified in the schema.
+
+By default, `strict_modifiers` is set to `true`, providing a safe and strict behavior. However, you can customize this configuration option according to your specific needs.
 
 ## TODO
 
@@ -148,25 +216,32 @@ Update this readme for better usage cases. Add info on arrays and modifiers.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
+the tests. You can
 also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
-version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag
+for the version,
 push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/austerlitz/json_data_extractor. This project
-is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+Bug reports and pull requests are welcome on GitHub
+at https://github.com/austerlitz/json_data_extractor. This project
+is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
+to
 the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of
+the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the JsonDataExtractor project’s codebases, issue trackers, chat rooms and mailing lists is
+Everyone interacting in the JsonDataExtractor project’s codebases, issue trackers, chat rooms and
+mailing lists is
 expected to follow
 the [code of conduct](https://github.com/austerlitz/json_data_extractor/blob/master/CODE_OF_CONDUCT.md).

data/lib/json_data_extractor.rb

@@ -1,4 +1,5 @@
 require 'src/version'
+require 'src/configuration'
 require 'jsonpath'
 
 class JsonDataExtractor
@@ -22,7 +23,16 @@ class JsonDataExtractor
       if val.is_a?(Hash)
         val.transform_keys!(&:to_sym)
         path       = val[:path]
-        modifiers  = Array(val[:modifiers] || val[:modifier]).map(&:to_sym)
+        modifiers  = Array(val[:modifiers] || val[:modifier]).map do |mod|
+          case mod
+          when Symbol, Proc
+            mod
+          when String
+            mod.to_sym
+          else
+            raise ArgumentError, "Invalid modifier: #{mod.inspect}"
+          end
+        end
         array_type = 'array' == val[:type]
         nested     = val.dup.delete(:schema)
       else
@@ -79,8 +89,21 @@ class JsonDataExtractor
       modifiers[modifier].call(value)
     elsif value.respond_to?(modifier)
       value.send(modifier)
+    elsif self.class.configuration.strict_modifiers
+      raise ArgumentError, "Invalid modifier: :#{modifier}"
     else
       value
     end
   end
+
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
 end

data/lib/src/configuration.rb

@@ -0,0 +1,9 @@
+class JsonDataExtractor
+  class Configuration
+    attr_accessor :strict_modifiers
+
+    def initialize
+      @strict_modifiers = true
+    end
+  end
+end

data/lib/src/version.rb

@@ -1,3 +1,3 @@
 class JsonDataExtractor
-  VERSION = '0.0.9'
+  VERSION = '0.0.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_data_extractor
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Max Buslaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - bin/setup
 - json_data_extractor.gemspec
 - lib/json_data_extractor.rb
+- lib/src/configuration.rb
 - lib/src/version.rb
 homepage: https://github.com/austerlitz/json_data_extractor
 licenses: