representative 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Williams
+
+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,97 @@
+Representative
+==============
+
+"Representative" makes it easier to create XML representations of your Ruby objects.
+It works best when you want the XML to roughly follow the object structure, 
+but still have complete control of the result.
+
+Example
+-------
+
+Given a Ruby data-structure:
+
+    books = [
+      OpenStruct.new(
+        :title => "Sailing for old dogs", 
+        :authors => ["Jim Watson"],
+        :published => OpenStruct.new(
+          :by => "Credulous Print",
+          :year => 1994
+        )
+      ),
+      OpenStruct.new(
+        :title => "On the horizon", 
+        :authors => ["Zoe Primpton", "Stan Ford"],
+        :published => OpenStruct.new(
+          :by => "McGraw-Hill",
+          :year => 2005
+        )
+      ),
+      OpenStruct.new(
+        :title => "The Little Blue Book of VHS Programming",
+        :authors => ["Henry Nelson"],
+        :rating => "****"
+      )
+    ]
+
+Representative::Xml can be used to generate XML, in a declarative style:
+
+    xml = Builder::XmlMarkup.new(:indent => 2)
+    representative = Representative::Xml.new(xml)
+
+    representative.list_of!(:books, books) do |_book|
+      _book.title
+      _book.list_of!(:authors)
+      _book.published do |_published|
+        _published.by
+        _published.year
+      end
+    end
+
+    puts xml.target!
+
+The resulting XML looks like this:
+
+    <books type="array">
+      <book>
+        <title>Sailing for old dogs</title>
+        <authors type="array">
+          <author>Jim Watson</author>
+        </authors>
+        <published>
+          <by>Credulous Print</by>
+          <year>1994</year>
+        </published>
+      </book>
+      <book>
+        <title>On the horizon</title>
+        <authors type="array">
+          <author>Zoe Primpton</author>
+          <author>Stan Ford</author>
+        </authors>
+        <published>
+          <by>McGraw-Hill</by>
+          <year>2005</year>
+        </published>
+      </book>
+      <book>
+        <title>The Little Blue Book of VHS Programming</title>
+        <authors type="array">
+          <author>Henry Nelson</author>
+        </authors>
+        <published/>
+      </book>
+    </books>
+
+Notice that:
+
+- Representative generates elements for each object-attribute you name (and not the ones you don't).
+- The structure of the XML mirrors the structure described by the nested Ruby blocks.
+- Using **list_of!** for a collection attribute generates an "array" element, which plays nicely
+  with most Ruby XML-to-hash converters.
+- Where a named object-attribute is nil, you get an empty element.
+
+Copyright
+---------
+
+Copyright (c) 2009 Mike Williams. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require "rubygems"
+require "rake"
+require "rake/clean"
+
+task :default => :spec
+
+def with_gem(gem_name, lib = gem_name)
+  begin
+    require(lib)
+  rescue LoadError
+    $stderr.puts "WARNING: can't load #{lib}.  Install it with: sudo gem install #{gem_name}"
+    return false
+  end
+  yield
+end
+
+with_gem "jeweler" do
+  
+  Jeweler::Tasks.new do |gem|
+    gem.name = "representative"
+    gem.summary = "Builds XML representations of your Ruby objects"
+    gem.email = "mdub@dogbiscuit.org"
+    gem.homepage = "http://github.com/mdub/representative"
+    gem.authors = ["Mike Williams"]
+    gem.add_dependency("activesupport", ">= 2.2.2")
+  end
+  
+  Jeweler::GemcutterTasks.new
+
+end
+
+require "spec/rake/spectask"
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.rcov = true
+end
+
+# with_gem "yard" do
+# 
+#   YARD::Rake::YardocTask.new(:yardoc) do |t|
+#     t.files   = FileList['lib/**/*.rb']
+#   end
+#   CLEAN << "doc"
+# 
+# end

data/VERSION

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

data/examples/xml_demo.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "rubygems"
+require "representative/xml"
+require "ostruct"
+
+books = [
+  OpenStruct.new(
+    :title => "Sailing for old dogs", 
+    :authors => ["Jim Watson"],
+    :published => OpenStruct.new(
+      :by => "Credulous Print",
+      :year => 1994
+    )
+  ),
+  OpenStruct.new(
+    :title => "On the horizon", 
+    :authors => ["Zoe Primpton", "Stan Ford"],
+    :published => OpenStruct.new(
+      :by => "McGraw-Hill",
+      :year => 2005
+    )
+  ),
+  OpenStruct.new(
+    :title => "The Little Blue Book of VHS Programming",
+    :authors => ["Henry Nelson"],
+    :rating => "****"
+  )
+]
+
+xml = Builder::XmlMarkup.new(:indent => 2)
+representative = Representative::Xml.new(xml)
+
+representative.list_of!(:books, books) do |_book|
+  _book.title
+  _book.list_of!(:authors)
+  _book.published do |_published|
+    _published.by
+    _published.year
+  end
+end
+
+puts xml.target!

data/init.rb

@@ -0,0 +1 @@
+require "representative"

data/lib/representative/xml.rb

@@ -0,0 +1,99 @@
+require "builder"
+require "active_support"
+
+module Representative
+
+  class Xml < BlankSlate
+
+    def initialize(xml_builder, subject = nil)
+      @xml = xml_builder
+      @subject = subject
+      yield self if block_given?
+    end
+
+    def method_missing(name, *args, &block)
+      if name.to_s =~ /!$/
+        super
+      else
+        property!(name, *args, &block)
+      end
+    end
+
+    def subject!
+      @subject
+    end
+    
+    def property!(property_name, *args, &block)
+
+      attributes = args.extract_options!
+      value_generator = args.empty? ? property_name : args.shift
+      raise ArgumentError, "too many arguments" unless args.empty?
+
+      element_name = property_name.to_s.dasherize
+
+      value = resolve(value_generator)
+      resolved_attributes = resolve_attributes(attributes, value)
+
+      element!(element_name, value, resolved_attributes, &block)
+
+    end
+
+    def element!(element_name, value, options, &block)
+      text = content_generator = nil
+      if block && value
+        content_generator = Proc.new do
+          block.call(Representative::Xml.new(@xml, value))
+        end
+      else
+        text = value
+      end
+      tag_args = [text, options].compact
+      @xml.tag!(element_name, *tag_args, &content_generator)
+    end
+
+    def list_of!(property_name, *args, &block)
+
+      options = args.extract_options!
+      value_generator = args.empty? ? property_name : args.shift
+      raise ArgumentError, "too many arguments" unless args.empty?
+
+      list_name = property_name.to_s.dasherize
+      list_attributes = options[:list_attributes] || {}
+      item_name = options[:item_name] || list_name.singularize
+      item_attributes = options[:item_attributes] || {}
+
+      items = resolve(value_generator)
+      resolved_list_attributes = resolve_attributes(list_attributes, items)
+
+      @xml.tag!(list_name, resolved_list_attributes.merge(:type => "array")) do
+        items.each do |item|
+          resolved_item_attributes = resolve_attributes(item_attributes, item)
+          element!(item_name, item, resolved_item_attributes, &block)
+        end
+      end
+
+    end
+
+    private 
+
+    def resolve(value_generator, subject = @subject)
+      if value_generator.respond_to?(:to_proc)
+        value_generator.to_proc.call(subject) if subject
+      else
+        value_generator
+      end
+    end
+
+    def resolve_attributes(attributes, subject)
+      if attributes
+        attributes.inject({}) do |resolved, (k,v)|
+          resolved_value = resolve(v, subject)
+          resolved[k.to_s.dasherize] = resolved_value unless resolved_value.nil?
+          resolved
+        end
+      end
+    end
+
+  end
+
+end

data/lib/representative.rb

@@ -0,0 +1 @@
+require "representative/xml"

data/representative.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{representative}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Williams"]
+  s.date = %q{2009-10-14}
+  s.email = %q{mdub@dogbiscuit.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "examples/xml_demo.rb",
+     "init.rb",
+     "lib/representative.rb",
+     "lib/representative/xml.rb",
+     "representative.gemspec",
+     "spec/representative/xml_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mdub/representative}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Builds XML representations of your Ruby objects}
+  s.test_files = [
+    "spec/representative/xml_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/xml_demo.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.2.2"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.2.2"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.2.2"])
+  end
+end

data/spec/representative/xml_spec.rb

@@ -0,0 +1,210 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require "representative/xml"
+
+require "rexml/document"
+
+describe Representative::Xml do
+
+  before do
+    @xml = Builder::XmlMarkup.new
+  end
+
+  def represent
+    @xml_representative
+  end
+
+  def resulting_xml
+    @xml.target!
+  end
+
+  describe "for some 'subject'" do
+
+    before do
+      @subject = OpenStruct.new(:name => "Fred", :width => 200)
+      @xml_representative = Representative::Xml.new(@xml, @subject)
+    end
+
+    describe "calling a method" do
+
+      it "generates an element with content extracted from the subject" do
+        represent.name
+        resulting_xml.should == %(<name>Fred</name>)
+      end
+
+      it "dasherizes the method name" do
+        @subject.full_name = "Fredrick"
+        represent.full_name
+        resulting_xml.should == %(<full-name>Fredrick</full-name>)
+      end
+
+      describe "with an attribute" do
+
+        it "generates attributes on the element" do
+          represent.name(:lang => "fr")
+          resulting_xml.should == %(<name lang="fr">Fred</name>)
+        end
+
+        it "dasherizes the attribute name" do
+          represent.name(:sourced_from => "phonebook")
+          resulting_xml.should == %(<name sourced-from="phonebook">Fred</name>)
+        end
+
+        describe "whose value supports #to_proc" do
+
+          it "calls the Proc on the subject to generate a value" do
+            represent.name(:rev => :reverse)
+            resulting_xml.should == %(<name rev="derF">Fred</name>)
+          end
+
+        end
+
+        describe "with value nil" do
+
+          it "omits the attribute" do
+            represent.name(:lang => nil)
+            resulting_xml.should == %(<name>Fred</name>)
+          end
+
+        end
+
+      end
+
+      describe "with a non-Hash argument" do
+
+        it "generates an element with explicitly provided content" do
+          represent.name("Bloggs")
+          resulting_xml.should == %(<name>Bloggs</name>)
+        end
+
+        describe "AND a Hash argument" do
+
+          it "generates attributes on the element" do
+            represent.name("Bloggs", :lang => "fr")
+            resulting_xml.should == %(<name lang="fr">Bloggs</name>)
+          end
+
+        end
+
+      end
+
+      describe "with an argument that supports #to_proc" do
+
+        it "calls the Proc on the subject to generate a value" do
+          represent.name(:width)
+          resulting_xml.should == %(<name>200</name>)
+        end
+
+      end
+
+      describe "with a nil argument" do
+
+        it "builds an empty element" do
+          represent.name(nil)
+          resulting_xml.should == %(<name/>)
+        end
+
+        describe "and a Hash entry value that supports #to_proc" do
+
+          it "omits the attribute" do
+            represent.name(nil, :size => :size)
+            resulting_xml.should == %(<name/>)
+          end
+
+        end
+
+        describe "and a block" do
+
+          it "doesn't call the block" do
+            represent.name(nil) do |name|
+              name.foo
+            end
+            resulting_xml.should == %(<name/>)
+          end
+
+        end
+
+      end
+
+      describe "with a block" do
+
+        it "generates nested elements" do
+          @subject.vehicle = OpenStruct.new(:year => "1959", :make => "Chevrolet")
+          represent.vehicle do |vehicle|
+            vehicle.year
+            vehicle.make
+          end
+          resulting_xml.should == %(<vehicle><year>1959</year><make>Chevrolet</make></vehicle>)
+        end
+
+      end
+
+    end
+
+    describe "#list_of!" do
+
+      before do
+        @subject.nick_names = ["Freddie", "Knucklenose"]
+      end
+
+      it "generates an array element" do
+        represent.list_of!(:nick_names)
+        resulting_xml.should == %(<nick-names type="array"><nick-name>Freddie</nick-name><nick-name>Knucklenose</nick-name></nick-names>)
+      end
+
+      describe "with :list_attributes" do
+        
+        it "attaches attributes to the array element" do
+          represent.list_of!(:nick_names, :list_attributes => {:color => "blue", :size => :size})
+          array_element_attributes = REXML::Document.new(resulting_xml).root.attributes
+          array_element_attributes["type"].should == "array"
+          array_element_attributes["color"].should == "blue"
+          array_element_attributes["size"].should == "2"
+          array_element_attributes.size.should == 3
+        end
+        
+      end
+
+      describe "with :item_attributes" do
+
+        it "attaches attributes to each item element" do
+          represent.list_of!(:nick_names, :item_attributes => {:length => :size})
+          resulting_xml.should == %(<nick-names type="array"><nick-name length="7">Freddie</nick-name><nick-name length="11">Knucklenose</nick-name></nick-names>)
+        end
+        
+      end
+
+      describe "with an explicit :item_name" do
+        it "uses the name provided" do
+          represent.list_of!(:nick_names, :item_name => :nick)
+          resulting_xml.should == %(<nick-names type="array"><nick>Freddie</nick><nick>Knucklenose</nick></nick-names>)
+        end
+      end
+
+      describe "with a block" do
+
+        it "generates a nested element for each list element" do
+          represent.list_of!(:nick_names) do |nick_name|
+            nick_name.length
+          end
+          resulting_xml.should == %(<nick-names type="array"><nick-name><length>7</length></nick-name><nick-name><length>11</length></nick-name></nick-names>)
+        end
+
+      end
+
+      describe "with :item_attributes AND block" do
+        
+        it "generates attributes and nested elements" do
+          represent.list_of!(:nick_names, :item_attributes => {:length => :size}) do |nick_name|
+            nick_name.reverse
+          end
+          resulting_xml.should == %(<nick-names type="array"><nick-name length="7"><reverse>eidderF</reverse></nick-name><nick-name length="11"><reverse>esonelkcunK</reverse></nick-name></nick-names>)
+        end
+        
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "rubygems"
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: representative
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-14 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+description: 
+email: mdub@dogbiscuit.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- examples/xml_demo.rb
+- init.rb
+- lib/representative.rb
+- lib/representative/xml.rb
+- representative.gemspec
+- spec/representative/xml_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mdub/representative
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Builds XML representations of your Ruby objects
+test_files: 
+- spec/representative/xml_spec.rb
+- spec/spec_helper.rb
+- examples/xml_demo.rb