representative 0.3.6 → 1.0.0

data/README.markdown

@@ -11,23 +11,23 @@ Generating XML
 Given a Ruby data-structure:
 
     @books = [
-      OpenStruct.new(
+      Book.new(
         :title => "Sailing for old dogs", 
         :authors => ["Jim Watson"],
-        :published => OpenStruct.new(
+        :published => Publication.new(
           :by => "Credulous Print",
           :year => 1994
         )
       ),
-      OpenStruct.new(
+      Book.new(
         :title => "On the horizon", 
         :authors => ["Zoe Primpton", "Stan Ford"],
-        :published => OpenStruct.new(
+        :published => Publication.new(
           :by => "McGraw-Hill",
           :year => 2005
         )
       ),
-      OpenStruct.new(
+      Book.new(
         :title => "The Little Blue Book of VHS Programming",
         :authors => ["Henry Nelson"],
         :rating => "****"
@@ -152,7 +152,35 @@ Representative is packaged as a Gem.  Install with:
 
     gem install representative
 
+Ruby on Rails integration
+-------------------------
+
+A separate gem, [RepresentativeView](https://github.com/mdub/representative_view), integrates Representative as an ActionPack template format.
+
+Tilt integration
+----------------
+
+Representative includes integration with [Tilt](https://github.com/rtomayko/tilt), which can be enabled with:
+
+    require "representative/tilt_integration"
+
+This registers handlers for "`.xml.rep`" and "`.json.rep`" templates.
+
 Copyright
 ---------
 
 Copyright (c) 2009 Mike Williams. See LICENSE for details.
+
+Similar projects
+----------------
+
+If Representative is not your cup of tea, you may prefer:
+
+* [Tokamak](https://github.com/abril/tokamak)
+* [Builder](http://rubygems.org/gems/builder)
+* [JSONify](https://github.com/bsiggelkow/jsonify)
+* [Argonaut](https://github.com/jbr/argonaut)
+* [JSON Builder](https://github.com/dewski/json_builder)
+* [RABL](https://github.com/nesquena/rabl)
+
+Just don't go back to using "`this_thing.to_xml`" and "`that_thing.to_json`", m'kay?

data/examples/{xml_demo.rb → books.rb}

@@ -1,12 +1,10 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+#! /usr/bin/env ruby
 
-require "rubygems"
-require "representative/nokogiri"
 require "ostruct"
 
 @books = [
   OpenStruct.new(
-    :title => "Sailing for old dogs", 
+    :title => "Sailing for old dogs",
     :authors => ["Jim Watson"],
     :published => OpenStruct.new(
       :by => "Credulous Print",
@@ -14,7 +12,7 @@ require "ostruct"
     )
   ),
   OpenStruct.new(
-    :title => "On the horizon", 
+    :title => "On the horizon",
     :authors => ["Zoe Primpton", "Stan Ford"],
     :published => OpenStruct.new(
       :by => "McGraw-Hill",
@@ -28,8 +26,10 @@ require "ostruct"
   )
 ]
 
-xml = Representative::Nokogiri.new do |r|
+require "representative/json"
+require "representative/nokogiri"
 
+def represent_books(r)
   r.list_of :books, @books do
     r.element :title
     r.list_of :authors
@@ -38,7 +38,14 @@ xml = Representative::Nokogiri.new do |r|
       r.element :year
     end
   end
-
 end
 
-puts xml.to_s
+puts "\n=== JSON ===\n\n"
+
+json = Representative::Json.new.tap { |r| represent_books(r) }.to_s
+puts json
+
+puts "\n=== XML ===\n\n"
+
+xml = Representative::Nokogiri.new.tap { |r| represent_books(r) }.to_s
+puts xml

data/lib/representative/json.rb

@@ -3,11 +3,11 @@ require "representative/base"
 require "multi_json"
 
 module Representative
-  
+
   class Json < Base
 
     DEFAULT_ATTRIBUTE_PREFIX = "@".freeze
-    
+
     def initialize(subject = nil, options = {})
       super(subject, options)
       @buffer = ""
@@ -16,19 +16,19 @@ module Representative
       now_at :beginning_of_buffer
       yield self if block_given?
     end
-    
+
     attr_reader :attribute_prefix
-    
+
     def element(name, *args, &block)
 
       metadata = @inspector.get_metadata(current_subject, name)
       attributes = args.extract_options!.merge(metadata)
 
-      subject_of_element = if args.empty? 
+      subject_of_element = if args.empty?
         lambda do |subject|
           @inspector.get_value(current_subject, name)
         end
-      else 
+      else
         args.shift
       end
 
@@ -36,13 +36,13 @@ module Representative
 
       label(name)
       value(subject_of_element, attributes, &block)
-      
+
     end
 
     def attribute(name, value_generator = name)
       element(attribute_prefix + name.to_s, value_generator)
     end
-    
+
     def list_of(name, *args, &block)
       options = args.extract_options!
       list_subject = args.empty? ? name : args.shift
@@ -60,7 +60,7 @@ module Representative
         end
       end
     end
-    
+
     def value(subject, attributes = {})
       representing(subject) do
         if block_given? && !current_subject.nil?
@@ -76,23 +76,23 @@ module Representative
       end
       now_at :end_of_item
     end
-        
+
     def comment(text)
       new_item
-      emit("// #{text}")
+      emit("// " + text)
       now_at :end_of_comment
     end
 
     def to_json
       @buffer + "\n"
     end
-    
+
     def to_s
       to_json
     end
 
     private
-    
+
     def emit(s)
       @buffer << s
     end
@@ -100,7 +100,7 @@ module Representative
     def encode(data)
       MultiJson.encode(data)
     end
-    
+
     def indentation
       ("  " * @indent_level)
     end
@@ -108,7 +108,7 @@ module Representative
     def label(name)
       return false if @indent_level == 0
       new_item
-      emit("#{encode(format_name(name))}: ")
+      emit(encode(format_name(name)) + ": ")
     end
 
     def new_item
@@ -117,14 +117,14 @@ module Representative
       emit(indentation)
       @pending_comma = ","
     end
-    
+
     def inside(opening_char, closing_char)
       emit(opening_char)
       @indent_level += 1
       now_at :beginning_of_block
       yield
       @indent_level -= 1
-      emit("\n#{indentation}") unless at? :beginning_of_block
+      emit("\n" + indentation) unless at? :beginning_of_block
       emit(closing_char)
       now_at :end_of_item
     end
@@ -136,9 +136,9 @@ module Representative
     def at?(state)
       @state == state
     end
-    
+
   end
-  
+
   JSON = Json
-  
+
 end

data/lib/representative/version.rb

@@ -1,3 +1,3 @@
 module Representative
-  VERSION = "0.3.6".freeze
+  VERSION = "1.0.0".freeze
 end

data/spec/representative/xml_behaviour.rb

@@ -8,15 +8,15 @@ shared_examples_for "an XML Representative" do
 
     before do
       @subject = OpenStruct.new(
-        :name => "Fred", 
-        :full_name => "Fredrick", 
-        :width => 200, 
+        :name => "Fred",
+        :full_name => "Fredrick",
+        :width => 200,
         :vehicle => OpenStruct.new(:year => "1959", :make => "Chevrolet")
       )
     end
 
     describe "#element" do
-      
+
       it "generates an element with content extracted from the subject" do
         r.element :name
         resulting_xml.should == %(<name>Fred</name>)
@@ -77,7 +77,7 @@ shared_examples_for "an XML Representative" do
 
       end
 
-      describe "with a Symbol argument" do
+      describe "with a Symbol value argument" do
 
         it "calls the named method to generate a value" do
           r.element :name, :width
@@ -103,7 +103,7 @@ shared_examples_for "an XML Representative" do
           end
           resulting_xml.should == %(<info><name>Fred</name></info>)
         end
-        
+
       end
 
       describe "with value argument nil" do
@@ -169,7 +169,7 @@ shared_examples_for "an XML Representative" do
       end
 
     end
-    
+
     describe "#list_of" do
 
       before do
@@ -181,8 +181,22 @@ shared_examples_for "an XML Representative" do
         resulting_xml.should == %(<nick-names type="array"><nick-name>Freddie</nick-name><nick-name>Knucklenose</nick-name></nick-names>)
       end
 
+      describe "with a Symbol value argument" do
+
+        it "calls the named method to generate a value" do
+          r.list_of(:foo_bars, :nick_names)
+          resulting_xml.should == %(<foo-bars type="array"><foo-bar>Freddie</foo-bar><foo-bar>Knucklenose</foo-bar></foo-bars>)
+        end
+
+      end
+
+      it "generates an array element" do
+        r.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
           r.list_of(:nick_names, :list_attributes => {:color => "blue", :size => :size})
           array_element_attributes = REXML::Document.new(resulting_xml).root.attributes
@@ -191,7 +205,7 @@ shared_examples_for "an XML Representative" do
           array_element_attributes["size"].should == "2"
           array_element_attributes.size.should == 3
         end
-        
+
       end
 
       describe "with :item_attributes" do
@@ -200,7 +214,7 @@ shared_examples_for "an XML Representative" do
           r.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
@@ -238,41 +252,41 @@ shared_examples_for "an XML Representative" do
           r.list_of(:nick_names, :item_attributes => {:value => :to_s}, &r.empty)
           resulting_xml.should == %(<nick-names type="array"><nick-name value="Freddie"/><nick-name value="Knucklenose"/></nick-names>)
         end
-        
+
       end
-      
+
       describe "with :item_attributes AND block" do
-        
+
         it "generates attributes and nested elements" do
           r.list_of(:nick_names, :item_attributes => {:length => :size}) do
             r.element :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
 
     describe "#representing" do
-    
+
       it "selects a new subject without generating an element" do
         r.representing :vehicle do
           r.element :make
         end
         resulting_xml.should == %(<make>Chevrolet</make>)
       end
-      
+
     end
 
     describe "#comment" do
-      
+
       it "inserts a comment" do
         r.element :vehicle do
           r.comment "Year of manufacture"
           r.element :year
         end
-        resulting_xml.should == 
+        resulting_xml.should ==
         %(<vehicle><!-- Year of manufacture --><year>1959</year></vehicle>)
       end
 

metadata

@@ -1,125 +1,121 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: representative
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  version: 0.3.6
 platform: ruby
-authors: 
+authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70241309663160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309663160
+- !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70241309662120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309662120
+- !ruby/object:Gem::Dependency
   name: builder
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70241309661380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309661380
+- !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70241309660480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309660480
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70241309659680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309659680
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70241309658960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309658960
+- !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &70241309658220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.9"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309658220
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &70241309657400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.4.2
   type: :development
   prerelease: false
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70241309657400
+- !ruby/object:Gem::Dependency
   name: diff-lcs
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &70241309656760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id009
+  version_requirements: *70241309656760
 description: 
 email: mdub@dogbiscuit.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/representative/abstract_xml.rb
 - lib/representative/base.rb
 - lib/representative/empty.rb
@@ -130,8 +126,7 @@ files:
 - lib/representative/version.rb
 - lib/representative/xml.rb
 - lib/representative.rb
-- examples/json_demo.rb
-- examples/xml_demo.rb
+- examples/books.rb
 - README.markdown
 - LICENSE
 - spec/representative/json_spec.rb
@@ -143,38 +138,35 @@ files:
 - Rakefile
 homepage: http://github.com/mdub/representative
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 412267701560150101
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2883973472066778787
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 412267701560150101
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -2883973472066778787
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Builds XML and JSON representations of your Ruby objects
-test_files: 
+test_files:
 - spec/representative/json_spec.rb
 - spec/representative/nokogiri_spec.rb
 - spec/representative/tilt_integration_spec.rb

data/examples/json_demo.rb

@@ -1,44 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-require "rubygems"
-require "representative/json"
-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 => "****"
-  )
-]
-
-json = Representative::Json.new do |r|
-
-  r.list_of :books, @books do
-    r.element :title
-    r.list_of :authors
-    r.element :published do
-      r.element :by
-      r.element :year
-    end
-  end
-
-end
-
-puts json.to_s