hom 0.1.0

data/README.txt

@@ -0,0 +1,50 @@
+A straightforward API for generating HTML programmatically.
+
+Install via rubygems (no dependencies):
+
+  gem install hom
+
+Either require it, or add it to your Rails Gemfile:
+
+  require 'hom'
+
+  gem 'hom'
+
+Generate HTML using HOM::Element objects. The first constuctor argument is
+a symbol representing the tag name, for example:
+
+  HOM::Element.new(:br)
+
+The second constructor argument represents the element attributes, and can be
+nil, a single symbol/string, a hash, or an array of hashes and symbols/strings.
+For example:
+
+  HOM::Element.new(:input, :disabled)
+
+  HOM::Element.new(:input, {type: :text, size: 30})
+
+  HOM::Element.new(:input, [{type: :text, size: 30}, :disabled])
+
+The third constructor argument is the inner content, which can be a string,
+another element object, or an array of child items. For example:
+
+  span = HOM::Element.new(:span, nil, '')
+
+  h1 = HOM::Element.new(:h1, {}, 'hello world')
+
+  image = HOM::Element.new(:img, {src: 'image.png', width: 100, height: 30})
+
+  link = HOM::Element.new(:a, {target: :_blank, href: '/'}, image)
+
+  list = HOM::Element.new(:ul, nil, (1..3).map { |n| HOM::Element.new(:li, nil, n) })
+
+Use HOM::Entity objects for HTML entities; integer values for numeric entities
+and symbol/string values for named entities, for example:
+
+  HOM::Element.new(:span, nil, HOM::Entity.new(160))
+
+  HOM::Element.new(:span, nil, HOM::Entity.new(:nbsp))
+
+Call #to_s or #html on a HOM::Element object to return a string containing
+the generated HTML. HOM::Element objects are safe to use directly in Rails
+templates, all escaping is handled automatically.

data/hom.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'hom'
+  s.version = '0.1.0'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Tim Craft']
+  s.email = ['mail@timcraft.com']
+  s.homepage = 'http://github.com/timcraft/hom'
+  s.description = 'A straightforward API for generating HTML programmatically'
+  s.summary = 'See description'
+  s.files = Dir.glob('{lib,test}/**/*') + %w(README.txt hom.gemspec)
+  s.add_development_dependency('activesupport', ['>= 3.0.3'])
+  s.require_path = 'lib'
+end

data/lib/hom/attribute.rb

@@ -0,0 +1,9 @@
+require 'cgi'
+
+module HOM
+  class Attribute < Struct.new(:name, :value)
+    def html
+      value.nil? ? " #{name}" : %( #{name}="#{CGI.escapeHTML(value.to_s)}")
+    end
+  end
+end

data/lib/hom/attribute_list.rb

@@ -0,0 +1,36 @@
+module HOM
+  class AttributeList < Array
+    def html
+      map(&:html).join
+    end
+
+    def lookup(name)
+      detect { |object| object.name.to_s == name.to_s }
+    end
+
+    def set(name, value = nil)
+      attribute = lookup(name)
+
+      if attribute.nil?
+        self << Attribute.new(name, value)
+      else
+        attribute.value = value
+      end
+    end
+
+    def update(object)
+      case object
+      when NilClass
+        :pass
+      when Hash
+        object.each { |k, v| set(k, v) }
+      when Array
+        object.each { |item| update(item) }
+      else
+        set(object)
+      end
+
+      return self
+    end
+  end
+end

data/lib/hom/element.rb

@@ -0,0 +1,51 @@
+require 'cgi'
+
+module HOM
+  class Element
+    attr_reader :tag_name, :attributes
+
+    def initialize(tag_name, attributes = nil, content = nil)
+      @tag_name, @attributes, @content = tag_name, AttributeList.new.update(attributes), content
+    end
+
+    def html
+      start_tag = "<#{@tag_name}#{@attributes.html}>"
+
+      @content.nil? ? start_tag : "#{start_tag}#{escape(@content)}</#{@tag_name}>"
+    end
+
+    def to_s
+      html_safe(html)
+    end
+
+    def method_missing(name, *args, &block)
+      if args.empty? && block.nil?
+        attribute = attributes.lookup(name)
+
+        unless attribute.nil? || attribute.value.nil?
+          return attribute.value
+        end
+      end
+
+      super name, *args, &block
+    end
+
+    private
+
+    def html_safe(string)
+      string.respond_to?(:html_safe) ? string.html_safe : string
+    end
+
+    def escape(object)
+      if object.is_a?(Array)
+        object.map { |item| escape(item) }.join
+      elsif object.respond_to?(:html)
+        object.html
+      elsif object.respond_to?(:html_safe?) && object.html_safe?
+        object.to_s
+      else
+        CGI.escapeHTML(object.to_s)
+      end
+    end
+  end
+end

data/lib/hom/entity.rb

@@ -0,0 +1,21 @@
+module HOM
+  class Entity
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def html
+      numeric? ? "&\##{value};" : "&#{value};"
+    end
+
+    def numeric?
+      Numeric === @value
+    end
+
+    def named?
+      !numeric?
+    end
+  end
+end

data/lib/hom.rb

@@ -0,0 +1,6 @@
+module HOM
+  autoload :Attribute, 'hom/attribute'
+  autoload :AttributeList, 'hom/attribute_list'
+  autoload :Element, 'hom/element'
+  autoload :Entity, 'hom/entity'
+end

data/test/hom_attribute_list.rb

@@ -0,0 +1,53 @@
+require 'minitest/autorun'
+
+$:.unshift 'lib'
+
+require 'hom'
+
+class HOM::AttributeList::TestCase < MiniTest::Unit::TestCase
+  def setup
+    @list = HOM::AttributeList.new
+  end
+
+  def test_update_with_nil
+    @list.update(nil)
+
+    assert_equal 0, @list.length
+  end
+
+  def test_update_with_symbol
+    @list.update(:disabled)
+
+    assert_equal 1, @list.length
+    assert_equal :disabled, @list[0].name
+    assert_equal nil, @list[0].value
+  end
+
+  def test_update_with_hash
+    @list.update({type: :text, size: 30})
+
+    assert_equal 2, @list.length
+    assert_equal :type, @list[0].name
+    assert_equal :text, @list[0].value
+    assert_equal :size, @list[1].name
+    assert_equal 30, @list[1].value
+  end
+
+  def test_update_with_array
+    @list.update([{type: :text}, :disabled])
+
+    assert_equal 2, @list.length
+    assert_equal :type, @list[0].name
+    assert_equal :text, @list[0].value
+    assert_equal :disabled, @list[1].name
+    assert_equal nil, @list[1].value
+  end
+
+  def test_update_with_duplicate_symbols
+    @list.update([:disabled, :disabled])
+
+    assert_equal 1, @list.length
+    assert_equal :disabled, @list[0].name
+    assert_equal nil, @list[0].value
+  end
+end

data/test/hom_element.rb

@@ -0,0 +1,46 @@
+require 'minitest/autorun'
+require 'active_support/core_ext/string/output_safety'
+
+$:.unshift 'lib'
+
+require 'hom'
+
+class HOM::Element::TestCase < MiniTest::Unit::TestCase
+  def setup
+    @br = HOM::Element.new(:br)
+    @i1 = HOM::Element.new(:input, :disabled)
+    @i2 = HOM::Element.new(:input, {type: :text, size: 30})
+    @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'))
+    @ul = HOM::Element.new(:ul, nil, (1..3).map { |n| HOM::Element.new(:li, nil, n) })
+  end
+
+  def test_stringification
+    assert_equal '<br>', @br.to_s
+    assert_equal '<input disabled>', @i1.to_s
+    assert_equal '<input type="text" size="30">', @i2.to_s
+    assert_equal '<input type="text" size="30" disabled>', @i3.to_s
+    assert_equal '<h1></h1>', @h1.to_s
+    assert_equal '<h2>hello world</h2>', @h2.to_s
+    assert_equal '<h3>a &amp;&amp; b, x &gt; y</h3>', @h3.to_s
+    assert_equal '<h4>1234567890</h4>', @h4.to_s
+    assert_equal '<h5><b>how bold</b></h5>', @h5.to_s
+    assert_equal '<ul><li>1</li><li>2</li><li>3</li></ul>', @ul.to_s
+  end
+
+  def test_output_safety
+    assert @br.to_s.html_safe?
+
+    assert '<span><br></span>', HOM::Element.new(:span, nil, '<br>'.html_safe).to_s
+  end
+
+  def test_attribute_access
+    assert_equal :text, @i3.type
+    assert_equal 30, @i3.size
+    assert_raises(NoMethodError) { @i3.disabled }
+  end
+end

data/test/hom_entity.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+
+$:.unshift 'lib'
+
+require 'hom'
+
+class HOM::Entity::TestCase < MiniTest::Unit::TestCase
+  def setup
+    @e160 = HOM::Entity.new(160)
+
+    @nbsp = HOM::Entity.new(:nbsp)
+  end
+
+  def test_value_method
+    assert_equal 160, @e160.value
+    assert_equal :nbsp, @nbsp.value
+  end
+
+  def test_numeric_query_method
+    assert_equal true, @e160.numeric?
+    assert_equal false, @nbsp.numeric?
+  end
+
+  def test_named_query_method
+    assert_equal false, @e160.named?
+    assert_equal true, @nbsp.named?
+  end
+
+  def test_html_method
+    assert_equal '&#160;', @e160.html
+    assert_equal '&nbsp;', @nbsp.html
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: hom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Craft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-19 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &3706480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: *3706480
+description: A straightforward API for generating HTML programmatically
+email:
+- mail@timcraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hom/attribute.rb
+- lib/hom/attribute_list.rb
+- lib/hom/element.rb
+- lib/hom/entity.rb
+- lib/hom.rb
+- test/hom_attribute_list.rb
+- test/hom_element.rb
+- test/hom_entity.rb
+- README.txt
+- hom.gemspec
+has_rdoc: true
+homepage: http://github.com/timcraft/hom
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: See description
+test_files: []