acts_as_dropdown 2.0.3

data/CHANGELOG

@@ -0,0 +1,17 @@
+2.0.3
+ * fix class Array extension from module in the gem (it worked as a plugin, but failed as a gem)
+
+2.0.2 (2008-10-10)
+ * mirror'd code from http://acts-as-dropdown.googlecode.com/svn/trunk/ (rev 17) to github
+ * added gemspec to build as gem
+ 
+2.0.0
+ * better testing support that now uses a sqlite3 database as the default.
+ * introduced the :include_blank option that works in a similar fashion to the select helper's, but also allow you to 
+   specify what appears as the text of the blank option.
+ * allowing customization of all ActiveRecord::Base#find options.
+ * fix a bug that caused the class attributes to be forgotten, requiring that all options be specified for every to_dropdown call.
+ * renamed and aliased methods to better match the helper methods that they are supposed to be used with.
+
+1.0.0 
+ * Initial release of the plugin. Includes documentation and tests.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 DeLynn Berry
+
+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,28 @@
+= acts_as_dropdown
+
+This plugin allows any ActiveRecord object to easily be used to create a HTML select option list.
+
+The github repository gbdev-acts_as_dropdown was copied from http://acts-as-dropdown.googlecode.com/svn/trunk/ (rev 17) on 2008-10-10
+
+The only current modifications in gbdev-acts_as_dropdown from the original are to make the plugin work as a gem and small reorganizing.
+
+== Resources
+
+Install
+
+* [ruby] script\plugin install http://acts-as-dropdown.googlecode.com/svn/trunk/
+
+  Or even better, use Piston (http://piston.rubyforge.org)
+
+* piston import http://acts-as-dropdown.googlecode.com/svn/trunk/ vendor/plugins/acts_as_dropdown
+
+RDocs
+
+* These can be found in the doc directory at the root of the acts_as_dropdown directory by loading the
+  index.html file into a browser.
+
+Subversion
+
+* http://acts-as-dropdown.googlecode.com/svn/
+
+Special thanks to courtenay of http://habtm.com for giving me the idea for this plugin.

data/RUNNING_UNIT_TESTS

@@ -0,0 +1,12 @@
+== Creating the test database
+
+The test suite currently uses sqlite3 out of the box. I highly recommend using this configuration
+for testing Rails plugins. If for some reason you can't install sqlite3 (and the required gem) you
+can get the test suite to run with any other database adapter with a little tweaking of the
+abstract_unit.rb file. 
+
+== Running by hand
+
+Unit tests are located in the test directory. To execute the test do the following:
+
+   ruby dropdown_test.rb

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_dropdown plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_dropdown plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsDropdown'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

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

data/lib/acts_as_dropdown.rb

@@ -0,0 +1,170 @@
+# Copyright (c) 2006 DeLynn Berry
+# 
+# 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.
+
+module DeLynnBerry
+  module Dropdown
+    def self.included(base) # :nodoc:
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      attr_accessor :dropdown_text_attr, :dropdown_value_attr, :include_blank, :find_arguments
+
+      # Specify this act if you want to your model be used easily with the <tt>select</tt> form helper. By default the
+      # plugin assumes you want to use the class' primary key for the option value and the <tt>name</tt> attribute for
+      # the option text.
+      #
+      # The acts_as_dropdown class method operates much like the ActiveRecord#find method when it comes to customization.
+      # You can alter the <tt>:text</tt> and <tt>:value</tt> attributes that are used. You can also alter what items are
+      # collected from the database by passing in any of the regular ActiveRecord#find options (i.e. <tt>:conditions</tt>,
+      # <tt>:order</tt>, <tt>:group</tt>, <tt>:limit</tt>, <tt>:offset</tt>, etc.)
+      #
+      # Examples:
+      #
+      #   class State < ActiveRecord::Base
+      #     acts_as_dropdown :text => "abbreviation", :conditions => "id < 4"
+      #   end
+      #
+      #   State.to_dropdown   # => [["AL", 1], ["AK", 2], ["AZ", 3]]
+      #
+      #   class State < ActiveRecord::Base
+      #     acts_as_dropdown :conditions => "id < 4", :order => "name DESC"
+      #   end
+      #
+      #   State.to_dropdown   # => [["Arizona", 3], ["Alaska", 2], ["Alabama", 1]]
+      #
+      # The class method <tt>to_dropdown</tt> can also alter the default class configuration using the same options hash.
+      #
+      # Example:
+      #
+      #   class State < ActiveRecord::Base
+      #     acts_as_dropdown :text => "abbreviation", :conditions => "id < 4"
+      #   end
+      #
+      #   State.to_dropdown :text => "name", :conditions => nil   # => [["Alabama", 1], ["Alaska", 2], ["Arizona", 3], ["California", 4], ["Colorado", 5]]
+      #
+      # == Configuration options
+      #
+      # * <tt>text</tt>           - This is the class attribute (database column) that will be used as the text/label for
+      #                             the option tag (defaults to 'name').
+      # * <tt>value</tt>          - This is the class attribute (database column) that will be used to fill in the option's
+      #                             value parameter (defaults to the class' primary_key).
+      # * <tt>include_blank</tt>  - Specify true if you'd like to have a blank item added to the beginning of your list, or
+      #                             a string that will be placed in the value attribute of the option group.
+      #
+      # All of ActiveRecord#find options are available as well:
+      #
+      # * <tt>:conditions</tt>: An SQL fragment like "administrator = 1" or [ "user_name = ?", username ].
+      # * <tt>:order</tt>: A SQL fragment like "created_at DESC, name".
+      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
+      # * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
+      # * <tt>:offset</tt>: An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
+      # * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
+      # * <tt>:include</tt>: Names associations that should be loaded alongside using LEFT OUTER JOINs. The symbols named refer
+      #   to already defined associations. See eager loading under Associations.
+      # * <tt>:select</tt>: By default, this is * as in SELECT * FROM, but can be changed if you for example want to do a join, but not
+      #   include the joined columns.
+      def acts_as_dropdown(*args)
+        options = {:text => 'name', :value => self.primary_key}
+        options.merge!(args.pop) unless args.empty?
+        options.merge!(:order => options[:value]) unless options.has_key?(:order)
+
+        self.dropdown_text_attr   = options.delete(:text)
+        self.dropdown_value_attr  = options.delete(:value)
+        self.include_blank        = options.delete(:include_blank)
+        self.find_arguments       = options
+      end
+    
+      # Examples:
+      #
+      #   class State < ActiveRecord::Base
+      #     acts_as_dropdown :text => "abbreviation", :conditions => "id < 4"
+      #   end
+      #
+      #   State.to_dropdown   # => [["AL", 1], ["AK", 2], ["AZ", 3]]
+      #
+      #   class State < ActiveRecord::Base
+      #     acts_as_dropdown :conditions => "id < 4", :order => "name DESC"
+      #   end
+      #
+      #   State.to_dropdown   # => [["Arizona", 3], ["Alaska", 2], ["Alabama", 1]]
+      #
+      # The class method <tt>to_dropdown</tt> can also alter the default class configuration using the same options hash.
+      #
+      # Example:
+      #
+      #   class State < ActiveRecord::Base
+      #     acts_as_dropdown :text => "abbreviation", :conditions => "id < 4"
+      #   end
+      #
+      #   State.to_dropdown :text => "name", :conditions => nil   # => [["Alabama", 1], ["Alaska", 2], ["Arizona", 3], ["California", 4], ["Colorado", 5]]
+      #
+      # See DeLynnBerry::Dropdown::ClassMethods#acts_as_dropdown for additional configuration options
+      def to_options_for_select(*args)
+        options = args.empty? ? {} : args.pop
+        text    = options.delete(:text)
+        value   = options.delete(:value)
+        blank   = options.delete(:include_blank)
+        options.merge!(:order => value) if (!value.nil? && self.dropdown_value_attr != value) && options.has_key?(:order) == false
+
+        items = find(:all, options.empty? ? self.find_arguments : options).to_dropdown(text   || self.dropdown_text_attr,
+                                                                                       value  || self.dropdown_value_attr)
+
+        if args.empty? && self.include_blank
+          items.insert(0, self.include_blank.kind_of?(String) ? [self.include_blank, ""] : ["", ""])
+        elsif blank
+          items.insert(0, blank.kind_of?(String) ? [blank, ""] : ["", ""])
+        end
+        items
+      end
+      alias :to_dropdown :to_options_for_select
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include DeLynnBerry::Dropdown }
+
+class Array #:nodoc:
+  # Collects the contents of the array and creates a new array that can be easily used
+  # with the <tt>select</tt> form helper method.
+  #
+  # == Options
+  #
+  # * <tt>text</tt>           - This is the attribute that will be used as the text/label for the option tag (defaults to 'name').
+  # * <tt>value</tt>          - This is the attribute that will be used to fill in the option's value parameter (defaults to 'id').
+  # * <tt>include_blank</tt>  - Specify true if you'd like to have a blank item added to the beginning of your aray, or
+  #                             a string that will be placed in the value attribute of the option group.
+  #
+  # === Example
+  #   >> @states = State.find(:all, :order => "id")
+  #   >> @states.to_dropdown 
+  #   => [["Alabama", 1], ["Alaska", 2], ["Arizona", 3], ["California", 4], ["Colorado", 5]]
+  def to_options_for_select(text = :name, value = :id, include_blank = false)
+    items = self.collect { |x| [x.send(text.to_sym), x.send(value.to_sym)] }
+
+    if include_blank
+      items.insert(0, include_blank.kind_of?(String) ? [include_blank, ""] : ["", ""])
+    end
+
+    items
+  end
+  alias :to_dropdown :to_options_for_select
+end

data/test/abstract_unit.rb

@@ -0,0 +1,37 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+RAILS_ROOT = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+require 'active_support/binding_of_caller'
+require 'active_support/breakpoint'
+require "#{File.dirname(__FILE__)}/../init"
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+
+  # Turn off transactional fixtures if you're working with MyISAM tables in MySQL
+  self.use_transactional_fixtures = true
+  
+  # Instantiated fixtures are slow, but give you @david where you otherwise would need people(:david)
+  self.use_instantiated_fixtures  = false
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/active_record_dropdown_test.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), 'abstract_unit')
+require File.join(File.dirname(__FILE__), 'fixtures/state')
+require File.join(File.dirname(__FILE__), 'fixtures/status')
+
+class ActiveRecordDropdownTest < Test::Unit::TestCase  # :nodoc:
+  fixtures :states, :statuses
+
+  def test_class_method
+    assert_equal [["Alabama", 1], ["Alaska", 2], ["Arizona", 3]],
+                 State.to_dropdown
+  end
+
+  def test_class_method_custom_conditions
+    assert_equal [["Alabama", 1], ["Alaska", 2], ["Arizona", 3]],
+                 State.to_dropdown(:conditions => "id < 4")
+  end
+
+  def test_class_method_change_text
+    assert_equal [["AL", 1], ["AK", 2], ["AZ", 3]],
+                 State.to_dropdown(:text => "abbreviation")
+  end
+
+  def test_class_method_change_text_custom_conditions
+    assert_equal [["AL", 1], ["AK", 2], ["AZ", 3]],
+                 State.to_dropdown(:text => "abbreviation", :conditions => "id < 4")
+  end
+
+  def test_class_method_change_value
+    assert_equal [["Alaska", "AK"], ["Alabama", "AL"], ["Arizona", "AZ"], ["California", "CA"], ["Colorado", "CO"]],
+                 State.to_dropdown(:value => "abbreviation")
+  end
+
+  def test_class_method_change_value_custom_conditions
+    assert_equal [["Alaska", "AK"], ["Alabama", "AL"], ["Arizona", "AZ"]],
+                 State.to_dropdown(:value => "abbreviation", :conditions => "id < 4")
+  end
+
+  def test_class_method_change_text_change_value
+    assert_equal [["AL", "Alabama"], ["AK", "Alaska"], ["AZ", "Arizona"], ["CA", "California"], ["CO", "Colorado"]],
+                 State.to_dropdown(:text => "abbreviation", :value => "name")
+  end
+
+  def test_class_method_change_text_change_value_custom_conditions
+    assert_equal [["AL", "Alabama"], ["AK", "Alaska"], ["AZ", "Arizona"]],
+                 State.to_dropdown(:text => "abbreviation", :value => "name", :conditions => "id < 4")
+  end
+
+  def test_class_method_custom_order
+    assert_equal [["Colorado", 5], ["California", 4], ["Arizona", 3], ["Alabama", 1], ["Alaska", 2]],
+                 State.to_dropdown(:order => "abbreviation DESC")
+  end
+
+  def test_class_method_custom_order_custom_conditions
+    assert_equal [["Alabama", 1], ["Alaska", 2], ["Arizona", 3], ["California", 4]],
+                 State.to_dropdown(:order => "name", :conditions => "id < 5")
+  end
+
+  def test_class_method_change_all
+    assert_equal [[3, "AZ"], [1, "AL"], [2, "AK"]],
+                 State.to_dropdown(:text => "id", :value => "abbreviation", :order => "abbreviation DESC", :conditions => "id < 4")
+  end
+
+  def test_class_method_include_blank
+    assert_equal [["", ""], ["Alabama", 1], ["Alaska", 2], ["Arizona", 3], ["California", 4], ["Colorado", 5]],
+                 State.to_dropdown(:conditions => nil, :order => "name", :include_blank => true)
+    assert_equal [["Select a State", ""], ["Alabama", 1], ["Alaska", 2], ["Arizona", 3], ["California", 4], ["Colorado", 5]],
+                 State.to_dropdown(:conditions => nil, :order => "name", :include_blank => "Select a State")
+  end
+
+  def test_class_method_different_value
+    assert_equal [["Bad", "B"], ["Good", "G"]],
+                 Status.to_dropdown
+  end
+
+end

data/test/array_dropdown_test.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'abstract_unit')
+require File.join(File.dirname(__FILE__), 'fixtures/state')
+
+class ArrayDropdownTest < Test::Unit::TestCase  # :nodoc:
+  fixtures :states
+
+  def test_array_to_dropdown
+    states = State.find(:all, :order => "id")
+    assert_equal [["Alabama", 1], ["Alaska", 2], ["Arizona", 3], ["California", 4], ["Colorado", 5]], states.to_dropdown
+  end
+
+  def test_array_to_dropdown_change_text
+    states = State.find(:all, :order => "id")
+    assert_equal [["AL", 1], ["AK", 2], ["AZ", 3], ["CA", 4], ["CO", 5]], states.to_dropdown("abbreviation")
+  end
+
+  def test_array_to_dropdown_change_both
+    states = State.find(:all, :order => "id")
+    assert_equal [["Alabama", "AL"], ["Alaska", "AK"], ["Arizona", "AZ"], ["California", "CA"], ["Colorado", "CO"]], states.to_dropdown("name", "abbreviation")
+  end
+
+  def test_array_to_dropdown_include_blank
+    states = State.find(:all, :order => "id")
+    assert_equal [["", ""], ["AL", 1], ["AK", 2], ["AZ", 3], ["CA", 4], ["CO", 5]], states.to_dropdown("abbreviation", "id", true)
+    assert_equal [["Select a State", ""], ["AL", 1], ["AK", 2], ["AZ", 3], ["CA", 4], ["CO", 5]], states.to_dropdown("abbreviation", "id", "Select a State")
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: acts_as_dropdown_plugin_test.sqlite3.db

data/test/fixtures/state.rb

@@ -0,0 +1,3 @@
+class State < ActiveRecord::Base
+  acts_as_dropdown(:conditions => "id < 4")
+end

data/test/fixtures/states.yml

@@ -0,0 +1,21 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+alabama:
+  id: 1
+  name: Alabama
+  abbreviation: AL
+alaska:
+  id: 2
+  name: Alaska
+  abbreviation: AK
+arizona:
+  id: 3
+  name: Arizona
+  abbreviation: AZ
+california:
+  id: 4
+  name: California
+  abbreviation: CA
+colorado:
+  id: 5
+  name: Colorado
+  abbreviation: CO

data/test/fixtures/status.rb

@@ -0,0 +1,3 @@
+class Status < ActiveRecord::Base
+  acts_as_dropdown(:text => "status", :value => "abbreviation")
+end

data/test/fixtures/statuses.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+good:
+  id: 1
+  status: Good
+  abbreviation: G
+bad:
+  id: 2
+  status: Bad
+  abbreviation: B

data/test/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :states, :force => true do |t|
+    t.column :name,           :string
+    t.column :abbreviation,   :string
+  end
+
+  create_table :statuses, :force => true do |t|
+    t.column :status,         :string
+    t.column :abbreviation,   :string
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_dropdown
+version: !ruby/object:Gem::Version 
+  version: 2.0.3
+platform: ruby
+authors: 
+- DeLynn Berry
+- John Dell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A Rails plugin that adds the ability to easily create an options list out of an ActiveRecord object
+email: 
+- delynn@gmail.com
+- spovich@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- RUNNING_UNIT_TESTS
+- lib/acts_as_dropdown.rb
+- test/abstract_unit.rb
+- test/active_record_dropdown_test.rb
+- test/array_dropdown_test.rb
+- test/database.yml
+- test/fixtures/state.rb
+- test/fixtures/states.yml
+- test/fixtures/status.rb
+- test/fixtures/statuses.yml
+- test/schema.rb
+has_rdoc: true
+homepage: http://github.com/gbdev/acts_as_dropdown
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Adds the ability to easily create an options list out of an ActiveRecord object
+test_files: 
+- test/abstract_unit.rb
+- test/active_record_dropdown_test.rb
+- test/array_dropdown_test.rb
+- test/database.yml
+- test/fixtures/state.rb
+- test/fixtures/states.yml
+- test/fixtures/status.rb
+- test/fixtures/statuses.yml
+- test/schema.rb