aeonscope-enhanced_select 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= v1.0.0
+
+* Initial version.

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brooke Kuhlmann of {Berserk Technologies}[http://www.berserktech.com]
+
+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,90 @@
+= Overview
+
+An enhanced select helper for forms that allows you to use the full {HTML spec}[http://www.w3schools.com/tags/tag_option.asp] for select option elements. This is more than what you get with the default Rails select helper which only allows you to specify the value, text, and selected/disabled attributes.
+
+= License
+
+Copyright (c) 2009 Brooke Kuhlmann of {Berserk Technologies}[http://www.berserktech.com].
+See the included LICENSE for more info.
+
+= History
+
+See the CHANGELOG file for more info.
+
+= Requirements
+
+1. {Ruby on Rails}[http://rubyonrails.org].
+
+= Installation
+
+Type the following from the command line to install:
+
+* *UNIX*: sudo gem install aeonscope-enhanced_select
+* *Windows*: gem install aeonscope-enhanced_select
+
+Update your environment.rb file to include the new gem:
+
+* config.gem "enhanced_select"
+
+= Usage
+
+Simply use "enhanced_select" instead of the Rails "select" helper method in your views:
+
+  <% form_for @city do |form| %>
+    <div><%= form.enhanced_select :id, @schools, :include_blank => "-select-" %></div>
+  <% end %>
+
+This will then yield the following results:
+
+  <select id="<auto filled>" name="<auto filled>">
+    <option value="">-select-</option>
+    <option value="1">Goldbugs</option>
+    <option value="2">Falcons</option>
+  </select>
+
+While the above is a simple example, lets look at a more interesting case. Assuming we are still dealing with cities, lets say
+we want cities but we want each city to have CSS classes associated with so that we might be able to attach jQuery behaviors to
+each option as it is selected (that and/or maybe we want to style each option). Here is how things might play out:
+
+<b>Model Code</b>
+
+  class School < ActiveRecord::Base
+    def kind
+      [special? ? "special" : nil, restricted? ? "restricted" : nil].compact.join(' ')
+    end
+  end
+
+<b>Controller Code</b>
+
+  class CityController < ApplicationController
+    before_filter :form_data, :only => [:new, :create, :edit, :update]
+
+    private
+
+    def form_data
+      @schools = School.all.collect {|school| {:value => school.id, :class => school.kind, :text => school.label}}
+    end
+  end
+
+<b>View Code</b>
+
+  <% form_for @city do |form| %>
+    <div><%= form.enhanced_select :id, @schools, :include_blank => "-select-" %></div>
+  <% end %>
+
+This would then yield the following results:
+
+  <select id="<auto filled>" name="<auto filled>">
+    <option value="">-select-</option>
+    <option value="1" class="restricted">Goldbugs</option>
+    <option value="2" class="special">Falcons</option>
+  </select>
+
+The possibilities are up to you as you can definitely build a hash array of options with more attributes than value, class, and text
+as shown above. The best part is that you have total control over how select options are built for your views.
+
+= Contact/Feedback/Issues
+
+* {Berserk Technologies}[http://www.berserktech.com] - Company web site.
+* Aeonscope[http://www.aeonscope.net] - Personal web site.
+* Twitter[http://www.twitter.com/Aeonscope] - Short bursts of insight and/or noise.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "enhanced_select"
+    gem.summary = "An enhanced select helper for forms that allows you to use the full HTML spec for select option elements."
+    gem.description = "Enhances the default capabilities found with the Rails select helper. Instead of being able to supply just the value, text, and selected/disabled attributes, you can use all valid HTML attributes for select option elements."
+    gem.authors = ["Brooke Kuhlmann"]
+    gem.email = "aeonscope@gmail.com"
+    gem.homepage = "http://github.com/aeonscope/enhanced_select"
+		gem.required_ruby_version = ">= 1.8.6"
+		gem.add_dependency "rails", ">= 2.3.2"
+		gem.rdoc_options << "CHANGELOG.rdoc"
+		gem.files = FileList["[A-Z]*", "{bin,lib,generators,rails_generators,test,spec}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+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 = "enhanced_select #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/lib/enhanced_select.rb

@@ -0,0 +1,56 @@
+# Enhanced Select
+module ActionView
+  module Helpers
+    module FormOptionsHelper
+      def enhanced_select object, method, choices, options = {}, html_options = {}
+        InstanceTag.new(object, method, self, options.delete(:object)).to_enhanced_select_tag(choices, options, html_options)
+      end
+			
+      # Accepts a hash array of options and returns a string of option tags. Each option hash is expected to be comprised of valid
+			# HTML option attributes (http://www.w3schools.com/tags/tag_option.asp) where the hash key is the HTML attribute name and the hash
+			# value is the attribute value. If +selected+ is specified, then the matching option will get the selected.
+      #
+      # Examples (call, result):
+      #   enhanced_options_for_select [{:value => 1, :text => "New York"}, {:value => 2, :text => "Denver"}]
+      #   <option value="1">New York</option>\n<option value="2">Denver</option>
+      #
+      #   enhanced_options_for_select [{:value => "bmw", :text => "BMW"}, {:value => "tesla", :text => "Tesla Motors"}], "tesla"
+      #   <option value="bmw">BMW</option>\n<option value="tesla" selected="selected">Tesla Motors</option>
+      #
+      # NOTE: Only the option tags are returned, you have to wrap this call in a regular HTML select tag.			
+      def enhanced_options_for_select options = [], selected = nil
+				# Ensure option selections are unique.
+				options.each {|option| option.delete :selected}
+				# Generate the HTML code.
+        options.map do |option|
+					option[:selected] = "selected" if option[:value] == selected
+					html = "<option"
+					option.each_pair {|key, value| html << build_attribute(key, value)}
+					html << ">#{html_escape option[:text].to_s}</option>\n"
+        end.to_s
+      end
+
+			private
+			
+			# Convenience method for assembling attributes based on a key and value.
+			def build_attribute key, value
+				key == :text ? '' : " #{key.to_s}=\"#{html_escape value.to_s}\""
+			end
+    end
+    
+    class InstanceTag
+      def to_enhanced_select_tag choices, options, html_options
+        html_options = html_options.stringify_keys
+        add_default_name_and_id(html_options)
+        value = value(object)
+        content_tag "select", add_options(enhanced_options_for_select(choices, value), options, value), html_options
+      end
+   end
+
+    class FormBuilder
+      def enhanced_select method, choices, options = {}, html_options = {}
+        @template.enhanced_select @object_name, method, choices, objectify_options(options), @default_options.merge(html_options)
+      end
+    end
+  end
+end

data/test/enhanced_select_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+class EnhancedSelectTest < Test::Unit::TestCase
+  should "be testable" do
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'enhanced_select'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: aeonscope-enhanced_select
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: Enhances the default capabilities found with the Rails select helper. Instead of being able to supply just the value, text, and selected/disabled attributes, you can use all valid HTML attributes for select option elements.
+email: aeonscope@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/enhanced_select.rb
+- test/enhanced_select_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/aeonscope/enhanced_select
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- CHANGELOG.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  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: An enhanced select helper for forms that allows you to use the full HTML spec for select option elements.
+test_files: 
+- test/enhanced_select_test.rb
+- test/test_helper.rb