@@ -1,3 +1,7 @@ *SVN* +*0.0.1* (August 17th, 2007) + +* Add documentation + * Convert dos newlines to unix newlines CHANGELOG @@ -17,4 +17,4 @@ 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. \ No newline at end of file +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. MIT-LICENSE @@ -4,6 +4,10 @@ styled_inputs adds automated styling of input fields with css classes. == Resources +API + +* http://api.pluginaweek.org/styled_inputs + Wiki * http://wiki.pluginaweek.org/Styled_inputs @@ -22,3 +26,23 @@ Development == 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. + +=== 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 + +This plugin depends on the presence of the following plugins: +* set_or_append - http://wiki.pluginaweek.org/Set_or_append README @@ -38,6 +38,7 @@ spec = Gem::Specification.new do |s| s.autorequire = 'styled_inputs' s.has_rdoc = true s.test_files = Dir['test/**/*_test.rb'] + s.add_dependency 'set_or_append', '>= 0.0.1' s.author = 'Aaron Pfeifer, Neil Abraham' s.email = 'info@pluginaweek.org' @@ -76,4 +77,4 @@ task :release => [:gem, :package] do ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file) end -end \ No newline at end of file +end Rakefile @@ -1 +1 @@ -require 'styled_inputs' \ No newline at end of file +require 'styled_inputs' init.rb @@ -5,31 +5,31 @@ module PluginAWeek #:nodoc: # Automatically adds css classes to input tags so that fields can be # easily styled. # - # For example, using tags: + # 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" /> # - # Using the form helpers: + # 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 appended to the current ones. For example, + # classes will be prepended to the current ones. For example, # - # text_field_tag('name', :class => 'selected') # => <input class="selected text" id="name" name="name" type="text" /> - # text_field_tag('name', :class => 'selected shadow') # => <input class="selected shadow text" id="name" name="name" type="text" /> - module StyledInputHelper + # 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 StyledInputsHelper # 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.set_or_append('class', options['type']) + options.set_or_prepend('class', options['type']) end options @@ -48,7 +48,7 @@ module ActionView #:nodoc: end class InstanceTag #:nodoc: - include PluginAWeek::Helpers::StyledInputHelper + include PluginAWeek::Helpers::StyledInputsHelper def tag_with_styled_input(name, options) #:nodoc: tag_without_styled_input(name, styled_input(name, options)) @@ -59,5 +59,5 @@ module ActionView #:nodoc: end ActionController::Base.class_eval do - helper PluginAWeek::Helpers::StyledInputHelper -end \ No newline at end of file + helper PluginAWeek::Helpers::StyledInputsHelper +end lib/styled_inputs.rb @@ -8,7 +8,7 @@ class Person end class StyledInputsTest < Test::Unit::TestCase - include PluginAWeek::Helpers::StyledInputHelper + include PluginAWeek::Helpers::StyledInputsHelper include ActionView::Helpers::TagHelper include ActionView::Helpers::FormTagHelper include ActionView::Helpers::FormHelper @@ -17,100 +17,100 @@ class StyledInputsTest < Test::Unit::TestCase @person = Person.new end - def test_styled_input_not_input + def test_should_not_style_input_if_tag_is_not_input expected = {} assert_equal expected, styled_input('td', expected) end - def test_styled_input_not_input_with_type + 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_styled_input + 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_styled_input_with_symbolic_name + 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_styled_input_without_type + 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_styled_input_with_predefined_class - expected = {'type' => 'text', 'class' => 'selected text'} + def test_should_prepend_style_if_class_is_already_populated + expected = {'type' => 'text', 'class' => 'text selected'} assert_equal expected, styled_input('input', {'type' => 'text', 'class' => 'selected'}) end - def test_tag + def test_should_style_general_tag_builder assert_equal '<input class="text" type="text" />', tag('input', {'type' => 'text'}) end # FormHelper tests - def test_text_field + 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_password_field + 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_hidden_field + 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_file_field + 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_check_box + 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_radio_button + 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 # FormTagHelper tests - def test_text_field_tag + 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_hidden_field_tag + 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_file_field_tag + 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_password_field_tag + 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_check_box_tag + 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_radio_button_tag + 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_submit_tag + def test_should_style_submit_tag assert_equal '<input class="submit" name="commit" type="submit" value="Submit" />', submit_tag('Submit') end - def test_image_submit_tag + def test_should_style_image_submit_tag assert_equal '<input class="image" src="button.png" type="image" />', image_submit_tag('button.png') end test/styled_inputs_test.rb @@ -1,7 +1,9 @@ +$:.unshift("#{File.dirname(__FILE__)}/../../../ruby/hash/set_or_append/lib") + require 'test/unit' require 'rubygems' require 'action_controller' require 'action_view' $:.unshift(File.dirname(__FILE__) + '/../lib') -require File.dirname(__FILE__) + '/../init' \ No newline at end of file +require File.dirname(__FILE__) + '/../init' test/test_helper.rb 8bc9fd8959f936c0ba24ec9e3950a47c9525c9f7 Aaron Pfeifer aaron.pfeifer@gmail.com http://github.com/pluginaweek/styled_inputs/commit/63f63e17c8af75aaee6145684310c2f05750e6b7 63f63e17c8af75aaee6145684310c2f05750e6b7 2007-08-16T22:49:29-07:00 2007-08-16T22:49:29-07:00 Add documentation Prepare for 0.0.1 release 0b159fcd35ea074b6d09f5f7a9d4f7e150763e69 Aaron Pfeifer aaron.pfeifer@gmail.com