oxm 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/CHANGELOG.markdown

@@ -0,0 +1,15 @@
+### 0.1.0 / 2011/09/19
+* Disclaimer: Not compatible to the previous versions
+** Removed: OXM::Object#cdata, OXM::Object#text, OXM::Object#text=
+** Added: OXM::Object#content, OXM::Object#content=
+** Changed: OXM::Object#to_s never returns nil
+** Changed: OXM::Object#compact! removes empty elements as well (no text value, no attributes at all)
+** Fix: Allows assignment of nil/empty string as element values
+
+### 0.0.2 / 2011/09/15
+* OXM::Object#compact! added
+* OXM::Object#elements as an alias of OXM::Object#children
+
+### 0.0.1 / 2011/09/15
+* Initial release
+

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end
+
+gem "builder", ">= 3.0.0"
+gem "nokogiri", ">= 1.5.0"

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.5.0)
+    nokogiri (1.5.0-java)
+    rake (0.9.2)
+    rcov (0.9.10)
+    rcov (0.9.10-java)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  builder (>= 3.0.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  nokogiri (>= 1.5.0)
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Junegunn Choi
+
+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.markdown

@@ -0,0 +1,81 @@
+# oxm
+
+A tiny, easy-to-use Object-XML-Mapper for Ruby. 
+Internally uses Nokogiri SAX parser which allows handling of large XML documents.
+
+## Installation
+
+```
+gem install oxm
+```
+
+## Examples
+
+```xml
+<orders>
+  <order date="2011/08/27">
+    <item amount="5">Apple</item>
+    <item amount="2">Banana</item>
+    <customer id="100">Alice</customer>
+  </order>
+  <order date="2011/08/27">
+    <item amount="1">Zoltax</item>
+    <customer id="200">Bob</customer>
+  </order>
+</orders>
+```
+
+```ruby
+require 'oxm'
+
+# With block
+OXM.from_xml(xml_data_or_io, 'orders/order') do |order|
+  # Accessing attributes of the element
+  order['date']
+  order.attributes
+
+  # Accessing attributes and text/cdata values of child elements
+  order.item.first['amount']
+  order.item.first.content
+  order.item.first.to_s
+  order.item.first.cdata?
+
+  # Traverses child elements
+  order.elements.each do |tag, elements_for_the_tag|
+    # ...
+  end
+
+  # Compaction: collapse single-element Arrays
+  order.customer.first.to_s
+  order.customer.first['id']
+  order.compact!
+  order.customer.to_s
+  order.customer['id']
+
+  # XML expression for the element
+  order.to_xml
+  order.item.first.to_xml
+end
+
+# Array of elements are returned when block is not given
+items = OXM.from_xml(xml_data_or_io, 'orders/order/item')
+```
+
+## TODO
+* When block is not given, make from_xml return an Enumerator instead of an Array
+
+## Contributing to oxm
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Junegunn Choi. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "oxm"
+  gem.homepage = "http://github.com/junegunn/oxm"
+  gem.license = "MIT"
+  gem.summary = %Q{A tiny Object-XML-Mapper}
+  gem.description = %Q{A tiny Object-XML-Mapper using Nokogiri SAX parser}
+  gem.email = "junegunn.c@gmail.com"
+  gem.authors = ["Junegunn Choi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "oxm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/oxm/object.rb

@@ -0,0 +1,154 @@
+module OXM
+  class Object
+    attr_reader :tag
+
+    # @return [String/NilClass]
+    def content
+      @data
+    end
+
+    # @param [String] val Text
+    # @param [String] val
+    # @return [String]
+    def content= val
+      @cdata = false
+      process val
+    end
+
+    # @param [String] val CDATA content
+    # @return [String]
+    def cdata= val
+      @cdata = true
+      process val
+    end
+
+    # @return [Boolean]
+    def cdata?
+      @cdata
+    end
+
+    # @return [String] XML expression for this object
+    def to_xml
+      io = StringIO.new
+      builder = Builder::XmlMarkup.new(:target => io)
+
+      build_node = lambda do |node|
+        builder.tag!(node.tag, node.attributes) do
+          node.elements.each do |tag, elements|
+            next if elements.nil?
+            elements = [elements] unless elements.is_a? Array
+            elements.each do |child|
+              build_node.call child
+            end
+          end
+          if node.content
+            if node.cdata?
+              builder.cdata! node.content
+            else
+              builder.text! node.content
+            end
+          end
+        end
+      end
+
+      build_node.call self
+      io.string
+    end
+
+    # @return [String]
+    def to_s
+      @data.to_s
+    end
+
+    # @return [String]
+    def inspect
+      to_xml
+    end
+
+    # @param [String] attr
+    # @return [String]
+    def [] attr
+      @attrs[attr.to_s]
+    end
+
+    # @param [String] attr
+    # @param [String] val
+    # @return [String]
+    def []= attr, val
+      @attrs[attr.to_s] = val
+    end
+
+    # @return [Hash]
+    def attributes
+      @attrs
+    end
+
+    # @return [Hash]
+    def elements
+      @nodes
+    end
+    alias children elements
+
+    # @param [String] tag
+    # @param [OXM::Object] object
+    # @return [OXM::Object]
+    def add_node tag, object
+      @nodes[tag] ||= []
+      @nodes[tag] << object
+      self
+    end
+
+    # Compacts the object by removing empty child elements and then collapsing element Arrays. 
+    # After compaction, single-element arrays are collapsed, and empty arrays become nil.
+    # @return [OXM::Object]
+    def compact!
+      @nodes.each do |key, value|
+        if value.is_a?(Array)
+          value = value.reject(&:empty?)
+          @nodes[key] =
+            case value.length
+            when 0
+              nil
+            when 1
+              value.first
+            else
+              value
+            end
+        end
+      end
+      self
+    end
+
+    # @param [String] tag
+    # @param [Hash] attrs
+    # @return [OXM::Object]
+    def initialize tag, attrs = {}
+      @tag = tag
+      @attrs = attrs
+      @nodes = {}
+      @cdata = false
+      @data  = nil
+    end
+
+    # @return [Boolean] Return if the element is empty (no text value and no attributes)
+    def empty?
+      self.to_s.empty? && self.attributes.empty?
+    end
+
+  private
+    def method_missing(symb, *args)
+      if @nodes.has_key?(symb.to_s)
+        return @nodes[symb.to_s]
+      else
+        raise NoMethodError.new("undefined method or attribute `#{symb}'")
+      end
+    end
+
+    def process str
+      str = str.to_s.strip
+      @data = str
+    end
+
+  end#Object
+end#OXM
+

data/lib/oxm/sax_handler.rb

@@ -0,0 +1,57 @@
+module OXM
+  class SaxHandler < Nokogiri::XML::SAX::Document
+    attr_reader :outputs
+
+    def initialize loop_node, &block
+      @loop_node = loop_node
+      @block = block
+      @tags = []
+      @objects = []
+      @outputs = []
+    end
+
+    def start_element tag, attributes
+      @tags << tag
+
+      # Met loop element
+      if @objects.empty?
+        if match?
+          @objects << @object = OXM::Object.new(tag, Hash[*attributes.flatten])
+        end
+      elsif @object
+        @object.add_node tag, node_obj = OXM::Object.new(tag, Hash[*attributes.flatten])
+        @objects << @object = node_obj
+      end
+    end
+
+    def cdata_block str
+      @object.cdata = @object.to_s + str if @object
+    end
+
+    def characters str
+      @object.content = @object.to_s + str if @object
+    end
+
+    def end_element tag
+      unless @objects.empty?
+        if match?
+          obj = @objects.pop
+          if @block
+            @block.call obj
+          else
+            @outputs << obj
+          end
+          @object = nil
+        else
+          @objects.pop
+          @object = @objects.last
+        end
+      end
+      @tags.pop
+    end
+
+    def match?
+      @tags.join('/') == @loop_node
+    end
+  end
+end#OXM

data/lib/oxm.rb

@@ -0,0 +1,16 @@
+require 'nokogiri'
+require 'builder'
+require 'oxm/sax_handler'
+require 'oxm/object'
+
+module OXM
+  # @param [IO/String] xml XML data
+  # @param [String] loop_element
+  # @return [Array] Array of OXM::Objects
+  def self.from_xml xml, loop_element, &block
+    handler = OXM::SaxHandler.new(loop_element, &block)
+    parser = Nokogiri::XML::SAX::Parser.new(handler)
+    parser.parse xml
+    handler.outputs unless block_given?
+  end
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'oxm'
+
+class Test::Unit::TestCase
+end

data/test/test_oxm.rb

@@ -0,0 +1,166 @@
+require 'helper'
+
+class TestOxm < Test::Unit::TestCase
+  def test_from_xml_string
+    str = <<-EOF
+    <container attr1="1" attr2="2">
+      <item dept="A">
+        <volume unit="ml"><![CDATA[ 100 ]]></volume>
+        <volume unit="ml"><![CDATA[200]]></volume>
+      </item>
+      <item dept="B">
+        <volume unit="l">200</volume>
+        <volume unit="l">300</volume>
+      </item>
+      <item dept="C">
+        <volume unit="l">300</volume>
+        <volume unit="ml">400</volume>
+      </item>
+      <item dept="D">
+        <volume unit="L">500</volume>
+        <volume></volume>
+      </item>
+    </container>
+    EOF
+
+    require 'tempfile'
+    tf = Tempfile.new('oxm')
+    tf << str
+    tf.flush
+
+    [str, File.open(tf.path)].each do |input|
+      result = OXM.from_xml(input, 'container')
+      assert       result.is_a?(Array)
+      assert_equal 1, result.length
+      assert_equal "", result.first.to_s
+      assert_equal({'attr1' => '1', 'attr2' => '2'}, result.first.attributes)
+      assert_equal(result.first.children, result.first.elements)
+      assert_equal(%w[item], result.first.children.keys)
+      assert_equal(4, result.first.elements.values.first.length)
+      assert_equal '1', result.first['attr1']
+      assert_equal '2', result.first['attr2']
+      assert_equal nil, result.first['attr3']
+
+      assert       result.map(&:item).all? { |items| items.is_a? Array }
+      assert       result.map(&:item).map(&:first).all? { |i| i.tag == 'item' }
+      assert       result.first.item.first.volume.all? { |i| i.cdata? }
+      assert       result.first.item.first.volume.all? { |i| i.content == i.to_s }
+      assert       result.first.item.last.volume.all? { |i| i.cdata? == false }
+
+      container = result.first
+      assert container.compact!.equal?(container) # Object identity
+      assert container.item.is_a?(Array)
+
+      result = OXM.from_xml(str, 'container/item')
+      assert_equal 4, result.length
+
+      item = result.last
+      item.compact!
+      assert item.volume.is_a?(OXM::Object)
+      assert_equal '500', item.volume.to_s
+      assert_equal 'L', item.volume['unit']
+
+      result = OXM.from_xml(str, 'container/item/volume')
+      assert_equal 8, result.length
+      assert_equal %w[100 200 200 300 300 400 500] + [""], result.map(&:to_s)
+      assert_equal %w[ml ml l l l ml L] + [nil], result.map { |e| e['unit'] }
+      assert_equal result.map { |e| e['unit'] }, result.map { |e| e[:unit] }
+      assert_equal '<volume unit="ml"><![CDATA[100]]></volume>', result.first.to_xml
+
+      vol = result[-3]
+      assert_equal '<volume unit="ml">400</volume>', vol.to_xml
+      vol['unit'] = 'L'
+      assert_equal '<volume unit="L">400</volume>', vol.to_xml
+      vol.content = 500
+      assert_equal '<volume unit="L">500</volume>', vol.to_xml
+      vol.content = 550
+      assert_equal '<volume unit="L">550</volume>', vol.to_xml
+      vol.cdata = 600
+      assert_equal '<volume unit="L"><![CDATA[600]]></volume>', vol.to_xml
+      vol.cdata = 660
+      assert_equal '<volume unit="L"><![CDATA[660]]></volume>', vol.to_xml
+
+      long_str = "_" * 1000000
+      vol.content = long_str
+      assert_equal '<volume unit="L">' + long_str + '</volume>', vol.to_xml
+
+      vol.cdata = long_str
+      assert_equal '<volume unit="L"><![CDATA[' + long_str + ']]></volume>', vol.to_xml
+
+      vol.cdata = ""
+      assert_equal '<volume unit="L"><![CDATA[]]></volume>', vol.to_xml
+
+      # invalid stripping might occur
+      long_str = "_" + ' ' * 1000000 + '_'
+      vol.content = long_str
+      assert_equal '<volume unit="L">' + long_str + '</volume>', vol.to_xml
+
+      vol.content = nil
+      assert_equal '<volume unit="L"></volume>', vol.to_xml
+
+      cnt = 0
+      result = OXM.from_xml(str, 'container/item/volume') do |obj|
+        assert_equal 'volume', obj.tag
+        assert obj.is_a?(OXM::Object)
+        cnt += 1
+      end
+      assert_equal 8, cnt
+      assert_nil result
+    end
+  end
+
+  def test_compaction
+    str = <<-EOF
+    <container attr1="1" attr2="2">
+      <item dept="array">
+        <volume unit="ml"><![CDATA[ 100 ]]></volume>
+        <volume unit="ml"><![CDATA[200]]></volume>
+      </item>
+
+      <item dept="single">
+        <volume unit="l">200</volume>
+      </item>
+
+      <item dept="single">
+        <volume unit="ML"></volume>
+      </item>
+
+      <item dept="single">
+        <volume unit="l">200</volume>
+        <volume></volume>
+      </item>
+
+      <item dept="nil">
+        <volume></volume>
+        <volume></volume>
+      </item>
+    </container>
+    EOF
+
+    items = OXM.from_xml(str, 'container/item')
+    assert_equal 5, items.length
+
+    items[0].compact!
+    assert_equal Array, items[0].volume.class
+
+    items[1].compact!
+    assert_equal OXM::Object, items[1].volume.class
+
+    items[2].compact!
+    assert_equal OXM::Object, items[2].volume.class
+    assert_equal nil, items[2].volume.content
+    assert_equal 'ML', items[2].volume['unit']
+
+    items[3].compact!
+    assert_equal OXM::Object, items[3].volume.class
+    assert_equal '<item dept="single"><volume unit="l">200</volume></item>', items[3].inspect
+    assert_equal "200", items[3].volume.content
+
+    items[4].compact!
+    assert_equal nil, items[4].volume
+
+    assert_raise(NoMethodError) {
+      items[4].voll
+    }
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: oxm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &2160763840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160763840
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2160755540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160755540
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2160753840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160753840
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2160752880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2160752880
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2160752000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160752000
+description: A tiny Object-XML-Mapper using Nokogiri SAX parser
+email: junegunn.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- CHANGELOG.markdown
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/oxm.rb
+- lib/oxm/object.rb
+- lib/oxm/sax_handler.rb
+- test/helper.rb
+- test/test_oxm.rb
+homepage: http://github.com/junegunn/oxm
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1267901525051297766
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A tiny Object-XML-Mapper
+test_files: []