hom 0.4.0 → 1.0.0

data/README.md

@@ -1,5 +1,6 @@
-HOM: A straightforward API for generating HTML
-==============================================
+A straightforward API for generating HTML
+=========================================
+
 
 Motivation
 ----------
@@ -8,6 +9,23 @@ HOM helps you implement HTML presentation logic in your code. Things like
 navigation links, select boxes, sets of checkboxes; anything with behaviour
 that is too complex for your templates.
 
+
+Installation
+------------
+
+    $ gem install hom
+
+
+Quick start
+-----------
+
+```ruby
+require 'hom'
+
+puts HOM::Element.new(:h1, nil, 'hello world')
+```
+
+
 Usage
 -----
 

data/hom.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'hom'
-  s.version = '0.4.0'
+  s.version = '1.0.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
@@ -8,6 +8,12 @@ Gem::Specification.new do |s|
   s.description = 'A straightforward API for generating HTML'
   s.summary = 'See description'
   s.files = Dir.glob('{lib,spec}/**/*') + %w(Rakefile README.md hom.gemspec)
+  s.add_development_dependency('rake', '~> 10.0.3')
+  s.add_development_dependency('mocha', '~> 0.13.2')
   s.add_development_dependency('activesupport', ['>= 3.0.3'])
   s.require_path = 'lib'
+
+  if RUBY_VERSION == '1.8.7'
+    s.add_development_dependency('minitest', '>= 4.2.0')
+  end
 end

data/lib/hom.rb

@@ -82,10 +82,6 @@ module HOM
         object.map { |item| encode(item) }.join
       elsif object.is_a?(Element)
         encode_element(object)
-      elsif object.respond_to?(:html) # TODO: REMOVE ME
-        Kernel.warn '[hom] defining #html on custom objects is deprecated, map the objects to elements instead'
-
-        object.html
       elsif object.respond_to?(:html_safe?) && object.html_safe?
         object.to_s
       else

data/spec/element_spec.rb

@@ -1,71 +1,25 @@
 require 'minitest/autorun'
-require 'active_support/core_ext/string/output_safety'
-
-require_relative '../lib/hom'
-
-describe 'Element' do
-  before do
-    @br = HOM::Element.new(:br)
-    @i1 = HOM::Element.new(:input, :disabled)
-    @i2 = HOM::Element.new(:input, {type: :text, size: 30, value: nil})
-    @i3 = HOM::Element.new(:input, [{type: :text, size: 30}, :disabled])
-    @h1 = HOM::Element.new(:h1, nil, '')
-    @h2 = HOM::Element.new(:h2, nil, 'hello world')
-    @h3 = HOM::Element.new(:h3, nil, 'a && b, x > y')
-    @h4 = HOM::Element.new(:h4, nil, 1234567890)
-    @h5 = HOM::Element.new(:h5, nil, HOM::Element.new(:b, nil, 'how bold'))
-    @h6 = HOM::Element.new(:h6, nil, nil)
-    @ul = HOM::Element.new(:ul, nil, (1..3).map { |n| HOM::Element.new(:li, nil, n) })
-  end
+require 'mocha/setup'
+require 'hom'
 
+describe 'HOM::Element' do
   describe 'content query method' do
-    it 'should return false if the content is undefined' do
-      @br.content?.must_equal(false)
+    it 'returns false if the content is undefined' do
+      HOM::Element.new(:br).content?.must_equal(false)
     end
 
-    it 'should return true otherwise' do
-      @h1.content?.must_equal(true)
+    it 'returns true otherwise' do
+      HOM::Element.new(:h1, nil, '').content?.must_equal(true)
     end
   end
 
   describe 'to_s method' do
-    it 'should return a string containing the correct markup' do
-      @br.to_s.must_equal('<br>')
-      @i1.to_s.must_equal('<input disabled>')
-      @i2.to_s.must_equal('<input type="text" size="30" value="">')
-      @i3.to_s.must_equal('<input type="text" size="30" disabled>')
-      @h1.to_s.must_equal('<h1></h1>')
-      @h2.to_s.must_equal('<h2>hello world</h2>')
-      @h3.to_s.must_equal('<h3>a &amp;&amp; b, x &gt; y</h3>')
-      @h4.to_s.must_equal('<h4>1234567890</h4>')
-      @h5.to_s.must_equal('<h5><b>how bold</b></h5>')
-      @h6.to_s.must_equal('<h6></h6>')
-      @ul.to_s.must_equal('<ul><li>1</li><li>2</li><li>3</li></ul>')
-    end
-
-    it 'should not encode content that has been marked as html safe' do
-      HOM::Element.new(:span, nil, '<br>').to_s.must_equal('<span>&lt;br&gt;</span>')
-      HOM::Element.new(:span, nil, '<br>'.html_safe).to_s.must_equal('<span><br></span>')
-    end
-
-    it 'should return content that is marked as html safe' do
-      @br.to_s.html_safe?.must_equal(true)
-    end
-  end
-
-  describe 'encoding objects with an html method' do # TODO: REMOVE ME
-    it 'should emit a deprecation warning' do
-      require 'mocha'
-
-      object = Object.new
-
-      def object.html; HOM::Element.new(:span, nil, 'html') end
-
-      div = HOM::Element.new(:div, nil, object)
+    it 'safely encodes itself using the encoding module' do
+      element = HOM::Element.new(:br)
 
-      Kernel.expects(:warn).with(regexp_matches(/defining #html on custom objects is deprecated/))
+      HOM::Encoding.expects(:safe_encode).with(element)
 
-      div.to_s.must_equal('<div><span>html</span></div>')
+      element.to_s
     end
   end
 end

data/spec/encoding_spec.rb

@@ -0,0 +1,97 @@
+require 'minitest/autorun'
+require 'active_support/core_ext/string/output_safety'
+require 'hom'
+
+describe 'HOM::Encoding' do
+  describe 'encode method' do
+    it 'renders elements with a tag name' do
+      element = HOM::Element.new(:br)
+
+      HOM::Encoding.encode(element).must_equal('<br>')
+    end
+
+    it 'renders elements with a symbol attribute' do
+      element = HOM::Element.new(:input, :disabled)
+
+      HOM::Encoding.encode(element).must_equal('<input disabled>')
+    end
+
+    it 'renders elements with a hash of attributes' do
+      element = HOM::Element.new(:input, {:type => :text, :size => 30, :value => nil})
+
+      output = HOM::Encoding.encode(element)
+      output.must_match(/<input .+>/)
+      output.must_include(' type="text"')
+      output.must_include(' size="30"')
+      output.must_include(' value=""')
+    end
+
+    it 'renders elements with an array of mixed attributes' do
+      element = HOM::Element.new(:input, [{:type => :text, :size => 30}, :disabled])
+
+      output = HOM::Encoding.encode(element)
+      output.must_match(/<input .+>/)
+      output.must_include(' type="text"')
+      output.must_include(' size="30"')
+      output.must_include(' disabled')
+    end
+
+    it 'renders elements with empty content' do
+      element = HOM::Element.new(:h1, nil, '')
+
+      HOM::Encoding.encode(element).must_equal('<h1></h1>')
+    end
+
+    it 'renders elements with string content' do
+      element = HOM::Element.new(:h2, nil, 'hello world')
+
+      HOM::Encoding.encode(element).must_equal('<h2>hello world</h2>')
+    end
+
+    it 'renders elements with numeric content' do
+      element = HOM::Element.new(:h4, nil, 1234567890)
+
+      HOM::Encoding.encode(element).must_equal('<h4>1234567890</h4>')
+    end
+
+    it 'renders elements with a single child element' do
+      element = HOM::Element.new(:h5, nil, HOM::Element.new(:b, nil, 'how bold'))
+
+      HOM::Encoding.encode(element).must_equal('<h5><b>how bold</b></h5>')
+    end
+
+    it 'renders elements with nil content' do
+      element = HOM::Element.new(:h6, nil, nil)
+
+      HOM::Encoding.encode(element).must_equal('<h6></h6>')
+    end
+
+    it 'renders elements with multiple child elements' do
+      element = HOM::Element.new(:ul, nil, (1..3).map { |n| HOM::Element.new(:li, nil, n) })
+
+      HOM::Encoding.encode(element).must_equal('<ul><li>1</li><li>2</li><li>3</li></ul>')
+    end
+
+    it 'escapes string content' do
+      element = HOM::Element.new(:h3, nil, 'a && b, x > y')
+
+      HOM::Encoding.encode(element).must_equal('<h3>a &amp;&amp; b, x &gt; y</h3>')
+    end
+
+    it 'does not escape content that has been marked as html safe' do
+      element = HOM::Element.new(:span, nil, '<br>'.html_safe)
+
+      HOM::Encoding.encode(element).must_equal('<span><br></span>')
+    end
+  end
+
+  describe 'safe_encode method' do
+    it 'encodes the argument and marks it as html safe' do
+      element = HOM::Element.new(:br)
+
+      output = HOM::Encoding.safe_encode(element)
+      output.must_equal('<br>')
+      output.html_safe?.must_equal(true)
+    end
+  end
+end

data/spec/entity_spec.rb

@@ -1,74 +1,73 @@
 require 'minitest/autorun'
+require 'hom'
 
-require_relative '../lib/hom'
-
-describe 'Named entity' do
+describe 'HOM::Entity initialized with a symbol' do
   before do
     @entity = HOM::Entity.new(:nbsp)
   end
 
   describe 'value method' do
-    it 'should return the symbol value' do
+    it 'returns the symbol value' do
       @entity.value.must_equal(:nbsp)
     end
   end
 
   describe 'numeric query method' do
-    it 'should return false' do
+    it 'returns false' do
       @entity.numeric?.must_equal(false)
     end
   end
 
   describe 'named query method' do
-    it 'should return true' do
+    it 'returns true' do
       @entity.named?.must_equal(true)
     end
   end
 
   describe 'to_s method' do
-    it 'should return the encoded html entity' do
+    it 'returns the encoded html entity' do
       @entity.to_s.must_equal(' ')
     end
   end
 
   describe 'html_safe query method' do
-    it 'should return true' do
+    it 'returns true' do
       @entity.html_safe?.must_equal(true)
     end
   end
 end
 
-describe 'Numeric entity' do
+describe 'HOM::Entity initialized with an integer' do
   before do
     @entity = HOM::Entity.new(160)
   end
 
   describe 'value method' do
-    it 'should return the integer value' do
+    it 'returns the integer value' do
       @entity.value.must_equal(160)
     end
   end
 
   describe 'numeric query method' do
-    it 'should return true' do
+    it 'returns true' do
       @entity.numeric?.must_equal(true)
     end
   end
 
   describe 'named query method' do
-    it 'should return false' do
+    it 'returns false' do
       @entity.named?.must_equal(false)
     end
   end
 
   describe 'to_s method' do
-    it 'should return the encoded html entity' do
+    it 'returns the encoded html entity' do
       @entity.to_s.must_equal(' ')
     end
   end
 
   describe 'html_safe query method' do
-    it 'should return true' do
+    it 'returns true' do
       @entity.html_safe?.must_equal(true)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hom
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -36,6 +68,7 @@ extra_rdoc_files: []
 files:
 - lib/hom.rb
 - spec/element_spec.rb
+- spec/encoding_spec.rb
 - spec/entity_spec.rb
 - Rakefile
 - README.md
@@ -65,4 +98,3 @@ signing_key:
 specification_version: 3
 summary: See description
 test_files: []
-has_rdoc: