xml_dsl 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8039a8956aa2ed81f448ceb371bf92523f9f1a3c
-  data.tar.gz: 5d8486f335d6a3fc412ce09ebe312a6738b187fe
+  metadata.gz: a06859b2ea2ebab29cd30ca0dd451005459ed911
+  data.tar.gz: 476df9143b24ecc659d2751d06d4b315216394c5
 SHA512:
-  metadata.gz: f24e74b53fb2e66b325c032c749ff1795a6268fbc79f1ad2cb9a0c0c392266d774027ab0cb6d5a4b86951813b52d3f6cc8ea87720b57714dd29f4cf7787178e0
-  data.tar.gz: 3981133746da9191c4b25555f65915257a3204772204a1289efb52e77e10e2f96d075b1e264a3d1721ced396bae67cd0c754e9c64fd041a97872e99fbdf69dc3
+  metadata.gz: 8803eeda3e875094fb8a52fed5bf224b5fd0b9f3eebf94f7c6f9632fa8d5be086871bc3e14a05872c0d19795ca6c804662cc98fde2f79fd75554c3db86384343
+  data.tar.gz: 20d55686eebf557caefd68da858ffd8215c1105ae8d53d9231d0d48309402a6cdb469313d58010f047b13d6667a7c28802ab485844b33f26c228a66316667950

data/README.md

@@ -70,6 +70,16 @@ Then we can define our mapper as following
         # any length of root path can be provided
         define_xml_parser Hash, :root, :offer do
 
+          # Here is basic validation blocks
+          # They MUST return some bool (if block)
+          before_parse? do |node|
+            !node.search('magick').empty?
+          end
+          
+          # Or just check for must_have key (or path to it)
+          before_parse? :jim
+          before_parse? [:areas, 'area[type=hobby]']
+
           # We can define a block to call every time an XmlDsl::ParseError os raised
           # it is raised if null: true is passed to field declaration, or manually via raise XmlDsl::ParseError
           error_handle do |e, node|
@@ -100,10 +110,28 @@ Then we can define our mapper as following
                 0
             end
           end
+          
+          # If something goes wrong - just raise XmlDsl::ParseError manually
+          field :fuu do |_, node|
+            raise XmlDsl::ParseError, 'FUUU' if node.search(:areas).length > 5
+          end
         end
       end
 ```
 
+Then you can use your newly defined parser as you wish:
+```
+    parser = Parser.new(nifty_xml, some_logger_eg)
+    
+    # just iterate with block
+    parser.iterate do |instance|
+        do_stuff_with_newly_mapped_instance_whatever(instance)
+    end
+    
+    # or you can pass some accumulator for your instances to be put into
+    parser.iterate acc: []
+```
+
 ## Contributing
 
 Feel free to request for some features or fork - implement - pul request.

data/lib/xml_dsl/block_method.rb

@@ -7,11 +7,11 @@ module XmlDsl
       @block = block if block_given?
     end
 
-    def call(instance, node, parser)
+    def call(a, b = nil, c = nil)
       if block
-        self.send method, *[instance, node, parser] + args, &block
+        self.send method, *[a, b, c].compact + args, &block
       else
-        self.send method, *[instance, node, parser] + args
+        self.send method, *[a, b, c].compact + args
       end
     end
 
@@ -21,15 +21,7 @@ module XmlDsl
         instance[target] = parser.instance_exec instance, node, &block
       else
         raise ArgumentError, 'No source specified' if source.nil?
-        source = case [source.class]
-                   when [Symbol]
-                     source.to_s
-                   when [Array]
-                     source.join('/')
-                   else
-                     source.to_s
-                 end
-        instance[target] = node.search(source).send(getter).send(matcher)
+        instance[target] = node.search(convert_source(source)).send(getter).send(matcher)
       end
       if null
         raise XmlDsl::ParseError, "#{target} is empty. Node: #{node}" if instance[target].nil? || instance[target] == ""
@@ -39,5 +31,26 @@ module XmlDsl
     def error_handle(exception, node, parser, &block)
       parser.instance_exec exception, node, &block
     end
+
+    def before_parse?(node, parser, key = nil, &block)
+      if block_given?
+        parser.instance_exec node, &block
+      else
+        raise ArgumentError, 'Key to check is nil' if key.nil?
+        !node.search(convert_source(key)).empty?
+      end
+    end
+
+    private
+    def convert_source(source)
+      case [source.class]
+        when [Symbol]
+          source.to_s
+        when [Array]
+          source.join('/')
+        else
+          source.to_s
+      end
+    end
   end
 end

data/lib/xml_dsl/extensions.rb

@@ -23,6 +23,11 @@ module XmlDsl
         raise ArgumentError, "If there is no @xml in parser, pass it to iterate" if xml_obj.nil?
         xml_obj.search(_xml_root_path).each do |node|
           begin
+            valid = _xml_parse_callbacks[:before_parsers].map do |bm|
+              bm.call node, self
+            end.reduce(true, :&)
+            next unless valid
+            # mapping
             instance = _xml_target_class.new
             _xml_parse_callbacks[:readers].each do |bm|
               bm.call instance, node, self

data/lib/xml_dsl/version.rb

@@ -1,3 +1,3 @@
 module XmlDsl
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/xml_dsl/xml_parser.rb

@@ -28,14 +28,27 @@ module XmlDsl
       @owner.instance_variable_set :@xml_parser, self
     end
 
+    # Field for parse definition
+    # receives args: target, source = nil, getter: :text, matcher: :to_s, null: false
+    # or block with |instance, node|
     def field(*args, &block)
       callbacks[:readers] << XmlDsl::BlockMethod.new(:field, *args, &block)
     end
 
+    # Error handler for automatic or manually raised XmlDsl::ParseError exceptions
+    # receives block with two args error and node, that caused the error to occur
+    # block with |exception, node|
     def error_handle(*args, &block)
       callbacks[:error_handlers] << XmlDsl::BlockMethod.new(:error_handle, *args, &block)
     end
 
+    # Validation like block
+    # receives key: symbol, string, or array of similar
+    # returns bool if true - normal, false - skip this node
+    def before_parse?(*args, &block)
+      callbacks[:before_parsers] << XmlDsl::BlockMethod.new(:before_parse?, *args, &block)
+    end
+
     def setup_parser_instance(instance)
       state_lock.synchronize do
         instance.instance_variable_set :@_xml_root_path, root_path

data/spec/fixtures/some.xml

@@ -35,7 +35,9 @@
       <area type="total">30</area>
       <area type="live">17</area>
       <area type="kitchen">7</area>
+      <area type="hobby">42</area>
     </areas>
     <magick>woodoo</magick>
+    <jim>Jarmush</jim>
   </offer>
 </root>

data/spec/integrational/example_parser_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'support/xml'
 
 describe 'Example Xml Mapper Spec' do
-  context 'normal parser' do
+  context 'basic parser' do
     before(:each) do
       clazz = Class.new
       clazz.class_eval do
@@ -100,6 +100,37 @@ describe 'Example Xml Mapper Spec' do
       expect(@external_obj).to receive(:notify).with(kind_of(Nokogiri::XML::Element)).once
       @parser.iterate
     end
+  end
+
+  context 'Parser with before_parse validation (good)' do
+    before(:each) do
+      clazz = Class.new
+      @external_obj = double
+      clazz.class_eval do
+        attr_accessor :xml, :external
+        def initialize(xml, external)
+          self.xml = xml
+          self.external = external
+        end
+
+        define_xml_parser Hash, :root, :offer do
+
+          before_parse? do |node|
+            !node.search('magick').empty?
+          end
+
+          before_parse? :jim
+          before_parse? [:areas, 'area[type=hobby]']
+
+          field :id, :id, matcher: :to_i
+          field :minutes, :distance, matcher: :to_i
+        end
+      end
+      @parser = clazz.new some_xml, @external_obj
+    end
 
+    it 'returns only one object' do
+      expect(@parser.iterate(acc:[]).length).to eql(1)
+    end
   end
 end

data/spec/unit/xml_dsl_spec.rb

@@ -52,6 +52,10 @@ describe XmlDsl do
           expect { in_definition { error_handle  } }.to change(xml_parser.callbacks[:error_handlers], :length).by(1)
         end
 
+        it 'defining before_parse is put inside before_parsers' do
+          expect { in_definition { before_parse? {} } }.to change(xml_parser.callbacks[:before_parsers], :length).by(1)
+        end
+
         def in_definition(&block)
           xml_parser.instance_eval &block
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml_dsl
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Vladislav Bogomolov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri