xml_mapper 0.3.2

data/.document

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-d

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree@xml_mapper

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'nokogiri'
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'autotest'
+  gem 'autotest-growl'
+  gem "rspec", "~> 2.1.0"
+  gem 'ruby-debug'
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    autotest (4.4.5)
+    autotest-growl (0.2.6)
+    builder (2.1.2)
+    columnize (0.3.1)
+    cucumber (0.9.2)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.5)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    linecache (0.43)
+    nokogiri (1.4.3.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  autotest-growl
+  bundler (~> 1.0.0)
+  cucumber
+  jeweler (~> 1.5.1)
+  nokogiri
+  rcov
+  rspec (~> 2.1.0)
+  ruby-debug

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Tobias Schwab
+
+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.rdoc

@@ -0,0 +1,118 @@
+= xml_mapper
+
+Declarative mapping of XML files to ruby attributes
+
+== Example XML
+
+  <album>
+    <title>Black on Both Sides</title>
+    <version_title>Extended Edition</version_title>
+    <released_in>1999</released_in>
+    <released_on>1999-10-12</released_on>
+    <country>de</country>
+    <allows_streaming>true</allows_streaming>
+    <artist>
+      <name>Mos Def</name>
+      <id>1212</id>
+    </artist>
+    <tracks>
+      <track>
+        <title>Fear Not of Man</title>
+        <number>1</number>
+        <disk>1</number>
+        <explicit_lyrics />
+      </track>
+      <track>
+        <title>Hip Hop</title>
+        <number>2</number>
+        <disk>1</number>
+      </track>
+    </tracks>
+  </album>
+
+== Example Mapper
+
+  require "xml_mapper"
+  require "date"
+
+  class MyMapper < XmlMapper
+    text :title, :version_title                         # 1:1 - maps xpaths title and version_title to attribute keys
+    integer :released_in                                # converts value to an integer
+    text :country, :after_map => :upcase                # calls after_map method on extracted value if value responds to the method
+    text :released_on, :after_map => :parse_date        # calls after_map method defined in Mapper class when value does not respond
+    boolean :allows_streaming                           # maps Y, y, yes, true => true, N, n, no, false => false
+  
+    within :artist do
+      text :name => :artist_name                        # adds mapping for xpath "artist/name" to :artist_name attribute
+      integer :id => :artist_id
+    end
+  
+    many "tracks/track" => :tracks do                   # maps xpath "tracks/track" to array with key :tracks
+      text :title => :track_title
+      integer :number => :track_number
+      integer :disk => :disk_number
+      exists :explicit_lyrics                           # checks if a node with the xpath exists
+    end
+  
+    after_map do                                        # is called after attributes are extracted, self references the extracted attributes
+      self[:tracks_count] = self[:tracks].length
+    end
+  
+    # to be used for after_map callbacks
+    def parse_date(date_string)
+      Date.parse(date_string)
+    end
+  end
+
+
+== How to call
+
+* MyMapper.attributes_from_xml(xml)
+* MyMapper.attributes_from_xml_path(xml) (also sets :xml_path)
+
+== Output
+
+  { :title=>"Black on Both Sides", :allows_streaming=>true, :version_title=>"Extended Edition", :tracks_count=>2, 
+    :xml_path=>"/Users/tobias/Projects/xml_mapper/spec/fixtures/base.xml", 
+    :tracks=>[
+      {:disk_number=>1, :explicit_lyrics=>true, :track_title=>"Fear Not of Man", :track_number=>1}, 
+      {:disk_number=>1, :explicit_lyrics=>true, :track_title=>"Hip Hop", :track_number=>2}
+    ], 
+    :released_in=>1999, :released_on=>#<Date: 4902927/2,0,2299161>, :artist_name=>"Mos Def", :artist_id=>1212, :country=>"DE"
+  }
+
+== Contributing to xml_mapper
+ 
+* 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) 2010 Tobias Schwab (Dynport GmbH).
+
+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,53 @@
+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 = "xml_mapper"
+  gem.homepage = "http://github.com/tobstarr/xml_mapper"
+  gem.license = "MIT"
+  gem.summary = %Q{Declarative and clever XML to Ruby Mapping}
+  gem.description = %Q{Just check out the examples}
+  gem.email = "tobias.schwab@dynport.de"
+  gem.authors = ["Tobias Schwab"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xml_mapper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.2

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/features/support/env.rb

@@ -0,0 +1,13 @@
+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
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'xml_mapper'
+
+require 'rspec/expectations'

data/features/xml_mapper.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/xml_mapper.rb

@@ -0,0 +1,175 @@
+require "nokogiri"
+
+class XmlMapper
+  attr_accessor :mappings, :after_map_block, :within_xpath
+  
+  class << self
+    attr_accessor :mapper
+    
+    def text(*args)
+      mapper.add_mapping(:text, *args)
+    end
+    
+    def integer(*args)
+      mapper.add_mapping(:integer, *args)
+    end
+    
+    def boolean(*args)
+      mapper.add_mapping(:boolean, *args)
+    end
+    
+    def exists(*args)
+      mapper.add_mapping(:exists, *args)
+    end
+    
+    def node(*args)
+      mapper.add_mapping(:node, *args)
+    end
+    
+    def within(xpath, &block)
+      self.mapper.within_xpath ||= []
+      self.mapper.within_xpath << xpath
+      self.instance_eval(&block)
+      self.mapper.within_xpath.pop
+    end
+    
+    def after_map(&block)
+      mapper.after_map(&block)
+    end
+    
+    def many(*args, &block)
+      sub_mapper = block_given? ? capture_submapping(&block) : nil
+      add_mapper_to_args(args, sub_mapper)
+      mapper.add_mapping(:many, *args)
+    end
+    
+    def attributes_from_xml(xml)
+      attributes_from_superclass(xml, :attributes_from_xml).merge(mapper.attributes_from_xml(xml))
+    end
+    
+    def attributes_from_superclass(xml, method = :attributes_from_xml)
+      if self.superclass && self.superclass.respond_to?(:mapper)
+        attributes = self.superclass.mapper.send(method, xml)
+        attributes.delete(:xml_path)
+        attributes
+      else
+        {}
+      end
+    end
+    
+    def attributes_from_xml_path(path)
+      attributes_from_superclass(path, :attributes_from_xml_path).merge(mapper.attributes_from_xml_path(path))
+    end
+    
+    def capture_submapping(&block)
+      saved_mapper = self.mapper
+      self.mapper = XmlMapper.new
+      self.instance_eval(&block)
+      captured_mapper = self.mapper
+      self.mapper = saved_mapper
+      captured_mapper
+    end
+    
+    def add_mapper_to_args(args, mapper)
+      if args.length > 1 && args.last.is_a?(Hash)
+        args.last[:mapper] = mapper
+      else
+        args << { :mapper => mapper }
+      end
+    end
+    
+    def mapper
+      @mapper ||= self.new
+    end
+  end
+  
+  def initialize
+    self.mappings = []
+  end
+  
+  def extract_options_from_args(args)
+    args.length > 1 && args.last.is_a?(Hash) ? args.pop : {}
+  end
+  
+  def add_mapping(type, *args)
+    options = extract_options_from_args(args)
+    if args.first.is_a?(Hash)
+      args.first.map { |xpath, key|  add_single_mapping(type, xpath, key, options) }
+    else
+      args.map { |arg| add_single_mapping(type, arg, arg, options) }
+    end
+  end
+  
+  def after_map(&block)
+    self.after_map_block = block
+  end
+  
+  def add_single_mapping(type, xpath, key, options = {})
+    self.mappings << { :type => type, :xpath => add_with_to_xpath(xpath), :key => key, :options => options }
+  end
+  
+  def add_with_to_xpath(xpath)
+    [self.within_xpath, xpath].flatten.compact.join("/")
+  end
+  
+  def attributes_from_xml_path(path)
+    attributes_from_xml(File.read(path), path)
+  end
+  
+  TYPE_TO_AFTER_CODE = {
+    :integer => :to_i,
+    :boolean => :string_to_boolean
+  }
+  
+  def attributes_from_xml(xml_or_doc, xml_path = nil)
+    if xml_or_doc.is_a?(Array)
+      xml_or_doc.map { |doc| attributes_from_xml(doc) } 
+    else
+      doc = xml_or_doc.is_a?(Nokogiri::XML::Node) ? xml_or_doc : Nokogiri::XML(xml_or_doc)
+      atts = self.mappings.inject(xml_path.nil? ? {} : { :xml_path => xml_path }) do |hash, mapping|
+        hash.merge(mapping[:key] => value_from_doc_and_mapping(doc, mapping))
+      end
+      atts.instance_eval(&self.after_map_block) if self.after_map_block
+      atts
+    end
+  end
+  
+  def value_from_doc_and_mapping(doc, mapping)
+    if mapping[:type] == :many
+      mapping[:options][:mapper].attributes_from_xml(doc.search(mapping[:xpath]).to_a)
+    elsif mapping[:type] == :exists
+      !doc.at("//#{mapping[:xpath]}").nil?
+    else
+      value = mapping[:type] == :node ? doc.at(mapping[:xpath]) : inner_text_for_xpath(doc, mapping[:xpath])
+      apply_after_map_to_value(value, mapping)
+    end
+  end
+  
+  def apply_after_map_to_value(value, mapping)
+    after_map = TYPE_TO_AFTER_CODE[mapping[:type]]
+    after_map ||= mapping[:options][:after_map]
+    if value && after_map
+      value = value.send(after_map)  if value.respond_to?(after_map)
+      value = self.send(after_map, value) if self.respond_to?(after_map)
+    end
+    value
+  end
+  
+  def inner_text_for_xpath(doc, xpath)
+    if node = doc.at(xpath)
+      node.inner_text
+    end
+  end
+  
+  MAPPINGS = {
+    "true" => true,
+    "false" => false,
+    "yes" => true,
+    "y" => true,
+    "n" => false
+  }
+  
+  def string_to_boolean(value)
+    MAPPINGS[value.to_s.downcase]
+  end
+end

data/spec/example_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require File.expand_path(File.dirname(__FILE__) + "/my_mapper")
+
+describe "ExampleSpec" do
+  describe "mapping spec/fixtures/base.xml" do
+    before(:all) do
+      @attributes = MyMapper.attributes_from_xml_path(File.expand_path(File.dirname(__FILE__) + '/fixtures/base.xml'))
+    end
+    
+    { 
+      :title => "Black on Both Sides", :version_title => "Extended Edition", :released_in => 1999,
+      :artist_name => "Mos Def", :artist_id => 1212, :country => "DE", :allows_streaming => true,
+      :tracks_count => 2, :released_on => Date.new(1999, 10, 12)
+    }.each do |key, value|
+      it "extracts #{value.inspect} as #{key}" do
+        @attributes[key].should == value
+      end
+    end
+    
+    [
+      { :track_title => "Fear Not of Man", :track_number => 1, :disk_number => 1, :explicit_lyrics => true },
+      { :track_title => "Hip Hop", :track_number => 2, :disk_number => 1, :explicit_lyrics => true },
+    ].each_with_index do |hash, offset|
+      hash.each do |key, value|
+        it "extracts #{value.inspect} for #{key} for track with offset #{offset}" do
+          @attributes[:tracks][offset][key].should == value
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/base.xml

@@ -0,0 +1,25 @@
+<album>
+  <title>Black on Both Sides</title>
+  <version_title>Extended Edition</version_title>
+  <released_in>1999</released_in>
+  <released_on>1999-10-12</released_on>
+  <country>de</country>
+  <allows_streaming>true</allows_streaming>
+  <artist>
+    <name>Mos Def</name>
+    <id>1212</id>
+  </artist>
+  <tracks>
+    <track>
+      <title>Fear Not of Man</title>
+      <number>1</number>
+      <disk>1</number>
+      <explicit_lyrics />
+    </track>
+    <track>
+      <title>Hip Hop</title>
+      <number>2</number>
+      <disk>1</number>
+    </track>
+  </tracks>
+</album>

data/spec/my_mapper.rb

@@ -0,0 +1,31 @@
+require "xml_mapper"
+require "date"
+
+class MyMapper < XmlMapper
+  text :title, :version_title                         # 1:1 - maps xpaths title and version_title to attribute keys
+  integer :released_in                                # converts value to an integer
+  text :country, :after_map => :upcase                # calls after_map method on extracted value if value responds to the method
+  text :released_on, :after_map => :parse_date        # calls after_map method defined in Mapper class when value does not respond
+  boolean :allows_streaming                           # maps Y, y, yes, true => true, N, n, no, false => false
+  
+  within :artist do
+    text :name => :artist_name                        # adds mapping for xpath "artist/name"
+    integer :id => :artist_id
+  end
+  
+  many "tracks/track" => :tracks do                   # maps xpath "tracks/track" to array with key :tracks
+    text :title => :track_title
+    integer :number => :track_number
+    integer :disk => :disk_number
+    exists :explicit_lyrics                           # checks if a node with the xpath exists
+  end
+  
+  after_map do                                        # is called after attributes are extracted, self references the extracted attributes
+    self[:tracks_count] = self[:tracks].length
+  end
+  
+  # to be used for after_map callbacks
+  def parse_date(date_string)
+    Date.parse(date_string)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'xml_mapper'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+if defined?(Debugger) && Debugger.respond_to?(:settings)
+  Debugger.settings[:autolist] = 1
+  Debugger.settings[:autoeval] = true
+end