twilson63-sinatra-formhelpers 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,21 @@
+sinatra-formhelpers - Suite of form helpers for sinatra
+Copyright 2009 Tom Wilson
+ 
+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.rdoc

@@ -0,0 +1,7 @@
+= sinatra-formhelpers
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 twilson63. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rake/clean'
+require 'rake/testtask'
+require 'fileutils'
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-formhelpers"
+    gem.summary = %Q{use basic form helpers for generic form management}
+    gem.email = "tom@jackrussellsoftware.com"
+    gem.homepage = "http://github.com/twilson63/sinatra-formhelpers"
+    gem.authors = ["twilson63"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_runtime_dependency 'sinatra', ['>= 0.9.2.0']
+    gem.add_runtime_dependency 'activesupport', ['>= 2.3.2.0']
+    
+    
+  end
+  
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+task :spec => :test
+
+# SPECS ===============================================================
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-rubygems'] if defined? Gem
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+  
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test-gem #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+

data/Rakefile.backup

@@ -0,0 +1,13 @@
+require 'rake/clean'
+require 'rake/testtask'
+require 'fileutils'
+
+task :default => :test
+task :spec => :test
+
+# SPECS ===============================================================
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-rubygems'] if defined? Gem
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/sinatra/formhelpers.rb

@@ -0,0 +1,98 @@
+require 'sinatra/base'
+require 'activesupport'
+
+module Sinatra
+  module FormHelpers
+    # FormHelpers are a suite of helper methods
+    # built to make building forms in Sinatra
+    # a breeze.
+    # 
+    # link "jackhq", "http://www.jackhq.com"
+    # 
+    # label :person, :first_name
+    # text :person, :first_name
+    # 
+    # area :person, :notes
+    # 
+    # etc.
+    
+    def link(content, href, options={})
+      tag :a, content, options.merge(:href => href)  
+    end
+    
+    def label(obj,field, options={})
+      tag :label, field.to_s.titleize, options.merge(:for => "#{obj}_#{field}")
+    end
+    
+    def text(obj, field, options={})
+      content = @params[obj] ? @params[obj][field.to_s] : ""       
+      single_tag :input, options.merge(:type => "text", :id => "#{obj}_#{field}", :name => "#{obj}[#{field}]", :value => content)
+    end
+    
+    def area(obj, field, options={})
+      content = @params[obj] ? @params[obj][field.to_s] : ""        
+      tag :textarea, content, options.merge(:id => "#{obj}_#{field}", :name => "#{obj}[#{field}]")
+    end
+    
+    def image(src, options={})
+      single_tag :img, options.merge(:src => src)
+    end
+    
+    def submit(obj, value, options={})
+      single_tag :input, options.merge(:type => "submit", :value => value)
+    end
+    
+    def checkbox(obj, field, options={})
+      single_tag :input, options.merge(:type => "checkbox", :id => "#{obj}_#{field}", :name => "#{obj}[#{field}]")
+      
+    end
+    
+    def radio(obj, field, value, options={})
+      content = @params[obj] && @params[obj][field.to_s] == value ? "true" : ""       
+      tag :input, value, options.merge(:type => "radio", :id => "#{obj}_#{field}", :name => "#{obj}[#{field}]", :value => value, :checked => content)
+      
+    end
+    
+    def select(obj, field, items, options={})
+      content = ""
+      items.each do |i|
+        content = content + tag(:option, i, { :value => i })
+      end
+      tag :select, content, options
+    end
+    
+    
+    # standard open and close tags
+    # EX : tag :h1, "shizam", :title => "shizam"
+    # => <h1 title="shizam">shizam</h1>
+    def tag(name,content,options={})
+      with_opts = "<#{name.to_s} #{options.to_html_attrs}>#{content}</#{name}>"
+      no_opts = "<#{name.to_s}>#{content}</#{name}>"
+      options.blank? ? no_opts : with_opts
+    end
+    
+    # standard single closing tags
+    # single_tag :img, :src => "images/google.jpg"
+    # => <img src="images/google.jpg" />
+    def single_tag(name,options={})
+      options ||= options.stringify_keys
+      "<#{name.to_s} #{options.to_html_attrs} />"
+    end 
+    
+  end
+  
+  helpers FormHelpers
+end
+
+
+class Hash
+  
+  def to_html_attrs
+    html_attrs = ""
+    self.stringify_keys.each do |key, val|
+      html_attrs << "#{key}='#{val}' "
+    end
+    html_attrs.chop
+  end
+  
+end

data/sinatra-formhelpers.gemspec

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-formhelpers}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["twilson63"]
+  s.date = %q{2009-06-14}
+  s.email = %q{tom@jackrussellsoftware.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README",
+     "README.rdoc",
+     "Rakefile",
+     "Rakefile.backup",
+     "VERSION.yml",
+     "lib/sinatra/formhelpers.rb",
+     "sinatra-formhelpers.gemspec",
+     "test/contest.rb",
+     "test/formhelpers_test.rb",
+     "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/twilson63/sinatra-formhelpers}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{use basic form helpers for generic form management}
+  s.test_files = [
+    "test/helper.rb",
+     "test/contest.rb",
+     "test/formhelpers_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0.9.2.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2.0"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0.9.2.0"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.2.0"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0.9.2.0"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.2.0"])
+  end
+end

data/test/contest.rb

@@ -0,0 +1,64 @@
+require "test/unit"
+
+# Test::Unit loads a default test if the suite is empty, and the only
+# purpose of that test is to fail. As having empty contexts is a common
+# practice, we decided to overwrite TestSuite#empty? in order to
+# allow them. Having a failure when no tests have been defined seems
+# counter-intuitive.
+class Test::Unit::TestSuite
+  unless method_defined?(:empty?)
+    def empty?
+      false
+    end
+  end
+end
+
+# We added setup, test and context as class methods, and the instance
+# method setup now iterates on the setup blocks. Note that all setup
+# blocks must be defined with the block syntax. Adding a setup instance
+# method defeats the purpose of this library.
+class Test::Unit::TestCase
+  def self.setup(&block)
+    setup_blocks << block
+  end
+  
+  def setup
+    self.class.setup_blocks.each do |block|
+      instance_eval(&block)
+    end
+  end
+  
+  def self.context(name, &block)
+    subclass = Class.new(self.superclass)
+    subclass.setup_blocks.unshift(*setup_blocks)
+    subclass.class_eval(&block)
+    const_set(context_name(name), subclass)
+  end
+  
+  def self.test(name, &block)
+    define_method(test_name(name), &block)
+  end
+  
+  class << self
+    alias_method :should, :test
+    alias_method :describe, :context
+  end
+  
+  private
+  
+  def self.setup_blocks
+    @setup_blocks ||= []
+  end
+  
+  def self.context_name(name)
+    "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
+  end
+  
+  def self.test_name(name)
+    "test_#{sanitize_name(name).gsub(/\s+/,'_')}".to_sym
+  end
+  
+  def self.sanitize_name(name)
+    name.gsub(/\W+/, ' ').strip
+  end
+end

data/test/formhelpers_test.rb

@@ -0,0 +1,195 @@
+require File.dirname(__FILE__) + '/helper'
+require 'haml'
+require 'sinatra/formhelpers'
+
+class FormHelpersTest < Test::Unit::TestCase
+  
+  def test_default
+    assert true
+  end
+    
+  describe 'formhelpers link' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= link 'google', 'http://www.google.com'"
+        end
+      }
+    end
+    
+    it 'renders an achor tag' do
+      get '/'
+      assert_equal "<a href='http://www.google.com'>google</a>\n", body
+    end    
+  end
+
+
+  describe 'formhelpers label' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= label :person, :first_name"
+        end
+      }
+    end
+    
+    it 'renders an label tag' do
+      get '/'
+      assert_equal "<label for='person_first_name'>First Name</label>\n", body
+    end    
+  end
+  
+  describe 'formhelpers text without @params' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= text :person, :first_name"
+        end
+      }
+    end
+    
+    it 'renders an input tag type text without @params' do
+      get '/'
+      assert_equal "<input name='person[first_name]' id='person_first_name' value='' type='text' />\n", body
+    end            
+  end
+
+  describe 'formhelpers text with @params' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          @params = { :person => {"first_name" => "Tom"}}
+          haml "= text :person, :first_name"
+        end
+      }
+    end
+        
+    it 'renders an input tag type text with @params' do
+      get '/'
+      assert_equal "<input name='person[first_name]' id='person_first_name' value='Tom' type='text' />\n", body
+    end        
+  end
+  
+  describe 'formhelpers area without @params' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= area :person, :notes"
+        end
+      }
+    end
+    
+    it 'renders an textarea tag type text without @params' do
+      get '/'
+      assert_equal "<textarea name='person[notes]' id='person_notes'></textarea>\n", body
+    end            
+  end
+  
+  describe 'formhelpers textarea with @params' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          @params = { :person => {"notes" => "This is a note"}}
+          haml "= area :person, :notes"
+        end
+      }
+    end
+    
+    it 'renders a textarea tag with @params' do
+      get '/'
+      assert_equal "<textarea name='person[notes]' id='person_notes'>This is a note</textarea>\n", body
+    end        
+  end
+  
+
+  describe 'formhelpers image' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= image '/images/hello.png'"
+        end
+      }
+    end
+    
+    it 'renders a textarea tag with @params' do
+      get '/'
+      assert_equal "<img src='/images/hello.png' />\n", body
+    end        
+  end
+
+  describe 'formhelpers submit' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= submit :person, 'Create'"
+        end
+      }
+    end
+    
+    it 'renders an input tag with a submit type' do
+      get '/'
+      assert_equal "<input value='Create' type='submit' />\n", body
+    end        
+  end
+  
+
+  describe 'formhelpers checkbox' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= checkbox :person, :active"
+        end
+      }
+    end
+    
+    it 'renders an input tag with a checkbox type' do
+      get '/'
+      assert_equal "<input name='person[active]' id='person_active' type='checkbox' />\n", body
+    end        
+  end
+  
+
+  describe 'formhelpers radio' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= radio :person, :gender, 'Male'"
+        end
+      }
+    end
+    
+    it 'renders an input tag with a radio type' do
+      get '/'
+      assert_equal "<input checked='' name='person[gender]' id='person_gender' value='Male' type='radio'>Male</input>\n", body
+    end        
+  end
+  
+  describe 'formhelpers select' do
+    setup do
+      mock_app {
+        helpers Sinatra::FormHelpers
+        get '/' do
+          haml "= select :person, :relationship, ['Friend','CoWorker','Lead']"
+        end
+      }
+    end
+    
+    it 'renders an select tag' do
+      get '/'
+      assert_equal "<select><option value='Friend'>Friend</option><option value='CoWorker'>CoWorker</option><option value='Lead'>Lead</option></select>\n", body
+    end        
+  end
+  
+
+end
+

data/test/helper.rb

@@ -0,0 +1,76 @@
+ENV['RACK_ENV'] = 'test'
+
+begin
+  require 'rack'
+rescue LoadError
+  require 'rubygems'
+  require 'rack'
+end
+
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require 'contest'
+require 'rack/test'
+require 'sinatra/base'
+
+class Sinatra::Base
+  # Allow assertions in request context
+  include Test::Unit::Assertions
+end
+
+Sinatra::Base.set :environment, :test
+
+class Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  class << self
+    alias_method :it, :test
+  end
+  
+  alias_method :response, :last_response
+  
+  setup do
+    Sinatra::Base.set :environment, :test
+  end
+  
+  # Sets up a Sinatra::Base subclass defined with the block
+  # given. Used in setup or individual spec methods to establish
+  # the application.
+  def mock_app(base=Sinatra::Base, &block)
+    @app = Sinatra.new(base, &block)
+  end
+  
+  def app
+    Rack::Lint.new(@app)
+  end
+  
+  def body
+    response.body.to_s
+  end
+  
+  # Delegate other missing methods to response.
+  def method_missing(name, *args, &block)
+    if response && response.respond_to?(name)
+      response.send(name, *args, &block)
+    else
+      super
+    end
+  end
+  
+  # Also check response since we delegate there.
+  def respond_to?(symbol, include_private=false)
+    super || (response && response.respond_to?(symbol, include_private))
+  end
+  
+  # Do not output warnings for the duration of the block.
+  def silence_warnings
+    $VERBOSE, v = nil, $VERBOSE
+    yield
+  ensure
+    $VERBOSE = v
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: twilson63-sinatra-formhelpers
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- twilson63
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2.0
+    version: 
+description: 
+email: tom@jackrussellsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- Rakefile.backup
+- VERSION.yml
+- lib/sinatra/formhelpers.rb
+- sinatra-formhelpers.gemspec
+- test/contest.rb
+- test/formhelpers_test.rb
+- test/helper.rb
+has_rdoc: false
+homepage: http://github.com/twilson63/sinatra-formhelpers
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: use basic form helpers for generic form management
+test_files: 
+- test/helper.rb
+- test/contest.rb
+- test/formhelpers_test.rb