decontaminate 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a19c276660c214e8f2048ee4b7368403c91ccb3
-  data.tar.gz: ef6acef5a324da44451220877c59b9db9ebd3432
+  metadata.gz: f731111d47eb751ba591ab27befd41721b22ab09
+  data.tar.gz: 4355d58ea218c7ea312e50ccd37bc4dd314345a9
 SHA512:
-  metadata.gz: 893c0c7b972eafed7c7afda763602e3f3ef177da07350c39f888fd430aeda37828fa6ee5c5b72ba499279060261c6a9195648298bb69f0c13fc2a63c495dcaf9
-  data.tar.gz: e6ce0f2510bf0ca46eff1e5eff0ac772903b2f42cd7e0c8e57148a0719d04be5a5275aa694d539c8146ba8830b6b62ad01c970a2a6585dd4bb1a631ee942dc0e
+  metadata.gz: 95e52b38d6260c8789ebedab7a56efa09e51464eefce1e02ac56adc3d82c8eea6062da2fabcb17e1cee2a675bc4359e94dd515dc676e38fa21857ee0396c2598
+  data.tar.gz: 1c6d7a83b722b26fc570dd4198e0b6ef3c6bd88c77bf6a3e0c759163da1bfecb44bbec44d000517765627652096465817c8e3250e7f743ad610d2ac6b99c1984

data/README.md

@@ -1,4 +1,4 @@
-# Decontaminate
+# Decontaminate [![Gem Version](https://badge.fury.io/rb/decontaminate.svg)](https://badge.fury.io/rb/decontaminate) [![Build Status](https://travis-ci.org/lexi-lambda/decontaminate.svg?branch=0.2.0)](https://travis-ci.org/lexi-lambda/decontaminate)
 
 Decontaminate is a tool for extracting information from large, potentially nested XML documents. It provides a simple Ruby DSL for selecting values from Nokogiri objects and storing the results in JSON-like Ruby hashes and arrays.
 
@@ -78,6 +78,19 @@ scalar 'RatingPercentage', key: 'rating_ratio', type: :float do |percentage|
 end
 ```
 
+Transformer blocks are evaluated in the context of the decontaminator instance, so instance methods can be called. Additionally, it is possible to call instance methods as transformers directly without needing to pass a block by passing the name of the method as the `transformer:` keyword argument.
+
+```ruby
+scalar 'RatingPercentage',
+       key: 'rating_ratio',
+       type: :float,
+       transformer: :percentage_to_ratio
+
+def percentage_to_ratio(percentage)
+  percentage && percentage / 100.0
+end
+```
+
 ### Nested Values
 
 It's also possible to specify nested or even deeply nested hashes with the `hash` class method:
@@ -195,6 +208,8 @@ tuple ['Height/text()', 'Height/@units'], key: 'height_cm' do |height, units|
 end
 ```
 
+Tuples also support the shorthand `transformer:` argument that `scalar` and `scalars` support.
+
 ### Flattening nested data
 
 Since source data is sometimes more nested than is desired, the `with` method is a helper for scoping decontamination directives to a given XML element without increasing the nesting depth of the resulting object. Like `hash`, it accepts an XPath and a block, but the attributes created from within the block will not be wrapped in a hash.

data/lib/decontaminate/decoder/array.rb

@@ -8,11 +8,11 @@ module Decontaminate
         @decoder = decoder
       end
 
-      def decode(xml_node)
+      def decode(this, xml_node)
         children = xml_node && xml_node.xpath(xpath)
         return [] unless children
         children.map do |child|
-          decoder.decode child
+          decoder.decode this, child
         end
       end
     end

data/lib/decontaminate/decoder/child_node_proxy.rb

@@ -8,9 +8,9 @@ module Decontaminate
         @decoder = decoder
       end
 
-      def decode(xml_node)
+      def decode(this, xml_node)
         child = xml_node && xml_node.at_xpath(xpath)
-        decoder.decode child
+        decoder.decode this, child
       end
     end
   end

data/lib/decontaminate/decoder/hash.rb

@@ -8,9 +8,9 @@ module Decontaminate
         @decontaminator = decontaminator
       end
 
-      def decode(xml_node)
+      def decode(this, xml_node)
         child = xml_node && xml_node.at_xpath(xpath)
-        decontaminator.new(child).as_json
+        decontaminator.new(child, instance: this).as_json
       end
     end
   end

data/lib/decontaminate/decoder/scalar.rb

@@ -9,9 +9,9 @@ module Decontaminate
         @transformer = transformer
       end
 
-      def decode(xml_node)
+      def decode(this, xml_node)
         value = value_from_xml_node xml_node
-        value = transformer.call value if transformer
+        value = this.instance_exec(value, &transformer) if transformer
         value
       end
 

data/lib/decontaminate/decoder/tuple.rb

@@ -9,13 +9,13 @@ module Decontaminate
         @transformer = transformer
       end
 
-      def decode(xml_node)
+      def decode(this, xml_node)
         xml_nodes = xpaths.map { |xpath| xml_node && xml_node.at_xpath(xpath) }
         tuple = xml_nodes.map do |element_node|
-          decoder.decode element_node
+          decoder.decode this, element_node
         end
 
-        tuple = transformer.call(*tuple) if transformer
+        tuple = this.instance_exec(*tuple, &transformer) if transformer
 
         tuple
       end

data/lib/decontaminate/decontaminator.rb

@@ -22,13 +22,24 @@ module Decontaminate
         end
       end
 
-      def scalar(xpath, type: :string, key: infer_key(xpath), &block)
+      def scalar(xpath,
+                 type: :string,
+                 key: infer_key(xpath),
+                 transformer: nil,
+                 &block)
+        block ||= self_proc_for_method transformer
         add_decoder key, Decontaminate::Decoder::Scalar.new(xpath, type, block)
       end
 
-      def scalars(xpath = nil, path: nil, type: :string, key: nil, &block)
+      def scalars(xpath = nil,
+                  path: nil,
+                  type: :string,
+                  key: nil,
+                  transformer: nil,
+                  &block)
         resolved_path = path || infer_plural_path(xpath)
         key ||= infer_key(path || xpath)
+        block ||= self_proc_for_method transformer
 
         singular = Decontaminate::Decoder::Scalar.new('.', type, block)
         decoder = Decontaminate::Decoder::Array.new(resolved_path, singular)
@@ -36,9 +47,16 @@ module Decontaminate
         add_decoder key, decoder
       end
 
-      def tuple(paths, key:, type: :string, &block)
+      def tuple(paths,
+                key:,
+                type: :string,
+                transformer: nil,
+                &block)
+        block ||= self_proc_for_method transformer
+
         scalar = Decontaminate::Decoder::Scalar.new('.', type, nil)
         decoder = Decontaminate::Decoder::Tuple.new(paths, scalar, block)
+
         add_decoder key, decoder
       end
 
@@ -84,12 +102,19 @@ module Decontaminate
       def infer_plural_path(xpath)
         xpath + '/' + xpath.split('/').last.singularize
       end
+
+      private
+
+      def self_proc_for_method(sym)
+        sym && proc { |*args| send sym, *args }
+      end
     end
 
     attr_reader :xml_node
 
-    def initialize(xml_node)
+    def initialize(xml_node, instance: nil)
       @xml_node = xml_node
+      @instance = instance
     end
 
     def as_json
@@ -97,7 +122,7 @@ module Decontaminate
 
       root_node = xml_node && xml_node.at_xpath(root)
       decoders.each do |key, decoder|
-        acc[key] = decoder.decode root_node
+        acc[key] = decoder.decode instance, root_node
       end
 
       acc
@@ -105,6 +130,12 @@ module Decontaminate
 
     private
 
+    # The canonical instance that all blocks should run within. Child
+    # (anonymous) decontaminators should delegate to the parent.
+    def instance
+      @instance || self
+    end
+
     def decoders
       self.class.decoders
     end

data/lib/decontaminate/version.rb

@@ -1,3 +1,3 @@
 module Decontaminate
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decontaminate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alexis King