styled_inputs 0.0.3

data/CHANGELOG

@@ -0,0 +1,15 @@
+*SVN*
+
+*0.0.3* (June 1st, 2008)
+
+* Remove dependency on set_or_append
+
+*0.0.2* (May 5th, 2008)
+
+* Updated documentation
+
+*0.0.1* (August 17th, 2007)
+
+* Add documentation
+
+* Convert dos newlines to unix newlines

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2008 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

@@ -0,0 +1,46 @@
+= styled_inputs
+
++styled_inputs+ adds automated styling of input fields with css classes.
+
+== Resources
+
+Wiki
+
+* http://wiki.pluginaweek.org/Styled_inputs
+
+API
+
+* http://api.pluginaweek.org/styled_inputs
+
+Development
+
+* http://dev.pluginaweek.org/browser/trunk/styled_inputs
+
+Source
+
+* http://svn.pluginaweek.org/trunk/styled_inputs
+
+== 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" />
+
+== Dependencies
+
+* Rails 2.0 or later
+* set_or_append[http://wiki.pluginaweek.org/Set_or_append]

data/Rakefile

@@ -0,0 +1,80 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+PKG_NAME           = 'styled_inputs'
+PKG_VERSION        = '0.0.3'
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBY_FORGE_PROJECT = 'pluginaweek'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the styled_inputs plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the styled_inputs plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StyledInputs'
+  rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = PKG_NAME
+  s.version         = PKG_VERSION
+  s.platform        = Gem::Platform::RUBY
+  s.summary         = 'Adds automated styling of input fields with css classes'
+  
+  s.files           = FileList['{lib,test}/**/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
+  s.require_path    = 'lib'
+  s.autorequire     = 'styled_inputs'
+  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'
+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', "#{PKG_FILE_NAME}.gem").upload
+end
+
+desc 'Publish the API documentation'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_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/#{PKG_FILE_NAME}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+  end
+end

data/init.rb

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

data/lib/styled_inputs/extensions/instance_tag.rb

@@ -0,0 +1,21 @@
+module PluginAWeek #:nodoc:
+  module StyledInputs
+    module Extensions #:nodoc:
+      module InstanceTag
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            alias_method_chain :tag, :styled_inputs
+          end
+        end
+        
+        def tag_with_styled_inputs(name, options) #:nodoc:
+          tag_without_styled_inputs(name, styled_input(name, options))
+        end
+      end
+    end
+  end
+end
+
+ActionView::Helpers::InstanceTag.class_eval do
+  include PluginAWeek::StyledInputs::Extensions::InstanceTag
+end

data/lib/styled_inputs/extensions/tag_helper.rb

@@ -0,0 +1,21 @@
+module PluginAWeek #:nodoc:
+  module StyledInputs
+    module Extensions #:nodoc:
+      module TagHelper
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            alias_method_chain :tag, :styled_inputs
+          end
+        end
+        
+        def tag_with_styled_inputs(name, options = nil, open = false) #:nodoc:
+          tag_without_styled_inputs(name, styled_input(name, options), open)
+        end
+      end
+    end
+  end
+end
+
+ActionView::Helpers::TagHelper.class_eval do
+  include PluginAWeek::StyledInputs::Extensions::TagHelper
+end

data/lib/styled_inputs.rb

@@ -0,0 +1,46 @@
+require 'styled_inputs/extensions/tag_helper'
+require 'styled_inputs/extensions/instance_tag'
+
+module PluginAWeek #:nodoc:
+  # 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" />
+  # 
+  # 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
+    # Appends the input type to the value currently stored in the html options
+    # for the tag.
+    def styled_input(name, options)
+      options = options.stringify_keys
+      
+      if name.to_s == 'input' && options.include?('type')
+        options['class'] = (options['class'].to_s + " #{options['type']}").strip
+      end
+      
+      options
+    end
+  end
+end
+
+ActionController::Base.class_eval do
+  helper PluginAWeek::StyledInputs
+end
+
+ActionView::Helpers::InstanceTag.class_eval do
+  include PluginAWeek::StyledInputs
+end

data/test/styled_inputs_test.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class StyledInputsTest < Test::Unit::TestCase
+  include PluginAWeek::StyledInputs
+  include ActionView::Helpers::TagHelper
+  
+  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
+
+class FormTagHelperTest < Test::Unit::TestCase
+  include PluginAWeek::StyledInputs
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::FormHelper
+  
+  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_style_hidden_field_tag
+    assert_equal '<input class="hidden" 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
+
+class FormHelperTest < Test::Unit::TestCase
+  class Person
+    attr_accessor :name,
+                  :agree,
+                  :picture,
+                  :secret
+  end
+  
+  include PluginAWeek::StyledInputs
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::FormHelper
+  
+  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_style_hidden_field
+    assert_equal '<input class="hidden" 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 class="checkbox" id="person_agree" name="person[agree]" type="checkbox" value="1" />' +
+      '<input class="hidden" name="person[agree]" type="hidden" value="0" />'
+    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/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'rubygems'
+require 'action_controller'
+require 'action_view'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require File.dirname(__FILE__) + '/../init'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: styled_inputs
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Aaron Pfeifer
+autorequire: styled_inputs
+bindir: bin
+cert_chain: []
+
+date: 2008-06-01 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/styled_inputs.rb
+- lib/styled_inputs
+- lib/styled_inputs/extensions
+- lib/styled_inputs/extensions/tag_helper.rb
+- lib/styled_inputs/extensions/instance_tag.rb
+- test/styled_inputs_test.rb
+- test/test_helper.rb
+- CHANGELOG
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README
+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: 
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Adds automated styling of input fields with css classes
+test_files: 
+- test/styled_inputs_test.rb