html 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+/.bundle
+/vendor

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+bundler_args: --without guard 
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode 
+  - rbx-19mode
+allowed_failures:
+  matrix:
+    - 1.8.7
+    - jruby-18mode 
+    - rbx-18mode
+notifications:
+  email:
+    - mbj@seonic.net

data/Changelog.md

@@ -0,0 +1,3 @@
+# v0.0.1 2012-03-01
+
+First public release!

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'devtools',            :git => 'https://github.com/datamapper/devtools.git'
+eval File.read('Gemfile.devtools')

data/Gemfile.devtools

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.0.3'
+  gem 'rspec', '~> 2.13.0'
+  gem 'yard',  '~> 0.8.5'
+end
+
+group :yard do
+  gem 'kramdown', '~> 0.14.2'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.6.2'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 2.4.1'
+
+  # file system change event handling
+  gem 'rb-fchange', '~> 0.0.6', :require => false
+  gem 'rb-fsevent', '~> 0.9.3', :require => false
+  gem 'rb-inotify', '~> 0.9.0', :require => false
+
+  gem 'listen', '~> 0.7.3'
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', :require => false
+  gem 'rb-notifu',               '~> 0.0.4', :require => false
+  gem 'terminal-notifier-guard', '~> 1.5.3', :require => false
+end
+
+group :metrics do
+  gem 'flay',            '~> 2.1.0'
+  gem 'flog',            '~> 3.2.2'
+  gem 'reek',            '~> 1.3.1'
+  gem 'metric_fu-roodi', '~> 2.2.1'
+  gem 'yardstick',       '~> 0.9.3'
+
+  platforms :ruby_18, :ruby_19 do
+    # this indirectly depends on ffi which does not build on ruby-head
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_19, :rbx do
+    gem 'mutant', '~> 0.2.20'
+  end
+
+  platforms :mri_19 do
+    gem 'simplecov', '~> 0.7.1'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.2'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.2'
+  end
+end

data/README.md

@@ -0,0 +1,39 @@
+HTML
+====
+
+[![Build Status](https://secure.travis-ci.org/mbj/html.png?branch=master)](http://travis-ci.org/mbj/html)
+[![Dependency Status](https://gemnasium.com/mbj/html.png)](https://gemnasium.com/mbj/html)
+[![Code Climate](https://codeclimate.com/github/mbj/html.png)](https://codeclimate.com/github/mbj/html)
+
+A library to generate html fragments. 
+
+Installation
+------------
+
+Install the gem `html` via your preferred method.
+
+Examples
+--------
+
+Soon.
+
+Credits
+-------
+
+* [Markus Schirp (mbj)](https://github.com/mbj) Author
+
+Contributing
+-------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile or version
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+License
+-------
+
+This gem is published under the MIT license. See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'devtools'
+Devtools.init_rake_tasks

data/TODO

@@ -0,0 +1,2 @@
+* Unit spec coverage
+* Add builder methods for all common html tags

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 14
+total_score: 26

data/config/flog.yml

@@ -0,0 +1,3 @@
+---
+threshold: 6.9
+total_score: 35

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: html
+namespace: HTML

data/config/roodi.yml

@@ -0,0 +1,18 @@
+---
+AbcMetricMethodCheck:            { score: 10.3 }
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 293 }
+ClassNameCheck:                  { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+ClassVariableCheck:              { }
+CyclomaticComplexityBlockCheck:  { complexity: 2 }
+CyclomaticComplexityMethodCheck: { complexity: 4 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+# TODO: decrease line_count to 5 to 10
+MethodLineCountCheck:            { line_count: 14 }
+MethodNameCheck:                 { pattern: !ruby/regexp '/\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|[+*&|-])\z/' }
+ModuleLineCountCheck:            { line_count: 295 }
+ModuleNameCheck:                 { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+# TODO: decrease parameter_count to 2 or less
+ParameterNumberCheck:            { parameter_count: 3 }

data/config/site.reek

@@ -0,0 +1,93 @@
+---
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 10
+  exclude: []
+  enabled: true
+  max_instance_variables: 2
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 2
+  exclude: 
+  - HTML#self.content_tag
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: []
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude:
+  - Adamantium::ModuleMethods#define_memoize_method # 2 levels
+  enabled: true
+  max_allowed_nesting: 1
+LongMethod:
+  max_statements: 7  # TODO: decrease max_statements to 5 or less
+  exclude: []
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude: []
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 1
+  exclude: []
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  exclude: []
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: []
+  enabled: true
+  max_copies: 1
+  min_clump_size: 3
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 1
+  exclude: []
+  enabled: true

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/html.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name        = 'html'
+  gem.version     = '0.0.1'
+  gem.authors     = [ 'Markus Schirp' ]
+  gem.email       = [ 'mbj@seonic.net' ]
+  gem.description = 'Because HTML is not a String'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/mbj/html'
+
+  gem.require_paths    = [ 'lib' ]
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- spec`.split("\n")
+  gem.extra_rdoc_files = %w[TODO]
+
+  gem.add_runtime_dependency('backports',  [ '~> 3.0', '>= 3.0.3' ])
+  gem.add_runtime_dependency('adamantium',   '~> 0.0.7')
+  gem.add_runtime_dependency('equalizer',    '~> 0.0.5')
+end

data/lib/html.rb

@@ -0,0 +1,117 @@
+#encoding: utf-8
+require 'backports'
+require 'adamantium'
+require 'equalizer'
+require 'ice_nine'
+
+# Library namespace
+module HTML
+
+  CONTENT_TAGS = IceNine.deep_freeze(%w(
+    a abbr address article aside audio b bdi bdo blockquote
+    body button canvas caption cite code col colgroup data 
+    dd del details dfn div dl dt em embed eventsource fieldset 
+    fieldsource figcaption figure footer form h1 h2 h3 h4 h5 h6 
+    head header hgroup html i iframe ins kbd label legend li link 
+    mark menu nav noscript object ol optgroup option output p pre 
+    q ruby rp rt s samp script section select small span strong 
+    style sub summary sup table tbody textarea tfoot th thead time 
+    title td tr ul var video
+  ))
+
+  NOCONTENT_TAGS = IceNine.deep_freeze(%w(
+    area br command hr img input keygen map meta meter progress
+    param source track wbr
+  ))
+
+  # Join html compoinents
+  #
+  # @param [Enumerable<#to_s>] components
+  #
+  # @return [HTML::Fragment]
+  #
+  # @api private
+  #
+  def self.join(components)
+    contents = components.map do |component| 
+      Fragment.build(component)
+    end
+    Fragment.new(contents.join)
+  end
+
+
+  # Escape html
+  #
+  # @param [String] text
+  #
+  # @return [String]
+  #
+  # @api private
+  #
+  def self.escape(text)
+    text.gsub(
+      /[><"]/,
+      '>' => '&lt;',
+      '<' => '&gt;',
+      '"' => '&amp;'
+    )
+  end
+  
+  CONTENT_TAGS.each do |name|
+    class_eval(<<-RUBY, __FILE__, __LINE__)
+      def self.#{name}(*args)
+        content_tag(:#{name}, *args)
+      end
+    RUBY
+  end
+
+  NOCONTENT_TAGS.each do |name|
+    class_eval(<<-RUBY, __FILE__, __LINE__)
+      def self.#{name}(*args)
+        tag(:#{name}, *args)
+      end
+    RUBY
+  end
+
+  # Create contentless html tag
+  #
+  # @param [#to_str] type
+  # @param [Hash] attributes
+  #
+  # @return [Fragment]
+  #
+  # @api private
+  #
+  def self.tag(type, attributes={})
+    Fragment.new("<#{type}#{attributes(attributes)}/>")
+  end
+
+  # Create content tag 
+  #
+  # @param [#to_str] type
+  # @param [String] content
+  #
+  # @return [Fragment]
+  #
+  # @api private
+  #
+  def self.content_tag(type, content, attributes={})
+    Fragment.new("<#{type}#{attributes(attributes)}>#{Fragment.build(content).to_s}</#{type}>")
+  end
+
+  # Create html attributes
+  #
+  # @param [Hash] attributes
+  #
+  # @return [String]
+  #
+  # @api private
+  #
+  def self.attributes(attributes)
+    attributes.map do |key, value|
+      %Q{ #{key.to_s}="#{escape(value.to_s)}"} 
+    end.join
+  end
+end
+
+require 'html/fragment'

data/lib/html/fragment.rb

@@ -0,0 +1,54 @@
+module HTML
+
+  # An html fragment
+  class Fragment
+    include Adamantium, Equalizer.new(:content)
+
+    # Return contents of fragment
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    attr_reader :content
+
+    # Initialize object
+    #
+    # @param [String] string
+    #
+    # @return [undefined]
+    #
+    # @api private
+    #
+    def initialize(string)
+      @content = string
+    end
+
+    # Return string 
+    #
+    # FIXME: This will be removed once I have my own templating language.
+    #
+    # @return [String]
+    #
+    alias_method :to_s, :content
+
+    # Create new fragment
+    #
+    # @param [String,Fragment] input
+    #  
+    # @return [Fragment]
+    #
+    # @api private
+    #   
+    def self.build(input)
+      if input.kind_of?(self)
+        input
+      else
+        new(HTML.escape(input))
+      end
+    end
+
+    EMPTY = new('')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'html'
+require 'rspec'
+
+# require spec support files and shared behavior
+Dir[File.expand_path('../{support,shared}/**/*.rb', __FILE__)].each { |f| require f }
+
+
+RSpec.configure do |config|
+end

data/spec/unit/html/class_methods/attributes_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe HTML, '.attributes' do
+  let(:object) { described_class }
+
+  subject { object.attributes(input) }
+
+  examples = {
+    { 'foo'  => 'bar' } => ' foo="bar"',
+    { 'foo'  => '"'   } => ' foo="&"',
+    { :class => :baz  } => ' class="baz"'
+  }
+
+  examples.each do |input, expectation|
+    context "with #{input} as input" do
+      let(:input) { input }
+      it { should eql(expectation) }
+    end
+  end
+end

data/spec/unit/html/class_methods/content_tag_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe HTML, '.tag' do
+  let(:object) { described_class }
+
+  subject { object.content_tag(*arguments) }
+
+  let(:name)    { 'foo'     }
+  let(:content) { 'content' }
+
+  context 'without attributes' do
+    let(:arguments) { [ name, content ] }
+
+    it 'should return html fragment' do
+      should eql(HTML::Fragment.new('<foo>content</foo>'))
+    end
+  end
+
+  context 'with attributes' do
+    let(:arguments) { [ name, content, attributes ] }
+
+    context 'empty' do
+      let(:attributes) { {} }
+
+      it 'should return html fragment' do
+        should eql(HTML::Fragment.new('<foo>content</foo>'))
+      end
+    end
+
+    context 'non empty' do
+      let(:attributes) { { :foo => :bar } }
+
+      it 'should return html fragment' do
+        should eql(HTML::Fragment.new('<foo foo="bar">content</foo>'))
+      end
+    end
+  end
+end

data/spec/unit/html/class_methods/content_tags_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe HTML, 'content tags' do
+  let(:object) { described_class }
+
+  HTML::CONTENT_TAGS.each do |name|
+    it "should render #{name} correcty" do
+      object.public_send(name, 'content', {:foo => :bar}).content.should eql(%Q(<#{name} foo="bar">content</#{name}>))
+    end
+  end
+end

data/spec/unit/html/class_methods/escape_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe HTML, '.escape' do
+  let(:object) { described_class }
+
+  subject { object.escape(string) }
+
+  examples = {
+    'foo' => 'foo',
+    '<>'  => '&gt;&lt;',
+    '<foo>'  => '&gt;foo&lt;',
+    '<foo bar="baz">'  => '&gt;foo bar=&amp;baz&amp;&lt;'
+  }
+
+  examples.each do |input, expectation|
+    context "with #{input} as input" do
+      let(:string) { input }
+      it { should eql(expectation) }
+    end
+  end
+end

data/spec/unit/html/class_methods/join_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe HTML, '.join' do
+  let(:object) { described_class }
+
+  subject { object.join(input) }
+
+  examples = {
+    []                                      => '',
+    ['foo']                                 => 'foo',
+    ['foo',   'bar']                        => 'foobar',
+    ['foo',   HTML::Fragment.new('bar')]    => 'foobar',
+    ['foo',   HTML::Fragment.new('<bar>')]  => 'foo<bar>',
+    ['<foo>', HTML::Fragment.new('<bar>')]  => '&gt;foo&lt;<bar>',
+  }
+
+  examples.each do |input, expectation|
+    context "with #{input.inspect} as input" do
+      let(:input) { input }
+      it { should eql(HTML::Fragment.new(expectation)) }
+    end
+  end
+end

data/spec/unit/html/class_methods/nocontent_tags_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe HTML, 'nocontent tags' do
+  let(:object) { described_class }
+
+  HTML::NOCONTENT_TAGS.each do |name|
+    it "should render #{name} correcty" do
+      object.public_send(name, :foo => :bar).content.should eql(%Q(<#{name} foo="bar"/>))
+    end
+  end
+end

data/spec/unit/html/class_methods/tag_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe HTML, '.tag' do
+  let(:object) { described_class }
+
+  subject { object.tag(*arguments) }
+
+  let(:name) { 'foo' }
+
+  context 'without attributes' do
+    let(:arguments) { [ name ] }
+
+    it 'should return html fragment' do
+      should eql(HTML::Fragment.new('<foo/>'))
+    end
+  end
+
+  context 'with attributes' do
+    let(:arguments) { [ name, attributes ] }
+
+    context 'empty' do
+      let(:attributes) { {} }
+
+      it 'should return html fragment' do
+        should eql(HTML::Fragment.new('<foo/>'))
+      end
+    end
+
+    context 'non empty' do
+      let(:attributes) { { :foo => :bar } }
+
+      it 'should return html fragment' do
+        should eql(HTML::Fragment.new('<foo foo="bar"/>'))
+      end
+    end
+  end
+end

data/spec/unit/html/fragment/class_methods/build_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe HTML::Fragment, '.build' do
+  let(:object) { described_class }
+  subject { object.build(input) }
+
+  context 'when input is string' do
+    let(:input) { '<foo>' }
+
+    it 'should store escaped string' do
+      subject.content.should eql('&gt;foo&lt;')
+    end
+
+    it { should be_a(described_class) }
+  end
+
+  context 'when input is HTML::Fragment' do
+    let(:input) { HTML::Fragment.new(mock) }
+
+    it 'should be input' do
+      should be(input)
+    end
+  end
+end

data/spec/unit/html/fragment/initialize_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+# NOTE: This will move to class_methods/new_spec.rb with mutant-0.3.0!
+describe HTML::Fragment, '#initialize' do
+  let(:object) { described_class }
+
+  subject { object.new(input) }
+
+  let(:input) { Object.new }
+
+  its(:content) { should eql(input) }
+
+  it 'should freeze input' do
+    subject
+    input.frozen?.should be(true)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: html
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Markus Schirp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: adamantium
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: equalizer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+description: Because HTML is not a String
+email:
+- mbj@seonic.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- TODO
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Changelog.md
+- Gemfile
+- Gemfile.devtools
+- README.md
+- Rakefile
+- TODO
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/roodi.yml
+- config/site.reek
+- config/yardstick.yml
+- html.gemspec
+- lib/html.rb
+- lib/html/fragment.rb
+- spec/spec_helper.rb
+- spec/unit/html/class_methods/attributes_spec.rb
+- spec/unit/html/class_methods/content_tag_spec.rb
+- spec/unit/html/class_methods/content_tags_spec.rb
+- spec/unit/html/class_methods/escape_spec.rb
+- spec/unit/html/class_methods/join_spec.rb
+- spec/unit/html/class_methods/nocontent_tags_spec.rb
+- spec/unit/html/class_methods/tag_spec.rb
+- spec/unit/html/fragment/class_methods/build_spec.rb
+- spec/unit/html/fragment/initialize_spec.rb
+homepage: https://github.com/mbj/html
+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.8.23
+signing_key: 
+specification_version: 3
+summary: Because HTML is not a String
+test_files:
+- spec/spec_helper.rb
+- spec/unit/html/class_methods/attributes_spec.rb
+- spec/unit/html/class_methods/content_tag_spec.rb
+- spec/unit/html/class_methods/content_tags_spec.rb
+- spec/unit/html/class_methods/escape_spec.rb
+- spec/unit/html/class_methods/join_spec.rb
+- spec/unit/html/class_methods/nocontent_tags_spec.rb
+- spec/unit/html/class_methods/tag_spec.rb
+- spec/unit/html/fragment/class_methods/build_spec.rb
+- spec/unit/html/fragment/initialize_spec.rb
+has_rdoc: