decontaminate 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf63bfebfa517d4e27965dee7e1793a1413c3758
-  data.tar.gz: 45604b7b1828c9e8c3b7d8271926188d03b09e94
+  metadata.gz: 7a19c276660c214e8f2048ee4b7368403c91ccb3
+  data.tar.gz: ef6acef5a324da44451220877c59b9db9ebd3432
 SHA512:
-  metadata.gz: 4ac44a8b13febd6e54446280107433e7ef07814376fafc200c1d59bb8ae6c40d848389f4cc8eb50b0cd934437e1582a02e687d2995dc1f9944628aa0c6f62838
-  data.tar.gz: eab601d9add7eea91c77f120ca4219bd0bead3ad0493c3e016260a1bfaf023f00d9ca6c590a6d075a42ee978815077e77e65f0641f6c716892d99c4794e98edc
+  metadata.gz: 893c0c7b972eafed7c7afda763602e3f3ef177da07350c39f888fd430aeda37828fa6ee5c5b72ba499279060261c6a9195648298bb69f0c13fc2a63c495dcaf9
+  data.tar.gz: e6ce0f2510bf0ca46eff1e5eff0ac772903b2f42cd7e0c8e57148a0719d04be5a5275aa694d539c8146ba8830b6b62ad01c970a2a6585dd4bb1a631ee942dc0e

data/README.md

@@ -68,6 +68,16 @@ Attributes can be specified with XPath syntax by prepending an `@` sign:
 scalar '@id', type: :integer
 ```
 
+#### Scalar Transformers
+
+In addition to customization of the parser using the `type:` keyword argument, `scalar` can be provided with a block that will allow custom transformation of the value. It will be supplied with the value as parsed according to the provided type, and the return value will be the result stored in the output.
+
+```ruby
+scalar 'RatingPercentage', key: 'rating_ratio', type: :float do |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:
@@ -169,6 +179,22 @@ There are some special things to note in the above example:
     hashes path: 'Article', key: 'articles' do; ...; end
     ```
 
+### Tuple Data
+
+Complementing `scalar` and `hash` is `tuple`, which accepts multiple paths and returns a fixed-length array containing an element for each path.
+
+```ruby
+tuple ['Height/text()', 'Height/@units'], key: 'height_with_units'
+```
+
+The `tuple` method is most useful when supplied with a block, which works like `scalar`'s value transformer, but is supplied with an argument for each path. This allows values to be parsed from multiple values in the source document.
+
+```ruby
+tuple ['Height/text()', 'Height/@units'], key: 'height_cm' do |height, units|
+  convert_units height.to_f, from: units, to: 'cm'
+end
+```
+
 ### 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/child_node_proxy.rb

@@ -10,7 +10,7 @@ module Decontaminate
 
       def decode(xml_node)
         child = xml_node && xml_node.at_xpath(xpath)
-        child && decoder.decode(child)
+        decoder.decode child
       end
     end
   end

data/lib/decontaminate/decoder/scalar.rb

@@ -1,32 +1,30 @@
 module Decontaminate
   module Decoder
     class Scalar
-      attr_reader :xpath, :type
+      attr_reader :xpath, :type, :transformer
 
-      def initialize(xpath, type)
+      def initialize(xpath, type, transformer)
         @xpath = xpath
         @type = type
+        @transformer = transformer
       end
 
       def decode(xml_node)
+        value = value_from_xml_node xml_node
+        value = transformer.call value if transformer
+        value
+      end
+
+      private
+
+      def value_from_xml_node(xml_node)
         child = xml_node && xml_node.at_xpath(xpath)
         return unless child
-        text = coerce_node_to_text child
 
-        case type
-        when :string
-          text
-        when :integer
-          text.to_i
-        when :float
-          text.to_f
-        when :boolean
-          coerce_string_to_boolean text
-        end
+        text = coerce_node_to_text child
+        coerce_string_to_type text, type
       end
 
-      private
-
       def coerce_node_to_text(node)
         if node.is_a?(Nokogiri::XML::Text) || node.is_a?(Nokogiri::XML::Attr)
           node.to_s
@@ -35,6 +33,19 @@ module Decontaminate
         end
       end
 
+      def coerce_string_to_type(str, type)
+        case type
+        when :string
+          str
+        when :integer
+          str.to_i
+        when :float
+          str.to_f
+        when :boolean
+          coerce_string_to_boolean str
+        end
+      end
+
       def coerce_string_to_boolean(str)
         str == 'true' || str == '1'
       end

data/lib/decontaminate/decoder/tuple.rb

@@ -0,0 +1,24 @@
+module Decontaminate
+  module Decoder
+    class Tuple
+      attr_reader :xpaths, :decoder, :transformer
+
+      def initialize(xpaths, decoder, transformer)
+        @xpaths = xpaths
+        @decoder = decoder
+        @transformer = transformer
+      end
+
+      def decode(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
+        end
+
+        tuple = transformer.call(*tuple) if transformer
+
+        tuple
+      end
+    end
+  end
+end

data/lib/decontaminate/decontaminator.rb

@@ -4,6 +4,7 @@ require_relative 'decoder/array'
 require_relative 'decoder/child_node_proxy'
 require_relative 'decoder/hash'
 require_relative 'decoder/scalar'
+require_relative 'decoder/tuple'
 
 module Decontaminate
   # Decontaminate::Decontaminator is the base class for creating XML extraction
@@ -21,20 +22,26 @@ module Decontaminate
         end
       end
 
-      def scalar(xpath, type: :string, key: infer_key(xpath))
-        add_decoder key, Decontaminate::Decoder::Scalar.new(xpath, type)
+      def scalar(xpath, type: :string, key: infer_key(xpath), &block)
+        add_decoder key, Decontaminate::Decoder::Scalar.new(xpath, type, block)
       end
 
-      def scalars(xpath = nil, path: nil, type: :string, key: nil)
+      def scalars(xpath = nil, path: nil, type: :string, key: nil, &block)
         resolved_path = path || infer_plural_path(xpath)
         key ||= infer_key(path || xpath)
 
-        singular = Decontaminate::Decoder::Scalar.new('.', type)
+        singular = Decontaminate::Decoder::Scalar.new('.', type, block)
         decoder = Decontaminate::Decoder::Array.new(resolved_path, singular)
 
         add_decoder key, decoder
       end
 
+      def tuple(paths, key:, type: :string, &block)
+        scalar = Decontaminate::Decoder::Scalar.new('.', type, nil)
+        decoder = Decontaminate::Decoder::Tuple.new(paths, scalar, block)
+        add_decoder key, decoder
+      end
+
       def hash(xpath = '.', key: infer_key(xpath), &body)
         decontaminator = Class.new(Decontaminate::Decontaminator, &body)
         add_decoder key, Decontaminate::Decoder::Hash.new(xpath, decontaminator)

data/lib/decontaminate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decontaminate
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexis King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -144,6 +144,7 @@ files:
 - lib/decontaminate/decoder/child_node_proxy.rb
 - lib/decontaminate/decoder/hash.rb
 - lib/decontaminate/decoder/scalar.rb
+- lib/decontaminate/decoder/tuple.rb
 - lib/decontaminate/decontaminator.rb
 - lib/decontaminate/version.rb
 homepage: https://github.com/lexi-lambda/decontaminate