json_data_extractor 0.1.02 → 0.1.04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e129238a06ab31a41e5439e15d6e74e11acab71e7f330c7a920fbf2e48aa7373
-  data.tar.gz: f1774885ec819854ce471b998f4c70607e63556da177a0424c0ed2596fa6fc40
+  metadata.gz: 78d2adf9786c1444ad0307cbc8b5a613be04a8b4ace56c5b1973f619fed58177
+  data.tar.gz: 78bdd81ae9c8b6bb68742b64c7d389fa4844fad20b498cd927ca3dd85a03e9a6
 SHA512:
-  metadata.gz: 4a87eb088c46700e369151cf2915c486a72bdf45fa32be7159c9bbac0eb841728b030fb25f5bbad7832f6b91de7633c245c8039ce4f2fb693f4ebff0ff1a97b7
-  data.tar.gz: 82e91e822c36e513f6da9ad253b05ff68d83fea7e896282838c47ba61c6f79f598b6c80243e2ce9eea8649918c61610f44e402b083bea3921d6ac6f0b6743f74
+  metadata.gz: ac6bc721be1214813aecefc887cfddb7cfb6b55730506dec85fd853d35a01cd403fd1726f93bbabe7af8ed1ad25763df42e8b41ca8794e3a602f87aff040165e
+  data.tar.gz: 7c1ba2814904cba8d1041f652d313eb097c2c02e59ccd386abd95cbc64b32414ddfff8e2cf7dfb57c98045b1bb50631490ebde0adaede4b14b4455d1fe9b878e

data/README.md

@@ -146,54 +146,76 @@ schema = {
   absent_value: nil
 }
 ```
-
 ### 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 supplied on object creation and/or added later by calling the `#add_modifier` method. Modifiers allow you to perform transformations on the extracted data before it is returned. They are useful for cleaning up data, formatting it, or applying any custom logic.
+
+Modifiers can now be defined in several ways:
+
+1. **By providing a symbol**: This symbol should correspond to the name of a method (e.g., `:to_i`) that will be called on each extracted value.
+2. **By providing an anonymous lambda or block**: Use a lambda or block to define the transformation logic inline.
+3. **By providing any callable object**: A class or object that implements a `call` method can be used as a modifier. This makes it flexible to use pre-defined classes, lambdas, or procs.
 
-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:
+Here’s an example schema showcasing the use of modifiers:
 
 ```ruby
 schema = {
-  name:  '$.name',
-  age:   { path: '$.age', modifier: :to_i },
-  email: { path: '$.contact.email', modifiers: [:downcase, lambda { |email| email.gsub(/\s/, '') }] }
+  name:  '$.name', # Extract as-is
+  age:   { path: '$.age', modifier: :to_i }, # Apply the `to_i` method
+  email: { 
+    path: '$.contact.email', 
+    modifiers: [ 
+      :downcase, 
+      ->(email) { email.gsub(/\s/, '') } # Lambda to remove whitespace
+    ]
+  }
 }
-
 ```
 
-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.
+- **Name**: The value is simply extracted as-is.
+- **Age**: The extracted value is converted to an integer using the `to_i` method.
+- **Email**:
+  1. The value is transformed to lowercase using `downcase`.
+  2. Whitespace is removed using an anonymous lambda.
+
+#### Defining Custom Modifiers
 
-You can also define custom modifiers by passing a lambda to the `add_modifier` method on a
-JsonDataExtractor instance:
+You can define your own custom modifiers using `add_modifier`. A modifier can be defined using a block, a lambda, or any callable object (such as a class that implements `call`):
 
 ```ruby
+# Using a block
 extractor = JsonDataExtractor.new(json_data)
 extractor.add_modifier(:remove_newlines) { |value| value.gsub("\n", '') }
 
+# Using a class with a `call` method
+class ReverseString
+  def call(value)
+    value.reverse
+  end
+end
+
+extractor.add_modifier(:reverse_string, ReverseString.new)
+
+# Lambda example
+capitalize = ->(value) { value.capitalize }
+extractor.add_modifier(:capitalize, capitalize)
+
+# Apply these modifiers in a schema
 schema = {
   name: 'name',
-  bio:  { path: 'bio', modifiers: [:remove_newlines] }
+  bio:  { path: 'bio', modifiers: [:remove_newlines, :reverse_string] },
+  category: { path: 'category', modifier: :capitalize }
 }
 
+# Extract data
 results = extractor.extract(schema)
-
 ```
 
-You can also define any class that implements a `call` method and use it as a modifier.
+#### Modifier Order
+
+Modifiers are called in the order in which they are defined. Keep this in mind when chaining multiple modifiers for complex transformations. For example, if you want to first format a string and then clean it up (or vice versa), define the order accordingly.
 
-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
+You can also configure the behavior of modifiers. By default, JDE raises an `ArgumentError` if a modifier cannot be applied to the extracted value. However, this strict behavior can be configured to ignore such errors. See the **Configuration** section for more details.
 
 ### Maps
 

data/json_data_extractor.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'json_data_extractor/version'
 
@@ -8,30 +8,31 @@ Gem::Specification.new do |spec|
   spec.authors = ['Max Buslaev']
   spec.email   = ['max@buslaev.net']
 
-  spec.summary     = %q{Transform JSON data structures with the help of a simple schema and JsonPath expressions.
+  spec.summary     = '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
-and a range of built-in or custom modifiers.}
-  spec.description = %q{json_data_extractor makes it easy to extract data from complex JSON structures,
+and a range of built-in or custom modifiers.'
+  spec.description = 'json_data_extractor makes it easy to extract data from complex JSON structures,
 such as API responses or configuration files, using a schema that defines the path to the data and any necessary
-transformations. The schema is defined as a simple Ruby hash that maps keys to paths and optional modifiers.}
+transformations. The schema is defined as a simple Ruby hash that maps keys to paths and optional modifiers.'
   spec.homepage    = 'https://github.com/austerlitz/json_data_extractor'
   spec.license     = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'amazing_print'
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'amazing_print'
   spec.add_development_dependency 'rubocop'
 
   spec.add_dependency 'jsonpath'
+  spec.add_dependency 'oj'
 end

data/lib/json_data_extractor/extractor.rb

@@ -8,15 +8,21 @@ module JsonDataExtractor
     # @param json_data [Hash,String]
     # @param modifiers [Hash]
     def initialize(json_data, modifiers = {})
-      @data = json_data.is_a?(Hash) ? json_data.to_json : json_data
+      @data = json_data.is_a?(Hash) ? Oj.dump(json_data, mode: :compat) : json_data
       @modifiers = modifiers.transform_keys(&:to_sym)
       @results = {}
+      @path_cache = {}
     end
 
     # @param modifier_name [String, Symbol]
-    def add_modifier(modifier_name, &block)
+    # @param callable [#call, nil] Optional callable object
+    def add_modifier(modifier_name, callable = nil, &block)
       modifier_name = modifier_name.to_sym unless modifier_name.is_a?(Symbol)
-      modifiers[modifier_name] = block
+      modifiers[modifier_name] = callable || block
+
+      return if modifiers[modifier_name].respond_to?(:call)
+
+      raise ArgumentError, 'Modifier must be a callable object or a block'
     end
 
     # @param schema [Hash] schema of the expected data mapping
@@ -24,7 +30,10 @@ module JsonDataExtractor
       schema.each do |key, val|
         element = JsonDataExtractor::SchemaElement.new(val.is_a?(Hash) ? val : { path: val })
 
-        extracted_data = JsonPath.on(@data, element.path) if element.path
+        path = element.path
+        json_path = path ? (@path_cache[path] ||= JsonPath.new(path)) : nil
+
+        extracted_data = json_path&.on(@data)
 
         if extracted_data.nil? || extracted_data.empty?
           # we either got nothing or the `path` was initially nil

data/lib/json_data_extractor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonDataExtractor
-  VERSION = '0.1.02'
+  VERSION = '0.1.04'
 end

data/lib/json_data_extractor.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
 require 'jsonpath'
+require 'multi_json'
+require 'oj'
 require_relative 'json_data_extractor/version'
 require_relative 'json_data_extractor/configuration'
 require_relative 'json_data_extractor/extractor'
 require_relative 'json_data_extractor/schema_element'
 
+# Set MultiJson to use Oj for performance
+MultiJson.use(:oj)
+Oj.default_options = { mode: :compat }
+
 # 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
 # and a range of built-in or custom modifiers.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: json_data_extractor
 version: !ruby/object:Gem::Version
-  version: 0.1.02
+  version: 0.1.04
 platform: ruby
 authors:
 - Max Buslaev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,49 +39,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: amazing_print
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,13 +95,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: jsonpath
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jsonpath
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="