json_data_extractor 0.1.02 → 0.1.03

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e129238a06ab31a41e5439e15d6e74e11acab71e7f330c7a920fbf2e48aa7373
-  data.tar.gz: f1774885ec819854ce471b998f4c70607e63556da177a0424c0ed2596fa6fc40
+  metadata.gz: 295cd6c872605a86b0656c236dd11ec26deb323aaea9f6a07478871f52fa5950
+  data.tar.gz: daad530af7cdb9880d28f92c8f0235c0f095466974fa6ed61d6d46e1113882f2
 SHA512:
-  metadata.gz: 4a87eb088c46700e369151cf2915c486a72bdf45fa32be7159c9bbac0eb841728b030fb25f5bbad7832f6b91de7633c245c8039ce4f2fb693f4ebff0ff1a97b7
-  data.tar.gz: 82e91e822c36e513f6da9ad253b05ff68d83fea7e896282838c47ba61c6f79f598b6c80243e2ce9eea8649918c61610f44e402b083bea3921d6ac6f0b6743f74
+  metadata.gz: a146df922bbe2e84b9ad7a7cffdc64f1f1fe9be243764049a41a5c13ebb7ea31ddd07525e628056b884e5ad53c3ef3780cbe3c5fed6dc46b23f695534b6d4188
+  data.tar.gz: ef3b8d6ff6589f72e2955c43b95ffea59459b4f7d524fbd7513c7133a540ec27be4257ffaefa08137e13abb131aa0e55a6fdec42df769cca6d44361768815532

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/lib/json_data_extractor/extractor.rb

@@ -14,9 +14,14 @@ module JsonDataExtractor
     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

data/lib/json_data_extractor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_data_extractor
 version: !ruby/object:Gem::Version
-  version: 0.1.02
+  version: 0.1.03
 platform: ruby
 authors:
 - Max Buslaev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler