html_attributes 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    html_attributes (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  html_attributes!
+  rspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 (Jan Sebastian Siwy, Martin Spickermann, Henning Staib)
+
+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,70 @@
+# HTML Attributes
+
+HTML Attributes provide helper methods to convert arrays and hashes to valid html attributes. If this gem is included in a Ruby on Rails project it will extend the view helpers to pass arrays or hashes for class or style attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "html_attributes"
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install html_attributes
+
+## Usage
+
+    { :first => true, :second => false, :third => true }.to_class_attr
+    => "first third"
+
+    [:first, :second, :third].to_class_attr
+    => "first second third"
+
+    { :margin => { :top => "10px", :left => "5px" }, :font_size => "12pt" }.to_style_attr
+    => "margin-top: 10px; margin-left: 5px; font-size: 12pt;"
+
+    ["padding-top: 8px", "padding-right: 15px", "font-size: 12pt"].to_style_attr
+    => "padding-top: 8px; padding-right: 15px; font-size: 12pt;"
+
+If gem is included in a Ruby on Rails project the view helpers are extended:
+
+    content_tag(:div, :class => { :first => true, :second => false, :third => true }) { ... }
+    => <div class="first third">...</div>
+
+    content_tag(:div, :style => { :margin => { :top => "10px", :left => "5px" }, :font_size => "12pt" })  { ... }
+    => <div style="margin-top: 10px; margin-left: 5px; font-size: 12pt;">...</div>
+
+## Extension
+
+To support additional conversions of arrays, hashed, or any other objects to HTML attributes when using the Rails view helpers a `#to_#{attribute_name}_attr` method can be implemented.
+
+    class MyImageClass
+
+      # initializer ...
+
+      def to_width_attr
+        @width
+      end
+
+      def to_height_attr
+        @height
+      end
+
+    end
+
+    img = MyImageClass.new
+    tag(:img, :width => img, :height => img)
+    => <img width="30" height="20" />
+
+## Test
+
+Checkout and cd into the repository and then run:
+
+    $ bundle install
+    $ bundle exec rspec spec
+
+Copyright (c) 2012 Jan Sebastian Siwy, Martin Spickermann, Henning Staib, released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/html_attributes.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/html_attributes/version", __FILE__)
+
+Gem::Specification.new do |gem|
+
+  gem.name          = "html_attributes"
+  gem.authors       = ["Jan Sebastian Siwy", "Martin Spickermann", "Henning Staib"]
+  gem.email         = ["github@henning-staib.de"]
+  gem.summary       = %q{html_attributes provide helper methods to convert arrays
+                          and hashes to valid html attributes.}
+  gem.description   = %q{html_attributes provide helper methods to convert arrays
+                          and hashes to valid html attributes.}
+  gem.homepage      = "https://github.com/serevaris/html_attributes"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.require_paths = ["lib"]
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.version       = HtmlAttributes::VERSION
+  gem.platform      = Gem::Platform::RUBY
+
+  gem.add_development_dependency "rspec"
+
+end

data/lib/html_attributes/array.rb

@@ -0,0 +1,45 @@
+class Array
+
+  # Returns a string representing the value of a HTML class attribute or nil (if empty).
+  #
+  # ==== Examples
+  #
+  #   ["post", "comment", "spam"].to_class_attr
+  #   # => "post comment spam"
+  #
+  #   [].to_class_attr
+  #   # => nil
+  #
+  def to_class_attr
+    empty? ? nil : join(' ')
+  end
+
+  # Returns a string representing the value of a HTML rel attribute or nil (if empty).
+  #
+  # ==== Examples
+  #
+  #   ["nofollow", "me"].to_rel_attr
+  #   # => "nofollow me"
+  #
+  #   [].to_class_attr
+  #   # => nil
+  #
+  def to_rel_attr
+    empty? ? nil : join(' ')
+  end
+
+  # Returns a string representing the value of a HTML style attribute or nil (if empty).
+  #
+  # ==== Examples
+  #
+  #   ["padding-top: 8px", "padding-right: 15px", "font-size: 12pt"].to_style_attr
+  #   # => "padding-top: 8px; padding-right: 15px; font-size: 12pt;"
+  #
+  #   [].to_style_attr
+  #   # => nil
+  #
+  def to_style_attr
+    empty? ? nil : join('; ').concat(';')
+  end
+
+end

data/lib/html_attributes/hash.rb

@@ -0,0 +1,98 @@
+class Hash
+
+  # Returns a string containing the class names whose conditions are neighter <tt>false</tt> nor <tt>nil</tt>,
+  # or returns <tt>nil</tt> if no class names remains.
+  #
+  # ==== Examples
+  #
+  #   { :first => true, :second => false, :third => true }.to_class_attr
+  #   # => "first third"
+  #
+  #   { :foo => false, :bar => false }.to_class_attr
+  #   # => nil
+  #
+  def to_class_attr
+    self.select { |klass, condition| condition }.           # remove classes with nil or false condition
+         map { |elem| elem.first.to_s }.                    # throw condition away
+         sort.                                              # sort alphabetically
+         to_class_attr                                      # join with ' ' or return nil if empty
+  end
+
+  # Returns a string containing the rel values whose conditions are neighter <tt>false</tt> nor <tt>nil</tt>,
+  # or returns <tt>nil</tt> if no rel values remains.
+  #
+  # ==== Examples
+  #
+  #   { :nofollow => true, :other => false, :me => true }.to_rel_attr
+  #   # => "nofollow me"
+  #
+  #   { :foo => false, :bar => false }.to_rel_attr
+  #   # => nil
+  #
+  def to_rel_attr
+    self.select { |klass, condition| condition }.           # remove rel values with nil or false condition
+         map { |elem| elem.first.to_s }.                    # throw condition away
+         sort.                                              # sort alphabetically
+         to_rel_attr                                        # join with ' ' or return nil if empty
+  end
+
+  # Returns a string containing a style attribute, or returns <tt>nil</tt> if no values remains.
+  #
+  # ==== Examples
+  #
+  #   { :padding => { :top => "8px", :right => "15px" }, :font_size => "12pt" }.to_style_attr
+  #   # => "font-size: 12pt; padding-right: 15px; padding-top: 8px;"
+  #
+  #   visible = true
+  #   { :display => visible ? nil : 'none' }.to_style_attr
+  #   # => nil
+  #
+  def to_style_attr
+    self.flatten { |keys| keys.join('_').gsub('_', '-') }.  # build CSS like key names
+         select { |key, value| !value.nil? }.               # remove properties with nil value
+         map { |key, value| "#{key}: #{value}" }.           # build property
+         sort.                                              # sort alphabetically
+         to_style_attr                                      # join with '; ' or return nil if empty
+  end
+
+  # Returns a new hash flatting the values (recursively), i.e. if a value of <tt>self</tt> is a hash again
+  # 1) the keys are build by combining the key of <tt>self</tt> (the one to access that hash value) with the
+  # keys of that hash;
+  # 2) the values are the values of that hash.
+  #
+  # You can either specify a seperator to to build the keys joining them, or a block which gets an array of keys
+  # and returns the new key.
+  #
+  # ==== Examples
+  #
+  #   styles = { :padding => { :top => "8px", :right => "15px" }, :font_size => "12pt" }
+  #
+  #   styles.flatten("_")
+  #   # => { "padding_top" => "8px", "padding_right" => "15px", "font_size" => "12pt" }
+  #
+  #   styles.flatten { |keys| keys.join('-').gsub('_', '-') }
+  #   # => { "padding-top" => "8px", "padding-right" => "15px", "font-size" => "12pt" }
+  #
+  def flatten(sep = $,, prefix_keys = [], &block) # :nodoc:
+    hash = self.class.new
+    self.each do |key, value|
+      prefix_keys.push(key)
+      case value
+      when ::Hash
+        value.flatten(sep, prefix_keys, &block).each do |k, v|
+          hash[k] = v
+        end
+      else
+        hash[block_given? ? yield(prefix_keys) : prefix_keys.join(sep)] = value
+      end
+      prefix_keys.pop
+    end
+    hash
+  end
+
+  # Flattens <tt>self</tt> in place.
+  def flatten!(sep = $,, prefix_keys = [], &block) # :nodoc:
+    replace(flatten(sep, prefix_keys, &block))
+  end
+
+end

data/lib/html_attributes/rails/tag_helper.rb

@@ -0,0 +1,21 @@
+module HtmlAttributes #:nodoc:
+
+  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).to_set
+
+  module TagHelper #:nodoc:
+
+    def self.included(base) #:nodoc:
+      base.alias_method_chain :tag_options, :html_attributes
+    end
+
+    def tag_options_with_html_attributes(options, escape = true) #:nodoc:
+      options = ::Hash[*options.map { |key, value| [key, value.respond_to?("to_#{key}_attr") ? value.send("to_#{key}_attr") : value] }.flatten] unless options.blank?
+      tag_options_without_html_attributes(options, escape)
+    end
+
+  end
+
+end

data/lib/html_attributes/version.rb

@@ -0,0 +1,12 @@
+module HtmlAttributes
+  VERSION = "0.1.0"
+
+  module Version
+    version = VERSION.to_s.split(".").map { |i| i.to_i }
+    MAJOR = version[0]
+    MINOR = version[1]
+    PATCH = version[2]
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+
+end

data/lib/html_attributes.rb

@@ -0,0 +1,15 @@
+require "html_attributes/array"
+require "html_attributes/hash"
+
+if defined?(ActionView::Helpers::TagHelper)
+
+  require "html_attributes/rails/tag_helper"
+
+  ActionView::Helpers::TagHelper.module_eval do
+    include HtmlAttributes::TagHelper
+  end
+
+  ActionView::Helpers::TagHelper::BOOLEAN_ATTRIBUTES.merge(::HtmlAttributes::BOOLEAN_ATTRIBUTES)
+  ActionView::Helpers::TagHelper::BOOLEAN_ATTRIBUTES.merge(ActionView::Helpers::TagHelper::BOOLEAN_ATTRIBUTES.map(&:to_sym))
+
+end

data/spec/html_attributes/array_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe Array do
+
+  describe "#to_class_attr" do
+
+    it "should return nil if array is empty" do
+      classes = []
+      classes.to_class_attr.should be_nil
+    end
+
+    it "should return a space separated string if array contains strings" do
+      classes = ["first", "second", "third"]
+      classes.to_class_attr.should eql("first second third")
+    end
+
+    it "should preserve existing spaces" do
+      classes = ["first", "second third", "forth"]
+      classes.to_class_attr.should eql("first second third forth")
+    end
+
+  end
+
+  describe "#to_style_attr" do
+
+    it "should return nil if array is empty" do
+      styles = []
+      styles.to_style_attr.should be_nil
+    end
+
+    it "should return a semicolon separated string if array contains strings" do
+      styles = ["padding-top: 8px", "padding-right: 15px", "font-size: 12pt"]
+      styles.to_style_attr.should eql("padding-top: 8px; padding-right: 15px; font-size: 12pt;")
+    end
+
+    it "should preserve existing semicolon" do
+      styles = ["padding-top: 8px; padding-right: 15px", "font-size: 12pt"]
+      styles.to_style_attr.should eql("padding-top: 8px; padding-right: 15px; font-size: 12pt;")
+    end
+
+  end
+
+end

data/spec/html_attributes/hash_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+describe Hash do
+
+  describe "#to_class_attr" do
+
+    it "should return nil if hash is empty" do
+      classes = {}
+      classes.to_class_attr.should be_nil
+    end
+
+    it "should return nil if hash only contains false values" do
+      classes = { :foo => false, :bar => false }
+      classes.to_class_attr.should be_nil
+    end
+
+    it "should return space separated string" do
+      classes = { :first => true, :second => true, :third => true }
+      classes.to_class_attr.should eql("first second third")
+    end
+
+    it "should return space separated string only for true values" do
+      classes = { :first => true, :second => false, :third => true }
+      classes.to_class_attr.should eql("first third")
+    end
+
+  end
+
+  describe "#to_style_attr" do
+
+    it "should return nil if hash is empty" do
+      styles = {}
+      styles.to_style_attr.should be_nil
+    end
+
+    it "should return nil if hash only contains nil values" do
+      styles = { :display => nil }
+      styles.to_style_attr.should be_nil
+    end
+
+    it "should return semicolon separated string" do
+      styles = { :display => "none", :visibility => "hidden" }
+      styles.to_style_attr.should eql("display: none; visibility: hidden;")
+    end
+
+    it "should replace '_' in keys with '-'" do
+      styles = { :font_size => "12pt" }
+      styles.to_style_attr.should eql("font-size: 12pt;")
+    end
+
+    it "should flatten hash to construct style statements" do
+      styles = { :padding => { :top => "8px", :right => "15px" }, :font_size => "12pt" }
+      styles.to_style_attr.should eql("font-size: 12pt; padding-right: 15px; padding-top: 8px;")
+    end
+
+  end
+
+  describe "#flatten" do
+
+    it "should do nothing for emtpy hash" do
+      {}.flatten.should eql({})
+    end
+
+    it "should do nothing for unnested hash" do
+      { "padding" => "8px", "font_size" => "12pt" }.flatten.should eql({ "padding" => "8px", "font_size" => "12pt" })
+    end
+
+    it "should convert symbolized keys to stringified keys" do
+      { :padding => "8px", :font_size => "12pt" }.flatten.should eql({ "padding" => "8px", "font_size" => "12pt" })
+    end
+
+    it "should flatten nested hash" do
+      styles = { :padding => { :top => "8px", :right => "15px" } }
+      styles.flatten.should eql({ "paddingtop" => "8px", "paddingright" => "15px" })
+    end
+
+    it "should flatten nested hash using given separator" do
+      styles = { :padding => { :top => "8px", :right => "15px" } }
+      styles.flatten("-").should eql({ "padding-top" => "8px", "padding-right" => "15px" })
+    end
+
+    it "should pass array of nested keys if block is given" do
+      styles = { :padding => { :top => "8px", :right => "15px" } }
+      styles.flatten { |keys| keys.join('-') }.should eql({ "padding-top" => "8px", "padding-right" => "15px" })
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "html_attributes"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: html_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Sebastian Siwy
+- Martin Spickermann
+- Henning Staib
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-12 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "html_attributes provide helper methods to convert arrays\n                          and
+  hashes to valid html attributes."
+email:
+- github@henning-staib.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- html_attributes.gemspec
+- lib/html_attributes.rb
+- lib/html_attributes/array.rb
+- lib/html_attributes/hash.rb
+- lib/html_attributes/rails/tag_helper.rb
+- lib/html_attributes/version.rb
+- spec/html_attributes/array_spec.rb
+- spec/html_attributes/hash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/serevaris/html_attributes
+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'
+      segments:
+      - 0
+      hash: -89085853264897424
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -89085853264897424
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: html_attributes provide helper methods to convert arrays and hashes to valid
+  html attributes.
+test_files:
+- spec/html_attributes/array_spec.rb
+- spec/html_attributes/hash_spec.rb
+- spec/spec_helper.rb