saxophone 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57c5242aea2b5daec2f7129d6b12fe56e28e07a8
+  data.tar.gz: c5f4823813e45c56693feeafbb808253367cf533
+SHA512:
+  metadata.gz: 18a39e8330f39c5da059bfcb39f147084d8d707fd6375a9561d4711ce3269dc16a98f860a717d45b181cbd79c555edfc329e7ff80818c0f7e41a65f29a0ce9e6
+  data.tar.gz: 6d4b5006f62bacf0d51e6300ba146083301fcb3922dd960282216272622a130ce7cd6fac88481ad5149ceedf4f0e69c5538decde24cae5fa16ae7944594a3c7c

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,35 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 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

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'guard-rspec'
+  gem 'simplecov', require: false, platforms: [:mri]
+  gem 'coveralls', require: false, platforms: [:mri]
+
+  gem 'activerecord', '~> 5.0.0'
+  gem 'nokogiri', '>= 1.8.2'
+  gem 'ox', '>= 2.1.2', platforms: [:mri, :rbx]
+  gem 'oga', '>= 0.3.4'
+end
+
+group :test do
+  gem 'sqlite3'
+end

data/README.md

@@ -0,0 +1,206 @@
+# Saxophone
+
+A declarative SAX parsing library backed by Nokogiri, Ox or Oga.
+
+## Origins
+
+This repository is a fork of [pauldix/sax-machine](https://github.com/pauldix/sax-machine). We'd like to
+thank all original authors and contributers for their work on the original repository. However, we have
+the feeling that the original repository is not being actively maintained anymore - that's why we decided to
+fork it and continue the work of the original authors in our façon. To make the distinction clear, we
+renamed the project from that point to `Saxophone`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'saxophone'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+Saxophone 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
+Saxophone.handler = :nokogiri
+```
+
+## Examples
+
+Include `Saxophone` in any class and define properties to parse:
+
+```ruby
+class AtomContent
+  include Saxophone
+  attribute :type
+  value :text
+end
+
+class AtomEntry
+  include Saxophone
+  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 Saxophone
+  # 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 Saxophone
+  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
+`Saxophone.configure` syntax:
+
+```ruby
+class X < ActiveRecord::Base
+  # This way no element, elements or ancestor method will be added to X
+  Saxophone.configure(X) do |c|
+    c.element :title
+  end
+end
+```
+
+Multiple elements can be mapped to the same alias:
+
+```ruby
+class RSSEntry
+  include Saxophone
+  # ...
+  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-2018:
+
+* [Paul Dix](http://www.pauldix.net)
+* [Julien Kirch](http://www.archiloque.net)
+* [Ezekiel Templin](http://zeke.templ.in)
+* [Dmitry Krasnoukhov](http://krasnoukhov.com)
+* [Robin Neumann](https://github.com/neumanrq)
+
+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

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

data/archive/HISTORY.md

@@ -0,0 +1,77 @@
+# Version history of parent gem "sax-machine":
+
+# 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/lib/saxophone.rb

@@ -0,0 +1,31 @@
+require "saxophone/version"
+require "saxophone/sax_document"
+require "saxophone/sax_configure"
+require "saxophone/sax_config"
+
+module Saxophone
+  def self.handler
+    @@handler ||= nil
+  end
+
+  def self.handler=(handler)
+    if handler
+      require "saxophone/handlers/sax_#{handler}_handler"
+      @@handler = handler
+    end
+  end
+end
+
+# Try handlers
+[:ox, :oga].each do |handler|
+  begin
+    Saxophone.handler = handler
+    break
+  rescue LoadError
+  end
+end
+
+# Still no handler, use Nokogiri
+if Saxophone.handler.nil?
+  Saxophone.handler = :nokogiri
+end

data/lib/saxophone/config/sax_ancestor.rb

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

data/lib/saxophone/config/sax_attribute.rb

@@ -0,0 +1,18 @@
+module Saxophone
+  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/saxophone/config/sax_collection.rb

@@ -0,0 +1,33 @@
+module Saxophone
+  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