sax-machine 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eced69c84dfa4d14f4e55e8f8f57af2c90f69281
+  data.tar.gz: a00ec939b3a116885109a44283c68d0d301ebb63
+SHA512:
+  metadata.gz: e728531fb1931246e61c4ecc5182f51f30ec2d7b4131976c282313f2db08c324a679c6f58f01fd02c2816fae380e4c711324764ca8cc192c04f4d8702218640f
+  data.tar.gz: 3014692c51809a0dd4cd0f0656fdc63d6d669ad9d3ba863fec64ac5aa0238a7b0dda83658b693ff4de800d8073ddf55d0bb6f32f7b3ac4370bbb24da9428606b

data/.gitignore

@@ -6,3 +6,5 @@ Gemfile.lock
 .DS_STORE
 pkg/
 coverage/
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -1,12 +1,22 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
-  - 2.0.0
+  - 2.0
+  - 2.1
+  - jruby-1.7
+  - rbx-2
   - ruby-head
-  - jruby-19mode
   - jruby-head
-  - rbx-19mode
 matrix:
   allow_failures:
+    - rvm: rbx-2
     - rvm: ruby-head
+    - rvm: jruby-head
+    - env: HANDLER="ox"
+      rvm: jruby-1.7
+    - env: HANDLER="ox"
+      rvm: jruby-head
+env:
+  matrix:
+    - HANDLER="nokogiri"
+    - HANDLER="ox"

data/Gemfile

@@ -5,5 +5,9 @@ gemspec
 group :development, :test do
   gem 'rake'
   gem 'guard-rspec'
-  gem 'simplecov', :require => false, :platforms => :mri_19
+  gem 'simplecov', require: false, platforms: [:mri]
+  gem 'coveralls', require: false, platforms: [:mri]
+
+  gem 'activerecord', '~> 4.1'
+  gem 'ox', '>= 2.1.2', platforms: [:mri, :rbx]
 end

data/Guardfile

@@ -1,5 +1,5 @@
-guard 'rspec', :version => 2 do
+guard "rspec", version: 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
 end

data/HISTORY.md

@@ -1,13 +1,30 @@
+# HEAD
+
+
+# 0.3.0
+
+* Option to use Ox as a SAX handler instead of Nokogiri [[#49](https://github.com/pauldix/sax-machine/pull/49)]
+* Bump RSpec to 3.0, convert existing specs
+
+# 0.2.1
+
+* Turn on replace_entities on Nokogiri parser [[#40](https://github.com/pauldix/sax-machine/pull/40)]
+* Provide mass assignment through initialize method [[#38](https://github.com/pauldix/sax-machine/pull/38)]
+* Bump nokogiri (~> 1.6) and rspec, drop growl dependency
+* Update 'with' option to allow pattern matching in addition to string matching
+
 # 0.2.0.rc1
-* Tried to reduce the number of instances of respond_to? in the code by
+
+* Try to reduce the number of instances of respond_to? in the code by
   pulling common uses of it out to methods. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
 * The parse stack is now composed of simple objects instead of it being
   an array of arrays. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
 * Now using an identifier for an empty buffer instead of empty string. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
-* Cleaned up several variables that were not being used. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
-* Encapsulated stack so it's not being exposed as part of the API. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
-* #cdata_block is now an alias instead of delegating to characters. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
+* Clean up several variables that were not being used. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
+* Encapsulate stack so it's not being exposed as part of the API. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
+* `cdata_block` is now an alias instead of delegating to characters. [[#32](https://github.com/pauldix/sax-machine/pull/32)]
 
 # 0.1.0
-* rename parent to ancestor
-* added SAXMachine.configure
+
+* Rename parent to ancestor
+* Add SAXMachine.configure

data/README.md

@@ -1,91 +1,162 @@
-# SAX Machine [![Build Status](https://secure.travis-ci.org/pauldix/sax-machine.png?branch=master)](http://travis-ci.org/pauldix/sax-machine)
+# SAX Machine
 
-[Wiki](https://github.com/pauldix/sax-machine/wiki)
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/sax-machine.svg)](http://badge.fury.io/rb/sax-machine)
+[![Build Status](https://secure.travis-ci.org/pauldix/sax-machine.svg?branch=master)](http://travis-ci.org/pauldix/sax-machine?branch=master)
+[![Coverage Status](https://img.shields.io/coveralls/pauldix/sax-machine.svg)](https://coveralls.io/r/pauldix/sax-machine?branch=master)
+[![Code Climate](https://img.shields.io/codeclimate/github/pauldix/sax-machine.svg)](https://codeclimate.com/github/pauldix/sax-machine)
+[![Dependencies](https://gemnasium.com/pauldix/sax-machine.svg)](https://gemnasium.com/pauldix/sax-machine)
 
 ## Description
 
-A declarative SAX parsing library backed by Nokogiri
+A declarative SAX parsing library backed by Nokogiri or Ox.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sax-machine'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
 
 ## Usage
+
+To use **Nokogiri** as a SAX handler:
+
 ```ruby
 require 'sax-machine'
+```
+
+To use **Ox** as a SAX handler:
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ox', '>= 2.1.2'
+```
+
+Tell SAXMachine to use Ox:
 
-# Class for information associated with content parts in a feed.
-#  Ex: <content type="text">sample</content>
-#  instance.type will be "text", instance.text will be "sample"
+```ruby
+require 'sax-machine'
+SAXMachine.handler = :ox
+```
+
+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:
+
+```ruby
 class AtomContent
   include SAXMachine
   attribute :type
   value :text
 end
 
-# Class for parsing an atom entry out of a feedburner atom feed
 class AtomEntry
   include SAXMachine
   element :title
-  # the :as argument makes this available through atom_entry.author instead of .name
-  element :name, :as => :author
-  element "feedburner:origLink", :as => :url
+  # The :as argument makes this available through entry.author instead of .name
+  element :name, as: :author
+  element "feedburner:origLink", as: :url
   element :summary
-  element :content, :class => AtomContent
+  element :content, class: AtomContent
   element :published
   ancestor :ancestor
 end
 
-# Class for parsing Atom feeds
 class Atom
   include SAXMachine
   element :title
-  # the :with argument means that you only match a link tag that has an attribute of :type => "text/html"
-  # the :value argument means that instead of setting the value to the text between the tag,
-  # it sets it to the attribute value of :href
-  element :link, :value => :href, :as => :url, :with => {:type => "text/html"}
-  element :link, :value => :href, :as => :feed_url, :with => {:type => "application/atom+xml"}
-  elements :entry, :as => :entries, :class => AtomEntry
+  # The :with argument means that you only match a link tag
+  # that has an attribute of type: "text/html"
+  element :link, value: :href, as: :url, with: {
+    type: "text/html"
+  }
+  # The :value argument means that instead of setting the value
+  # to the text between the tag, it sets it to the attribute value of :href
+  element :link, value: :href, as: :feed_url, with: {
+    type: "application/atom+xml"
+  }
+  elements :entry, as: :entries, class: AtomEntry
 end
+```
+
+Then parse any XML with your class:
 
-# you can then parse like this
+```ruby
 feed = Atom.parse(xml_text)
-# then you're ready to rock
-feed.title # => whatever the title of the blog is
-feed.url # => the main url of the blog
-feed.feed_url # => goes to the feedburner feed
-
-feed.entries.first.title # => title of the first entry
-feed.entries.first.author # => the author of the first entry
-feed.entries.first.url # => the permalink on the blog for this entry
-feed.entries.first.ancestor # => the Atom ancestor
-# etc ...
-
-# you can also use the elements method without specifying a class like so
-class SomeServiceResponse
+
+feed.title # Whatever the title of the blog is
+feed.url # The main URL of the blog
+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.ancestor # The Atom ancestor
+feed.entries.first.content # Instance of AtomContent
+feed.entries.first.content.text # Entry content text
+```
+
+You can also use the elements method without specifying a class:
+
+```ruby
+class ServiceResponse
   include SAXMachine
-  elements :message, :as => :messages
+  elements :message, as: :messages
 end
 
-response = SomeServiceResponse.parse("<response><message>hi</message><message>world</message></response>")
-response.messages.first # => "hi"
-response.messages.last  # => "world"
+response = ServiceResponse.parse("
+  <response>
+    <message>hi</message>
+    <message>world</message>
+  </response>
+")
+response.messages.first # hi
+response.messages.last  # world
+```
 
-# To limit conflicts in the class used for mappping, you can use the alternate SAXMachine.configure syntax
+To limit conflicts in the class used for mappping, you can use the alternate
+`SAXMachine.configure` syntax:
 
+```ruby
 class X < ActiveRecord::Base
-  # this way no element, elements or ancestor method will be added to X
+  # This way no element, elements or ancestor method will be added to X
   SAXMachine.configure(X) do |c|
     c.element :title
   end
 end
 ```
 
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
 ## LICENSE
 
 The MIT License
 
-Copyright (c) 2009-2012:
+Copyright (c) 2009-2014:
 
 * [Paul Dix](http://www.pauldix.net)
 * [Julien Kirch](http://www.archiloque.net)
 * [Ezekiel Templin](http://zeke.templ.in)
+* [Dmitry Krasnoukhov](http://krasnoukhov.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -104,4 +175,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,6 +1,7 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new(:spec)
-task :test => :spec
-task :default => :test
+task test: :spec
+task default: :test

data/lib/sax-machine.rb

@@ -1,8 +1,17 @@
 require "sax-machine/version"
 require "sax-machine/sax_document"
 require "sax-machine/sax_configure"
-require "sax-machine/sax_handler"
 require "sax-machine/sax_config"
 
 module SAXMachine
-end
+  def self.handler
+    @@handler
+  end
+
+  def self.handler=(handler)
+    require "sax-machine/handlers/sax_#{handler}_handler"
+    @@handler = handler
+  end
+end
+
+SAXMachine.handler = :nokogiri

data/lib/sax-machine/{sax_ancestor_config.rb → config/sax_ancestor.rb}

@@ -1,21 +1,17 @@
 module SAXMachine
   class SAXConfig
-
     class AncestorConfig
       attr_reader :name, :setter
 
       def initialize(name, options)
-        @name = name.to_s
-
-        @as = options[:as]
+        @name   = name.to_s
+        @as     = options[:as]
         @setter = "#{@as}="
       end
 
       def column
         @as || @name.to_sym
       end
-
     end
-
   end
-end
+end

data/lib/sax-machine/{sax_attribute_config.rb → config/sax_attribute.rb}

@@ -1,13 +1,12 @@
 module SAXMachine
   class SAXConfig
-
     class AttributeConfig
       attr_reader :name, :setter
 
       def initialize(name, options)
-        @name = name.to_s
-        @as = options[:as]
-        @setter = "#{@as}="
+        @name     = name.to_s
+        @as       = options[:as]
+        @setter   = "#{@as}="
         @required = options[:required]
       end
 
@@ -16,7 +15,7 @@ module SAXMachine
       end
 
       def required?
-        @required
+        !!@required
       end
 
       def value_from_attrs(attrs)
@@ -35,6 +34,5 @@ module SAXMachine
         false
       end
     end
-
   end
 end

data/lib/sax-machine/{sax_collection_config.rb → config/sax_collection.rb}

@@ -1,20 +1,19 @@
 module SAXMachine
   class SAXConfig
-    
     class CollectionConfig
       attr_reader :name
-      
+
       def initialize(name, options)
         @name  = name.to_s
         @class = options[:class]
         @as    = options[:as].to_s
         @with  = options.fetch(:with, {})
       end
-      
+
       def accessor
         as
       end
-      
+
       def attrs_match?(attrs)
         @with.all? do |key, value|
           value === attrs[key.to_s]
@@ -23,15 +22,12 @@ module SAXMachine
 
       def data_class
         @class || @name
-      end      
-      
-    protected
-      
+      end
+
+      protected
       def as
         @as
       end
-      
     end
-    
   end
 end

data/lib/sax-machine/{sax_element_config.rb → config/sax_element.rb}

@@ -1,31 +1,31 @@
 module SAXMachine
   class SAXConfig
-    
     class ElementConfig
       attr_reader :name, :setter, :data_class, :collection
-      
+
       def initialize(name, options)
         @name = name.to_s
         @with = options.fetch(:with, {})
 
-        if options.has_key?(:value)
-          @value = options[:value].to_s
+        @value = if options.has_key?(:value)
+          options[:value].to_s
         else
-          @value = nil
+          nil
         end
-        
+
         @as = options[:as]
         @collection = options[:collection]
-        
-        if @collection
-          @setter = "add_#{options[:as]}"
+
+        @setter = if @collection
+          "add_#{options[:as]}"
         else
-          @setter = "#{@as}="
+          "#{@as}="
         end
+
         @data_class = options[:class]
         @required = options[:required]
       end
-      
+
       def value_configured?
         !@value.nil?
       end
@@ -39,27 +39,26 @@ module SAXMachine
       end
 
       def required?
-        @required
+        !!@required
       end
 
       def value_from_attrs(attrs)
         attrs.fetch(@value, nil)
       end
-      
+
       def attrs_match?(attrs)
         @with.all? do |key, value|
           value === attrs[key.to_s]
         end
       end
-      
+
       def has_value_and_attrs_match?(attrs)
         !@value.nil? && attrs_match?(attrs)
       end
-      
+
       def collection?
-        @collection
+        !!@collection
       end
     end
-    
   end
 end