ox-mapper 0.2.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.so
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ox-mapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexei Mikhailov
+
+MIT License
+
+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/README.md

@@ -0,0 +1,53 @@
+# Ox::Mapper
+
+Ox::Mapper's intention is to simplify creation of parsers based on [`ox`](https://github.com/ohler55/ox)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ox-mapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ox-mapper
+
+## Usage
+
+All you need to do is to setup callbacks for elements and attributes in Ruby style
+```ruby
+mapper = Ox::Mapper.new
+
+mapper.on(:book) { |book| puts book.attributes.inspect }
+mapper.on(:title) { |title| title.parent[:title] = title.text }
+
+# collected attributes should be set up explicitely
+mapper.on(:author, :attributes => :name) { |e| e.parent[:author] = e[:name] }
+
+# setup transformation for attribute "value" of "price" element
+mapper.on(:price, :attributes => :value) { |e| e.parent[:price] = Float(e[:value]) }
+
+mapper.parse(StringIO.new <<-XML) # => {:title => "Serenity", :author => "John Dow", :price => 1123.0}
+  <xml>
+    <book>
+      <title>Serenity</title>
+      <author name="John Dow" age="99" />
+      <price value="1123" />
+    </book>
+  </xml>
+XML
+```
+
+This API is unstable and a subject to change.
+
+## 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

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# Setup spec task
+RSpec::Core::RakeTask.new

data/lib/ox-mapper.rb

@@ -0,0 +1,2 @@
+# coding: utf-8
+require "ox/mapper"

data/lib/ox/mapper.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+require "ox/mapper/version"
+
+module Ox
+  # Ox::Mapper's intention is to simplify usage of Ox::Sax parsers
+  # All you need to do is to setup callbacks for elements and attributes in Ruby style
+  #
+  # Example:
+  #   mapper = Ox::Mapper.new
+  #   mapper.on_element(:book) { |e| puts book.attributes.inspect }
+  #   mapper.on_element(:title) { |e| e.parent[:title] = e.text }
+  #
+  #   mapper.collect_attribute(:author => :name)
+  #   mapper.on_element(:author) { |e| e.parent[:author] = e[:name] }
+  #
+  #   # setup transformation for attribute "value" of "price" element
+  #   mapper.on_attribute(:price => :value) { |v| Float(v) }
+  #   mapper.on_element(:price) { |e| e.parent[:price] = e[:value] }
+  #
+  #   mapper.parse(StringIO.new <<-XML) # => {:title => "Serenity", :author => "John Dow", :price => 1123.0}
+  #     <xml>
+  #       <book>
+  #         <title>Serenity</title>
+  #         <author name="John Dow" />
+  #         <price value="1123" />
+  #       </book>
+  #     </xml>
+  #   XML
+  module Mapper
+    autoload :Parser, "ox/mapper/parser"
+
+    def self.new
+      Parser.new
+    end
+  end # module Mapper
+end

data/lib/ox/mapper/element.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+module Ox
+  module Mapper
+    # An element representing XML-node
+    #
+    # @api private
+    class Element
+      attr_accessor :parent, :name, :text, :line, :column
+      attr_writer :attributes
+
+      # Initialize element with +name+
+      #
+      # @param [Symbol] name
+      # @param [Integer] line
+      # @param [Integer] column
+      def initialize(name, line = nil, column = nil)
+        @name, @line, @column = name, line, column
+      end
+
+      # Set element attribute
+      #
+      # @param [Symbol, String] name attribute name
+      # @param [Object] value attribute value
+      def []=(name, value)
+        attributes[name] = value
+      end
+
+      # Get attribute value
+      #
+      # @param [Symbol, String] name attribute name
+      # @return [Object] attribute value
+      def [](name)
+        @attributes && @attributes[name.to_sym]
+      end
+
+      # Get attributes hash
+      #
+      # @return [Hash] attributes
+      def attributes
+        @attributes ||= {}
+      end
+    end # class Element
+  end # module Mapper
+end # module Ox

data/lib/ox/mapper/handler.rb

@@ -0,0 +1,109 @@
+require 'set'
+require 'ox/mapper/element'
+
+module Ox
+  module Mapper
+    # Sax handler
+    #
+    # @api private
+    class Handler
+      OUTPUT_ENCODING = Encoding::UTF_8
+
+      def initialize
+        # ox supports lines and columns starting from 1.9.0
+        # we just need to set these ivars
+        @line, @column = nil, nil
+        @stack = []
+        # collected elements
+        @elements_callbacks = Hash.new
+        # collected attributes
+        @attributes = Hash.new
+      end
+
+      # Assigns +callback+ to elements with given tag +name+
+      #
+      # @param [String, Symbol] name
+      # @param [Proc] callback
+      def setup_element_callback(name, callback)
+        (@elements_callbacks[name.to_sym] ||= []) << callback.to_proc
+      end
+
+      # Collect values of attributes with given +attribute_name+
+      # at elements with tag of given +tag_name+
+      #
+      # @param [String, Symbol] tag_name
+      # @param [String, Symbol] attribute_name
+      def collect_attribute(tag_name, attribute_name)
+        (@attributes[tag_name.to_sym] ||= Set.new) << attribute_name.to_sym
+      end
+
+      # "start_element" handler just pushes an element to stack and assigns a pointer to parent element
+      #
+      # @api private
+      def start_element(name)
+        element = Element.new(name, @line, @column)
+        element.parent = top
+
+        @stack.push(element)
+      end
+
+      # "end_element" handler pushes an element if it is attached to callbacks
+      #
+      # @api private
+      def end_element(*)
+        element = @stack.pop
+
+        if collect_element?(element.name)
+          encode(element.text)
+
+          @elements_callbacks[element.name].each { |cb| cb.call(element) }
+        end
+      end
+
+      # attributes handler assigns attribute value to current element
+      #
+      # @api private
+      def attr(name, value)
+        top[name] = encode(value) if collect_attribute?(name)
+      end
+
+      # text handler appends given +value+ to current element +text+ attribute
+      #
+      # @api private
+      def text(value)
+        if value && top
+          value.strip!
+
+          if top.text
+            top.text << encode(value)
+          else
+            top.text = encode(value)
+          end
+        end
+      end
+      alias cdata text
+
+      private
+      def collect_element?(element)
+        element && @elements_callbacks.has_key?(element)
+      end
+
+      def collect_attribute?(name)
+        top &&
+        collect_element?(top.name) &&
+        @attributes.has_key?(top.name) &&
+        @attributes[top.name].include?(name)
+      end
+
+      # encode +str+ to utf-8
+      def encode(str)
+        str && !str.ascii_only? ? str.encode!(OUTPUT_ENCODING) : str
+      end # def encode
+
+      # returns top element
+      def top
+        @stack.last
+      end
+    end
+  end
+end

data/lib/ox/mapper/parser.rb

@@ -0,0 +1,66 @@
+# coding: utf-8
+require 'ox'
+require 'ox/mapper/handler'
+
+module Ox
+  module Mapper
+    # Configurable SAX-parser
+    #
+    # Usage:
+    #   parser = Mapper.new
+    #
+    #   parser.on(:offer) { |offer| puts offer }
+    #   parser.on(:offer => [:id]) { |v| v.to_i }
+    class Parser
+      def initialize
+        @handler = Handler.new
+      end
+
+      # Parse given +io+ object
+      def parse(io, options = {})
+        Ox.sax_parse(@handler, io, options)
+      end
+
+      # Define a callbacks to be called when +elements+ processed
+      #
+      # @example
+      #   parser.on(:offer, :price) { |elem| p elem }
+      #   parser.on(:book, :attributes => [:author, :isbn]) { |book| p book[:author], book[:isbn] }
+      #
+      # @param [Array<String, Symbol>] elements elements names
+      # @yield [element]
+      # @yieldparam [Ox::Mapper::Element] element
+      # @option options [Array<String, Symbol>] :attributes list of collected attributes
+      def on(*elements, &block)
+        options = (Hash === elements.last) ? elements.pop : {}
+
+        attributes = Array(options[:attributes]).flatten
+
+        elements.each do |e|
+          @handler.setup_element_callback(e, block)
+
+          attributes.each { |attr| @handler.collect_attribute(e, attr) }
+        end
+      end
+      alias on_element on
+
+      # Set attribute callback
+      #
+      # @example
+      #   parser.collect_attribute(:offer => :id, 'ns:offer' => 'ns:id')
+      #
+      # @param [Hash{String, Symbol => String, Symbol}] map hash with element names as keys
+      #                                                 and attributes names as value
+      # @deprecated
+      def collect_attribute(map)
+        warn 'Ox::Mapper::Parser#on_attribute method is deprecated and shall be removed in future versions. '\
+             'Please use #on(element_name, :attributes => [...]) notation.'
+
+        map.each_pair do |k, attributes|
+          Array(attributes).flatten.each { |attr| @handler.collect_attribute(k, attr) }
+        end
+      end
+      alias on_attribute collect_attribute
+    end # class Parser
+  end # module Mapper
+end # module Ox

data/lib/ox/mapper/version.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+module Ox
+  module Mapper
+    VERSION = '0.2.0'
+  end
+end

data/ox-mapper.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ox/mapper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ox-mapper'
+  gem.version       = Ox::Mapper::VERSION
+  gem.authors       = ['Alexei Mikhailov']
+  gem.email         = %w(amikhailov83@gmail.com)
+  gem.summary       = %q{Create SAX parsers based on `ox` with simple DSL}
+  gem.homepage      = 'https://github.com/take-five/ox-mapper'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w(lib)
+
+  gem.add_dependency 'ox'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/ox-mapper/parser_spec.rb

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'ox/mapper/parser'
+require 'stringio'
+
+describe Ox::Mapper::Parser do
+  let(:parser) { Ox::Mapper::Parser.new }
+  let :xml do
+    StringIO.new <<-XML
+<xml>
+  <offer id="1" id2="0">
+    <price value="1"/>
+  </offer>
+  <offer id="2" id2="0">
+    <price value="2"/>
+  </offer>
+  <text>text</text>
+  <text>
+    <![CDATA[
+    text
+    ]]>
+  </text>
+  <ns:offer ns:id="3" />
+</xml>
+    XML
+  end
+
+  describe '#on' do
+    let(:elements) { [] }
+
+    context 'when one element given' do
+      before { parser.on(:offer) { |e| elements << e } }
+      before { parser.parse(xml) }
+
+      it 'should execute given block on each given element' do
+        elements.should have(2).items
+      end
+    end
+
+    context 'when multiple elements given' do
+      before do
+        parser.on :offer,
+                  :price,
+                  'ns:offer',
+                  :attributes => [:id, :value, 'ns:id'] do |e|
+          elements << e
+        end
+      end
+      before { parser.parse(xml) }
+
+      subject { elements }
+
+      it { should have(5).items }
+
+      it 'should collect elements in ascending order (starting from leafs to root)' do
+        elements[0].name.should eq :price
+        elements[0][:value].should eq '1'
+
+        elements[1].name.should eq :offer
+        elements[1][:id].should eq '1'
+
+        elements[2].name.should eq :price
+        elements[2][:value].should eq '2'
+
+        elements[3].name.should eq :offer
+        elements[3][:id].should eq '2'
+
+        elements[4]['ns:id'].should eq '3'
+      end
+
+      it 'should collect parent element' do
+        elements[0].parent.should be elements[1]
+        elements[1].parent.name.should eq :xml
+      end
+    end
+  end
+
+  describe 'parsing element contents' do
+    let(:elements) { [] }
+    before { parser.on_element(:text) { |e| elements << e.text } }
+    before { parser.parse(xml) }
+
+    subject { elements }
+
+    it { should have(2).items }
+    it { should eq %w(text text) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'simplecov'
+
+#RSpec.configure do |config|
+#end
+
+SimpleCov.start do
+  add_filter '/spec/'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: ox-mapper
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexei Mikhailov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: ox
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: simplecov
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: 
+email:
+- amikhailov83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ox-mapper.rb
+- lib/ox/mapper.rb
+- lib/ox/mapper/element.rb
+- lib/ox/mapper/handler.rb
+- lib/ox/mapper/parser.rb
+- lib/ox/mapper/version.rb
+- ox-mapper.gemspec
+- spec/ox-mapper/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/take-five/ox-mapper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 639433533
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 639433533
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Create SAX parsers based on `ox` with simple DSL
+test_files:
+- spec/ox-mapper/parser_spec.rb
+- spec/spec_helper.rb