representative 0.2.5 → 0.3.0

data/spec/representative/json_spec.rb

@@ -53,6 +53,38 @@ describe Representative::Json do
         end
         
       end
+      
+      describe "with attributes" do
+        
+        describe "and a block" do
+          
+          it "generates labelled fields for the attributes" do
+            @book = OpenStruct.new(:lang => "fr", :title => "En Edge")
+            r.element :book, @book, :lang => :lang do
+              r.element :title
+            end
+            resulting_json.should == undent(<<-JSON)
+            {
+              "@lang": "fr",
+              "title": "En Edge"
+            }
+            JSON
+          end
+          
+        end
+
+        describe "and an explicit value" do
+          
+          it "ignores the attributes" do
+            r.element :review, "Blah de blah", :lang => "fr"
+            resulting_json.should == undent(<<-JSON)
+            "Blah de blah"
+            JSON
+          end
+          
+        end
+        
+      end
 
       describe "without an explicit value" do
 
@@ -199,6 +231,23 @@ describe Representative::Json do
 
     end
 
+    describe "#attribute" do
+      
+      it "generates labelled values, with a label prefix" do
+        r.element :author, Object.new do
+          r.attribute :href, "http://example.com/authors/1"
+          r.element :name, "Fred"
+        end
+        resulting_json.should == undent(<<-JSON)
+        {
+          "@href": "http://example.com/authors/1",
+          "name": "Fred"
+        }
+        JSON
+      end
+      
+    end
+    
     describe "#comment" do
       
       it "inserts a comment" do

data/spec/representative/nokogiri_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+require "nokogiri"
+require "representative/nokogiri"
+require "representative/xml_behaviour"
+
+describe Representative::Nokogiri do
+
+  def r
+    @representative ||= Representative::Nokogiri.new(@subject)
+  end
+
+  def resulting_xml
+    r.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).rstrip
+  end
+
+  it_should_behave_like "an XML Representative"
+
+  describe "for some 'subject'" do
+
+    before do
+      @subject = OpenStruct.new(:name => "Fred", :width => 200, :vehicle => OpenStruct.new(:year => "1959", :make => "Chevrolet"))
+    end
+
+    describe "#attribute" do
+
+      describe "without a value argument" do
+        it "extracts the named field of the subject" do
+          r.element :person, @subject do
+            r.attribute :name
+          end
+          resulting_xml.should == %(<person name="Fred"/>)
+        end
+      end
+
+      describe "with an explicit value" do
+        it "attaches an attribute to the current element" do
+          r.element :person, @subject do
+            r.attribute :lang, "fr"
+          end
+          resulting_xml.should == %(<person lang="fr"/>)
+        end
+      end
+
+      describe "with a value that supports #to_proc" do
+        it "calls the Proc on the subject to generate attribute value" do
+          r.element :person, @subject do
+            r.attribute :name, lambda { |person| person.name.reverse } 
+          end
+          resulting_xml.should == %(<person name="derF"/>)
+        end
+      end
+
+      it "dasherizes the attribute name" do
+        r.element :name do
+          r.attribute :sourced_from, "phonebook"
+        end
+        resulting_xml.should == %(<name sourced-from="phonebook"/>)
+      end
+
+      describe "with value nil" do
+        it "omits the attribute" do
+          r.element :person, @subject do
+            r.attribute :name, nil
+          end
+          resulting_xml.should == %(<person/>)
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/representative/tilt_integration_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+require "ostruct"
+require "representative/tilt_integration"
+
+describe Representative::Tilt do
+
+  def with_template(file_name, content)
+    @template = Tilt.new(file_name, 1) { content }
+  end
+
+  def render(*args, &block)
+    @output = @template.render(*args, &block)
+  end
+
+  describe "XML template" do
+
+    def resulting_xml
+      @output.sub(/^<\?xml.*\n/, '')
+    end
+
+    describe "#render" do
+
+      it "generates XML" do
+        with_template("whatever.xml.rep", <<-RUBY)
+          r.element :foo, "bar"
+        RUBY
+        render
+        resulting_xml.should == %{<foo>bar</foo>\n}
+      end
+
+      it "provides access to scope" do
+
+        with_template("whatever.xml.rep", <<-RUBY)
+        r.element :author, @mike do
+          r.element :name
+        end
+        RUBY
+
+        scope = Object.new
+        scope.instance_eval do
+          @mike = OpenStruct.new(:name => "Mike")
+        end
+        render(scope)
+
+        resulting_xml.should == undent(<<-XML)
+          <author>
+            <name>Mike</name>
+          </author>
+        XML
+
+      end
+
+      it "provides access to local variables" do
+
+        with_template("whatever.xml.rep", <<-RUBY)
+        r.element :author, author do
+          r.element :name
+        end
+        RUBY
+
+        render(Object.new, {:author => OpenStruct.new(:name => "Mike")})
+
+        resulting_xml.should == undent(<<-XML)
+          <author>
+            <name>Mike</name>
+          </author>
+        XML
+
+      end
+
+    end
+
+  end
+  
+  describe "JSON template" do
+
+    def resulting_json
+      @output.sub(/^<\?xml.*\n/, '')
+    end
+
+    describe "#render" do
+
+      it "generates JSON" do
+        with_template("whatever.json.rep", <<-RUBY)
+        r.element :foo, "bar"
+        RUBY
+        render
+        resulting_json.should == %{"bar"\n}
+      end
+
+      it "provides access to scope" do
+
+        with_template("whatever.json.rep", <<-RUBY)
+          r.element :author, @mike do
+            r.element :name
+          end
+        RUBY
+
+        scope = Object.new
+        scope.instance_eval do
+          @mike = OpenStruct.new(:name => "Mike")
+        end
+        render(scope)
+
+        resulting_json.should == undent(<<-JSON)
+          {
+            "name": "Mike"
+          }
+        JSON
+
+      end
+
+      it "provides access to local variables" do
+
+        with_template("whatever.json.rep", <<-RUBY)
+          r.element :author, author do
+            r.element :name
+          end
+        RUBY
+
+        render(Object.new, {:author => OpenStruct.new(:name => "Mike")})
+
+        resulting_json.should == undent(<<-JSON)
+          {
+            "name": "Mike"
+          }
+        JSON
+
+      end
+
+    end
+
+  end
+
+end

data/spec/representative/xml_behaviour.rb

@@ -0,0 +1,270 @@
+require 'spec_helper'
+
+require "rexml/document"
+
+shared_examples_for "an XML Representative" do
+
+  describe "for some 'subject'" do
+
+    before do
+      @subject = OpenStruct.new(:name => "Fred", :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>)
+      end
+
+      it "dasherizes the property name" do
+        @subject.full_name = "Fredrick"
+        r.element :full_name
+        resulting_xml.should == %(<full-name>Fredrick</full-name>)
+      end
+
+      describe "with attributes" do
+
+        it "generates attributes on the element" do
+          r.element :name, :lang => "fr"
+          resulting_xml.should == %(<name lang="fr">Fred</name>)
+        end
+
+        it "dasherizes the attribute name" do
+          r.element :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
+            r.element :name, :rev => :reverse
+            resulting_xml.should == %(<name rev="derF">Fred</name>)
+          end
+
+        end
+
+        describe "with value nil" do
+
+          it "omits the attribute" do
+            r.element :name, :lang => nil
+            resulting_xml.should == %(<name>Fred</name>)
+          end
+
+        end
+
+      end
+
+      describe "with an explicit value" do
+
+        it "generates an element with explicitly provided content" do
+          r.element :name, "Bloggs"
+          resulting_xml.should == %(<name>Bloggs</name>)
+        end
+
+        describe "AND attributes" do
+
+          it "generates attributes on the element" do
+            r.element :name, "Bloggs", :lang => "fr"
+            resulting_xml.should == %(<name lang="fr">Bloggs</name>)
+          end
+
+        end
+
+      end
+
+      describe "with a value argument that supports #to_proc" do
+
+        it "calls the Proc on the subject to generate a value" do
+          r.element :name, :width
+          resulting_xml.should == %(<name>200</name>)
+        end
+
+      end
+
+      describe "with value argument :self" do
+
+        it "doesn't alter the subject" do
+          r.element :info, :self do
+            r.element :name
+          end
+          resulting_xml.should == %(<info><name>Fred</name></info>)
+        end
+        
+      end
+
+      describe "with value argument nil" do
+
+        it "builds an empty element" do
+          r.element :name, nil
+          resulting_xml.should == %(<name/>)
+        end
+
+        describe "and attributes" do
+
+          it "omits attributes derived from the subject" do
+            r.element :name, nil, :size => :size
+            resulting_xml.should == %(<name/>)
+          end
+
+          it "retains attributes with explicit values" do
+            r.element :name, nil, :lang => "en"
+            resulting_xml.should == %(<name lang="en"/>)
+          end
+
+        end
+
+        describe "and a block" do
+
+          it "doesn't call the block" do
+            r.element :name, nil do
+              raise "hell"
+            end
+            resulting_xml.should == %(<name/>)
+          end
+
+        end
+
+      end
+
+      describe "with a block" do
+
+        it "generates nested elements" do
+          r.element :vehicle do
+            r.element :year
+            r.element :make
+          end
+          resulting_xml.should == %(<vehicle><year>1959</year><make>Chevrolet</make></vehicle>)
+        end
+
+        it "yields each new subject" do
+          r.element :vehicle do |vehicle|
+            r.element :year, vehicle.year
+          end
+          resulting_xml.should == %(<vehicle><year>1959</year></vehicle>)
+        end
+
+      end
+
+      describe "with an EMPTY block" do
+
+        it "generates an empty element" do
+          r.element :vehicle, :year => :year, &r.empty
+          resulting_xml.should == %(<vehicle year="1959"/>)
+        end
+
+      end
+
+    end
+    
+    describe "#list_of" do
+
+      before do
+        @subject.nick_names = ["Freddie", "Knucklenose"]
+      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
+          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
+          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
+        it "uses the name provided" do
+          r.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 an argument that resolves to nil" do
+
+        it "omits the attribute" do
+          r.list_of(:services) do
+            r.date
+          end
+          resulting_xml.should == %(<services/>)
+        end
+
+      end
+
+      describe "with a block" do
+
+        it "generates a nested element for each list element" do
+          r.list_of(:nick_names) do
+            r.element :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 an EMPTY block" do
+
+        it "generates empty elements for each list element" 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 == 
+        %(<vehicle><!-- Year of manufacture --><year>1959</year></vehicle>)
+      end
+      
+    end
+    
+  end
+
+end