sax-machine 0.1.0 → 1.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18613b2e2d45b525b4557712c55bf590634e3909
+  data.tar.gz: 75211d7241bd4e5d1f2eda7ea9ebe6bdad8d3027
+SHA512:
+  metadata.gz: 3212a43c353264ca6e00ab2e2e4ec34f04f107dd49506c283af383fa67c9c3c61b56e9a2abbbd3a1e6eae53209336f5647bf6aea822676f2691d5ae4e9c531f3
+  data.tar.gz: a778a1df288ce48494bd10300c2170e8ba00666b5a7ea6149d2937d051f003245d633d46962491b9bd0bdbd809f7f8fe8986941b54613230b9c42207a6957bce

data/.gitignore

@@ -0,0 +1,10 @@
+.idea
+.bundle
+*.gem
+Gemfile.lock
+.rvmrc
+.DS_STORE
+pkg/
+coverage/
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,32 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby-1.7
+  - rbx-2
+  - ruby-head
+  - jruby-head
+
+sudo: false
+
+env:
+  matrix:
+    - HANDLER="nokogiri"
+    - HANDLER="ox"
+    - HANDLER="oga"
+
+matrix:
+  exclude:
+    - env: HANDLER="ox"
+      rvm: jruby-1.7
+    - env: HANDLER="ox"
+      rvm: jruby-head
+  allow_failures:
+    - env: HANDLER="oga"
+      rvm: jruby-1.7
+    - rvm: rbx-2
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -1,4 +1,15 @@
 source "http://rubygems.org"
 
-gem 'nokogiri', '>= 1.4.4'
-gem 'rspec', '>= 2.6.0'
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'guard-rspec'
+  gem 'simplecov', require: false, platforms: [:mri]
+  gem 'coveralls', require: false, platforms: [:mri]
+
+  gem 'activerecord', '~> 4.1'
+  gem 'nokogiri', '~> 1.6'
+  gem 'ox', '>= 2.1.2', platforms: [:mri, :rbx]
+  gem 'oga', '>= 0.3.4'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+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" }
+end

data/HISTORY.md

@@ -0,0 +1,77 @@
+# HEAD
+
+# 1.3.2
+
+* Compatibility with Oga 0.3
+
+# 1.3.1
+
+* Allow default value to be `false` [[#66](https://github.com/pauldix/sax-machine/pull/66)]
+* Support adding class to an attribute [[#68](https://github.com/pauldix/sax-machine/pull/68)]
+* Adjust Ox handler to skip empty text/cdata values
+
+# 1.3.0
+
+* Improve block modifiers to support all config options
+* Make block modifiers run in instance context
+* Make all handlers support IO as a input
+
+# 1.2.0
+
+* Add support for blocks as value modifiers [[#61](https://github.com/pauldix/sax-machine/pull/61)]
+
+# 1.1.1
+
+* Fix Nokogiri autoloading [[#60](https://github.com/pauldix/sax-machine/pull/60)]
+
+# 1.1.0
+
+* Option to use Oga as a SAX handler
+
+# 1.0.3
+
+* Remove missed `nokogiri` reference [[#54](https://github.com/pauldix/sax-machine/pull/54)]
+* Add support for `Symbol` data type conversion [[#57](https://github.com/pauldix/sax-machine/pull/57)]
+* Add specs for multiple elements with the same alias [[#53](https://github.com/pauldix/sax-machine/pull/53)]
+* Various code and documentation enhancements
+
+# 1.0.2
+
+* Make sure SAXConfig getters do not modify internal vars. Prevent race conditions
+
+# 1.0.1
+
+* Improve normalize_name performance
+
+# 1.0.0
+
+* Make `nokogiri` dependency optional
+* Add :default argument for elements [[#51](https://github.com/pauldix/sax-machine/pull/51)]
+
+# 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
+
+* 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)]
+* 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
+* Add SAXMachine.configure

data/README.md

@@ -0,0 +1,207 @@
+# SAX Machine
+
+## 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, Ox or Oga.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sax-machine'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+SAX Machine can use either `nokogiri`, `ox` or `oga` as XML SAX handler.
+
+To use **Nokogiri** add this line to your Gemfile:
+
+```ruby
+gem 'nokogiri', '~> 1.6'
+```
+
+To use **Ox** add this line to your Gemfile:
+
+```ruby
+gem 'ox', '>= 2.1.2'
+```
+
+To use **Oga** add this line to your Gemfile:
+
+```ruby
+gem 'oga', '>= 0.2.0'
+```
+
+You can also specify which handler to use manually, like this:
+
+```ruby
+SAXMachine.handler = :nokogiri
+```
+
+## Examples
+
+Include `SAXMachine` in any class and define properties to parse:
+
+```ruby
+class AtomContent
+  include SAXMachine
+  attribute :type
+  value :text
+end
+
+class AtomEntry
+  include SAXMachine
+  element :title
+  # The :as argument makes this available through entry.author instead of .name
+  element :name, as: :author
+  element "feedburner:origLink", as: :url
+  # 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
+end
+
+class Atom
+  include SAXMachine
+  # Use block to modify the returned value
+  # Blocks are working with pretty much everything,
+  # except for `elements` with `class` attribute
+  element :title do |title|
+    title.strip
+  end
+  # 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:
+
+```ruby
+feed = Atom.parse(xml_text)
+
+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.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
+```
+
+You can also use the elements method without specifying a class:
+
+```ruby
+class ServiceResponse
+  include SAXMachine
+  elements :message, as: :messages
+end
+
+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:
+
+```ruby
+class X < ActiveRecord::Base
+  # This way no element, elements or ancestor method will be added to X
+  SAXMachine.configure(X) do |c|
+    c.element :title
+  end
+end
+```
+
+Multiple elements can be mapped to the same alias:
+
+```ruby
+class RSSEntry
+  include SAXMachine
+  # ...
+  element :pubDate, as: :published
+  element :pubdate, as: :published
+  element :"dc:date", as: :published
+  element :"dc:Date", as: :published
+  element :"dcterms:created", as: :published
+end
+```
+
+If more than one of these elements exists in the source, the value from the *last one* is used. The order of
+the `element` declarations in the code is unimportant. The order they are encountered while parsing the
+document determines the value assigned to the alias.
+
+If an element is defined in the source but is blank (e.g., `<pubDate></pubDate>`), it is ignored, and non-empty one is picked.
+
+## 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-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
+'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/Rakefile

@@ -1,21 +1,7 @@
-require "rspec/core/rake_task"
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-require 'sax-machine'
-
-desc "Run all specs"
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
-end
-
-task :default => [:spec]
-
-task :test do
-    sh 'rspec spec'
-end
-
-task :install do
-  rm_rf "*.gem"
-  puts `gem build sax-machine.gemspec`
-  puts `sudo gem install sax-machine-#{SAXMachine::VERSION}.gem`
-end
+RSpec::Core::RakeTask.new(:spec)
+task test: :spec
+task default: :test

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/config/sax_attribute.rb

@@ -0,0 +1,18 @@
+module SAXMachine
+  class SAXConfig
+    class AttributeConfig < ElementValueConfig
+      def value_from_attrs(attrs)
+        attrs.fetch(@name, nil)
+      end
+
+      def attrs_match?(attrs)
+        attrs.key?(@name) || attrs.value?(@name)
+      end
+      alias_method :has_value_and_attrs_match?, :attrs_match?
+
+      def collection?
+        false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+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]
+        end
+      end
+
+      def data_class
+        @class || @name
+      end
+
+      protected
+      def as
+        @as
+      end
+    end
+  end
+end

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

@@ -1,37 +1,32 @@
 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
-        
-        if options.has_key?(:with)
-          # for faster comparisons later
-          @with = options[:with].to_a.flatten.collect {|o| o.to_s}
-        else
-          @with = nil
-        end
-        
-        if options.has_key?(:value)
-          @value = options[:value].to_s
+        @with = options.fetch(:with, {})
+
+        @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]}"
+        @default = options[:default]
+
+        @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
@@ -45,29 +40,26 @@ module SAXMachine
       end
 
       def required?
-        @required
+        !!@required
       end
 
       def value_from_attrs(attrs)
-        attrs.index(@value) ? attrs[attrs.index(@value) + 1] : nil
+        attrs.fetch(@value, nil)
       end
-      
+
       def attrs_match?(attrs)
-        if @with
-          @with == (@with & attrs)
-        else
-          true
+        @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

data/lib/sax-machine/{sax_element_value_config.rb → config/sax_element_value.rb}

@@ -1,14 +1,14 @@
 module SAXMachine
   class SAXConfig
-
     class ElementValueConfig
-      attr_reader :name, :setter
+      attr_reader :name, :setter, :data_class
 
       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]
+        @data_class = options[:class]
       end
 
       def column
@@ -16,9 +16,8 @@ module SAXMachine
       end
 
       def required?
-        @required
+        !!@required
       end
     end
-
   end
-end
+end