arbre 1.0.0 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30b53bbea249a4468d48f14a136eda6c20fc65b7
+  data.tar.gz: 17a5b69fd8d6b97bb0c4231ae675e726307044c4
+SHA512:
+  metadata.gz: de40bce2886fe8180f32ca25fb0a6a8eae6cef04d0f8bcd9af568332241f4e5a4aec73a6064fc6af8ddb4e42a78d74b715be61aeff4925d84686f7d0e70d1a79
+  data.tar.gz: 789a7b6cc502b10ce1a2eb2d46fac659500727c22915c0539f511529a1f947cd5d51f6fe2990241adfe0708816831a9cbe62c6c2d4eaed21d9f5994e3161bbba

data/.gitignore

@@ -3,6 +3,8 @@
 Gemfile.lock
 pkg/*
 benchmarks
-/.rvmrc
-/tags
+.rvmrc
+.ruby-version
+.ruby-gemset
+tags
 .DS_Store

data/.travis.yml

@@ -1,5 +1,4 @@
 script: bundle exec rake
 rvm:
-  - ree
-  - 1.9.2
   - 1.9.3
+  - 2.1.2

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 1.0.2
+
+* make `Element#inspect` behave correctly in Ruby 2.0 (@seanlinsley, #16)
+* prevent `Arbre::Element#flatten` infinite recursion (@seanlinsley, #32)
+* make `find_by_class` correctly find children by class (@kaapa, #33)
+
+## 1.0.1
+
+* Template handler converts to string to satisfy Rack::Lint (@jpmckinney, #6)
+* Fix to `Tag#add_class` when passing a string of classes to Tag build method
+  (@gregbell, #7)
+* Not longer uses the default separator (@LTe, #4)
+
 ## 1.0.0
 
 * Added support for the use of `:for` with non Active Model objects

data/Gemfile

@@ -1,13 +1,16 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec
 
 group :test do
-  gem "rspec"
+  gem 'rspec'
+  gem 'rack'
+  gem 'pry'
 end
 
 group :rails do
-  gem "rspec-rails"
-  gem 'combustion', '0.3.2'
-  gem "capybara"
+  gem 'rails'
+  gem 'rspec-rails'
+  gem 'combustion'
+  gem 'capybara'
 end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Greg Bell
+
+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.md

@@ -0,0 +1,110 @@
+# Arbre - HTML Views in Ruby
+
+Arbre makes it easy to generate HTML directly in Ruby. This gem was extracted from [Active Admin](https://github.com/activeadmin/active_admin).
+
+[![Version  ](http://img.shields.io/gem/v/arbre.svg)                    ](https://rubygems.org/gems/arbre)
+[![Travis CI](http://img.shields.io/travis/activeadmin/arbre/master.svg)](https://travis-ci.org/activeadmin/arbre)
+
+## Simple Usage
+
+```ruby
+html = Arbre::Context.new do
+  h2 "Why is Arbre awesome?"
+
+  ul do
+    li "The DOM is implemented in ruby"
+    li "You can create object oriented views"
+    li "Templates suck"
+  end
+end
+
+puts html.to_s # =>
+```
+
+```html
+<h2>Why is Arbre awesome?</h2>
+<ul>
+  <li>The DOM is implemented in ruby</li>
+  <li>You can create object oriented views</li>
+  <li>Templates suck</li>
+</ul>
+```
+
+## The DOM in Ruby
+
+The purpose of Arbre is to leave the view as ruby objects as long
+as possible. This allows OO Design to be used to implement the view layer.
+
+```ruby
+html = Arbre::Context.new do
+  h2 "Why Arbre is awesome?"
+end
+
+html.children.size # => 1
+html.children.first # => #<Arbre::HTML::H2>
+```
+
+## Components
+
+The purpose of Arbre is to be able to create shareable and extendable HTML
+components. To do this, you create a subclass of Arbre::Component.
+
+For example:
+
+```ruby
+class Panel < Arbre::Component
+  builder_method :panel
+
+  def build(title, attributes = {})
+    super(attributes)
+
+    h3(title, :class => "panel-title")
+  end
+end
+```
+
+The builder_method defines the method that will be called to build this component
+when using the DSL. The arguments passed into the builder_method will be passed 
+into the #build method for you.
+
+You can now use this panel in any Arbre context:
+
+```ruby
+html = Arbre::Context.new do
+  panel "Hello World", :id => "my-panel" do
+    span "Inside the panel"
+  end
+end
+
+puts html.to_s # =>
+```
+
+```html
+<div class='panel' id="my-panel">
+  <h3 class='panel-title'>Hello World</h3>
+  <span>Inside the panel</span>
+</div>
+```      
+      
+### Text Nodes
+
+To insert unwrapped text nodes use `text_node`:
+
+```ruby
+html = Arbre::Context.new do
+  panel "Hello World", :id => "my-panel" do
+    span "Inside the panel"
+    text_node "Plain text"
+  end
+end
+
+puts html.to_s # =>
+```
+
+```html
+<div class='panel' id="my-panel">
+  <h3 class='panel-title'>Hello World</h3>
+  <span>Inside the panel</span>
+  Plain text
+</div>
+```

data/Rakefile

@@ -5,3 +5,14 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+
+  require 'pry'
+  require 'arbre'
+
+  ARGV.clear
+  IRB.start
+end

data/arbre.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = ""
   s.summary     = %q{An Object Oriented DOM Tree in Ruby}
   s.description = %q{An Object Oriented DOM Tree in Ruby}
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/arbre/element.rb

@@ -1,4 +1,5 @@
 require 'arbre/element/builder_methods'
+require 'arbre/element/proxy'
 require 'arbre/element_collection'
 
 module Arbre
@@ -106,8 +107,8 @@ module Arbre
     def get_elements_by_class_name(class_name)
       elements = ElementCollection.new
       children.each do |child|
-        elements << child if child.class_list =~ /#{class_name}/
-        elements.concat(child.get_elements_by_tag_name(tag_name))
+        elements << child if child.class_list.include?(class_name)
+        elements.concat(child.get_elements_by_class_name(class_name))
       end
       elements
     end
@@ -129,6 +130,10 @@ module Arbre
       [to_s].each(&block)
     end
 
+    def inspect
+      to_s
+    end
+
     def to_str
       to_s
     end
@@ -143,11 +148,11 @@ module Arbre
       else
         element = Arbre::HTML::TextNode.from_string(element)
       end
-      ElementCollection.new([self]) + element
+      to_ary + element
     end
 
     def to_ary
-      ElementCollection.new [self]
+      ElementCollection.new [Proxy.new(self)]
     end
     alias_method :to_a, :to_ary
 

data/lib/arbre/element/proxy.rb

@@ -0,0 +1,28 @@
+module Arbre
+  class Element
+    class Proxy < BasicObject
+      undef_method :==
+      undef_method :equal?
+
+      def initialize(element)
+        @element = element
+      end
+
+      def respond_to?(method, include_all = false)
+        if method.to_s == 'to_ary'
+          false
+        else
+          super || @element.respond_to?(method, include_all)
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        if method.to_s == 'to_ary'
+          super
+        else
+          @element.__send__ method, *args, &block
+        end
+      end
+    end
+  end
+end

data/lib/arbre/element_collection.rb

@@ -18,7 +18,7 @@ module Arbre
     def to_s
       self.collect do |element|
         element.to_s
-      end.join.html_safe
+      end.join('').html_safe
     end
   end
 

data/lib/arbre/html/attributes.rb

@@ -4,13 +4,22 @@ module Arbre
     class Attributes < Hash
 
       def to_s
-        self.collect do |name, value|
+        map do |name, value|
+          next if value_empty?(value)
           "#{html_escape(name)}=\"#{html_escape(value)}\""
-        end.join(" ")
+        end.compact.join ' '
+      end
+
+      def any?
+        super{ |k,v| !value_empty?(v) }
       end
 
       protected
 
+      def value_empty?(value)
+        value.respond_to?(:empty?) ? value.empty? : !value
+      end
+
       def html_escape(s)
         ERB::Util.html_escape(s)
       end

data/lib/arbre/html/class_list.rb

@@ -6,6 +6,13 @@ module Arbre
     # Holds a set of classes
     class ClassList < Set
 
+      def self.build_from_string(class_names)
+        list = new
+        list.add(class_names)
+
+        list
+      end
+
       def add(class_names)
         class_names.to_s.split(" ").each do |class_name|
           super(class_name)

data/lib/arbre/html/tag.rb

@@ -77,7 +77,16 @@ module Arbre
       end
 
       def class_list
-        get_attribute(:class) || set_attribute(:class, ClassList.new)
+        list = get_attribute(:class)
+
+        case list
+        when ClassList
+          list
+        when String
+          set_attribute(:class, ClassList.build_from_string(list))
+        else
+          set_attribute(:class, ClassList.new)
+        end
       end
 
       def to_s
@@ -121,7 +130,7 @@ module Arbre
       end
 
       def self_closing_tag?
-        %w|meta link|.include?(tag_name)
+        %w|br link meta|.include?(tag_name)
       end
 
       def no_child?
@@ -132,9 +141,8 @@ module Arbre
         children.size == 1 && children.first.is_a?(TextNode)
       end
 
-
       def attributes_html
-        attributes.any? ? " " + attributes.to_s : nil
+        " #{attributes}" if attributes.any?
       end
 
       def set_for_attribute(record)

data/lib/arbre/html/text_node.rb

@@ -22,6 +22,10 @@ module Arbre
         @content = string
       end
 
+      def class_list
+        []
+      end
+
       def tag_name
         nil
       end

data/lib/arbre/rails/template_handler.rb

@@ -1,14 +1,14 @@
 module Arbre
   module Rails
-
     class TemplateHandler
-
       def call(template)
-        "Arbre::Context.new(assigns, self){ #{template.source} }"
+        <<-END
+        Arbre::Context.new(assigns, self) {
+          #{template.source}
+        }.to_s
+        END
       end
-
     end
-
   end
 end
 

data/lib/arbre/version.rb

@@ -1,3 +1,3 @@
 module Arbre
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/spec/arbre/integration/html_spec.rb

@@ -6,17 +6,17 @@ describe Arbre do
   let(:assigns){ {} }
 
   it "should render a single element" do
-    arbre {
+    expect(arbre {
       span "Hello World"
-    }.to_s.should == "<span>Hello World</span>\n"
+    }.to_s).to eq("<span>Hello World</span>\n")
   end
 
   it "should render a child element" do
-    arbre {
+    expect(arbre {
       span do
         span "Hello World"
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <span>
   <span>Hello World</span>
 </span>
@@ -24,13 +24,13 @@ HTML
   end
 
   it "should render an unordered list" do
-    arbre {
+    expect(arbre {
       ul do
         li "First"
         li "Second"
         li "Third"
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <ul>
   <li>First</li>
   <li>Second</li>
@@ -40,14 +40,14 @@ HTML
   end
 
    it "should allow local variables inside the tags" do
-     arbre {
+     expect(arbre {
        first = "First"
        second = "Second"
        ul do
          li first
          li second
        end
-     }.to_s.should == <<-HTML
+     }.to_s).to eq <<-HTML
 <ul>
   <li>First</li>
   <li>Second</li>
@@ -57,14 +57,14 @@ HTML
 
 
   it "should add children and nested" do
-    arbre {
+    expect(arbre {
       div do
         ul
         li do
           li
         end
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <div>
   <ul></ul>
   <li>
@@ -76,13 +76,13 @@ HTML
 
 
   it "should pass the element in to the block if asked for" do
-    arbre {
+    expect(arbre {
       div do |d|
         d.ul do
           li
         end
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <div>
   <ul>
     <li></li>
@@ -93,11 +93,11 @@ HTML
 
 
   it "should move content tags between parents" do
-    arbre {
+    expect(arbre {
       div do
         span(ul(li))
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <div>
   <span>
     <ul>
@@ -109,14 +109,14 @@ HTML
   end
 
   it "should add content to the parent if the element is passed into block" do
-    arbre {
+    expect(arbre {
       div do |d|
         d.id = "my-tag"
         ul do
           li
         end
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <div id="my-tag">
   <ul>
     <li></li>
@@ -126,42 +126,43 @@ HTML
   end
 
   it "should have the parent set on it" do
+    list, item = nil
     arbre {
-      item = nil
       list = ul do
         li "Hello"
         item = li "World"
       end
-      item.parent.should == list
     }
+    expect(item.parent).to eq list
   end
 
   it "should set a string content return value with no children" do
-    arbre {
+    expect(arbre {
       li do
         "Hello World"
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <li>Hello World</li>
 HTML
   end
 
   it "should turn string return values into text nodes" do
+    node = nil
     arbre {
       list = li do
         "Hello World"
       end
       node = list.children.first
-      node.class.should == Arbre::HTML::TextNode
     }
+    expect(node).to be_a Arbre::HTML::TextNode
   end
 
   it "should not render blank arrays" do
-    arbre {
+    expect(arbre {
       tbody do
         []
       end
-    }.to_s.should == <<-HTML
+    }.to_s).to eq <<-HTML
 <tbody></tbody>
 HTML
   end
@@ -169,21 +170,27 @@ HTML
   describe "self-closing nodes" do
 
     it "should not self-close script tags" do
-      arbre {
+      expect(arbre {
         script :type => 'text/javascript'
-      }.to_s.should == "<script type=\"text/javascript\"></script>\n"
+      }.to_s).to eq("<script type=\"text/javascript\"></script>\n")
     end
 
     it "should self-close meta tags" do
-      arbre {
+      expect(arbre {
         meta :content => "text/html; charset=utf-8"
-      }.to_s.should == "<meta content=\"text/html; charset=utf-8\"/>\n"
+      }.to_s).to eq("<meta content=\"text/html; charset=utf-8\"/>\n")
     end
 
     it "should self-close link tags" do
-      arbre {
+      expect(arbre {
         link :rel => "stylesheet"
-      }.to_s.should == "<link rel=\"stylesheet\"/>\n"
+      }.to_s).to eq("<link rel=\"stylesheet\"/>\n")
+    end
+
+    it "should self-close br tags" do
+      expect(arbre {
+        br
+      }.to_s).to eq("<br/>\n")
     end
 
   end
@@ -191,23 +198,23 @@ HTML
   describe "html safe" do
 
     it "should escape the contents" do
-      arbre {
+      expect(arbre {
         span("<br />")
-      }.to_s.should == <<-HTML
+      }.to_s).to eq <<-HTML
 <span>&lt;br /&gt;</span>
 HTML
     end
 
     it "should return html safe strings" do
-      arbre {
+      expect(arbre {
         span("<br />")
-      }.to_s.should be_html_safe
+      }.to_s).to be_html_safe
     end
 
     it "should not escape html passed in" do
-      arbre {
+      expect(arbre {
         span(span("<br />"))
-      }.to_s.should == <<-HTML
+      }.to_s).to eq <<-HTML
 <span>
   <span>&lt;br /&gt;</span>
 </span>
@@ -215,13 +222,13 @@ HTML
     end
 
     it "should escape string contents when passed in block" do
-      arbre {
+      expect(arbre {
         span {
           span {
             "<br />"
           }
         }
-      }.to_s.should == <<-HTML
+      }.to_s).to eq <<-HTML
 <span>
   <span>&lt;br /&gt;</span>
 </span>
@@ -229,9 +236,9 @@ HTML
     end
 
     it "should escape the contents of attributes" do
-      arbre {
+      expect(arbre {
         span(:class => "<br />")
-      }.to_s.should == <<-HTML
+      }.to_s).to eq <<-HTML
 <span class="&lt;br /&gt;"></span>
 HTML
     end