helpful_fields 0.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+group :dev do # not development <-> would add unneeded development dependencies in gemspec
+  gem 'rake'
+  gem 'actionpack', '2.3.12'
+  gem 'rspec', '~>2'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.12)
+      activesupport (= 2.3.12)
+      rack (~> 1.1.0)
+    activesupport (2.3.12)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.2)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (= 2.3.12)
+  jeweler
+  rake
+  rspec (~> 2)

data/Rakefile

@@ -0,0 +1,18 @@
+task :default do
+  sh "rspec spec/"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'helpful_fields'
+    gem.summary = "Many helpful field helpers e.g. check_box_with_label"
+    gem.email = "michael@grosser.it"
+    gem.homepage = "http://github.com/grosser/#{gem.name}"
+    gem.authors = ["Michael Grosser"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
+end

data/Readme.md

@@ -0,0 +1,43 @@
+Many helpful field helpers for Rails(need ActionView)
+
+ - prefilled form elements with values from params (even deep nesting like 'search[foo][bar][]')
+ - check boxes/radio buttos with matching labels
+ - selects directly filled with values
+
+Install
+=======
+
+    sudo gem install helpful_fields
+Or
+
+    rails plugin install git://github.com/grosser/helpful_fields.git
+
+
+Usage
+=====
+
+    # text field filled from params
+    <%= params_text_field_tag 'search[category]' %>
+
+    # check box with label
+    # selected if params[:search][:user] is 1 or is an array that includes 1
+    <%= params_check_box_with_label 'search[with_user]', 1, 'Search with users' %>
+
+    # radio button with label, checked when in params
+    <%= params_radio_button_with_label 'search[type]', 'product', 'by Product' %>
+    <%= params_radio_button_with_label 'search[type]', 'shop', 'by Shop' %>
+
+    # select tag with options, preselected from params(or :value => xxx)
+    <%= params_select_options_tag :type, ['', 'none'] %>
+    <%= params_select_options_tag :type, [[0,'none'], [1, 'all']] %>
+    <%= params_select_options_tag :type, {'none' => 0, 'all' => 1} %>
+
+    # check box/radio with label for forms
+    <% f.check_box_with_label :is_admin, 'Can destroy stuff?' %>
+    <% f.radio_button_with_label :type, 'evil', 'No so nice' %>
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/helpful_fields.gemspec

@@ -0,0 +1,40 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{helpful_fields}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2011-07-17}
+  s.email = %q{michael@grosser.it}
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "helpful_fields.gemspec",
+    "lib/helpful_fields.rb",
+    "lib/helpful_fields/core_ext/hash.rb",
+    "spec/helpful_fields_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/helpful_fields}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Many helpful field helpers e.g. check_box_with_label}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/helpful_fields.rb

@@ -0,0 +1,87 @@
+require 'helpful_fields/core_ext/hash'
+
+class HelpfulFields
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+
+  def self.check_box_checked?(params, name, value)
+    in_params = params.value_from_nested_key(name).presence
+    if in_params.is_a?(Array)
+      in_params.map(&:to_s).include?(value.to_s)
+    else
+      in_params.to_s == value.to_s
+    end
+  end
+
+  module TagHelper
+    # --- misc
+    def params_text_field_tag(name, options={})
+      text_field_tag name, params.value_from_nested_key(name), options
+    end
+
+    def params_text_area_tag(name, options={})
+      text_area_tag name, params.value_from_nested_key(name), options
+    end
+
+    def params_hidden_field_tag (name, options={})
+      hidden_field_tag name, params.value_from_nested_key(name), options
+    end
+
+    def params_select_options_tag(name, list, options={})
+      list = list.map{|x| x.is_a?(Array) ? [x[0],h(x[1])] : h(x) } # stringify values from lists
+      selected = h(options[:value] || params.value_from_nested_key(name))
+      select_tag(name, options_for_select(list,selected), options.except(:value))
+    end
+
+    # --- check_box
+    def params_check_box_tag(name, value, options={})
+      check_box_tag(name, value, HelpfulFields.check_box_checked?(params, name, value), options)
+    end
+
+    def check_box_with_label(name, value, checked, label, options={})
+      label_for = options[:id] || name
+      check_box_tag(name, value, checked, options) + label_tag(label_for, label)
+    end
+
+    def params_check_box_with_label(name, value, label, options={})
+      check_box_with_label(name, value, HelpfulFields.check_box_checked?(params, name, value), label, options)
+    end
+
+    # --- radio_button
+    def radio_button_with_label(name, value, checked, label, options={})
+      label_for = if options[:id]
+        options[:id]  # when id was changed, label has to be for this id
+      else
+        # name[hello][world] -> name_hello_world_
+        # name[hello][] -> name_hello_world__
+        # name -> name_
+        clean_name = name.to_s.gsub('[]','_').gsub('][','_').gsub(/[\]\[]/,'_')
+        clean_name += '_' unless clean_name =~ /_$/
+        clean_name + value.to_s.downcase
+      end
+      radio_button_tag(name, value, checked) + label_tag(label_for, label)
+    end
+
+    def params_radio_button_tag(name, value, options={})
+      radio_button_tag(name, value, HelpfulFields.check_box_checked?(params, name, value), options)
+    end
+
+    def params_radio_button_with_label(name, value, label, options={})
+      radio_button_with_label(name, value, HelpfulFields.check_box_checked?(params, name, value), label, options)
+    end
+  end
+
+  module FormBuilder
+    def check_box_with_label(field, label, options={})
+      check_box(field, options) + label(field, label, options)
+    end
+
+    def radio_button_with_label(field, value, label, options={})
+      radio_button(field, value, options) + label("#{field}_#{value}", label, options)
+    end
+  end
+end
+
+if defined?(ActionView)
+  ActionView::Base.send(:include, HelpfulFields::TagHelper)
+  ActionView::Helpers::FormBuilder.send(:include, HelpfulFields::FormBuilder)
+end

data/lib/helpful_fields/core_ext/hash.rb

@@ -0,0 +1,16 @@
+class Hash
+  # {'x'=>{'y'=>{'z'=>1}}.value_from_nested_key('x[y][z]') => 1
+  def value_from_nested_key(key)
+    if key.to_s.include?('[')
+      match, first, nesting = key.to_s.match(/(.+?)\[(.*)\]/).to_a
+      value = self[first]
+      nesting.split('][').each do |part|
+        return nil unless value.is_a?(Hash)
+        value = value[part]
+      end
+      value
+    else
+      self[key]
+    end
+  end
+end

data/spec/helpful_fields_spec.rb

@@ -0,0 +1,214 @@
+require File.expand_path('spec/spec_helper')
+
+describe HelpfulFields do
+  def render(text, params={})
+    view = ActionView::Base.new
+    view.stub!(:params).and_return params.with_indifferent_access
+    view.stub!(:protect_against_forgery?).and_return false
+    view.render(:inline => text)
+  end
+
+  it "has a VERSION" do
+    HelpfulFields::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+
+  describe 'core ext' do
+    describe :value_from_nested_key do
+      it "accesses normal keys" do
+        {:x => 1}.value_from_nested_key(:x).should == 1
+        {'x' => 1}.value_from_nested_key('x').should == 1
+      end
+
+      it "can access deep values" do
+        {'x' => {'y' => {'z' => 1}}}.value_from_nested_key('x[y][z]').should == 1
+      end
+
+      it "returns nil for unfound keys" do
+        {'x' => 1}.value_from_nested_key('x[y][z]').should == nil
+      end
+
+      it "can get values from xxx[]" do
+        {'x' => {'y' => [1,2,3]}}.value_from_nested_key('x[y][]').should == [1,2,3]
+        {'x' => [1,2,3]}.value_from_nested_key('x[]').should == [1,2,3]
+      end
+
+      it "does not mess up with escaped =" do
+        {'x=y' => 1}['x=y'].should == 1
+      end
+    end
+  end
+
+  describe 'TagHelper' do
+    describe :params_text_field_tag do
+      it "renders empty" do
+        render('<%= params_text_field_tag :xxx %>').
+          should == "<input id=\"xxx\" name=\"xxx\" type=\"text\" />"
+      end
+
+      it "grabs the value from params" do
+        render('<%= params_text_field_tag :xxx %>', 'xxx' => 1).
+          should == "<input id=\"xxx\" name=\"xxx\" type=\"text\" value=\"1\" />"
+      end
+
+      it "renders with nested params" do
+        render('<%= params_text_field_tag "foo[bar]" %>').
+          should == "<input id=\"foo_bar\" name=\"foo[bar]\" type=\"text\" />"
+      end
+
+      it "grabs the value from nested params" do
+        render('<%= params_text_field_tag "foo[bar]" %>', :foo => {:bar => 2}).
+          should == "<input id=\"foo_bar\" name=\"foo[bar]\" type=\"text\" value=\"2\" />"
+      end
+    end
+
+    describe :params_text_area_tag do
+      it "renders with value" do
+        render('<%= params_text_area_tag "foo[bar]" %>', :foo => {:bar => 2}).
+          should == "<textarea id=\"foo_bar\" name=\"foo[bar]\">2</textarea>"
+      end
+    end
+
+    describe :params_hidden_field_tag do
+      it "renders with value" do
+        render('<%= params_hidden_field_tag "foo[bar]" %>', :foo => {:bar => 2}).
+          should == "<input id=\"foo_bar\" name=\"foo[bar]\" type=\"hidden\" value=\"2\" />"
+      end
+    end
+
+    describe :params_check_box_tag do
+      it "renders with value" do
+        render('<%= params_check_box_tag "foo[bar]", "1" %>', :foo => {:bar => 1}).
+          should == "<input checked=\"checked\" id=\"foo_bar\" name=\"foo[bar]\" type=\"checkbox\" value=\"1\" />"
+      end
+
+      it "is not checked when value does not match" do
+        render('<%= params_check_box_tag "foo[bar]", "2" %>', :foo => {:bar => 1}).
+          should == "<input id=\"foo_bar\" name=\"foo[bar]\" type=\"checkbox\" value=\"2\" />"
+      end
+
+      it "is checked when value is in array" do
+        render('<%= params_check_box_tag "foo[bar][]", "1" %>', :foo => {:bar => [1,2,3]}).
+          should == "<input checked=\"checked\" id=\"foo_bar_\" name=\"foo[bar][]\" type=\"checkbox\" value=\"1\" />"
+      end
+
+      it "is not checked when value is not in array" do
+        render('<%= params_check_box_tag "foo[bar][]", "1" %>', :foo => {:bar => [2,3]}).
+          should == "<input id=\"foo_bar_\" name=\"foo[bar][]\" type=\"checkbox\" value=\"1\" />"
+      end
+    end
+
+    describe :check_box_with_label do
+      it "adds a label to the checkbox" do
+        render('<%= check_box_with_label "foo[bar]", "1", true, "Click it" %>').
+          should == "<input checked=\"checked\" id=\"foo_bar\" name=\"foo[bar]\" type=\"checkbox\" value=\"1\" /><label for=\"foo_bar\">Click it</label>"
+      end
+
+      it "uses a given id" do
+        render('<%= check_box_with_label "foo[bar]", "1", true, "Click it", :id => "xxx" %>').
+          should == "<input checked=\"checked\" id=\"xxx\" name=\"foo[bar]\" type=\"checkbox\" value=\"1\" /><label for=\"xxx\">Click it</label>"
+      end
+    end
+
+    describe :params_check_box_with_label do
+      it "its not surprise" do
+        render('<%= params_check_box_with_label "foo[bar]", "1", "Click it" %>', :foo => {:bar => 1}).
+          should == "<input checked=\"checked\" id=\"foo_bar\" name=\"foo[bar]\" type=\"checkbox\" value=\"1\" /><label for=\"foo_bar\">Click it</label>"
+      end
+    end
+
+    describe :radio_button_with_label do
+      it "adds a simple label to a radio button" do
+        render('<%= radio_button_with_label "foo", "1", true, "Click it" %>').
+          should == "<input checked=\"checked\" id=\"foo_1\" name=\"foo\" type=\"radio\" value=\"1\" /><label for=\"foo_1\">Click it</label>"
+      end
+
+      it "generates labels for nested attributes" do
+        render('<%= radio_button_with_label "foo[bar][baz]", "1", true, "Click it" %>').
+          should == "<input checked=\"checked\" id=\"foo_bar_baz_1\" name=\"foo[bar][baz]\" type=\"radio\" value=\"1\" /><label for=\"foo_bar_baz_1\">Click it</label>"
+      end
+
+      it "generates labels for arrays" do
+        render('<%= radio_button_with_label "foo[]", "1", true, "Click it" %>').
+          should == "<input checked=\"checked\" id=\"foo__1\" name=\"foo[]\" type=\"radio\" value=\"1\" /><label for=\"foo_1\">Click it</label>"
+      end
+
+      it "generates labels for nested attribute-arrays" do
+        render('<%= radio_button_with_label "foo[bar][baz][]", "1", true, "Click it" %>').
+          should == "<input checked=\"checked\" id=\"foo_bar_baz__1\" name=\"foo[bar][baz][]\" type=\"radio\" value=\"1\" /><label for=\"foo_bar_baz__1\">Click it</label>"
+      end
+    end
+
+    describe :params_radio_button_tag do
+      it "renders normally" do
+        render('<%= params_radio_button_tag "foo", "1" %>').
+          should == "<input id=\"foo_1\" name=\"foo\" type=\"radio\" value=\"1\" />"
+      end
+
+      it "fetches value from params" do
+        render('<%= params_radio_button_tag "foo", "1" %>', :foo => 1).
+          should == "<input checked=\"checked\" id=\"foo_1\" name=\"foo\" type=\"radio\" value=\"1\" />"
+      end
+
+      it "fetches value from nested params" do
+        render('<%= params_radio_button_tag "foo[bar]", "1" %>', :foo => {:bar => 1}).
+          should == "<input checked=\"checked\" id=\"foo_bar_1\" name=\"foo[bar]\" type=\"radio\" value=\"1\" />"
+      end
+
+      it "fetches value from nested params-array" do
+        render('<%= params_radio_button_tag "foo[bar][]", "1" %>', :foo => {:bar => [1]}).
+          should == "<input checked=\"checked\" id=\"foo_bar__1\" name=\"foo[bar][]\" type=\"radio\" value=\"1\" />"
+      end
+    end
+
+    describe :params_radio_button_with_label do
+      it "its not surprise" do
+        render('<%= params_radio_button_with_label "foo", "1", "Click it" %>', :foo => 1).
+          should == "<input checked=\"checked\" id=\"foo_1\" name=\"foo\" type=\"radio\" value=\"1\" /><label for=\"foo_1\">Click it</label>"
+      end
+    end
+
+    describe :params_select_options_tag do
+      it "builds from simple list" do
+        render('<%= params_select_options_tag "foo", [1] %>').
+          should == "<select id=\"foo\" name=\"foo\"><option value=\"1\">1</option></select>"
+      end
+
+      it "builds from nested array" do
+        render('<%= params_select_options_tag "foo", [[1,2]] %>').
+          should == "<select id=\"foo\" name=\"foo\"><option value=\"2\">1</option></select>"
+      end
+
+      it "builds from simple list and nested array" do
+        render('<%= params_select_options_tag "foo", [1, [2,3]] %>').
+          should == "<select id=\"foo\" name=\"foo\"><option value=\"1\">1</option>\n<option value=\"3\">2</option></select>"
+      end
+
+      it "builds from hash" do
+        render('<%= params_select_options_tag "foo", {1 => 2} %>').
+          should == "<select id=\"foo\" name=\"foo\"><option value=\"2\">1</option></select>"
+      end
+
+      it "is prefilled" do
+        render('<%= params_select_options_tag "foo", [1,2,3] %>', :foo => '3').
+          should == "<select id=\"foo\" name=\"foo\"><option value=\"1\">1</option>\n<option value=\"2\">2</option>\n<option value=\"3\" selected=\"selected\">3</option></select>"
+      end
+
+      it "is prefilled from :value" do
+        render('<%= params_select_options_tag "foo", [1,2,3], :value => 2 %>', :foo => '3').
+          should == "<select id=\"foo\" name=\"foo\"><option value=\"1\">1</option>\n<option value=\"2\" selected=\"selected\">2</option>\n<option value=\"3\">3</option></select>"
+      end
+    end
+  end
+
+  describe 'FormBuilder' do
+    it "adds check_box_with_label" do
+      render('<% form_for :user, nil, :url=> "/xxx" do |f| %> <%= f.check_box_with_label :simple, "Hes so simple" %> <% end %>').
+        should == "<form action=\"/xxx\" method=\"post\"> <input name=\"user[simple]\" type=\"hidden\" value=\"0\" /><input id=\"user_simple\" name=\"user[simple]\" type=\"checkbox\" value=\"1\" /><label for=\"user_simple\">Hes so simple</label> </form>"
+    end
+
+    it "adds radio_button_with_label" do
+      render('<% form_for :user, nil, :url=> "/xxx" do |f| %> <%= f.radio_button_with_label :simple, "yes", "Hes so simple" %> <% end %>').
+        should == "<form action=\"/xxx\" method=\"post\"> <input id=\"user_simple_yes\" name=\"user[simple]\" type=\"radio\" value=\"yes\" /><label for=\"user_simple_yes\">Hes so simple</label> </form>"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'active_support/all'
+require 'action_view'
+$LOAD_PATH.unshift 'lib'
+require 'helpful_fields'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: helpful_fields
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-17 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michael@grosser.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- VERSION
+- helpful_fields.gemspec
+- lib/helpful_fields.rb
+- lib/helpful_fields/core_ext/hash.rb
+- spec/helpful_fields_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/helpful_fields
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Many helpful field helpers e.g. check_box_with_label
+test_files: []
+