element_factory 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in element_factory.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/element_factory/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robert Ross
+
+MIT License
+
+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,29 @@
+# Element Factory
+
+Element Factory is a more object oriented approach to generating markup in Ruby. No DSL to learn, just objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'element_factory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install element_factory
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/element_factory.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'element_factory/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "element_factory"
+  gem.version       = ElementFactory::VERSION
+  gem.authors       = ["Robert Ross"]
+  gem.email         = ["robert@creativequeries.com"]
+  gem.description   = %q{Element Factory is a more object oriented approach to generating markup.}
+  gem.summary       = %q{Element Factory isn't a fancy DSL, it's Ruby, it's friendly, it's neat.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('rspec', '~> 2.11')
+  gem.add_development_dependency('simplecov')
+  gem.add_development_dependency('awesome_print')
+  gem.add_development_dependency('nokogiri')
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('guard-rspec')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rb-fsevent', '~> 0.9.1')
+
+  gem.add_dependency('activesupport', '~> 3.2.11')
+end

data/lib/element_factory.rb

@@ -0,0 +1,14 @@
+require "element_factory/version"
+require "active_support/core_ext/string"
+require "active_support/core_ext/hash"
+
+require "erb"
+
+module ElementFactory
+  autoload :Element, "element_factory/element"
+  autoload :HtmlAttributes, "element_factory/html_attributes"
+
+  module Elements
+    autoload :TextElement, "element_factory/elements/text_element"
+  end
+end

data/lib/element_factory/element.rb

@@ -0,0 +1,62 @@
+module ElementFactory
+  class Element
+    attr_accessor :name, :attributes
+
+    def initialize(name, attributes_or_string=nil)
+      @name = name.to_s
+      @attributes = coerce_attributes(attributes_or_string)
+
+      if attributes[:text].is_a?(String)
+        add_child Elements::TextElement.new(attributes[:text])
+      end
+    end
+
+    def to_html
+      tag_start + tag_middle + tag_end
+    end
+    alias to_s to_html
+
+    def html_attributes
+      HtmlAttributes.new(self.attributes.dup)
+    end
+
+    def add_child(child)
+      children << child
+    end
+    alias << add_child
+
+    def add_children(children)
+      children.each {|child| add_child(child) }
+    end
+
+    def children
+      @children ||= []
+    end
+
+    def tag_start
+      tag_attributes = attributes.any?? " #{html_attributes}" : ""
+      %|<%s%s>| % [name, tag_attributes]
+    end
+
+    def tag_end
+      %|</%s>| % name
+    end
+
+    def tag_middle
+      children.map(&:to_html).join
+    end
+
+    private
+
+    def coerce_attributes(attributes)
+      case attributes
+      when String
+        {text: attributes}
+      when Hash
+        attributes
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/element_factory/elements/text_element.rb

@@ -0,0 +1,15 @@
+module ElementFactory
+  module Elements
+    class TextElement
+      attr_accessor :string
+
+      def initialize(string)
+        @string = string
+      end
+
+      def to_html
+        ERB::Util.h(string)
+      end
+    end
+  end
+end

data/lib/element_factory/html_attributes.rb

@@ -0,0 +1,41 @@
+module ElementFactory
+  class HtmlAttributes
+    BOOLEAN_ATTRIBUTES = %w(disabled readonly multiple checked autobuffer
+                           autoplay controls loop selected hidden scoped async
+                           defer reversed ismap seemless muted required
+                           autofocus novalidate formnovalidate open pubdate)
+
+    attr_accessor :attributes
+
+    def initialize(attributes={})
+      @attributes = attributes
+    end
+
+    def data_attributes
+      (attributes[:data] || {}).each_with_object({}) do |(key,value), new_attributes|
+        new_attributes["data-#{key.to_s.dasherize}"] = value
+      end
+    end
+
+    def boolean_attributes
+      attributes.each_with_object({}) do |(key, value), new_attributes|
+        next unless BOOLEAN_ATTRIBUTES.include?(key.to_s)
+        new_attributes[key] = key.to_s
+      end
+    end
+
+    def to_s
+      attributes = self.attributes
+        .merge(data_attributes)
+        .merge(boolean_attributes)
+        .stringify_keys
+
+      attributes.delete("data")
+
+      attributes.keys.sort.map do |attribute|
+        value = ERB::Util.html_escape(attributes[attribute])
+        %(#{attribute}="#{value}")
+      end.join(" ").html_safe
+    end
+  end
+end

data/lib/element_factory/version.rb

@@ -0,0 +1,3 @@
+module ElementFactory
+  VERSION = "0.1.0"
+end

data/spec/lib/element_spec.rb

@@ -0,0 +1,108 @@
+require "spec_helper"
+
+describe ElementFactory::Element do
+  subject { described_class.new(:table) }
+
+  context "initializes" do
+    subject { described_class }
+
+    specify "with a tag" do
+      tag = subject.new(:table)
+      expect(tag.name).to eq("table")
+    end
+
+    specify "with attributes" do
+      tag = subject.new(:table, {class: "something"})
+      expect(tag.attributes).to have_key :class
+      expect(tag.attributes[:class]).to eq("something")
+    end
+
+    specify "with a string" do
+      tag = subject.new(:span, "Some text")
+      expect(tag.attributes[:text]).to eq("Some text")
+    end
+
+    specify "with a string adds a child" do
+      tag = subject.new(:span, "Some text")
+      expect(tag).to have(1).children
+    end
+  end
+
+  context "tag pieces" do
+    subject { described_class.new(:table) }
+
+    context ".tag_start" do
+      it "returns correct markup" do
+        expect(subject.tag_start).to eq("<table>")
+      end
+
+      it "returns with attributes" do
+        subject.attributes[:class] = "something"
+        expect(subject.tag_start).to eq("<table class=\"something\">")
+      end
+    end
+  end
+
+  context ".html_attributes" do
+    let(:attributes) { Hash.new }
+    subject { described_class.new(:table) }
+    before do
+      ElementFactory::HtmlAttributes.
+        should_receive(:new).
+        and_return(attributes)
+    end
+
+    specify "are delegated" do
+      expect(subject.html_attributes).to be attributes
+    end
+  end
+
+  context ".to_html" do
+    subject { described_class.new(:table, class: "a-class") }
+
+    it "returns the tag" do
+      expect(subject.to_html).to match /<table(.*)>(.*)<\/table>/
+    end
+
+    it "returns the tag with attributes" do
+      element = to_element(subject.to_html, "table")
+      expect(element[:class]).to eq("a-class")
+    end
+
+    context "with children" do
+      let(:child) { described_class.new(:tr) }
+      before { subject << child }
+
+      it "recusively renders all children of the node" do
+        element = to_element(subject.to_html, "table")
+        expect(element.at_css("tr")).to be_present
+      end
+    end
+
+    context "with string children" do
+      subject { described_class.new(:span, "Text") }
+
+      it "includes a string node" do
+        element = to_element(subject.to_html, "span")
+        expect(element.text).to eq("Text")
+      end
+    end
+  end
+
+  context "children" do
+    let(:child) { described_class.new(:tr) }
+    let(:children) { [described_class.new(:td),described_class.new(:td)] }
+
+    context ".add_child" do
+      it "adds a child element to the list" do
+        expect { subject.add_child(child) }.to change(subject.children, :size).by(1)
+      end
+    end
+
+    context ".add_children" do
+      it "adds multiple chilren" do
+        expect { subject.add_children(children) }.to change(subject.children, :size).by(2)
+      end
+    end
+  end
+end

data/spec/lib/elements/text_element_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe ElementFactory::Elements::TextElement do
+  subject { described_class.new("Some text") }
+
+  context ".to_html" do
+    it "returns the text" do
+      expect(subject.to_html).to eq("Some text")
+    end
+
+    it "escapes naughty things" do
+      subject.string = "Some & Thing"
+      expect(subject.to_html).to eq("Some & Thing")
+    end
+  end
+end

data/spec/lib/html_attributes_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe ElementFactory::HtmlAttributes  do
+  let(:attributes) { Hash.new }
+  subject { described_class.new(attributes) }
+
+  it "assigns attributes" do
+    expect(subject.attributes).to eq(attributes)
+  end
+
+  context ".data_attributes" do
+    it "returns keys with data prefix" do
+      attributes[:data] = {key1: "value1"}
+      expect(subject.data_attributes).to have_key "data-key1"
+    end
+
+    it "dasherizes the keys" do
+      attributes[:data] = {key_1: "value"}
+      expect(subject.data_attributes).to have_key "data-key-1"
+    end
+  end
+
+  context ".boolean_attributes" do
+    it "returns itself if true" do
+      attributes[:disabled] = true
+      expect(subject.boolean_attributes[:disabled]).to eq("disabled")
+    end
+  end
+
+  context ".to_s" do
+    it "returns attributes in markup form" do
+      attributes[:class] = "a-class"
+      attributes[:data] = {key: "val"}
+      attributes[:disabled] = true
+
+      expect(subject.to_s).to eq(%(class="a-class" data-key="val" disabled="disabled"))
+    end
+
+    it "escapes attribute values" do
+      attributes[:class] = "<lawl> \""
+      expect(subject.to_s).to eq(%(class="&lt;lawl&gt; &quot;"))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "element_factory"
+Dir['./spec/support/**/*.rb'].each {|f| require f }
+
+require "awesome_print"
+require "nokogiri"
+require "pry"
+require "active_support/core_ext/class"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  config.include ElementHelpers
+end

data/spec/support/element_helpers.rb

@@ -0,0 +1,5 @@
+module ElementHelpers
+  def to_element(string, type)
+    Nokogiri::HTML(string).at_xpath(".//#{type}")
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: element_factory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+description: Element Factory is a more object oriented approach to generating markup.
+email:
+- robert@creativequeries.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- element_factory.gemspec
+- lib/element_factory.rb
+- lib/element_factory/element.rb
+- lib/element_factory/elements/text_element.rb
+- lib/element_factory/html_attributes.rb
+- lib/element_factory/version.rb
+- spec/lib/element_spec.rb
+- spec/lib/elements/text_element_spec.rb
+- spec/lib/html_attributes_spec.rb
+- spec/spec_helper.rb
+- spec/support/element_helpers.rb
+homepage: ''
+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: Element Factory isn't a fancy DSL, it's Ruby, it's friendly, it's neat.
+test_files:
+- spec/lib/element_spec.rb
+- spec/lib/elements/text_element_spec.rb
+- spec/lib/html_attributes_spec.rb
+- spec/spec_helper.rb
+- spec/support/element_helpers.rb
+has_rdoc: