pluginaweek-styled_inputs 0.1.1

data/CHANGELOG.rdoc

@@ -0,0 +1,32 @@
+== master
+
+== 0.1.1 / 2008-12-28
+
+* Don't style hidden inputs
+* Fix input styling not always being included on classes directly including ActionView::Helpers::TagHelper
+
+== 0.1.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+* Update tests to use ActionView::TestCase
+
+== 0.0.5 / 2008-06-22
+
+* Remove log files from gems
+
+== 0.0.4 / 2008-06-03
+
+* Add support for Rails 2.0+
+
+== 0.0.3 / 2008-06-01
+
+* Remove dependency on set_or_append
+
+== 0.0.2 / 2008-05-05
+
+* Updated documentation
+
+== 0.0.1 / 2007-08-17
+
+* Add documentation
+* Convert dos newlines to unix newlines

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2009 Aaron Pfeifer
+
+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,54 @@
+= styled_inputs
+
++styled_inputs+ adds automated styling of input fields with css classes.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/styled_inputs
+
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13289-styled_inputs
+
+Development
+
+* http://github.com/pluginaweek/styled_inputs
+
+Source
+
+* git://github.com/pluginaweek/styled_inputs.git
+
+== Description
+
+Normally, it is difficult to style inputs without adding classes to them so
+that you can specify css for each type of input.  Since this can become a
+tedious manual task, styled_inputs automatically adds a classes to each
+input that is generated either by tag or form helpers.  The class that is
+specified is the type of input being generated.
+
+== Usage
+
+=== Tags
+
+  text_field_tag('name')    # => <input class="text" id="name" name="name" type="text" />
+  hidden_field_tag('name')  # => <input class="hidden" id="name" name="name" type="hidden" />
+
+=== Form helpers
+
+  text_field(:person, :name)    # => <input class="text" id="person_name" name="person[name]" size="30" type="text" />
+  hidden_field(:person, :name)  # => <input class="hidden" id="person_name" name="person[name]" type="hidden" />
+
+== Testing
+
+Before you can run any tests, the following gem must be installed:
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
+
+To run against a specific version of Rails:
+
+  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
+
+== Dependencies
+
+* Rails 2.0 or later

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+spec = Gem::Specification.new do |s|
+  s.name              = 'styled_inputs'
+  s.version           = '0.1.1'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Adds automated styling of input fields with css classes in Rails'
+  s.description       = s.summary
+  
+  s.files             = FileList['{lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc) - FileList['test/app_root/{log,log/*,script,script/*}']
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
+task :default => :test
+
+desc "Test the #{spec.name} plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = spec.test_files
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = spec.name
+  rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
+end
+
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem.'
+task :pgem => [:package] do
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
+end
+
+desc 'Publish the API documentation.'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pgem, :pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new.configure
+  ruby_forge.login
+  
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'styled_inputs'

data/lib/styled_inputs.rb

@@ -0,0 +1,27 @@
+require 'styled_inputs/extensions/tag_helper'
+require 'styled_inputs/extensions/instance_tag'
+
+# Automatically adds css classes to input tags so that fields can be
+# easily styled.
+# 
+# == Tag examples
+#   
+#   text_field_tag('name')        # => <input class="text" id="name" name="name" type="text" />
+#   hidden_field_tag('name')      # => <input class="hidden" id="name" name="name" type="hidden" />
+#   radio_button_tag('agree', 1)  # => <input class="radio" id="agree_1" name="agree" type="radio" value="1" />
+# 
+# == Form helper examples
+# 
+#   text_field(:person, :name)        # => <input class="text" id="person_name" name="person[name]" size="30" type="text" />
+#   hidden_field(:person, :name)      # => <input class="hidden" id="person_name" name="person[name]" type="hidden" />
+#   radio_button(:person, :agree, 1)  # => <input class="radio" id="person_agree_1" name="person[agree]" type="radio" value="1" />
+# 
+# == Merging options
+# 
+# If you specify additional classes when creating a tag, the automated css
+# classes will be prepended to the current ones.  For example,
+# 
+#   text_field_tag('name', :class => 'selected')        # => <input class="text selected" id="name" name="name" type="text" />
+#   text_field_tag('name', :class => 'selected shadow') # => <input class="text selected shadow" id="name" name="name" type="text" />
+module StyledInputs
+end

data/lib/styled_inputs/extensions/instance_tag.rb

@@ -0,0 +1,6 @@
+# ActiveRecordHelper chains InstanceTag's +tag+ implementation.  As a result,
+# in order to add styled inputs, that re-implementation needs to be chained
+# again.
+ActionView::Helpers::InstanceTag.class_eval do
+  alias_method_chain :tag, :styled_inputs
+end

data/lib/styled_inputs/extensions/tag_helper.rb

@@ -0,0 +1,19 @@
+# The TagHelper module is re-opened directly instead of including additional
+# modules in order for the chained behavior to be applied to other, unanticipated
+# classes that include ActionView::Helpers::TagHelper directly.
+ActionView::Helpers::TagHelper.class_eval do
+  # Appends the input type to the value currently stored in the html options
+  # for the tag.
+  def styled_input(name, options = nil)
+    options = (options || {}).stringify_keys
+    options['class'] = "#{options['class']} #{options['type']}".strip if name.to_s == 'input' && options.include?('type') && options['type'] != 'hidden'
+    options
+  end
+  
+  # Ensure that the options are updated for input tags before generating
+  # the html for the tag
+  def tag_with_styled_inputs(name, options = nil, *args) #:nodoc:
+    tag_without_styled_inputs(name, styled_input(name, options), *args)
+  end
+  alias_method_chain :tag, :styled_inputs
+end

data/test/helpers/date_helper_test.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class DateHelperTest < ActionView::TestCase
+  def test_should_not_style_hidden_date_fields_if_using_hidden
+    assert_equal '<input id="date_year" name="date[year]" type="hidden" value="1980" />', select_year(1980, :use_hidden => true).strip
+  end
+  
+  def test_should_not_style_hidden_date_fields_if_not_using_hidden
+    expected = <<-end_str
+<select id="date_year" name="date[year]">
+<option selected="selected" value="1980">1980</option>
+<option value="1981">1981</option>
+</select>
+end_str
+    assert_equal expected, select_year(1980, :start_year => 1980, :end_year => 1981)
+  end
+end

data/test/helpers/form_helper_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class FormHelperTest < ActionView::TestCase
+  class Person
+    attr_accessor :name,
+                  :agree,
+                  :picture,
+                  :secret
+  end
+  
+  def setup
+    @person = Person.new
+  end
+  
+  def test_should_style_text_field
+    assert_equal '<input class="text" id="person_name" name="person[name]" size="30" type="text" />', text_field(:person, :name)
+  end
+  
+  def test_should_style_password_field
+    assert_equal '<input class="password" id="person_secret" name="person[secret]" size="30" type="password" />', password_field(:person, :secret)
+  end
+  
+  def test_should_not_style_hidden_field
+    assert_equal '<input id="person_name" name="person[name]" type="hidden" />', hidden_field(:person, :name)
+  end
+  
+  def test_should_style_file_field
+    assert_equal '<input class="file" id="person_picture" name="person[picture]" size="30" type="file" />', file_field(:person, :picture)
+  end
+  
+  def test_should_style_check_box
+    expected =
+      '<input name="person[agree]" type="hidden" value="0" />' +
+      '<input class="checkbox" id="person_agree" name="person[agree]" type="checkbox" value="1" />'
+    assert_equal expected, check_box(:person, :agree)
+  end
+  
+  def test_should_style_radio_button
+    assert_equal '<input class="radio" id="person_agree_1" name="person[agree]" type="radio" value="1" />', radio_button(:person, :agree, 1)
+  end
+end

data/test/helpers/form_tag_helper_test.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class FormTagHelperTest < ActionView::TestCase
+  def test_should_style_text_field_tag
+    assert_equal '<input class="text" id="name" name="name" type="text" />', text_field_tag('name')
+  end
+  
+  def test_should_not_style_hidden_field_tag
+    assert_equal '<input id="name" name="name" type="hidden" />', hidden_field_tag('name')
+  end
+  
+  def test_should_style_file_field_tag
+    assert_equal '<input class="file" id="picture" name="picture" type="file" />', file_field_tag('picture')
+  end
+  
+  def test_should_style_password_field_tag
+    assert_equal '<input class="password" id="secret" name="secret" type="password" />', password_field_tag('secret')
+  end
+  
+  def test_should_style_check_box_tag
+    assert_equal '<input class="checkbox" id="agree" name="agree" type="checkbox" value="1" />', check_box_tag('agree')
+  end
+  
+  def test_should_style_radio_button_tag
+    assert_equal '<input class="radio" id="agree_1" name="agree" type="radio" value="1" />', radio_button_tag('agree', 1)
+  end
+  
+  def test_should_style_submit_tag
+    assert_equal '<input class="submit" name="commit" type="submit" value="Submit" />', submit_tag('Submit')
+  end
+  
+  def test_should_style_image_submit_tag
+    assert_equal '<input class="image" src="button.png" type="image" />', image_submit_tag('button.png')
+  end
+  
+  private
+    def path_to_image(source)
+      source
+    end
+end

data/test/helpers/styled_inputs_test.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class StyledInputsTest < ActionView::TestCase
+  def test_should_not_style_input_if_tag_is_not_input
+    expected = {}
+    assert_equal expected, styled_input('td', expected)
+  end
+  
+  def test_should_not_style_input_if_correct_type_but_tag_is_not_input
+    expected = {'type' => 'text'}
+    assert_equal expected, styled_input('td', expected)
+  end
+  
+  def test_should_style_input_if_tag_is_input
+    expected = {'type' => 'text', 'class' => 'text'}
+    assert_equal expected, styled_input('input', {'type' => 'text'})
+  end
+  
+  def test_should_style_input_if_tag_is_symbolic_input
+    expected = {'type' => 'text', 'class' => 'text'}
+    assert_equal expected, styled_input(:input, {'type' => 'text'})
+  end
+  
+  def test_should_not_style_input_if_tag_is_input_but_type_not_specified
+    expected = {}
+    assert_equal expected, styled_input('input', expected)
+  end
+  
+  def test_should_append_style_if_class_is_already_populated
+    expected = {'type' => 'text', 'class' => 'selected text'}
+    assert_equal expected, styled_input('input', {'type' => 'text', 'class' => 'selected'})
+  end
+  
+  def test_should_style_general_tag_builder
+    assert_equal '<input class="text" type="text" />', tag('input', {'type' => 'text'})
+  end
+end

data/test/helpers/tag_helper_test.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TagHelperTest < ActionView::TestCase
+  def test_should_allow_no_options_to_be_specified
+    assert_equal '<br />', tag('br')
+  end
+  
+  def test_should_allow_options_to_be_specified
+    assert_equal '<input class="text" disabled="disabled" type="text" />', tag('input', {:type => 'text', :disabled => true})
+  end
+  
+  def test_should_allow_open_to_be_specified
+    assert_equal '<br>', tag('br', nil, true)
+  end
+  
+  def test_should_allow_escape_to_be_specified
+    assert_equal '<img src="open &amp; shut.png" />', tag('img', {:src => 'open &amp; shut.png'}, false, false)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: pluginaweek-styled_inputs
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Aaron Pfeifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Adds automated styling of input fields with css classes in Rails
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/styled_inputs
+- lib/styled_inputs/extensions
+- lib/styled_inputs/extensions/tag_helper.rb
+- lib/styled_inputs/extensions/instance_tag.rb
+- lib/styled_inputs.rb
+- test/helpers
+- test/helpers/styled_inputs_test.rb
+- test/helpers/date_helper_test.rb
+- test/helpers/form_helper_test.rb
+- test/helpers/tag_helper_test.rb
+- test/helpers/form_tag_helper_test.rb
+- test/test_helper.rb
+- CHANGELOG.rdoc
+- init.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
+rdoc_options: []
+
+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: pluginaweek
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Adds automated styling of input fields with css classes in Rails
+test_files: 
+- test/helpers/styled_inputs_test.rb
+- test/helpers/date_helper_test.rb
+- test/helpers/form_helper_test.rb
+- test/helpers/tag_helper_test.rb
+- test/helpers/form_tag_helper_test.rb