sergio 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+*.swp
+*.swo

data/Gemfile.lock

@@ -4,7 +4,6 @@ GEM
     diff-lcs (1.1.2)
     nokogiri (1.4.4)
     rake (0.9.0)
-    rcov (0.9.9)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -20,5 +19,4 @@ PLATFORMS
 DEPENDENCIES
   nokogiri
   rake
-  rcov
   rspec

data/lib/sergio/hash_methods.rb

@@ -17,8 +17,12 @@ module Sergio
       k = k.is_a?(Array) ? k[0] : k
       v = hash[k]
       if v
-        if v.is_a?(Hash) && path.length > 0
-          value_at_path(path, v)
+        if path.length > 0
+          if v.is_a?(Hash)
+            value_at_path(path, v)
+          elsif v.last.is_a?(Hash)
+            value_at_path(path, v.last)
+          end
         else
           v
         end
@@ -54,5 +58,37 @@ module Sergio
       end
       v
     end
+
+    def hash_recursive_append(lval, rval)
+      r = {}
+      v = lval.merge(rval) do |key, oldval, newval|
+        r[key] = if oldval.is_a?(Hash) && newval.is_a?(Hash)
+          if newval.size == 0
+            [oldval, newval]
+          else
+            hash_recursive_append(oldval, newval)
+          end
+        else
+          if oldval.is_a?(Array)
+            if oldval.last.is_a?(Hash) && newval.is_a?(Hash) && newval.size > 0
+              oldval << hash_recursive_append(oldval.pop, newval)
+            else
+              oldval << newval
+            end
+          elsif newval.is_a?(Array)
+            newval << oldval
+          else
+            [oldval] << newval
+          end
+        end
+      end
+      v
+    end
+  end
+
+  def remove_empty_hashes(hash)
+    hash.delete_if do |k,v|
+      true
+    end
   end
 end

data/lib/sergio/sergio_config.rb

@@ -23,6 +23,7 @@ module Sergio
       newname = name unless newname
       name = [name] unless name.is_a?(Array)
       newname = [newname] unless newname.is_a?(Array)
+      aggregate_element = false
 
       name.each do |n|
         @current_path << n
@@ -42,11 +43,12 @@ module Sergio
       if blk.arity < 1
         blk.call
         callback = lambda {|v|{}}
+        aggregate_element = true
       else
         callback = blk
       end
 
-      elem = SergioElement.new(new_path, args, callback)
+      elem = Sergio::Element.new(new_path, args, callback, aggregate_element)
 
       @parsing_elements = hash_recursive_merge_to_arrays(@parsing_elements, hash_from_path(current_path, {:sergio_elem => elem}))
       current_path.pop(name.length)
@@ -60,7 +62,7 @@ module Sergio
       if v
         v = v[:sergio_elem]
         if v
-          v = [v] if v.is_a?(SergioElement)
+          v = [v] if v.is_a?(Sergio::Element)
           vs = v.select do |v|
             if v.options[:having]
               match = v.options[:having].any? do |attr,value|

data/lib/sergio/sergio_element.rb

@@ -1,8 +1,11 @@
-class SergioElement
-  attr_accessor :new_path, :callback, :options
-  def initialize(new_path, args, callback)
-    @new_path = new_path.clone
-    @callback = callback
-    @options = args
+module Sergio
+  class Element
+    attr_accessor :new_path, :callback, :options, :aggregate_element
+    def initialize(new_path, args, callback, aggregate_element)
+      @new_path = new_path.clone
+      @callback = callback
+      @options = args
+      @aggregate_element = aggregate_element
+    end
   end
 end

data/lib/sergio/sergio_parsed_document.rb

@@ -8,24 +8,14 @@ module Sergio
     end
 
     def set_element(path, val, options = {})
-      v = value_at_path(path.clone, self.parsed_hash)
+      old_val = value_at_path(path.clone, self.parsed_hash)
 
-      val = if v
-        if v.is_a? Array
-          v << val
-        else
-          if val.is_a?(Hash) && val.empty?
-            options[:as_array] ? [v] : v
-          else
-            [v] << val
-          end
-        end
-      else
-        options[:as_array] ? [val] : val
+      if options[:as_array] && !val.is_a?(Array) && !old_val.is_a?(Array)
+        val = [val]
       end
 
       h = hash_from_path(path, val)
-      @parsed_hash = hash_recursive_merge(self.parsed_hash, h)
+      @parsed_hash = hash_recursive_append(self.parsed_hash, h)
       @parsed_hash
     end
   end

data/lib/sergio/sergio_sax.rb

@@ -2,10 +2,21 @@ class SergioSax < Nokogiri::XML::SAX::Document
   def initialize(object)
     @stack = []
     @object = object
+    @current_configs = []
+    @parent_callbacks = []
   end
 
   def start_element(name, attrs = [])
     @stack << [name, attrs]
+    if current_configs = @object.class.sergio_config.get_element_configs(@stack.clone)
+      current_configs.each do |c|
+        if c.aggregate_element
+          @parent_callbacks << lambda do
+            @object.sergio_parsed_document.set_element(c.new_path, {}, c.options)
+          end
+        end
+      end
+    end
   end
 
   def characters(string)
@@ -18,28 +29,36 @@ class SergioSax < Nokogiri::XML::SAX::Document
   end
   
   def end_element(name)
-    e_context = @stack.clone
+    current_configs = @object.class.sergio_config.get_element_configs(@stack.clone)
     name, attrs = @stack.pop
-    if sergio_elements = @object.class.sergio_config.get_element_configs(e_context)
-      sergio_elements.each do |sergio_element|
-        attr = sergio_element.options[:attribute]
+    if current_configs
+      current_configs.each do |c|
+        attr = c.options[:attribute]
         val = attrs.assoc(attr)
-        if val
-          val = val[1]
-          hash_path = sergio_element.new_path
-          callback = sergio_element.callback
+        callback = c.callback
 
+        if val && !c.aggregate_element
+          val = val[1]
           r = if callback.arity == 1
             callback.call(val)
           elsif callback.arity == 2
             h = Hash[*attrs.flatten]
             h.delete('@text')
-            callback.call(val, Hash[*attrs.flatten])
+            callback.call(val, h)
+          end
+
+          #only builds parent elements if at least one of their child elements has a match
+          @parent_callbacks.each do |c|
+            c.call
           end
+          @parent_callbacks = []
 
-          @object.sergio_parsed_document.set_element(hash_path, r, sergio_element.options)
+          #build an array of hashes if return value from callback is a hash
+          @object.sergio_parsed_document.set_element(c.new_path, {}, c.options) if r.is_a?(Hash)
+          @object.sergio_parsed_document.set_element(c.new_path, r, c.options)
         end
       end
     end
+    @parent_callbacks = []
   end
 end

data/lib/sergio/version.rb

@@ -0,0 +1,3 @@
+module Sergio
+  VERSION = "0.0.2"
+end

data/readme.markdown

@@ -0,0 +1,91 @@
+<a href='http://www.youtube.com/watch?v=GaoLU6zKaws'><img src="http://i.imgur.com/HThQt.jpg" alt="" title="Hosted by imgur.com" /></a>
+### Sergio is a SAX parser with a handy dsl for transforming xml into hashes
+
+##Usage
+    require 'sergio'
+
+    class MyXmlMunger
+      include Sergio
+
+      #the hash key will be renamed to the second argument passed to element if one is provided
+      element 'body', 'bro' do
+
+        #if a second argument isn't provided it will just use the original name of the element
+        element 'id'
+
+        #the :attribute option specifies what attribute to draw the value from for the resulting hash
+        element 'a', 'link', :attribute => 'href'
+
+        #You can pass a block to #element with a value argument and the hash value will be set to the result of the block
+        element 'p', 'content' do |v|
+          v.reverse
+        end
+
+        #You can pass :having to #element to specify attributes required to match against
+        element 'div', 'cars', :having => {'class' => 'car'} do
+
+          #You can pass value and attributes arguments into the block you pass to element
+          element 'p', 'description' do |value, attributes|
+            "#{value} #{attributes['attribute']}"
+          end
+        end
+
+        #You can pass arbitrary nestings to match against and merge to
+        element ['some', 'nesting'], ['some', 'other', 'nesting']
+
+        #Duplicate elements in the same scope are automatically made into an array:
+        element 'some', 'thing'
+
+        #parses
+        #<body><some>hey</some><some>hi</some></body>
+        #as
+        #{'document' => {'thing' => ['hey, 'hi']}}
+        #and
+        #<body><some>hi</some></body>
+        #as
+        #{'document' => {'thing' => 'hi'}}
+
+        #You can force arrays for even a single matching element within a given scope using the :as_array option
+        element 'some', 'thing', :as_array => true
+
+        #parses
+        #<body><some>hi</some></body>
+        #as
+        #{'document' => {'thing' => ['hi']}}
+        #and
+        #<body><some>hey</some><some>hi</some></body>
+        #as
+        #{'document' => {'thing' => ['hey', 'hi']}}
+      end
+    end
+
+###To parse a document into a hash, call parse on an instance of your parsing class with a document string as an argument
+    MyXmlMunger.new.parse("<body><id>1</id><a href='dude'>something</a></body>")
+    #returns {'bro' => {'id' => '1', 'link' => 'dude'}}
+
+##LICENSE
+
+(The MIT License)
+
+Copyright © 2011:
+
+Max Justus Spransy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+‘Software’), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/sergio.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sergio/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sergio"
+  s.version     = Sergio::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Max Justus Spransy"]
+  s.email       = ["maxjustus@gmail.com"]
+  s.homepage    = "https://github.com/maxjustus/Sergio"
+  s.summary     = %q{SAXy xml to hash transformation.}
+  s.description = %q{
+      Sergio provides a declarative syntax for parsing unruly xml into nice pretty hashes.
+    }
+
+  s.rubyforge_project = "sergio"
+
+  s.add_dependency 'nokogiri'
+  s.add_development_dependency 'rspec', '~> 2.5.0'
+  s.add_development_dependency 'rake'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/unit/sergio_hash_methods_spec.rb

@@ -13,6 +13,12 @@ describe Sergio::HashMethods do
       v.should == '2'
     end
 
+    it 'gets the value from last hash in array of hashes in passed in hash at point in heirarchy specified by passed in array' do
+      v = @s.value_at_path([['thing'], ['stuff']], {'thing' => [{'stuff' => '1'}, {'stuff' => '2'}]})
+      v = @s.value_at_path([['thing']], {'thing' => [{'stuff' => '1'}, {'stuff' => '2'}]})
+      v.should == [{'stuff' => '1'}, {'stuff' => '2'}]
+    end
+
     it 'gets the value from passed in hash at point in heirarchy specified by passed in array if array is one element long' do
       v = @s.value_at_path([['thing']], {'thing' => {'stuff' => '2'}})
       v.should == {'stuff' => '2'}
@@ -31,7 +37,6 @@ describe Sergio::HashMethods do
       end.new
     end
 
-
     it 'merges subhashes together' do
       h1 = {:thing => {'guy' => 'cool'}}
       h2 = {:thing => {'guys' => 'cool'}}
@@ -75,5 +80,76 @@ describe Sergio::HashMethods do
       h2 = {:thing => {'guy' => 'cools'}}
       @s.hash_recursive_merge(h1, h2).should == {:thing => {'guy' => 'cools'}}
     end
+
+    it 'merges new key values into existing hash if one is present' do
+      h1 = {:thing => {'guy' => 'cool'}}
+      h2 = {:thing => {'neat' => 'cools'}}
+      @s.hash_recursive_merge(h1, h2).should == {:thing => {'guy' => 'cool', 'neat' => 'cools'}}
+    end
+  end
+
+  context 'hash_recursive_append' do
+    before do
+      @s = Class.new do
+        include Sergio::HashMethods
+      end.new
+    end
+
+    it 'merges subhashes together' do
+      h1 = {:thing => {'guy' => 'cool'}}
+      h2 = {:thing => {'guys' => 'cool'}}
+      @s.hash_recursive_append(h1, h2).should == {:thing => {'guy' => 'cool', 'guys' => 'cool'}}
+    end
+
+    it 'aggregates intersecting key values into an array' do
+      h1 = {:thing => {'guy' => 'cool'}}
+      h2 = {:thing => {'guy' => 'cools'}}
+      @s.hash_recursive_append(h1, h2).should == {:thing => {'guy' => ['cool', 'cools']}}
+    end
+
+    it 'aggregates intersecting key values into an array of values where values are not hashes' do
+      h1 = {:thing => {'guy' => 'cool'}}
+      h2 = {:thing => {'guy' => 'cools'}}
+      @s.hash_recursive_append(h1, h2).should == {:thing => {'guy' => ['cool', 'cools']}}
+      h1 = {:thing => {'guy' => {'cool' => '1'}}}
+      h2 = {:thing => {'guy' => {'cool' => '3'}}}
+      @s.hash_recursive_append(h1, h2).should == {:thing => {'guy' => {'cool' => ['1', '3']}}}
+    end
+
+    it 'merges new key values into existing hash if one is present' do
+      h1 = {:thing => {'guy' => 'cool'}}
+      h2 = {:thing => {'neat' => 'cools'}}
+      @s.hash_recursive_append(h1, h2).should == {:thing => {'guy' => 'cool', 'neat' => 'cools'}}
+    end
+
+    it 'creates an array of hashes at given value if new hash value is an empty hash' do
+      h1 = {:thing => {'guy' => 'cool'}}
+      h2 = {:thing => {}}
+      @s.hash_recursive_append(h1, h2).should == {:thing => [{'guy' => 'cool'}, {}]}
+    end
+
+    it 'merges key values into last hash in existing array of hashes if one is present' do
+      h1 = {:thing => {'guy' => 'cool'}}
+      h2 = {:thing => {'neat' => 'cools'}}
+      h1 = @s.hash_recursive_append(h1, h2)
+      h2 = {:thing => {}}
+      h1 = @s.hash_recursive_append(h1, h2)
+      h1.should == {:thing => [{'guy' => 'cool', 'neat' => 'cools'}, {}]}
+      h2 = {:thing => {'guy' => 'cools'}}
+      h1 = @s.hash_recursive_append(h1, h2)
+      h1.should == {:thing => [{'guy' => 'cool', 'neat' => 'cools'}, {'guy' => 'cools'}]}
+      h2 = {:thing => {'neat' => 'cools'}}
+      h1 = @s.hash_recursive_append(h1, h2)
+      h1.should == {:thing => [{'guy' => 'cool', 'neat' => 'cools'}, {'guy' => 'cools', 'neat' => 'cools'}]}
+      h2 = {:thing => {'neat' => 'cools'}}
+      h1 = @s.hash_recursive_append(h1, h2)
+      h1.should == {:thing => [{'guy' => 'cool', 'neat' => 'cools'}, {'guy' => 'cools', 'neat' => ['cools', 'cools']}]}
+      h2 = {:thing => {}}
+      h1 = @s.hash_recursive_append(h1, h2)
+      h1.should == {:thing => [{'guy' => 'cool', 'neat' => 'cools'}, {'guy' => 'cools', 'neat' => ['cools', 'cools']}, {}]}
+      h2 = {:thing => {'hi' => 'hey'}}
+      h1 = @s.hash_recursive_append(h1, h2)
+      h1.should == {:thing => [{'guy' => 'cool', 'neat' => 'cools'}, {'guy' => 'cools', 'neat' => ['cools', 'cools']}, {'hi' => 'hey'}]}
+    end
   end
 end

data/spec/unit/sergio_spec.rb

@@ -15,27 +15,65 @@ describe Sergio do
     it 'parses duplicate elements into an array' do
       s = new_sergio do
         element 'parent' do
-          element 'id'
+          element 'post', 'posts' do
+            element 'id', :as_array => true
+          end
         end
       end
 
-      @xml = "<parent><id>1</id><id>2</id></parent>"
+      @xml = "<parent><post><id>1</id><id>2</id></post><post><id>3</id></post><post></post></parent>"
       @hash = s.new.parse(@xml)
-      @hash['parent']['id'].should == ['1', '2']
+      @hash['parent']['posts'][0]['id'].should == ['1', '2']
+      @hash['parent']['posts'][1]['id'].should == ['3']
+    end
+
+    it 'ignores empty adjacent elements' do
+      s = new_sergio do
+        element 'a' do
+          element 'b' do
+            element 'f'
+          end
+          element 'c', 'b' do
+            element 'e'
+          end
+        end
+      end
+      @xml = '<a>
+        <b></b>
+        <b><f>a</f></b>
+        <b>he</b>
+        <c>a</c>
+        <c>
+          <e>e</e>
+        </c>
+        </a>'
+      h = s.new.parse(@xml)
+      h.should == {'a' => {'b' => [{'f' => 'a'}, {'e' => 'e'}]}}
     end
 
     it 'parses duplicate elements whose callbacks return a hash into an array' do
       s = new_sergio do
         element 'parent' do
-          element 'id' do |v|
-            {'v' => v}
+          element 'p' do
+            element 'id', do |v, attributes|
+              {'v' => v}
+            end
           end
         end
       end
 
-      @xml = "<parent><id>1</id><id>2</id></parent>"
+      @xml = "<parent>
+        <p>
+          <id cool='neat'>1</id>
+          <id>2</id>
+        </p>
+        <p>
+          <id>5</id>
+        </p>
+        </parent>"
       @hash = s.new.parse(@xml)
-      @hash['parent']['id'].should == [{'v' => '1',}, {'v' => '2'}]
+      @hash['parent']['p'][0]['id'].should == [{'v' => '1'}, {'v' => '2'}]
+      @hash['parent']['p'][1]['id'].should == {'v' => '5'}
     end
 
     it 'parses a nested element' do
@@ -105,7 +143,7 @@ describe Sergio do
 
       @xml = "<parent><id>1</id><id>2</id></parent>"
       @hash = s.new.parse(@xml)
-      @hash['post'].should == {'di' => ['1', '2']}
+      @hash['post'].keys.should == ['di']
     end
 
     it 'matches against attributes using :having argument' do
@@ -244,5 +282,13 @@ describe Sergio do
       v = @s.new.sergio_parsed_document.set_element(['thing', 'stuff'], '1')
       v.should == {'thing' => {'stuff' => '1'}}
     end
+
+    it 'aggregates adjacent parents into arrays' do
+      s = @s.new
+      s.sergio_parsed_document.set_element(['thing', 'stuff'], '1')
+      s.sergio_parsed_document.set_element(['thing'], {})
+      v = s.sergio_parsed_document.set_element(['thing', 'stuff'], '2')
+      v.should == {'thing' => [{'stuff' => '1'}, {'stuff' => '2'}]}
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: sergio
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Max Justus Spransy
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 -05:00
+date: 2011-05-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - Rakefile
@@ -65,6 +66,9 @@ files:
 - lib/sergio/sergio_element.rb
 - lib/sergio/sergio_parsed_document.rb
 - lib/sergio/sergio_sax.rb
+- lib/sergio/version.rb
+- readme.markdown
+- sergio.gemspec
 - spec/spec_helper.rb
 - spec/support/buzz_activity_stream.xml
 - spec/support/facebook_activity_stream.xml