grumpymapper 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in grumpy_mapper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+Introduction to GrumpyMapper [![Build Status](https://secure.travis-ci.org/marcinwyszynski/grumpymapper.png?branch=master)](http://travis-ci.org/marcinwyszynski/grumpymapper)
+------------------------
+
+GrumpyMapper is a simple alternative to the excellent [HappyMapper](https://github.com/jnunemaker/happymapper/) gem. Unlike HappyMapper it only works one way - parsing XML into a Ruby object. It is also more difficult to use as it assumes some knowledge of XPath. I did create the gem for myself but as a reference for my future self and perhaps a lost visitor to this repository below is some documentation.
+
+Using GrumpyMapper
+------------------
+
+GrumpyMapper is a module which you include in your classes. Once included, it gives access to three class macros ("tag", "has_one" and "has_many") as well as one class method ("parse"). Here is how you'd use it:
+
+```ruby
+class Venue
+  include GrumpyMapper
+  tag "//venue"
+  has_one :name,         ".//name/text()",  String
+  has_one :latitude,     ".//lat/text()",   Float
+  has_one :longitude,    ".//long/text()",  Float
+end
+
+
+class Event
+  include GrumpyMapper
+  tag "//event"
+  has_one :name,        ".//title/text()",          String
+  has_one :cancelled,    ".//cancelled/text()",     Boolean
+  has_one :venue,       ".//venue",                 Venue
+  has_one :start_date,  ".//startDate/text()",      DateTime
+  has_many :artists,    ".//artists/artist/text()", String
+end
+
+events = Event::parse(some_xml_content) # ... events is an Array of Event objects
+````
+
+For a piece of XML this is supposed to parse, please see fixtures/lastfm.xml or the unit test for this library. In any case, the "tag" class macro defines what is the parent tag for your mapped object. Both attributes and children are then defined using XPath expressions in "has_one" and "has_many" class macros. Each of these macros takes at least three arguments - the attribute to map to the value to, the XPath expression (can be an attribute as well as an element) to search by and the expected class of the element found. A number of simple classes is supported - that is String, Integer, Float, Date and DateTime. A Boolean class is defined inside the GrumpyMapper as Ruby does not have one built-in. If you specify any other class, it should be one that responds to the "parse" class method - preferably one that also includes the GrumpyMapper module. One slight difference between "has_one" and "has_many" class macros is that the first allows you to specify a default value as the fourth argument. It will be used when the XPath expression finds no matches. Some expected classes like String, Integer and Float have a default default - "", 0 and 0.0 respectively. For others it is a Ruby native nil value. The "has_many" class macro always has an empty Array as it's default.
+
+Parting words
+-------------
+
+For more inspiration on how to use the library use the unit test, source code and make sure to have your favorite XPath tutorial close at hand. Enjoy!

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake"
+require "rake/testtask"
+
+task :default => [ :unittests ]
+
+Rake::TestTask.new("unittests") do |t|
+  t.pattern = "test/*_test.rb"
+  t.verbose = true
+end

data/grumpymapper.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "grumpymapper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "grumpymapper"
+  s.version     = GrumpyMapper::VERSION
+  s.authors     = ["Marcin Wyszynski"]
+  s.email       = ["marcin.pixie@gmail.com"]
+  s.homepage    = "http://github.com/marcinwyszynski/grumpymapper"
+  s.summary     = %q{More versatile, XPath-based one-way version of HappyMapper}
+  s.description = %q{More versatile, XPath-based one-way version of HappyMapper}
+
+  s.rubyforge_project = "grumpymapper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("nokogiri")
+  
+end

data/lib/grumpymapper/version.rb

@@ -0,0 +1,3 @@
+module GrumpyMapper
+  VERSION = "0.0.2"
+end

data/lib/grumpymapper.rb

@@ -0,0 +1,90 @@
+require "date"
+require "nokogiri"
+require "grumpymapper/version"
+  
+module GrumpyMapper
+  
+  class Boolean; end
+    
+  Property = Struct::new(:xpath, :klass, :multi, :default)
+    
+  def self.included(base)
+    base.instance_variable_set("@tag", nil)
+    base.instance_variable_set("@attributes", {})
+    base.extend ClassMethods
+  end
+    
+  module ClassMethods
+      
+    def tag(xpath)
+      @tag = xpath
+    end
+      
+    def has_one(name, xpath, klass, default=nil)
+      attr_accessor name
+      if default.nil?
+        default = if klass.eql?(String)
+          ""
+        elsif klass.eql?(Integer)
+          0
+        elsif klass.eql?(Float)
+          0.0
+        else
+          nil
+        end
+      end
+      @attributes[name] = Property::new(xpath, klass, false, default)
+    end
+      
+    def has_many(name, xpath, klass)
+      attr_accessor name
+      @attributes[name] = Property::new(xpath, klass, true, [])
+    end
+      
+    def parse(xml)
+      result = []
+      Nokogiri::XML(xml).xpath(@tag).each do |tag|
+        entity = new
+        @attributes.each do |key,property|
+          matches = tag.xpath(property.xpath)
+          if matches.size > 0
+            matches = if property.klass.eql?(Integer)
+              matches.map(&:text).map(&:to_i)
+            elsif property.klass.eql?(Float)
+              matches.map(&:text).map(&:to_f)
+            elsif property.klass.eql?(Boolean)
+              matches.map(&:text).map do |m|
+                %w(true t 1).include?(m) ? true : false
+              end
+            elsif property.klass.eql?(Date)
+              matches.map(&:text).map do |m|
+                Date::parse(m)
+              end
+            elsif property.klass.eql?(DateTime)
+              matches.map(&:text).map do |m|
+                DateTime::parse(m)
+              end          
+            elsif property.klass.eql?(String)
+              matches.map(&:text)
+            else
+              matches.map do |m|
+                property.klass.parse(m.to_s).first
+              end
+            end
+            if property.multi
+              entity.send(:"#{key}=", matches)
+            else
+              entity.send(:"#{key}=", matches.first)
+            end
+          else
+            entity.send(:"#{key}=", property.default)
+          end # if matches.size > 0
+        end # @attributes.each
+        result << entity
+      end # each tag
+      return result
+    end
+      
+  end
+    
+end

data/test/fixtures/lastfm.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="utf-8"?>
+<lfm status="ok">
+  <events artist="Radiohead" festivalsonly="0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" page="1" perPage="50" totalPages="1" total="24">
+    <event xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" >
+      <id>3109094</id>
+      <title>Fuji Rock Festival 2012</title>
+      <artists>
+        <artist>Radiohead</artist>
+        <artist>ケンイシイ</artist>
+        <headliner>Radiohead</headliner>
+      </artists>
+      <venue>
+        <id>8802452</id>
+        <name>Naeba Ski Resort</name>
+        <location>
+          <city>Yuzawa</city>
+          <country>Japan</country>
+          <street></street>
+          <postalcode></postalcode>
+          <geo:point>
+            <geo:lat>36.9333333</geo:lat>
+            <geo:long>138.8166667</geo:long>
+          </geo:point>
+        </location>
+        <url>http://www.last.fm/venue/8802452+Naeba+Ski+Resort</url>
+        <website></website>
+        <phonenumber></phonenumber>
+      </venue>
+      <startDate>Fri, 27 Jul 2012 18:28:01</startDate>
+      <endDate>Sun, 29 Jul 2012 18:28:01</endDate>
+      <description>A detailed description in Japanese.</description>
+      <image size="small">http://userserve-ak.last.fm/serve/34/76106242.jpg</image>
+      <image size="medium">http://userserve-ak.last.fm/serve/64/76106242.jpg</image>
+      <image size="large">http://userserve-ak.last.fm/serve/126/76106242.jpg</image>
+      <image size="extralarge">http://userserve-ak.last.fm/serve/252/76106242.jpg</image>
+      <attendance>557</attendance>
+      <reviews>0</reviews>
+      <tag>lastfm:event=3109094</tag>    
+      <url>http://www.last.fm/festival/3109094+Fuji+Rock+Festival+2012</url>
+      <website>http://www.fujirockfestival.com/</website>
+      <tickets> </tickets>
+      <cancelled>0</cancelled>
+    </event>
+    <event xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" >
+      <id>3191725</id>
+      <title>Jisan Valley Rock Festival</title>
+      <artists>
+        <artist>Radiohead</artist>
+        <artist>Owl City</artist>
+        <headliner>Radiohead</headliner>
+      </artists>
+      <venue>
+        <id>10240273</id>
+        <name>Jisan Valley Ski Resort</name>
+        <location>
+          <city>Icheon</city>
+          <country>Korea, Republic of</country>
+          <street></street>
+          <postalcode></postalcode>
+          <geo:point>
+            <geo:lat></geo:lat>
+            <geo:long></geo:long>
+          </geo:point>
+        </location>
+        <url>http://www.last.fm/venue/10240273+Jisan+Valley+Ski+Resort</url>
+        <website></website>
+        <phonenumber></phonenumber>
+        <image size="small"></image>
+      </venue>
+      <startDate>Fri, 27 Jul 2012 19:21:01</startDate>
+      <endDate>Sun, 29 Jul 2012 19:21:01</endDate>
+      <description>Something in Korean.</description>
+      <image size="small">http://userserve-ak.last.fm/serve/34/79922351.jpg</image>
+      <image size="medium">http://userserve-ak.last.fm/serve/64/79922351.jpg</image>
+      <image size="large">http://userserve-ak.last.fm/serve/126/79922351.jpg</image>
+      <image size="extralarge">http://userserve-ak.last.fm/serve/252/79922351.jpg</image>
+      <attendance>103</attendance>
+      <reviews>0</reviews>
+      <tag>lastfm:event=3191725</tag>    
+      <url>http://www.last.fm/festival/3191725+Jisan+Valley+Rock+Festival</url>
+      <website>http://valleyrockfestival.mnet.com/2012/index.asp</website>
+      <tickets></tickets>
+      <cancelled>1</cancelled>
+      <tags>
+        <tag>rock</tag>
+      </tags>
+    </event>
+  </events>
+</lfm>

data/test/lastfm_test.rb

@@ -0,0 +1,94 @@
+require "test/unit"
+require "grumpymapper"
+require "pry"
+
+
+class Venue
+  include GrumpyMapper
+  tag "//venue"
+  has_one :name,         ".//name/text()",  String
+  has_one :lastfm_id,    ".//id/text()",    Integer
+  has_one :latitude,     ".//lat/text()",   Float
+  has_one :longitude,    ".//long/text()",  Float
+  has_one :city,         ".//city/text()",  String
+end
+
+
+class Event
+  include GrumpyMapper
+  tag "//event"
+  has_one :name,        ".//title/text()",          String
+  has_one :lastfm_id,    ".//id/text()",            Integer
+  has_one :cancelled,    ".//cancelled/text()",     Boolean
+  has_one :description, ".//description/text()",    String
+  has_one :venue,       ".//venue",                 Venue
+  has_one :start_date,  ".//startDate/text()",      DateTime
+  has_many :artists,    ".//artists/artist/text()", String
+end
+
+
+class LastFMTest < Test::Unit::TestCase
+
+  def setup
+    @content = File::open(File::join(File::dirname(__FILE__),
+                            "fixtures", "lastfm.xml")).read()
+  end
+
+  def test_parsing_correctness
+    # Check for parsing correctness
+    events = nil
+    assert_nothing_raised do
+      events = Event::parse(@content)
+    end
+    assert_equal 2, events.size, "Should have parsed two events"
+  end
+
+  def test_boolean_parsing
+    events = Event::parse(@content)
+    assert !events.first.cancelled, "First event should not be cancelled"
+    assert events.last.cancelled, "Second event should be cancelled"
+  end
+
+  def test_integer_parsing
+    events = Event::parse(@content)
+    assert events.first.lastfm_id.is_a?(Integer), "LastFM ID is not an integer"
+    assert_equal 3109094, events.first.lastfm_id, "Wrong LastFM ID"
+  end
+
+  def test_datetime_parsing
+    events = Event::parse(@content)
+    assert events.first.start_date.is_a?(DateTime), "Start date not a DateTime object"
+    assert_equal 2012, events.first.start_date.year, "Wrong year parsed"
+    assert_equal 7, events.first.start_date.month, "Wrong month parsed"
+    assert_equal 27, events.first.start_date.day, "Wrong day parsed"
+    assert events.first.start_date < events.last.start_date
+  end
+
+  def test_single_string_parsing
+    events = Event::parse(@content)
+    assert events.first.name.is_a?(String), "Event name not a String"
+    assert_equal "Fuji Rock Festival 2012", events.first.name, "Wrong name parsed"
+  end
+
+  def test_multiple_string_parsing
+    events = Event::parse(@content)
+    assert events.first.artists.is_a?(Array), "Artist list not an Array"
+    assert events.first.artists.first.is_a?(String), "First artist name not a String"
+    assert_equal "Radiohead", events.first.artists.first, "Wrong name parsed"
+  end
+
+  def test_single_object_parsing
+    events = Event::parse(@content)
+    venue = events.first.venue
+    assert venue.is_a?(Venue), "Not a Venue object"
+    assert_equal "Naeba Ski Resort", venue.name, "Wrong Venue name"
+  end
+
+  def test_float_parsing
+    venue = Event::parse(@content).first.venue
+    assert venue.latitude.is_a?(Float), "Venue latitude not a Float"
+    assert venue.longitude.is_a?(Float), "Venue longitude not a Float"
+    assert_equal 36.9333333, venue.latitude, "Wrong latitude parsed"
+  end
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: grumpymapper
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Marcin Wyszynski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: More versatile, XPath-based one-way version of HappyMapper
+email: 
+- marcin.pixie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grumpymapper.gemspec
+- lib/grumpymapper.rb
+- lib/grumpymapper/version.rb
+- test/fixtures/lastfm.xml
+- test/lastfm_test.rb
+homepage: http://github.com/marcinwyszynski/grumpymapper
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: grumpymapper
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: More versatile, XPath-based one-way version of HappyMapper
+test_files: 
+- test/fixtures/lastfm.xml
+- test/lastfm_test.rb