effigy 0.3.2 → 0.4.0

data/Rakefile

@@ -31,6 +31,13 @@ begin
   end
 
   task :spec => :rails_root
+
+  desc "Run all specs individually to ensure that requires are correct"
+  task :check_requires do
+    Dir["spec/**/*_spec.rb"].each do |spec_file|
+      system("spec -cfp #{spec_file}") or raise "Failed while running #{spec_file}"
+    end
+  end
 rescue LoadError => exception
   puts "Missing dependencies for specs"
   task :spec do

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/lib/effigy/view.rb

@@ -85,7 +85,7 @@ module Effigy
     #
     # @return [String] the resulting document
     def render(template)
-      @current_context = Nokogiri::XML.parse(template)
+      @current_context = Nokogiri::HTML.fragment(template)
       yield if block_given?
       transform
       output
@@ -136,13 +136,13 @@ module Effigy
     #
     # @param [String] selector a CSS or XPath string describing the element to
     #   transform
-    # @param [String] xml the new contents of the selected element. Markup is
+    # @param [String] inner_html the new contents of the selected element. Markup is
     #   not escaped.
     # @example
     #   html('p', '<b>Welcome!</b>')
     #   find('p').html('<b>Welcome!</b>')
-    def html(selector, xml)
-      select(selector).inner_html = xml
+    def html(selector, inner_html)
+      select(selector).inner_html = inner_html
     end
 
     # Replaces the selected element with live markup.
@@ -151,10 +151,23 @@ module Effigy
     #
     # @param [String] selector a CSS or XPath string describing the element to
     #   transform
-    # @param [String] xml the new markup to replace the selected element. Markup is
+    # @param [String] html the new markup to replace the selected element. Markup is
     #   not escaped.
-    def replace_with(selector, xml)
-      select(selector).after(xml).unlink
+    def replace_with(selector, html)
+      select(selector).after(html).unlink
+    end
+
+    # Adds the given markup to the end of the selected element.
+    #
+    # @param [String] selector a CSS or XPath string describing the element to
+    #   which this HTML should be appended
+    # @param [String] html_to_append the new markup to append to the selected
+    #   element. Markup is not escaped.
+    def append(selector, html_to_append)
+      node = select(selector)
+      current_context.fragment(html_to_append).children.each do |child|
+        node << child
+      end
     end
 
     # Selects an element or elements for chained transformation.
@@ -220,10 +233,10 @@ module Effigy
     # Returns the first node that matches the given selection, or the nodes
     # themselves if given a set of nodes.
     #
-    # @param nodes [String,Nokogiri::XML::NodeSet] if a String, the selector to
+    # @param nodes [String,Nokogiri::HTML::NodeSet] if a String, the selector to
     #   use when determining the current context. When a NodeSet, the set of
     #   nodes that should be returned.
-    # @return [Nokogiri::XML::NodeSet] the nodes selected by the given selector
+    # @return [Nokogiri::HTML::NodeSet] the nodes selected by the given selector
     #   or node set.
     # @raise [ElementNotFound] if no nodes match the given selector
     def select(nodes)
@@ -238,7 +251,7 @@ module Effigy
     # Returns a set of nodes matching the given selector.
     #
     # @param selector [String] the selctor to use when finding nodes
-    # @return [Nokogiri::XML::NodeSet] the nodes selected by the given selector
+    # @return [Nokogiri::HTML::NodeSet] the nodes selected by the given selector
     # @raise [ElementNotFound] if no nodes match the given selector
     def select_all(selector)
       result = current_context.search(selector)
@@ -249,10 +262,10 @@ module Effigy
     # Clones an element, sets it as the current context, and yields to the
     # given block with the given item.
     #
-    # @param [Nokogiri::XML::Element] the element to clone
+    # @param [Nokogiri::HTML::Element] the element to clone
     # @param [Object] item the item that should be yielded to the block
     # @yield [Object] the item passed as item
-    # @return [Nokogiri::XML::Element] the clone of the original element
+    # @return [Nokogiri::HTML::Element] the clone of the original element
     def clone_element_with_item(original_element, item, &block)
       item_element = original_element.dup
       find(item_element) { yield(item) }
@@ -269,7 +282,7 @@ module Effigy
     #
     # @return [String] the transformed document as a string
     def output
-      current_context.to_xhtml
+      current_context.to_html
     end
 
   end

data/spec/effigy/view_spec.rb

@@ -7,130 +7,157 @@ module Effigy
       template = %{<test><element one="abc">something</element></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.text 'element', 'expected'
       end
 
-      xml.should have_selector(:element, :contents => 'expected', :one => 'abc')
+      html.should have_selector(:element, :contents => 'expected', :one => 'abc')
     end
 
     it "should replace element attributes" do
       template = %{<test><element one="abc">something</element></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.attr 'element', :one => '123', :two => '234'
       end
 
-      xml.should have_selector(:element, :contents => 'something', :one => '123', :two => '234')
+      html.should have_selector(:element, :contents => 'something', :one => '123', :two => '234')
     end
 
     it "should replace one attribute" do
       template = %{<test><element one="abc">something</element></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.attr 'element', :one, '123'
       end
 
-      xml.should have_selector(:element, :contents => 'something', :one => '123')
+      html.should have_selector(:element, :contents => 'something', :one => '123')
     end
 
     it "should replace an element with a clone for each item in a collection" do
       template = %{<test><element><value>original</value></element></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.replace_each('element', %w(one two)) do |value|
           view.text('value', value)
         end
       end
 
-      xml.should have_selector('element value', :contents => 'one')
-      xml.should have_selector('element value', :contents => 'two')
-      xml.should_not have_selector('element value', :contents => 'original')
-      xml.should =~ /one.*two/m
+      html.should have_selector('element value', :contents => 'one')
+      html.should have_selector('element value', :contents => 'two')
+      html.should_not have_selector('element value', :contents => 'original')
+      html.should =~ /one.*two/m
     end
 
     it "should replace within a context" do
       template = %{<test><element><value>original</value></element></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.find('element') do
           view.text('value', 'expected')
         end
       end
 
-      xml.should have_selector('element value', :contents => 'expected')
+      html.should have_selector('element value', :contents => 'expected')
     end
 
     it "should remove all matching elements" do
       template = %{<test><first class="yes"/><other class="yes"/><last class="no"/></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.remove('.yes')
       end
 
-      xml.should have_selector('.no')
-      xml.should_not have_selector('.yes')
+      html.should have_selector('.no')
+      html.should_not have_selector('.yes')
     end
 
     it "should add the given class names" do
       template = %{<test class="original"/>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.add_class('test', 'one', 'two')
       end
 
-      xml.should have_selector('test.original')
-      xml.should have_selector('test.one')
-      xml.should have_selector('test.two')
+      html.should have_selector('test.original')
+      html.should have_selector('test.one')
+      html.should have_selector('test.two')
     end
 
     it "should remove the given class names" do
       template = %{<test class="one two three"/>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.remove_class('test', 'one', 'two')
       end
 
-      xml.should have_selector('test.three')
-      xml.should_not have_selector('test.one')
-      xml.should_not have_selector('test.two')
+      html.should have_selector('test.three')
+      html.should_not have_selector('test.one')
+      html.should_not have_selector('test.two')
     end
 
     it "should replace an element's inner markup" do
       template = %{<test><original>contents</original></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.html 'test', '<new>replaced</new>'
       end
 
-      xml.should have_selector('test new', :contents => 'replaced')
-      xml.should_not have_selector('original')
+      html.should have_selector('test new', :contents => 'replaced')
+      html.should_not have_selector('original')
     end
 
     it "should replace an element's outer markup" do
       template = %{<test><original>contents</original></test>}
 
       view = Effigy::View.new
-      xml = view.render(template) do
+      html = view.render(template) do
         view.replace_with 'test', '<new>replaced</new>'
       end
 
-      xml.should have_selector('new', :contents => 'replaced')
-      xml.should_not have_selector('test')
+      html.should have_selector('new', :contents => 'replaced')
+      html.should_not have_selector('test')
     end
 
-    it "should render xhtml by default" do
+    it "should append text to an element" do
+      template = %{<test>start</test>}
+
+      view = Effigy::View.new
+      html = view.render(template) do
+        view.append 'test', '<p>middle</p><p>end</p>'
+      end
+
+      html.should include("<test>start")
+      html.should have_selector('test p', :contents => 'middle')
+      html.should have_selector('test p', :contents => 'end')
+    end
+
+    it "should render html by default" do
       template = %{<html/>}
-      xml = Effigy::View.new.render(template)
-      xml.should_not include('<?xml')
+      html = Effigy::View.new.render(template)
+      html.should_not include('<?xml')
+      html.should_not include('xmlns')
+    end
+
+    it "should keep multiple top-level elements" do
+      template = %{<p>fragment one</p><p>fragment two</p>}
+      html = Effigy::View.new.render(template)
+      html.should include('one')
+      html.should include('two')
+    end
+
+    it "should handle html fragments" do
+      template = %{<h1>hello</h1>}
+      html = Effigy::View.new.render(template)
+      html.should == template
     end
 
     %w(find f).each do |chain_method|
@@ -138,11 +165,11 @@ module Effigy
         template = %{<test><element one="abc">something</element></test>}
 
         view = Effigy::View.new
-        xml = view.render(template) do
+        html = view.render(template) do
           view.send(chain_method, 'element').text('expected')
         end
 
-        xml.should have_selector(:element, :contents => 'expected', :one => 'abc')
+        html.should have_selector(:element, :contents => 'expected', :one => 'abc')
       end
     end
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: effigy
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Joe Ferris
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-14 00:00:00 -05:00
+date: 2010-03-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: Define views in Ruby and templates in HTML. Avoid code interpolation or ugly templating languages. Use ids, class names, and semantic structures already present in your documents to produce content.
 email: jferris@thoughtbot.com
 executables: []
@@ -76,18 +83,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Effigy provides a view and template framework without a templating language.