saxerator 0.1.0 → 0.1.2

data/README.md

@@ -42,6 +42,7 @@ You can combine predicates to isolate just the tags you want.
 ```ruby
 parser.for_tag(:name).each { |x| all_the_names_in_a_document << x }
 parser.for_tag(:name).at_depth(2).each { |x| names_nested_under_document_root << x }
+parser.for_tag(:name).within(:author).each { |x| author_names << x }
 ```
 
 Known Issues

data/lib/saxerator/document.rb

@@ -16,6 +16,10 @@ module Saxerator
       Document.new(@source, @config, @latches + [Parser::DepthLatch.new(depth.to_i)])
     end
 
+    def within(tag)
+      Document.new(@source, @config, @latches + [Parser::WithinElementLatch.new(tag.to_s)])
+    end
+
     def each(&block)
       document = Parser::LatchedAccumulator.new(@config, @latches, block)
       parser = ::Nokogiri::XML::SAX::Parser.new document

data/lib/saxerator/parser/depth_latch.rb

@@ -6,14 +6,14 @@ module Saxerator
         @actual_depth = 0
       end
 
-      def start_element name, attrs = []
+      def start_element(_, __)
         @actual_depth += 1
         if @actual_depth == @depth
           open
         end
       end
 
-      def end_element name
+      def end_element(_)
         @actual_depth -= 1
       end
     end

data/lib/saxerator/parser/latched_accumulator.rb

@@ -11,19 +11,19 @@ module Saxerator
       end
 
       def reset_latches
-        @latches.each(&:reset)
+        @latches.each { |latch| latch.reset }
       end
 
       def check_latches_and_passthrough(method, *args)
         @latches.each { |latch| latch.send(method, *args) }
-        if @latches.all?(&:open?)
+        if @latches.all? { |latch| latch.open? }
           @accumulator.send(method, *args)
         else
           reset_latches
         end
       end
 
-      def xmldecl version, encoding, standalone
+      def xmldecl(version, encoding, standalone)
         check_latches_and_passthrough(:xmldecl, version, encoding, standalone)
       end
 
@@ -35,39 +35,39 @@ module Saxerator
         check_latches_and_passthrough(:end_document)
       end
 
-      def start_element name, attrs = []
+      def start_element(name, attrs = [])
         check_latches_and_passthrough(:start_element, name, attrs)
       end
 
-      def end_element name
+      def end_element(name)
         check_latches_and_passthrough(:end_element, name)
       end
 
-      def start_element_namespace name, attrs = [], prefix = nil, uri = nil, ns = []
+      def start_element_namespace(name, attrs = [], prefix = nil, uri = nil, ns = [])
         check_latches_and_passthrough(:start_element_namespace, name, attrs, prefix, uri, ns)
       end
 
-      def end_element_namespace name, prefix = nil, uri = nil
+      def end_element_namespace(name, prefix = nil, uri = nil)
         check_latches_and_passthrough(:end_element_namespace, name, prefix, uri)
       end
 
-      def characters string
+      def characters(string)
         check_latches_and_passthrough(:characters, string)
       end
 
-      def comment string
+      def comment(string)
         check_latches_and_passthrough(:comment, string)
       end
 
-      def warning string
+      def warning(string)
         check_latches_and_passthrough(:warning, string)
       end
 
-      def error string
+      def error(string)
         check_latches_and_passthrough(:error, string)
       end
 
-      def cdata_block string
+      def cdata_block(string)
         check_latches_and_passthrough(:cdata_block, string)
       end
     end

data/lib/saxerator/parser/within_element_latch.rb

@@ -0,0 +1,30 @@
+module Saxerator
+  module Parser
+    class WithinElementLatch < DocumentLatch
+      def initialize(name)
+        @name = name
+        @inner_depth = 0
+      end
+
+      def start_element name, _
+        if @inner_depth == 0
+          if name == @name
+            @inner_depth += 1
+          end
+        else
+          open if @inner_depth == 1
+          @inner_depth += 1
+        end
+      end
+
+      def end_element _
+        if @inner_depth > 0
+          @inner_depth -= 1
+          close if @inner_depth == 0
+        end
+      end
+
+      def reset; end
+    end
+  end
+end

data/lib/saxerator/version.rb

@@ -1,3 +1,3 @@
 module Saxerator
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/saxerator.rb

@@ -10,6 +10,7 @@ require 'saxerator/parser/accumulator'
 require 'saxerator/parser/document_latch'
 require 'saxerator/parser/element_name_latch'
 require 'saxerator/parser/depth_latch'
+require 'saxerator/parser/within_element_latch'
 require 'saxerator/parser/latched_accumulator'
 
 module Saxerator

data/spec/lib/saxerator_spec.rb

@@ -35,7 +35,7 @@ describe Saxerator do
     context "with a string with an element at multiple depths" do
       let(:xml) do
         <<-eos
-          <books>
+          <publications>
             <book>
               <name>How to eat an airplane</name>
               <author>
@@ -49,7 +49,13 @@ describe Saxerator do
                 <name>Jeanne Clarewood</name>
               </author>
             </book>
-          </books>
+            <article>
+              <name>Is our children learning?</name>
+              <author>
+                <name>Hazel Nutt</name>
+              </author>
+            </article>
+          </publication>
         eos
       end
 
@@ -57,15 +63,28 @@ describe Saxerator do
         results = []
         subject.at_depth(3).each { |x| results << x }
         results.should == [
-          'How to eat an airplane', {'name' => ['Leviticus Alabaster', 'Eunice Diesel']},
-          'To wallop a horse in the face', {'name' => 'Jeanne Clarewood'}
+          'How to eat an airplane', { 'name' => ['Leviticus Alabaster', 'Eunice Diesel'] },
+          'To wallop a horse in the face', { 'name' => 'Jeanne Clarewood' },
+          'Is our children learning?', { 'name' => 'Hazel Nutt' }
         ]
       end
 
       it "should only parse the requested tag depth and tag" do
         results = []
         subject.at_depth(3).for_tag(:name).each { |x| results << x }
-        results.should == ['How to eat an airplane', 'To wallop a horse in the face']
+        results.should == ['How to eat an airplane', 'To wallop a horse in the face', 'Is our children learning?']
+      end
+
+      it "should only parse tags nested inside the specified tag" do
+        results = []
+        subject.within(:article).each { |x| results << x }
+        results.should == ['Is our children learning?', { 'name' => 'Hazel Nutt' }]
+      end
+
+      it "should only parse specified tags nested inside a specified tag" do
+        results = []
+        subject.for_tag(:name).within(:article).each { |x| results << x }
+        results.should == ['Is our children learning?', 'Hazel Nutt'  ]
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saxerator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -85,6 +85,7 @@ files:
 - lib/saxerator/parser/document_latch.rb
 - lib/saxerator/parser/element_name_latch.rb
 - lib/saxerator/parser/latched_accumulator.rb
+- lib/saxerator/parser/within_element_latch.rb
 - lib/saxerator/string_with_attributes.rb
 - lib/saxerator/version.rb
 - lib/saxerator/xml_node.rb