saxerator 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65e8c906e3b63d2bc0968eb8efbf8e737827a0f6
-  data.tar.gz: ef9f928056120981840202ea4c19e3778c8c5424
+  metadata.gz: c3275996c0843e22e1ef7148b6fc14c58aff415d
+  data.tar.gz: bd4ea2b9abb8c9ad8cea065c7d2c41fd472df4e7
 SHA512:
-  metadata.gz: 2ee3f52630eda84e56596e0972369e902f28ddf4a20fd23cd10fbda360bec551aae51d5045267f98007017d08e3880b59c5ad566fdeb9546bc76c054cd349bd0
-  data.tar.gz: e535bd0e982ec499187b39864851237923d909852c5ce86f75412a62c597823e9be6a6f2c92abb6958ee2ed5f06857d1b97de3e04340d849b8ca6abe35349b3d
+  metadata.gz: 5891cd6b524b6880717f21c59552dd909f73ec3135439aaafc79e90dcf76a4a30d774c1b12ad14ebf7b395d7cff6a1c2e3a049bb958ab03d0b681d06092d1b15
+  data.tar.gz: 82f8257eeaedf4b4942979aa961dcd4574f7c4320fd821697fbea25bc1926064bad3f5fd5cbc176382443d81fb69a79d9c323fd1fc87263c713b6b35a44e8e34

data/.travis.yml

@@ -2,6 +2,7 @@ script: "rspec spec"
 language: ruby
 bundler_args: --without coverage
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.2
   - 1.9.3

data/README.md

@@ -119,6 +119,16 @@ Why not DOM parsing?
   > DOM parsers load the entire document into memory. Saxerator only holds a single chunk in memory at a time. If your
   > document is very large, this can be an important consideration.
 
+When I fetch a tag that has one or more elements, sometimes I get an `Array`, and other times I get a `Hash` or `String`. Is there a way I can treat these consistently?
+
+  > You can treat objects consistently as arrays using
+  > [Ruby's built-in array conversion method](http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-Array)
+  > in the form `Array(element_or_array)`
+  >
+  > Generally you should not need to convert a parsed element to a `String` or `Hash`. One case it
+  > occasionally comes up is for elements that are sometimes-empty. Empty elements behave mostly like an
+  > empty `Hash`, however you may convert it to a more `String`-like object via `#to_s`
+
 ### Acknowledgements ###
 Saxerator was inspired by - but not affiliated with - [nori](https://github.com/savonrb/nori) and [Gregory Brown](http://majesticseacreature.com/)'s
 [Practicing Ruby](http://practicingruby.com/)

data/lib/saxerator.rb

@@ -8,9 +8,10 @@ require 'saxerator/document_fragment'
 require 'saxerator/configuration'
 
 require 'saxerator/builder'
-require 'saxerator/builder/string_element'
-require 'saxerator/builder/hash_element'
 require 'saxerator/builder/array_element'
+require 'saxerator/builder/empty_element'
+require 'saxerator/builder/hash_element'
+require 'saxerator/builder/string_element'
 require 'saxerator/builder/hash_builder'
 require 'saxerator/builder/xml_builder'
 

data/lib/saxerator/builder/array_element.rb

@@ -2,6 +2,9 @@ module Saxerator
   module Builder
     class ArrayElement < Array
       attr_accessor :name
+
+      def to_ary; self end
+      def to_a; self end
     end
   end
-end
+end

data/lib/saxerator/builder/empty_element.rb

@@ -0,0 +1,24 @@
+require 'saxerator/builder/hash_element'
+
+module Saxerator
+  module Builder
+    class EmptyElement < HashElement
+      def nil?; true end
+      def !; true end
+
+      def to_s
+        StringElement.new('', name, attributes)
+      end
+
+      def to_h
+        HashElement.new(name, attributes)
+      end
+
+      def to_a
+        array = ArrayElement.new
+        array.name = name
+        array
+      end
+    end
+  end
+end

data/lib/saxerator/builder/hash_builder.rb

@@ -16,6 +16,10 @@ module Saxerator
         @children << node
       end
 
+      def to_empty_element
+        EmptyElement.new(@name, @attributes)
+      end
+
       def to_s
         StringElement.new(@children.join, @name, @attributes)
       end
@@ -27,14 +31,14 @@ module Saxerator
           name = child.name
           element = child.block_variable
 
-          add_to_hash_element( hash, name, element)
+          add_to_hash_element(hash, name, element)
         end
 
         if @config.put_attributes_in_hash?
 
           @attributes.each do |attribute|
             attribute.each_slice(2) do |name, element|
-              add_to_hash_element( hash, name, element)
+              add_to_hash_element(hash, name, element)
             end
           end
         end
@@ -56,7 +60,9 @@ module Saxerator
       end
 
       def block_variable
-        @text ? to_s : to_hash
+        return to_s if @text
+        return to_hash if @children.count > 0
+        to_empty_element
       end
     end
   end

data/lib/saxerator/builder/hash_element.rb

@@ -1,3 +1,5 @@
+require 'saxerator/builder/array_element'
+
 module Saxerator
   module Builder
     class HashElement < Hash
@@ -8,6 +10,13 @@ module Saxerator
         self.name = name
         self.attributes = attributes
       end
+
+      def to_a
+        array = ArrayElement.new
+        array.name = name
+        array.concat super
+        array
+      end
     end
   end
-end
+end

data/lib/saxerator/builder/string_element.rb

@@ -1,3 +1,5 @@
+require 'saxerator/builder/array_element'
+
 module Saxerator
   module Builder
     class StringElement < String
@@ -9,6 +11,13 @@ module Saxerator
         self.attributes = attributes
         super(str)
       end
+
+      def to_a
+        array = ArrayElement.new
+        array << self
+        array.name = name
+        array
+      end
     end
   end
-end
+end

data/lib/saxerator/version.rb

@@ -1,3 +1,3 @@
 module Saxerator
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/spec/lib/builder/hash_builder_spec.rb

@@ -26,6 +26,24 @@ describe "Saxerator (default) hash format" do
   # name on a string
   specify { entry['title'].name.should == 'title' }
 
+  describe "#to_a" do
+    it "preserves the element name on a parsed hash" do
+      entry.to_a.name.should == 'entry'
+    end
+
+    it "converts parsed hashes to nested key/value pairs (just like regular hashes)" do
+      entry.to_a.first.should == ['id', '1']
+    end
+
+    it "preserves the element name on a parsed string" do
+      entry['title'].to_a.name.should == 'title'
+    end
+
+    it "preserves the element name on an array" do
+      entry['contributor'].to_a.name.should eq 'contributor'
+    end
+  end
+
   # name on an array
   specify { entry['contributor'].name.should == 'contributor' }
 
@@ -33,5 +51,32 @@ describe "Saxerator (default) hash format" do
   specify { entry['content'].should == "<p>Airplanes are very large — this can present difficulty in digestion.</p>" }
 
   # empty element
-  specify { entry['media:thumbnail'].should == {} }
-end
+  context "parsing an empty element" do
+    subject(:element) { entry['media:thumbnail'] }
+
+    it "behaves somewhat like nil" do
+      element.should be_nil
+      (!element).should eq true
+      element.to_s.should eq ''
+      element.to_h.should eq Hash.new
+    end
+
+    it { should be_empty }
+
+    it "has attributes" do
+      element.attributes.keys.should eq ['url']
+    end
+
+    [:to_s, :to_h, :to_a].each do |conversion|
+      it "preserves the element name through ##{conversion}" do
+        element.send(conversion).name.should eq 'media:thumbnail'
+      end
+    end
+
+    [:to_s, :to_h].each do |conversion|
+      it "preserves attributes through ##{conversion}" do
+        element.send(conversion).attributes.keys.should eq ['url']
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saxerator
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Bradley Schaefer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -58,6 +58,7 @@ files:
 - lib/saxerator.rb
 - lib/saxerator/builder.rb
 - lib/saxerator/builder/array_element.rb
+- lib/saxerator/builder/empty_element.rb
 - lib/saxerator/builder/hash_builder.rb
 - lib/saxerator/builder/hash_element.rb
 - lib/saxerator/builder/string_element.rb