json_data_extractor 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b205c1e3094b426d39161a47261d0d0168244cff62b3c99b557d7f0e286a322
-  data.tar.gz: 3bf7cc322309d9e0c7bb8997eaae41346fbb97e42280a78b5e663c8307ec5311
+  metadata.gz: 2a35a6bf0ed27b3f5a0ef9a13e96ff21ac28ff873772696aef65069821dbf23e
+  data.tar.gz: 9dba998316601c445cebe5872f04e18c68575196b9ed52e4128f01b47139049a
 SHA512:
-  metadata.gz: 7973f7ca4b7575333282cbb0033f6d326b30003b8c36a7f9b7f0be4e7ee6194bbeb712e5abe2446d77e8ab8ffd5b7bf48c9d125a280da4c7d54aa62d11d2c0a8
-  data.tar.gz: 23507463438d1a106da73c0b561912ac16963aa49160563d876883586792c89ca2a2b0531ab236fffb11a45dc2eba0573f012727b28b518cb72ea3b7db35d558
+  metadata.gz: 204620707292cb9e1f805db3bbc72b44e6dca7f1dc86dceefa8b9b1126f437fa70bc152af38bb502741d620884f141b46664a6a6c80fb135bc20f394b8d62300
+  data.tar.gz: '0482bfd00032c8e07c0a97ce88c6bbfba824bc6ea7eb6ec7aecd329c92982afae2853333f096695d68f52f737a01cca253a9f199616a22e565211b60b9d0f6eb'

data/README.md

@@ -120,6 +120,35 @@ The resulting json will be:
 
 ```
 
+
+### Handling Default Values
+
+With JsonDataExtractor, you can specify default values in your schema for keys that might be absent in the input JSON. Use the `path` and `default` keys in the schema for this purpose.
+
+```ruby
+schema = {
+  absent_value: { path: nil },
+  default: { path: '$.some_real_path', default: 'foo' },
+  default_with_lambda: { path: '$.table', default: -> { 'DEFAULT' } },
+  absent_with_default: { path: nil, default: 'bar' }
+}
+```
+
+- `absent_value`: Will be `nil` in the output as there's no corresponding key in the input JSON and no default is provided.
+- `default`: Will either take the value from `$.some_real_path` in the input JSON or 'foo' if the path does not exist.
+- `default_with_lambda`: Will take the value from `$..table` in the input JSON or 'DEFAULT' if the path does not exist.
+- `absent_with_default`: Will be 'bar' in the output as there's no corresponding key in the input JSON but a default is provided.
+
+#### Simplified Syntax for Absent Values
+
+For keys that you expect to be absent in the input JSON but still want to include in the output with a `nil` value, you can use a simplified syntax by setting the schema value to `nil`.
+
+```ruby
+schema = {
+  absent_value: nil
+}
+```
+
 ### Modifiers
 
 Modifiers can be supplied on object creation and/or added later by calling `#add_modifier` method.
@@ -191,7 +220,7 @@ schema     = {
     map:  FUEL_TYPES
   }
 }
-result     = described_class.new(data).extract(schema) # => {"fuel":["Petrol","Diesel",nil,"Unknown"]}
+result     = JsonDataExtractor.new(data).extract(schema) # => {"fuel":["Petrol","Diesel",nil,"Unknown"]}
 ```
 
 A map is essentially a dictionary that defines key-value pairs, where the keys represent the source

data/lib/json_data_extractor.rb

@@ -20,9 +20,11 @@ class JsonDataExtractor
   def extract(schema)
     results = {}
     schema.each do |key, val|
+      default_value = nil
       if val.is_a?(Hash)
         val.transform_keys!(&:to_sym)
         path       = val[:path]
+        default_value = val[:default]
         maps       = Array([val[:maps] || val[:map]]).flatten.compact.map do |map|
           if map.is_a?(Hash)
             map
@@ -48,11 +50,12 @@ class JsonDataExtractor
         maps      = []
       end
 
-      extracted_data = JsonPath.on(@data, path)
+      extracted_data = JsonPath.on(@data, path) if path
 
-      if extracted_data.empty?
-        results[key] = nil
+      if extracted_data.nil? || extracted_data.empty?
+        results[key] = default_value.is_a?(Proc) ? default_value.call : (default_value || nil)
       else
+        extracted_data.map! { |val| val.nil? ? default_value : val }
         transformed_data = apply_modifiers(extracted_data, modifiers)
         results[key]     = apply_maps(transformed_data, maps)
 
@@ -107,7 +110,7 @@ class JsonDataExtractor
     elsif value.respond_to?(modifier)
       value.send(modifier)
     elsif self.class.configuration.strict_modifiers
-      raise ArgumentError, "Invalid modifier: :#{modifier}"
+      raise ArgumentError, "Modifier: <:#{modifier}> cannot be applied to value <#{value.inspect}>"
     else
       value
     end

data/lib/src/version.rb

@@ -1,3 +1,3 @@
 class JsonDataExtractor
-  VERSION = '0.0.12'
+  VERSION = '0.0.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_data_extractor
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors:
 - Max Buslaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler