sax-machine 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eced69c84dfa4d14f4e55e8f8f57af2c90f69281
-  data.tar.gz: a00ec939b3a116885109a44283c68d0d301ebb63
+  metadata.gz: d0fb49e4c86a5d258cd1266f3b39f0279ff6ecc4
+  data.tar.gz: 9221aa8a9a9a552f1ac9ce7e5b962db2e5987515
 SHA512:
-  metadata.gz: e728531fb1931246e61c4ecc5182f51f30ec2d7b4131976c282313f2db08c324a679c6f58f01fd02c2816fae380e4c711324764ca8cc192c04f4d8702218640f
-  data.tar.gz: 3014692c51809a0dd4cd0f0656fdc63d6d669ad9d3ba863fec64ac5aa0238a7b0dda83658b693ff4de800d8073ddf55d0bb6f32f7b3ac4370bbb24da9428606b
+  metadata.gz: 6da8e076f9d871aebfee80887b007712768c60643d5690b514cd886758583e132971417533afb560de2a4c8aee988131a46a62da28b32be9ed2837c7f4cf9e86
+  data.tar.gz: 8f28dd9652e24a9d853ded552df3ca25e80cba2eead23bb1ead8d331bc50768778938d7709ab3ebaa7cc11c3ebb411c74de119b8c64897f3d1ae7a41c3457911

data/Gemfile

@@ -9,5 +9,6 @@ group :development, :test do
   gem 'coveralls', require: false, platforms: [:mri]
 
   gem 'activerecord', '~> 4.1'
+  gem 'nokogiri', '~> 1.6'
   gem 'ox', '>= 2.1.2', platforms: [:mri, :rbx]
 end

data/HISTORY.md

@@ -1,5 +1,9 @@
 # HEAD
 
+# 1.0.0
+
+* Make `nokogiri` dependency optional
+* Add :default argument for elements [[#51](https://github.com/pauldix/sax-machine/pull/51)]
 
 # 0.3.0
 

data/README.md

@@ -28,30 +28,26 @@ $ bundle
 
 ## Usage
 
-To use **Nokogiri** as a SAX handler:
+SAX Machine can use either `nokogiri` or `ox` as XML SAX handler.
+
+To use **Nokogiri** add this line to your Gemfile:
 
 ```ruby
-require 'sax-machine'
+gem 'nokogiri', '~> 1.6'
 ```
 
-To use **Ox** as a SAX handler:
-
-Add this line to your application's Gemfile:
+To use **Ox** add this line to your Gemfile:
 
 ```ruby
 gem 'ox', '>= 2.1.2'
 ```
 
-Tell SAXMachine to use Ox:
+You can also specify which handler to use manually, like this:
 
 ```ruby
-require 'sax-machine'
-SAXMachine.handler = :ox
+SAXMachine.handler = :nokogiri
 ```
 
-Please note that this operation is not thread-safe, so it's better to define
-handler at initialization stage and do not change it during runtime.
-
 ## Examples
 
 Include `SAXMachine` in any class and define properties to parse:
@@ -69,7 +65,8 @@ class AtomEntry
   # The :as argument makes this available through entry.author instead of .name
   element :name, as: :author
   element "feedburner:origLink", as: :url
-  element :summary
+  # The :default argument specifies default value for element when it's missing
+  element :summary, class: String, default: "No summary available"
   element :content, class: AtomContent
   element :published
   ancestor :ancestor
@@ -104,6 +101,7 @@ feed.feed_url # The URL of the blog feed
 feed.entries.first.title # Title of the first entry
 feed.entries.first.author # The author of the first entry
 feed.entries.first.url # Permalink on the blog for this entry
+feed.entries.first.summary # Returns "No summary available" if summary is missing
 feed.entries.first.ancestor # The Atom ancestor
 feed.entries.first.content # Instance of AtomContent
 feed.entries.first.content.text # Entry content text

data/lib/sax-machine.rb

@@ -14,4 +14,8 @@ module SAXMachine
   end
 end
 
-SAXMachine.handler = :nokogiri
+begin
+  SAXMachine.handler = :ox
+rescue LoadError
+  SAXMachine.handler = :nokogiri
+end

data/lib/sax-machine/config/sax_attribute.rb

@@ -25,10 +25,7 @@ module SAXMachine
       def attrs_match?(attrs)
         attrs.key?(@name) || attrs.value?(@name)
       end
-
-      def has_value_and_attrs_match?(attrs)
-        attrs_match?(attrs)
-      end
+      alias_method :has_value_and_attrs_match?, :attrs_match?
 
       def collection?
         false

data/lib/sax-machine/config/sax_element.rb

@@ -1,7 +1,7 @@
 module SAXMachine
   class SAXConfig
     class ElementConfig
-      attr_reader :name, :setter, :data_class, :collection
+      attr_reader :name, :as, :setter, :data_class, :collection, :default
 
       def initialize(name, options)
         @name = name.to_s
@@ -15,6 +15,7 @@ module SAXMachine
 
         @as = options[:as]
         @collection = options[:collection]
+        @default = options[:default]
 
         @setter = if @collection
           "add_#{options[:as]}"

data/lib/sax-machine/handlers/sax_abstract_handler.rb

@@ -104,19 +104,18 @@ module SAXMachine
         else
           value =
             case config.data_class.to_s
-            when "String"  then value.to_s
-            when "Integer" then value.to_i
-            when "Float"   then value.to_f
+            when "String"  then value != NO_BUFFER ? value.to_s : value
+            when "Integer" then value != NO_BUFFER ? value.to_i : value
+            when "Float"   then value != NO_BUFFER ? value.to_f : value
             # Assumes that time elements will be string-based and are not
             # something else, e.g. seconds since epoch
-            when "Time"    then Time.parse(value.to_s)
+            when "Time"    then value != NO_BUFFER ? Time.parse(value.to_s) : value
             when ""        then value
             else
               element
             end
 
           object.send(config.setter, value) unless value == NO_BUFFER
-
           mark_as_parsed(object, config)
         end
 

data/lib/sax-machine/sax_config.rb

@@ -18,7 +18,7 @@ module SAXMachine
     end
 
     def columns
-      @top_level_elements.map { |name, ecs| ecs }.flatten
+      @top_level_elements.map { |_, ecs| ecs }.flatten
     end
 
     def initialize_copy(sax_config)

data/lib/sax-machine/sax_document.rb

@@ -33,6 +33,15 @@ module SAXMachine
       attributes.each do |name, value|
         send("#{name}=", value)
       end
+
+      self.class.sax_config.top_level_elements.each do |_, configs|
+        configs.each do |config|
+          next unless config.default
+          next unless send(config.as).nil?
+
+          send(config.setter, config.default)
+        end
+      end
     end
   end
 
@@ -48,19 +57,19 @@ module SAXMachine
     def element(name, options = {})
       real_name = (options[:as] ||= name).to_s
       sax_config.add_top_level_element(name, options)
-      create_attr real_name
+      create_attr(real_name)
     end
 
     def attribute(name, options = {})
       real_name = (options[:as] ||= name).to_s
       sax_config.add_top_level_attribute(self.class.to_s, options.merge(name: name))
-      create_attr real_name
+      create_attr(real_name)
     end
 
     def value(name, options = {})
       real_name = (options[:as] ||= name).to_s
       sax_config.add_top_level_element_value(self.class.to_s, options.merge(name: name))
-      create_attr real_name
+      create_attr(real_name)
     end
 
     def ancestor(name, options = {})

data/lib/sax-machine/version.rb

@@ -1,3 +1,3 @@
 module SAXMachine
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/sax-machine.gemspec

@@ -16,6 +16,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.platform      = Gem::Platform::RUBY
 
-  s.add_dependency "nokogiri", "~> 1.6.0"
   s.add_development_dependency "rspec", "~> 3.0"
 end

data/spec/sax-machine/sax_activerecord_spec.rb

@@ -1,23 +1,21 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'active_record'
 
-describe "ActiveRecord" do
-  describe "integration" do
-    before :each do
-      class MySaxModel < ActiveRecord::Base
-        SAXMachine.configure(MySaxModel) do |c|
-          c.element :title
-        end
+describe "SAXMachine ActiveRecord integration" do
+  before do
+    class MySaxModel < ActiveRecord::Base
+      SAXMachine.configure(MySaxModel) do |c|
+        c.element :title
       end
     end
+  end
 
-    after :each do
-      Object.send(:remove_const, :MySaxModel)
-    end
+  after do
+    Object.send(:remove_const, :MySaxModel)
+  end
 
-    it "parses document" do
-      document = MySaxModel.parse("<xml><title>My Title</title></xml>")
-      expect(document.title).to eq("My Title")
-    end
+  it "parses document" do
+    document = MySaxModel.parse("<xml><title>My Title</title></xml>")
+    expect(document.title).to eq("My Title")
   end
 end

data/spec/sax-machine/sax_configure_spec.rb

@@ -1,32 +1,35 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-class A
-  SAXMachine.configure(A) do |c|
-    c.element :title
-  end
-end
+describe "SAXMachine configure" do
+  before do
+    class A
+      SAXMachine.configure(A) do |c|
+        c.element :title
+      end
+    end
 
-class B < A
-  SAXMachine.configure(B) do |c|
-    c.element :b
-  end
-end
+    class B < A
+      SAXMachine.configure(B) do |c|
+        c.element :b
+      end
+    end
 
-class C < B
-  SAXMachine.configure(C) do |c|
-    c.element :c
-  end
-end
+    class C < B
+      SAXMachine.configure(C) do |c|
+        c.element :c
+      end
+    end
 
-describe "SAXMachine configure" do
-  before do
     xml = "<top><title>Test</title><b>Matched!</b><c>And Again</c></top>"
-    @a = A.new
-    @a.parse xml
-    @b = B.new
-    @b.parse xml
-    @c = C.new
-    @c.parse xml
+    @a = A.parse xml
+    @b = B.parse xml
+    @c = C.parse xml
+  end
+
+  after do
+    Object.send(:remove_const, :A)
+    Object.send(:remove_const, :B)
+    Object.send(:remove_const, :C)
   end
 
   it { expect(@a).to be_a(A) }

data/spec/sax-machine/sax_document_spec.rb

@@ -3,10 +3,13 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "SAXMachine" do
   describe "element" do
     describe "when parsing a single element" do
-      before :each do
+      before do
         @klass = Class.new do
           include SAXMachine
           element :title
+          ancestor :body
+          value :something, required: false
+          attribute :anything, required: true
         end
       end
 
@@ -21,10 +24,6 @@ describe "SAXMachine" do
         expect(document.title).to eq("Title")
       end
 
-      it "allows introspection of the elements" do
-        expect(@klass.column_names).to match_array([:title])
-      end
-
       it "does not overwrites the getter is there is already one present" do
         @klass = Class.new do
           def title
@@ -97,6 +96,38 @@ describe "SAXMachine" do
         expect(document.title).to eq("My Title")
       end
 
+      describe "the introspection" do
+        it "allows to get column names" do
+          expect(@klass.column_names).to match_array([:title])
+        end
+
+        it "allows to get elements" do
+          expect(@klass.sax_config.top_level_elements.values.flatten.map(&:to_s)).to \
+            match_array(["name: title dataclass:  setter: title= required:  value:  as:title collection:  with: {}"])
+        end
+
+        it "allows to get ancestors" do
+          expect(@klass.sax_config.ancestors.map(&:column)).to \
+            match_array([:body])
+        end
+
+        it "allows to get values" do
+          expect(@klass.sax_config.top_level_element_value.map(&:column)).to \
+            match_array([:something])
+          expect(@klass.sax_config.top_level_element_value.map(&:required?)).to \
+            match_array([false])
+        end
+
+        it "allows to get attributes" do
+          expect(@klass.sax_config.top_level_attributes.map(&:column)).to \
+            match_array([:anything])
+          expect(@klass.sax_config.top_level_attributes.map(&:required?)).to \
+            match_array([true])
+          expect(@klass.sax_config.top_level_attributes.map(&:collection?)).to \
+            match_array([false])
+        end
+      end
+
       describe "the class attribute" do
         before(:each) do
           @klass = Class.new do
@@ -153,6 +184,21 @@ describe "SAXMachine" do
         end
       end
 
+      describe "the default attribute" do
+        it "is available" do
+          @klass = Class.new do
+            include SAXMachine
+            element :number, class: Integer, default: 0
+          end
+
+          document = @klass.parse("<no>number</no>")
+          expect(document.number).to eq(0)
+
+          document = @klass.parse("<number></number>")
+          expect(document.number).to eq(0)
+        end
+      end
+
       describe "the required attribute" do
         it "is available" do
           @klass = Class.new do
@@ -165,7 +211,7 @@ describe "SAXMachine" do
     end
 
     describe "when parsing multiple elements" do
-      before :each do
+      before do
         @klass = Class.new do
           include SAXMachine
           element :title
@@ -212,7 +258,7 @@ describe "SAXMachine" do
 
     describe "when using options for parsing elements" do
       describe "using the 'as' option" do
-        before :each do
+        before do
           @klass = Class.new do
             include SAXMachine
             element :description, as: :summary
@@ -233,7 +279,7 @@ describe "SAXMachine" do
 
       describe "using the :with option" do
         describe "and the :value option" do
-          before :each do
+          before do
             @klass = Class.new do
               include SAXMachine
               element :link, value: :href, with: { foo: "bar" }
@@ -251,7 +297,7 @@ describe "SAXMachine" do
           end
 
           describe "and the :as option" do
-            before :each do
+            before do
               @klass = Class.new do
                 include SAXMachine
                 element :link, value: :href, as: :url, with: { foo: "bar" }
@@ -268,7 +314,7 @@ describe "SAXMachine" do
         end
 
         describe "with only one element" do
-          before :each do
+          before do
             @klass = Class.new do
               include SAXMachine
               element :link, with: { foo: "bar" }
@@ -297,7 +343,7 @@ describe "SAXMachine" do
         end
 
         describe "with multiple elements of same tag" do
-          before :each do
+          before do
             @klass = Class.new do
               include SAXMachine
               element :link, as: :first, with: { foo: "bar" }
@@ -317,7 +363,7 @@ describe "SAXMachine" do
         end
 
         describe "with only one element as a regular expression" do
-          before :each do
+          before do
             @klass = Class.new do
               include SAXMachine
               element :link, with: { foo: /ar$/ }
@@ -347,7 +393,7 @@ describe "SAXMachine" do
       end
 
       describe "using the 'value' option" do
-        before :each do
+        before do
           @klass = Class.new do
             include SAXMachine
             element :link, value: :foo
@@ -395,7 +441,7 @@ describe "SAXMachine" do
       end
 
       describe "when desiring both the content and attributes of an element" do
-        before :each do
+        before do
           @klass = Class.new do
             include SAXMachine
             element :link
@@ -416,7 +462,7 @@ describe "SAXMachine" do
 
   describe "elements" do
     describe "when parsing multiple elements" do
-      before :each do
+      before do
         @klass = Class.new do
           include SAXMachine
           elements :entry, as: :entries
@@ -451,7 +497,7 @@ describe "SAXMachine" do
     end
 
     describe "when using the with and class options" do
-      before :each do
+      before do
         class Bar
           include SAXMachine
           element :title
@@ -484,7 +530,7 @@ describe "SAXMachine" do
     end
 
     describe "when using the class option" do
-      before :each do
+      before do
         class Foo
           include SAXMachine
           element :title
@@ -559,7 +605,7 @@ describe "SAXMachine" do
   end
 
   describe "full example" do
-    before :each do
+    before do
       @xml = File.read("spec/fixtures/atom.xml")
 
       class AtomEntry
@@ -881,11 +927,20 @@ describe "SAXMachine" do
       end
 
       @errors = []
-      @item = ItemElement5.parse(@xml, ->(x) { @errors << x })
+      @warnings = []
+      @item = ItemElement5.parse(
+        @xml,
+        ->(x) { @errors << x },
+        ->(x) { @warnings << x },
+      )
     end
 
     it "has error" do
       expect(@errors.uniq.size).to eq(1)
     end
+
+    it "has no warning" do
+      expect(@warnings.uniq.size).to eq(0)
+    end
   end
 end

data/spec/sax-machine/sax_include_spec.rb

@@ -1,20 +1,20 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-class A
-  include SAXMachine
-  element :title
-end
+describe "SAXMachine inheritance" do
+  before do
+    class A
+      include SAXMachine
+      element :title
+    end
 
-class B < A
-  element :b
-end
+    class B < A
+      element :b
+    end
 
-class C < B
-  element :c
-end
+    class C < B
+      element :c
+    end
 
-describe "SAXMachine inheritance" do
-  before do
     xml = "<top><title>Test</title><b>Matched!</b><c>And Again</c></top>"
     @a = A.new
     @a.parse xml
@@ -24,6 +24,12 @@ describe "SAXMachine inheritance" do
     @c.parse xml
   end
 
+  after do
+    Object.send(:remove_const, :A)
+    Object.send(:remove_const, :B)
+    Object.send(:remove_const, :C)
+  end
+
   it { expect(@a).to be_a(A) }
   it { expect(@a).not_to be_a(B) }
   it { expect(@a).to be_a(SAXMachine) }

data/spec/spec_helper.rb

@@ -14,9 +14,7 @@ rescue LoadError
 end
 
 require File.expand_path(File.dirname(__FILE__) + '/../lib/sax-machine')
-if ENV['HANDLER'] == 'ox'
-  SAXMachine.handler = :ox
-end
+SAXMachine.handler = ENV['HANDLER'].to_sym
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sax-machine
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Paul Dix
@@ -11,22 +11,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement