sinatra-tag-helpers 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGVlNzVlZWYzMTRmMWIxZTlmNDIwNmRjMTM0Yjc1YWQ3NzZjMDhlMg==
+  data.tar.gz: !binary |-
+    ODFhMmRmOThjZWM0MjZjOWExYTEyZjc3Mzc5ZDg5NjI0ZTFkMGJiYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDllZTg1NjQ3OGQwZjk5YmQxZGRkNTBhOWE3M2NhNTMxMjdlODg4ZmQ4Nzcz
+    YWUxMDJkMDRlNjBhMTA3NzJkZDFhYzY4YjFiZDI2ZTk3OTkwOWY4MWNjMDYx
+    YzIzOGRiNThiNWJkZTYxYWQ3MmU1ZjY5ZWViMDUwNjNjYTk0MmY=
+  data.tar.gz: !binary |-
+    YTNmMjMxNDE4ZWE0N2Q4MTE1YmJkOTViODNlNzZhMGVmMDE4MjE2YWM3YWQ3
+    NTVkMTk5MTA0NTI1NzA1ZDBjNzZhZGU2YzMyZmQ0NzgzMWE5YTQ2NjNlNjE5
+    ODMxZjBmNzE2MDE2MWU1Y2MwNzE0ZTEzOWI2ZjRiZGM0MWZhNTc=

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Evan Lecklider
+
+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,31 @@
+# Sinatra::TagHelpers
+
+Some real simple tag helpers to make things easier for myself.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-tag-helpers', :require => 'sinatra/tag-helpers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-tag-helpers
+
+## Usage
+
+Classic style apps should be good to go and modular apps can do the old:
+
+    helpers Sinatra::TagHelpers
+
+## 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/lib/sinatra/tag-helpers/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module TagHelpers
+    VERSION = "0.0.1"
+  end
+end

data/lib/sinatra/tag-helpers.rb

@@ -0,0 +1,199 @@
+require 'sinatra/base'
+require 'sinatra/tag-helpers/version'
+
+module Sinatra
+  module TagHelpers
+    # don't even try it
+    def html_escape(text = '')
+      EscapeUtils.escape_html(text || '')
+    end
+    alias_method :h, :html_escape
+
+    # converts a hash into HTML style attributes
+    def to_attributes(hash)
+      hash.collect do |key, value|
+        # for things like data: { stuff: 'hey' }
+        if value.is_a? Hash
+          value.collect do |k, v|
+            "#{key}-#{k}='#{v}'"
+          end
+        else
+          value.is_a?(TrueClass) ? key.to_s : "#{key}='#{value}'"
+        end
+      end.join(' ').chomp
+    end
+
+    # mostly so we can override this if we need to look anywhere besides the params
+    # * cough * session * cough *
+    def param_value(param_name)
+      html_escape(params[param_name.to_sym] || '')
+    end
+
+    # link helper
+    # examples:
+    #
+    #   link_to 'Overview', '/account/overview' # => <a href='/account/overview'>Overview</a>
+    #
+    # when on /account/overview
+    #
+    #   <a href='/account/overview' class='current'>Overview</a>
+    #
+    def link_to(text, link, attributes = {})
+      if link == request.path_info
+        attributes[:class] = "#{ attributes[:class] } current"
+      end
+
+      attributes.merge!({ :href => to(link) })
+
+      "<a #{ to_attributes(attributes) }>#{ text }</a>"
+    end
+
+    # input_for creates an <input> tag with a number of configurable options
+    #   if `param` is set in the `params` hash, the values from the `params` hash will be populated in the tag.
+    #
+    #   <%= input_for 'something_hidden', type: 'hidden', value: 'Shhhhhh' %>
+    #
+    # Yields:
+    #
+    #   <input type='hidden' name='something_hidden' id='something_hidden' value='Shhhhhh'>
+    #
+    def input_for(param, attributes = {})
+      attributes = {
+        :type  => 'text',
+        :value => param_value(param),
+        :name  => param,
+        :id    => param
+      }.merge(attributes)
+
+      "<input #{ to_attributes(attributes) }>"
+    end
+
+    # radio_for creates an input tag of type radio and marks it `checked` if the param argument is set to the same value in the `params` hash
+    def radio_for(param, attributes = {})
+      attributes = {
+        :type => 'radio'
+      }.merge(attributes)
+
+      if param_value(param) == attributes[:value].to_s
+        attributes.merge!({ :checked => true })
+      end
+
+      input_for param, attributes
+    end
+
+    # checkbox_for creates an input of type checkbox with a `checked_if` argument to determine if it should be checked
+    #
+    #   <%= checkbox_for 'is_cool', User.is_cool? %>
+    #
+    # Yields:
+    #
+    #   <input type='checkbox' name='is_cool' id='is_cool' value='true'>
+    #
+    # Which will be marked with `checked` if `User.is_cool?` evaluates to true
+    #
+    def checkbox_for(param, checked_if, attributes = {})
+      attributes = {
+        :type  => 'checkbox',
+        :value => 'true'
+      }.merge(attributes)
+
+      if checked_if || param_value(param) == attributes[:value].to_s
+        attributes.merge!({ checked: true })
+      end
+
+      input_for param, attributes
+    end
+
+    # creates a simple <textarea> tag
+    def textarea_for(param, attributes = {})
+      attributes = {
+        :name => param,
+        :id   => param
+      }.merge(attributes)
+
+      "<textarea #{ attributes.to_attr }>#{ param_value(param) }</textarea>"
+    end
+
+    # option_for creates an <option> element with the specified attributes
+    #   if the param specified is set to the value of this option tag then it is marked as 'selected'
+    #   designed to be used within a <select> element
+    #
+    #   <%= option_for 'turtles', key: 'I love them', value: 'love' %>
+    #
+    # Yields:
+    #
+    #   <option value='love'>I love them</option>
+    #
+    # If params[:turtle] is set to 'love' this yields:
+    #
+    #   <option value='love' selected>I love them</option>
+    #
+    def option_for(param, attributes = {})
+      default = attributes.delete(:default).to_s
+
+      if !params[param.to_sym].nil? && !params[param.to_sym].empty?
+        default = param_value(param)
+      end
+
+      attributes.merge!({ :selected => true }) if default == attributes[:value].to_s
+      key = attributes.delete(:key)
+
+      "<option #{ to_attributes(attributes) }>#{ key }</option>"
+    end
+
+    # select_for creates a <select> element with the specified attributes
+    #   options are the available <option> tags within the <select> box
+    #
+    #   <%= select_for 'days', { monday: 'Monday', myday: 'MY DAY!' } %>
+    #
+    # Yields:
+    #
+    #   <select name='days' id='days' size='1'>
+    #     <option value='monday'>Monday</option>
+    #     <option value='myday'>MY DAY!</option>
+    #   </select>
+    #
+    def select_for(param, options, attributes = {})
+      select = ["<select #{ to_attributes(attributes) } name='#{ param }' id='#{ param }' size='1'>"]
+
+      options.collect do |key, val|
+        select.push option_for(param, :key => key, :value => val, :default => attributes[:default])
+      end
+
+      select.push('</select>').join(' ').chomp
+    end
+
+    # shortcut to generate a month list
+    def months_for(param, attributes = {})
+      select_for(param, { 'Month' => '', '1 - January' => '01', '2 - February' => '02', '3 - March' => '03', '4 - April' => '04', '5 - May' => '05', '6 - June' => '06', '7 - July' => '07', '8 - August' => '08', '9 - September' => '09', '10 - October' => '10', '11 - November' => '11', '12 - December' => '12' }, attributes)
+    end
+
+    def years_for(param, range = 1940..Date.today.year, attributes = {})
+      options = { 'Year' => '' }
+
+      if range.last > range.first
+        # top down
+        range.last.downto(range.first) do |r|
+          options[r] = r
+        end
+      else
+        # bottom up
+        range.last.upto(range.first) do |r|
+          options[r] = r
+        end
+      end
+
+      select_for(param, options, attributes)
+    end
+
+    def days_for(param, attributes = {})
+      options = { 'Day' => '' }
+
+      (1..31).each do |day|
+        options[day] = day
+      end
+
+      select_for(param, options, attributes)
+    end
+  end
+end

data/sinatra-tag-helpers.gemspec

@@ -0,0 +1,24 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'sinatra/tag-helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sinatra-tag-helpers'
+  spec.version       = Sinatra::TagHelpers::VERSION
+  spec.authors       = ['Evan Lecklider']
+  spec.email         = ['evan.lecklider@gmail.com']
+  spec.description   = %q{Tag helpers (links and input tags) for Sinatra}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/l3ck/sinatra-tag-helpers'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.license       = 'MIT'
+
+  spec.add_dependency 'sinatra', '~> 1.4.0'
+  spec.add_dependency 'escape_utils', '>= 0.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-tag-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Lecklider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tag helpers (links and input tags) for Sinatra
+email:
+- evan.lecklider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra/tag-helpers.rb
+- lib/sinatra/tag-helpers/version.rb
+- sinatra-tag-helpers.gemspec
+homepage: https://github.com/l3ck/sinatra-tag-helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Tag helpers (links and input tags) for Sinatra
+test_files: []