reagent-graft 0.1.0

data/README.rdoc

@@ -0,0 +1,44 @@
+= Graft
+
+== Description
+
+Graft provides an easy way to map XML data onto your Ruby classes.
+
+== Installation
+
+Stable:
+
+    $ sudo gem install graft
+    
+Bleeding edge:
+
+    $ sudo gem install reagent-graft --source=http://gems.github.com
+
+== Usage
+
+TBD
+
+== License
+
+Copyright (c) 2009 Patrick Reagan (reaganpr@gmail.com)
+
+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,40 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/graft/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'graft'
+  s.version          = Graft::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "Simple XML to attribute mapping for your Ruby classes"
+  s.author           = 'Patrick Reagan'
+  s.email            = 'reaganpr@gmail.com'
+  s.homepage         = 'http://sneaq.net/'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  
+  s.add_dependency('hpricot', '~> 0.6.0')
+  s.add_dependency('activesupport', '~> 2.0')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/graft/attribute.rb

@@ -0,0 +1,44 @@
+module Graft
+  class Attribute
+
+    # TODO: Refactor the location / attribute logic into a Source class
+
+    attr_reader :name, :sources
+
+    def initialize(name, sources = nil)
+      @name = name.to_sym
+
+      @sources = Array(sources)
+      @sources << @name.to_s if @sources.empty?
+    end
+
+    def split(source)
+      location, attribute = source.split('@')
+      location = self.name.to_s if location.blank?
+
+      [location, attribute]
+    end
+
+    def node_for(document, source)
+      document.at(location(source)) || document.search("//[@#{attribute(source)}]").first
+    end
+
+    def attribute(source)
+      location, attribute = source.split('@')
+      attribute || location
+    end
+
+    def location(source)
+      split(source).first
+    end
+
+    def value_from(document)
+      values = sources.map do |source|
+        node = node_for(document, source)
+        (node.attributes[attribute(source)] || node.inner_text) unless node.nil?
+      end
+      values.compact.first
+    end
+
+  end
+end

data/lib/graft/model.rb

@@ -0,0 +1,47 @@
+module Graft
+  module Model
+    
+    module ClassMethods
+      
+      def attributes
+        @attributes ||= []
+      end
+      
+      def attribute(name, options = {})
+        self.attributes << Attribute.new(name, options[:from])
+        class_eval "attr_accessor :#{name}"
+      end
+      
+    end
+    
+    module InstanceMethods
+      
+      def initialize(document = nil)
+        self.document = document
+        self.populate_from(self.document) unless self.document.nil?
+      end
+      
+      def document=(document)
+        @document = document.is_a?(String) ? Hpricot.XML(document) : document
+      end
+      
+      def document
+        @document
+      end
+      
+      def populate_from(document)
+        self.class.attributes.each do |attribute|
+          value = attribute.value_from(document)
+          self.send("#{attribute.name}=".to_sym, value) unless value.nil?
+        end
+      end
+      
+    end
+    
+    def self.included(other)
+      other.send(:extend, Graft::Model::ClassMethods)
+      other.send(:include, Graft::Model::InstanceMethods)
+    end
+    
+  end
+end

data/lib/graft/version.rb

@@ -0,0 +1,13 @@
+module Graft
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/lib/graft.rb

@@ -0,0 +1,7 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'hpricot'
+require 'active_support/core_ext/blank'
+
+require 'graft/attribute'
+require 'graft/model'

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'throat_punch'
+
+require File.dirname(__FILE__) + '/../lib/graft'

data/test/unit/attribute_test.rb

@@ -0,0 +1,133 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Graft
+  class AttributeTest < Test::Unit::TestCase
+    describe "An instance of the Attribute class" do
+
+      it "should know the name of the attribute" do
+        attr = Attribute.new('foo')
+        attr.name.should == :foo
+      end
+
+      it "should have a default source" do
+        attr = Attribute.new(:foo)
+        attr.sources.should == ['foo']
+      end
+      
+      it "should be able to assign multiple sources" do
+        attr = Attribute.new(:foo, ['foo1', 'foo2'])
+        attr.sources.should == ['foo1', 'foo2']
+      end
+
+      it "should pull the location from the source" do
+        attr = Attribute.new('foo')
+        attr.location('foo').should == 'foo'
+      end
+      
+      it "should return the location when splitting" do
+        attr = Attribute.new('foo')
+        attr.split('foo').should == ['foo', nil]
+      end
+      
+      it "should return the name for the location when splitting if the location isn't specified" do
+        attr = Attribute.new('foo')
+        attr.split('@bar').should == ['foo', 'bar']
+      end
+      
+      it "should allow the setting of the location information" do
+        attr = Attribute.new('foo', 'bar')
+        attr.sources.should == ['bar']
+      end
+      
+      it "should allow the setting of the attribute value" do
+        attr = Attribute.new('foo')
+        attr.attribute('@bogon').should == 'bogon'
+      end
+      
+      it "should use the location as the attribute" do
+        attr = Attribute.new('foo')
+        attr.attribute('foo').should == 'foo'
+      end
+      
+      it "should use the attribute for the attribute if specified" do
+        attr = Attribute.new(:id, '@nsid')
+        attr.attribute('@nsid').should == 'nsid'
+      end
+
+      it "should be able to retrieve the node from the path" do
+        document = Hpricot.XML('<name>Bassdrive</name>')
+        expected = document.at('name')
+        
+        attr = Attribute.new(:name)
+        attr.node_for(document, 'name').should == expected
+      end
+      
+      it "should be able to retrieve the node that contains the specified attribute" do
+        document = Hpricot.XML('<user id="1337" />')
+        expected = document.at('user')
+        
+        attr = Attribute.new(:id)
+        attr.node_for(document, '@id').should == expected
+      end
+
+      it "should be able to retrieve the node for the specified attribute" do
+        document = Hpricot.XML('<user nsid="1337" />')
+        expected = document.at('user')
+        
+        attr = Attribute.new(:id, '@nsid')
+        attr.node_for(document, '@nsid').should == expected
+      end
+      
+      it "should be able to pull simple values from an XML document" do
+        document = Hpricot.XML('<name>Bassdrive</name>')
+        attr = Attribute.new(:name)
+        attr.value_from(document).should == 'Bassdrive'
+      end
+
+      it "should be able to pull an attribute value from the current XML node" do
+        document = Hpricot.XML('<user id="1337" />')
+        attr = Attribute.new(:id)
+        attr.value_from(document).should == '1337'
+      end
+        
+      it "should be able to pull a specific attribute value from the current XML node" do
+        document = Hpricot.XML('<user nsid="1337" />')
+        attr = Attribute.new(:id, '@nsid')
+        attr.value_from(document).should  == '1337'
+      end
+
+      it "should be able to pull an attribute value for a node and attribute" do
+        document = Hpricot.XML('<station><genre slug="dnb">Drum & Bass</genre></station>')
+        attr = Attribute.new(:slug, 'station/genre@slug')
+        attr.value_from(document).should == 'dnb'
+      end
+        
+      it "should be able to pull a value from a nested XML node" do
+        document = Hpricot.XML('<rsp><user>blip</user></rsp>')
+        attr = Attribute.new(:user)
+        attr.value_from(document).should == 'blip'
+      end
+      
+      # it "should be able to pull a value from an attribute once it's found a node by another attribute" do
+      #   document = Hpricot.XML('<node type="blip" value="bleep" />')
+      #   attr = Attribute.new(:blip, "node[@type='blip]@value")
+      #   
+      #   attr.value_from(document).should == 'bleep'
+      # end
+
+      it "should return nil if it cannot find the specified node" do
+        document = Hpricot.XML('<user id="1" />')
+        attr = Attribute.new(:photoset, '@nsid')
+        attr.value_from(document).should be(nil)
+      end
+
+      it "should be able to try a series of nodes to find a value" do
+        document = Hpricot.XML('<photoid>123</photoid>')
+
+        attr = Attribute.new(:id, ['photo@nsid', 'photoid'])
+        attr.value_from(document).should == '123'
+      end
+
+    end
+  end
+end

data/test/unit/model_test.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class EmptyModel
+  include Graft::Model
+end
+
+class ModelWithAttributes
+  include Graft::Model
+
+  attribute :name
+  attribute :description, :from => 'desc'
+  attribute :rating,      :from => 'rating@value'
+  attribute :size,        :from => "node[@type='size']@value"
+  
+end
+
+class ModelTest < Test::Unit::TestCase
+
+  describe "The EmptyModel class" do
+    it "should have an empty list of attributes if none are supplied" do
+      EmptyModel.attributes.should == []
+    end
+
+  end
+
+  describe "The ModelWithAttributes class" do
+    it "should know the names of all its attributes" do
+      ModelWithAttributes.attributes.map {|a| a.name.to_s }.should == %w(name description rating size)
+    end
+  end
+
+  describe "An instance of the ModelWithAttributes class" do
+
+    before { @simple_xml = '<name>Graft</name>' }
+
+    it "should have default reader method for :name" do
+      ModelWithAttributes.new.respond_to?(:name).should be(true)
+    end
+    
+    it "should be able to populate its data on initialization" do
+      xml = Hpricot.XML(@simple_xml)
+      ModelWithAttributes.new(xml).name.should == 'Graft'
+    end
+    
+    it "should have a reference to the original document" do
+      xml = Hpricot.XML(@simple_xml)
+      ModelWithAttributes.new(xml).document.should == xml
+    end
+    
+    it "should be able to populate from an XML string" do
+      ModelWithAttributes.new(@simple_xml).name.should == 'Graft'
+    end
+    
+    context "when populating data from an XML document" do
+      
+      before do
+        xml = <<-XML
+          <name>Graft</name>
+          <desc>A sweet Ruby library</desc>
+          <rating value="100" />
+          <node type="color" value="blue" />
+          <node type="size" value="large" />
+        XML
+
+        @model = ModelWithAttributes.new
+        @model.populate_from(Hpricot.XML(xml))
+      end
+
+      it "should have the correct value for :name" do
+        @model.name.should == 'Graft'
+      end
+      
+      it "should have the correct value for :description" do
+        @model.description.should == 'A sweet Ruby library'
+      end
+      
+      it "should have the correct value for :rating" do
+        @model.rating.should == '100'
+      end
+      
+      # it "should have the correct value for :size" do
+      #   @model.size.should == 'large'
+      # end
+      
+    end
+  end
+  
+end

data/test/unit/source_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+module Graft
+  class SourceTest < Test::Unit::TestCase
+    
+    describe "An instance of the Source class" do
+      
+      
+      
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: reagent-graft
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Patrick Reagan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+description: 
+email: reaganpr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/graft
+- lib/graft/attribute.rb
+- lib/graft/model.rb
+- lib/graft/version.rb
+- lib/graft.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/attribute_test.rb
+- test/unit/model_test.rb
+- test/unit/source_test.rb
+has_rdoc: true
+homepage: http://sneaq.net/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple XML to attribute mapping for your Ruby classes
+test_files: []
+