json_data_extractor 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be51d8200f061eb267a9c591934a29072729462d242c349c6057e48cb5e77627
-  data.tar.gz: 88213a955399a735f2cd15546d9c0b9ad22ba38de8798e9070d5a35e4a47902f
+  metadata.gz: aeef2dddd8e11795c682d9db785b955164fbab87e4dc1c63843ba02a76b65905
+  data.tar.gz: e17a062f72e0ae56bc09b42ccaa237c12149b667b63dfb0e58a60dd3ea8e5830
 SHA512:
-  metadata.gz: f724f3a5b3542644abe1103d8831bdefa0e6bbf2f073d8bfe928cce6f8d42992ecf570527f4adceba4b8a01f12fe0146511ae2ef80301f1a48a52b7e0f5c697a
-  data.tar.gz: e4318e950ec778eb19558cc1a7da37234f730ba977b42ff19f5be4d5b86c8b7a4b8a7e50a85705fa38c89d41d9cb0f39493d8f6c0bfa1e79215956f2e9817528
+  metadata.gz: b574bc9f7c79a4405d7b86739e1bf50e0ccbc82f1016befedf3e5bbb0da040db263492ee8978cd3d83957546d47338980bcfba80770a620a9c637937675bad46
+  data.tar.gz: 2a83cf29049a8c4205851a83e12e0867f42ae684564c6bc7ae9e183b4399f9a2390f9be36724f137064bf8e76f74b30d977539fdb1c620972c05a949f19883f2

data/README.md

@@ -88,14 +88,16 @@ an optional modifier field that specifies one or more modifiers to apply to the
 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):
-
-```yaml
-schemas:
-  authors:
-    path: $.store.book[*].author
-    modifier: downcase
-  categories: $..category
+the one used in the previous example:
+
+```json
+{
+  "authors": {
+    "path": "$.store.book[*].author",
+    "modifier": "downcase"
+  },
+  "categories": "$..category"
+}
 ```
 
 The resulting json will be:
@@ -161,7 +163,8 @@ results = extractor.extract(schema)
 ```
 
 Modifiers are called in the order in which they are defined, so keep that in mind when defining your
-schema.
+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
 
@@ -186,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
 

data/lib/json_data_extractor.rb

@@ -1,4 +1,5 @@
 require 'src/version'
+require 'src/configuration'
 require 'jsonpath'
 
 class JsonDataExtractor
@@ -88,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.10'
+  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.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Max Buslaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-12 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: