active_component 0.1.2

data/spec/active_component_spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+#require 'spec_helper'
+
+#require 'haml'
+
+require 'active_component'
+
+require 'factory_girl'
+require 'factories'

data/spec/base_spec.rb

@@ -0,0 +1,154 @@
+# encoding: utf-8
+
+describe ActiveComponent::Base do
+
+  context "component initialization" do
+    describe "html_class" do
+      it "should include the hyphenized component title" do
+        g = GreetingBox.new
+        g.title = "Happy greeting box"
+        g.instance_eval {[html_class].flatten}.should be_include 'happy-greeting-box'
+        d = Div.new
+        d.title = "Happy div"
+        d.instance_eval {[html_class].flatten}.should be_include 'happy-div'
+      end
+      it "should include the class_name unless it is an html tag wrapper" do
+        g = GreetingBox.new
+        g.instance_eval {[html_class].flatten}.should be_include 'greeting-box'
+        d = Div.new
+        d.instance_eval {[html_class].flatten}.should_not be_include 'div'
+      end
+    end
+
+    class NewsWidget < ActiveComponent::Base
+      attr_accessor :author
+
+      def initialize(*args, &content_block)
+        init_component(args, [:content, :title, :author, :attributes], &content_block)
+      end
+    end
+
+    describe "init_component" do
+      context "custom component" do
+        before :all do
+          @news_content = "The pope claims that condoms are not necessarily evil. Where is this heading to?"
+          # TODO support for special character removal pending
+          #@news_title   = "Scandal in the Vatican!"
+          @news_title   = "Scandal in the Vatican"
+          @news_author  = "Karl Atzinger"
+          @news_attributes = {:class => 'gossip', :title => 'click to read whole article'}
+        end
+
+        it "should set all parameters correctly when given in order" do
+          n = NewsWidget.new @news_content, @news_title, @news_author, {:class => 'gossip'}
+          n.content.should    == @news_content
+          n.title.should      == @news_title
+          n.author.should     == @news_author
+          n.attributes.should == {:class => ['scandal-in-the-vatican', 'news-widget', 'gossip']}
+        end
+
+        it "should set all parameters correctly when given as key value pairs" do
+          n = NewsWidget.new :attributes => @news_attributes, :title => @news_title, :content => @news_content, :author => @news_author
+          n.content.should    == @news_content
+          n.title.should      == @news_title
+          n.author.should     == @news_author
+          n.attributes.should == {:title => @news_attributes[:title], :class => ['scandal-in-the-vatican', 'news-widget', 'gossip']}
+        end
+
+        it "should set all parameters correctly when given in a mixed way" do
+          n = NewsWidget.new @news_title, @news_author, :content => @news_content, :attributes => @news_attributes
+          n.content.should    == @news_content
+          n.title.should      == @news_title
+          n.author.should     == @news_author
+          n.attributes.should == {:title => @news_attributes[:title], :class => ['scandal-in-the-vatican', 'news-widget', 'gossip']}
+        end
+
+        it "should prioritize content blocks over content arguments" do
+          n = NewsWidget.new(:content => "ignorable") { @news_content }
+          n.content.should == @news_content
+        end
+
+        it "should fill @attributes with remaining arguments of the last hash" do
+          n = NewsWidget.new @news_title, :id => 'news', :content => @news_content, :class => @news_attributes[:class]
+          n.content.should    == @news_content
+          n.title.should      == @news_title
+          n.attributes.should == {:id => 'news', :class => ['scandal-in-the-vatican', 'news-widget', 'gossip']}
+        end
+      end
+
+      context "html wrapper component (grand-child of base)" do
+        before :all do
+          @bq_content     = "It is better to be quotable than to be honest."
+          @bq_title       = "Tom Stoppard on Quotations"
+          @bq_attributes  = {:class => 'quotes', :cites => "http://www.quotationspage.com/quote/368.html"}
+        end
+
+        it "should set all parameters correctly when given in order" do
+          bq = Blockquote.new @bq_content, @bq_title, @bq_author, @bq_attributes
+          bq.content.should    == @bq_content
+          bq.title.should      == @bq_title
+          bq.attributes.should == {:cites => @bq_attributes[:cites], :class => [@bq_title.hyphenize, 'quotes']}
+        end
+
+        it "should set all parameters correctly when given as key value pairs" do
+          bq = Blockquote.new :attributes => @bq_attributes, :title => @bq_title, :content => @bq_content
+          bq.content.should    == @bq_content
+          bq.title.should      == @bq_title
+          bq.attributes.should == {:cites => @bq_attributes[:cites], :class => [@bq_title.hyphenize, 'quotes']}
+        end
+
+        it "should set all parameters correctly when given in a mixed way" do
+          bq = Blockquote.new @bq_title, :content => @bq_content, :attributes => @bq_attributes
+          bq.content.should    == @bq_content
+          bq.title.should      == @bq_title
+          bq.attributes.should == {:cites => @bq_attributes[:cites], :class => [@bq_title.hyphenize, 'quotes']}
+        end
+
+        it "should prioritize content blocks over content arguments" do
+          bq = Blockquote.new(:content => "ignorable") { @bq_content }
+          bq.content.should    == @bq_content
+        end
+
+        it "should fill attributes with remaining arguments of the last hash" do
+          bq = Blockquote.new @bq_title, :cites => "http://www.quotationspage.com/quote/368.html", :content => @bq_content, :class => 'quotes'
+          bq.content.should    == @bq_content
+          bq.title.should      == @bq_title
+          bq.attributes.should == {:cites => @bq_attributes[:cites], :class => [@bq_title.hyphenize, 'quotes']}
+        end
+      end
+
+    end
+  end
+
+  context "tree node management" do
+    it "should enable to add nodes as children" do
+      a = Block.new
+      b = Block.new("foo")
+      c = Block.new("bar")
+      a << b
+      a << c
+      a[b.object_id].should == b
+      children = []
+      a.children {|child| children << child.node_name}
+      children.should == [b.object_id, c.object_id]
+    end
+  end
+
+  context "instantiation helpers" do
+    it "should be available after creating a component" do
+      class NewGreetingBox < ActiveComponent::Base; end
+      ActiveComponent.instance_methods.map(&:to_sym).should be_include(:new_greeting_box)
+    end
+
+    # TODO: How to test this?
+    it "should be available to ActionView and render output"
+    #   class GreetingBox < ActiveComponent::Base
+    #     def initialize(*args, &content_block); init_component(args, [:content], &content_block); end
+    #     def to_html; Span.new("Hello " + print_object(content), :class => 'greeting').to_html; end
+    #   end
+    #   ActiveComponent::TemplateHandler.new.instance_eval { compile(greeting_box("world")) }.should == "not specified yet"
+    # end
+  end
+
+end
+

data/spec/components/block_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+describe Block do
+  include ActiveComponent
+  include Haml::Helpers
+
+  before :each do
+    @content     = "It is better to be quotable than to be honest."
+    @title       = "Tom Stoppard on Quotations"
+    @tag_type    = :blockquote
+    @attributes  = {:class => 'quotes', :cites => "http://www.quotationspage.com/quote/368.html"}
+  end
+
+  describe "initialize" do
+    it "should assume :div as default block type" do
+      block = Block.new { @content }
+      block.tag_type.should == :div
+    end
+
+    it "should not be possible to overwrite tag_type for subclasses of Block" do
+      for elem in ActiveComponent::BLOCK_ELEMENTS
+        elem_class = elem.to_s.camelize.constantize
+        block = elem_class.new(:tag_type => :block) { @content }
+        block.tag_type.should == elem
+      end
+    end
+  end
+
+  describe "to_html" do
+    it "should render nested blocks" do
+      init_buffer
+      block = Block.new @title, @tag_type, @attributes do
+        [
+          Block.new(@title, :tag_type => :h1),
+          Block.new(@content, :tag_type => :p),
+          Block.new("Details", :tag_type => :aside) do
+            print_buffer do
+              tag_to_buffer :dl do
+                tag_to_buffer :dt, "Author"
+                tag_to_buffer :dd, "Tom Stoppard"
+              end
+            end
+          end
+        ]
+      end
+      block.to_html.should == "<#{@tag_type} cites='#{@attributes[:cites]}' class='#{@title.hyphenize} block #{@attributes[:class]}'>\n  <h1 class='block'>\n    #{@title}\n  </h1>\n  <p class='block'>\n    #{@content}\n  </p>\n  <aside class='details block'>\n    <dl>\n      <dt>Author</dt>\n      <dd>Tom Stoppard</dd>\n    </dl>\n    \n  </aside>\n  \n</#{@tag_type}>\n"
+    end
+  end
+
+end
+

data/spec/components/heading_spec.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+describe Heading do
+  include ActiveComponent
+  include Haml::Helpers
+  
+  before :all do
+    @content     = "Wall Street Retreats in the Face of a Slowdown"
+    @title       = "Business News"
+    @level       = 3
+    @attributes  = {:class => 'news business'}
+  end
+
+  describe "siblings_level" do
+    
+    it "should adopt correct siblings level" do
+      h1 = Heading.new('header 1', :level => 3)
+      h2 = Heading.new
+      h3 = Heading.new [h1, h2]
+      h2.siblings_level.should == 3
+    end
+    
+    it "should return nil if no heading sibling exists" do
+      h1 = Heading.new
+      h2 = Heading.new h1
+      h1.siblings_level.should be_nil
+    end
+        
+    it "should return nil if existing heading sibling has no rank" do
+      h1 = Heading.new('header 1')
+      h2 = Heading.new
+      h3 = Heading.new [h1, h2]
+      h2.siblings_level.should be_nil
+    end
+    
+  end
+  
+  describe "determine_level" do
+    
+    it "should return the rank of a given sibling Heading" do
+      h1 = Heading.new(:level => 3)
+      h2 = Heading.new
+      h3 = Heading.new([h1, h2])
+      
+      h2.determine_level.should == 3
+    end
+    
+    it "should determine heading rank correctly based on the hierarchy" do
+      h1 = Heading.new('header 1')
+      h2 = Heading.new('header 2')
+      h3 = Heading.new('header 3')
+      div2 = Div.new(:content => [h2, h3])
+      div = Div.new(:content => [
+        h1, 
+        div2
+      ])
+      h2.determine_level.should == 2
+    end
+    
+  end
+  
+  
+  describe "to_html" do
+    
+    it "should compute heading levels automatically based on the node hierarchy" do
+      section = Section.new(:heading => @title, :content => [
+        Heading.new("It's better to be honest!"),
+        Section.new(:heading => "Tom Stoppard", :content => [
+          Div.new(:title => "Some div inbetween", :content => [
+            Heading.new("Yet Another Heading"),
+            Section.new("Details", :heading => "Leaf Heading")
+          ])
+        ])
+      ])
+      section.to_html.should == "<section>\n  <h1 class='heading'>\n    Business News\n  </h1>\n  \n  <h1 class='heading'>\n    It's better to be honest!\n  </h1>\n  \n  <section>\n    <h2 class='heading'>\n      Tom Stoppard\n    </h2>\n    \n    <div class='some-div-inbetween'>\n      <h3 class='heading'>\n        Yet Another Heading\n      </h3>\n      \n      <section>\n        <h4 class='heading'>\n          Leaf Heading\n        </h4>\n        \n        Details\n      </section>\n      \n    </div>\n    \n  </section>\n  \n</section>\n"
+    end
+  
+    it "should compute heading levels automatically also when block syntax used" do
+      section = Section.new(:heading => @title, :content => [
+        Heading.new("It's better to be honest!"),
+        Section.new(:heading => "Tom Stoppard", :content => [
+          Div.new(:title => "Some div inbetween") do 
+            [
+              Heading.new("Yet Another Heading"),
+              Section.new("Details", :heading => "Leaf Heading")
+            ]
+          end
+        ])
+      ])
+      section.to_html.should == "<section>\n  <h1 class='heading'>\n    Business News\n  </h1>\n  \n  <h1 class='heading'>\n    It's better to be honest!\n  </h1>\n  \n  <section>\n    <h2 class='heading'>\n      Tom Stoppard\n    </h2>\n    \n    <div class='some-div-inbetween'>\n      <h3 class='heading'>\n        Yet Another Heading\n      </h3>\n      \n      <section>\n        <h4 class='heading'>\n          Leaf Heading\n        </h4>\n        \n        Details\n      </section>\n      \n    </div>\n    \n  </section>\n  \n</section>\n"
+    end
+    
+  end
+  
+end

data/spec/components/section_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+describe Section do
+  
+  before :each do
+    @content     = "It is better to be quotable than to be honest."
+    @title       = "Tom Stoppard on Quotations"
+    @tag_type    = :blockquote
+    @attributes  = {:class => 'quotes', :cites => "http://www.quotationspage.com/quote/368.html"}
+  end
+
+  describe "initialize" do
+    it "should assume :section as default section type" do
+      section = Section.new @content
+      section.tag_type.should == :section
+    end
+
+    it "should not be possible to overwrite tag_type for subclasses of section" do
+      for elem in ActiveComponent::SECTION_ELEMENTS
+        elem_class = elem.to_s.camelize.constantize
+        section = elem_class.new(:tag_type => :section) { @content }
+        section.tag_type.should == elem
+      end
+    end
+  end
+
+  describe "to_html" do
+    it "should be able to render nested sections"
+
+    it "should be able to render section subclasses" do
+      b = Blockquote.new(@content, @title, @attributes)
+      b.to_html.should == "<blockquote cites='http://www.quotationspage.com/quote/368.html' class='tom-stoppard-on-quotations quotes'>\n  It is better to be quotable than to be honest.\n</blockquote>"
+    end
+  end
+end

data/spec/components/table_spec.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+describe Table do
+
+  def things
+    things = []
+    things << Factory.build(:thing, :name => "thingamabob", :color => :yellow)
+    things << Factory.build(:thing, :name => "whatchamacallit", :color => :red)
+    things << Factory.build(:thing, :name => "gizmo", :color => :blue)
+    things
+  end
+
+  context "rendering a matrix of primitive data" do
+    it "should render without further input" do
+      content = [["a", 1, "first entry"], ["b", 2, "second entry"]]
+      table = Table.new content
+      table.to_html.should == "<table cellspacing='0' class='arrays'>\n  <tr>\n    <td>a</td>\n    <td>1</td>\n    <td>first entry</td>\n  </tr>\n  <tr>\n    <td>b</td>\n    <td>2</td>\n    <td>second entry</td>\n  </tr>\n</table>\n"
+    end
+
+    it "should render correctly with all inputs set" do
+      content = [["a", 1, "first entry"], ["b", 2, "second entry"]]
+      table = Table.new content, 'examples', :cols => :to_s, :headers => ["char", "number", "entry"]
+      table.to_html.should == "<table cellspacing='0' class='examples'>\n  <tr>\n    <th>char</th>\n    <th>number</th>\n    <th>entry</th>\n  </tr>\n  <tr>\n    <td>a</td>\n    <td>1</td>\n    <td>first entry</td>\n  </tr>\n  <tr>\n    <td>b</td>\n    <td>2</td>\n    <td>second entry</td>\n  </tr>\n</table>\n"
+    end
+  end
+
+  context "rendering a collection of complex objects (e.g. instances of an Active Record model)" do
+    it "should render without further input" do
+      things = [Factory.build(:thing), Factory.build(:thing, :name => "Whatchamacallit", :color => :red)]
+      table = Table.new things
+      table.to_html.should == "<table cellspacing='0' class='things'>\n  <tr>\n    <th>Name</th>\n    <th>Color</th>\n  </tr>\n  <tr>\n    <td>Thingamabob</td>\n    <td>yellow</td>\n  </tr>\n  <tr>\n    <td>Whatchamacallit</td>\n    <td>red</td>\n  </tr>\n</table>\n"
+    end
+
+    it "should render complex ojects correctly with all inputs set" do
+      color_temperature = proc {|thing| [:yellow, :orange, :red].include?(thing.color) ? "warm" : "cold"}
+      table = Table.new things, 'things-table', :cols => [:name, color_temperature], :headers =>  ["Name", "Color Temperature"]
+      table.to_html.should == "<table cellspacing='0' class='things-table'>\n  <tr>\n    <th>Name</th>\n    <th>Color Temperature</th>\n  </tr>\n  <tr>\n    <td>thingamabob</td>\n    <td>warm</td>\n  </tr>\n  <tr>\n    <td>whatchamacallit</td>\n    <td>warm</td>\n  </tr>\n  <tr>\n    <td>gizmo</td>\n    <td>cold</td>\n  </tr>\n</table>\n"
+    end
+
+    # According Haml template code
+    #-----------------------------
+    # %table
+    #   %tr
+    #     %th Name
+    #     %th Reverse Name
+    #     %th Color Temperature
+    #   - @things.each |thing| do
+    #     %tr
+    #       %td= thing.name
+    #       %td= thing.name.reverse
+    #       %td.color-temp
+    #         - temp = [:yellow, :orange, :red].include?(thing.color) ? "warm" : "cold"
+    #         %span{:class => temp}
+    #           = temp + "!"
+    it "should render complex ojects using other components" do
+      table = Table.new(things, 'things-table', :headers => ["Name", "Color Temperature"], :cols => [
+        :name,
+        proc {|thing| thing.name.reverse},
+        proc do |thing|
+          temp = [:yellow, :orange, :red].include?(thing.color) ? "warm" : "cold"
+          Span.new(temp + "!", :class => temp)
+        end
+      ])
+      table.to_html.should == "<table cellspacing='0' class='things-table'>\n  <tr>\n    <th>Name</th>\n    <th>Color Temperature</th>\n  </tr>\n  <tr>\n    <td>thingamabob</td>\n    <td>bobamagniht</td>\n    <td>\n      <span class='warm'>\n        warm!\n      </span>\n      \n    </td>\n  </tr>\n  <tr>\n    <td>whatchamacallit</td>\n    <td>tillacamahctahw</td>\n    <td>\n      <span class='warm'>\n        warm!\n      </span>\n      \n    </td>\n  </tr>\n  <tr>\n    <td>gizmo</td>\n    <td>omzig</td>\n    <td>\n      <span class='cold'>\n        cold!\n      </span>\n      \n    </td>\n  </tr>\n</table>\n"
+    end
+    #
+    # it "should render using short hand helper functions"
+    #   pending {}
+    #   #tab = table(things, 'color-table', :cols => [ col(:name, 'Name'), col(nil, 'Reverse Name') {|thing| thing.name.reverse} ])
+    #     #col(:title => 'Color Temperature', :class => 'color-temp') { |thing|
+    #     #  temp = [:yellow, :orange, :red].include?(thing.color) ? "warm" : "cold"
+    #     #  span(temp + "!", :class => temp)
+    #     #}
+    #   #tab.to_html.should == "not specified yet"
+    # end
+  end
+
+  context "passing HTML attributes" do
+    it "should forward attributes for headers" do
+      table = Table.new things, :title => "my-things",
+        :style => "padding: 10px", :class => "custom-class", :cellpadding => 0,
+        :header_attrs => [{:class => 'name-header', :width => '200px'}, {:id => 'temp-col-header', :style => 'color: red'}]
+      table.row_attrs = [{:class => 'head-row'}] + table.content.map {|thing| {:class => thing.name}}
+      table.to_html.should == "<table cellpadding='0' cellspacing='0' class='my-things custom-class' style='padding: 10px'>\n  <tr class='head-row'>\n    <th class='name-header' width='200px'>Name</th>\n    <th id='temp-col-header' style='color: red'>Color</th>\n  </tr>\n  <tr class='thingamabob'>\n    <td>thingamabob</td>\n    <td>yellow</td>\n  </tr>\n  <tr class='whatchamacallit'>\n    <td>whatchamacallit</td>\n    <td>red</td>\n  </tr>\n  <tr class='gizmo'>\n    <td>gizmo</td>\n    <td>blue</td>\n  </tr>\n</table>\n"
+    end
+  end
+
+end

data/spec/core_extensions_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+#TODO transmogrify on more than 2 levels
+
+describe Object do
+  
+  context "transmogrify" do
+    it "should yield self if its not enumerable" do
+      block = Proc.new {|x| x.to_s.to_sym}
+      obj = Object.new
+      obj.transmogrify(&block).should eql(block.call(obj))
+    end
+  end
+  context "transmogrify_with_index" do
+    it "should not differ from transmogrify" do
+      block = Proc.new {|x| x.to_s.to_sym}
+      obj = Object.new
+      obj.transmogrify_with_index(&block).should eql(obj.transmogrify(&block))
+    end
+  end
+  
+end
+
+describe Enumerable do
+  
+  context "transmogrify" do
+    before(:each) do
+      @has_yielded = false
+      @results = []
+      @block = Proc.new do |x|
+        @results << x.to_s.to_sym
+        @has_yielded = true
+      end
+    end
+    it "should yield each element" do  
+      %w(a b c).transmogrify(&@block)
+      @has_yielded.should be_true
+      @results.should eql([:a, :b, :c])
+    end
+    after(:each) do
+      @has_yielded, @results, @block = nil
+    end
+  end
+  
+  context "transmogrify_with_index" do
+    before(:each) do
+      @has_yielded = false
+      @results = {}
+      @block = Proc.new do |elem, index|
+        @results[index] = elem.to_s.to_sym
+      end
+    end
+    it "should yield each element with index" do
+      %w(a b c).transmogrify_with_index(&@block)
+      @results.should == { 0 => :a, 1 => :b, 2 => :c }
+    end
+    after(:each) do
+      @result, @results, @block = nil
+    end
+  end
+  
+end