dm-is-select 0.0.5

data/.gitignore

@@ -0,0 +1,16 @@
+## OS STUFF
+.DS_Store
+
+## TM SPECIFIC
+*.tmproj
+tmtags
+
+## PROJECT::GENERAL
+*.sw?
+coverage
+rdoc
+pkg
+doc
+
+## PROJECT::SPECIFIC
+

data/History.rdoc

@@ -0,0 +1,24 @@
+=== 0.0.1 / 2009-07-12
+
+* Release!
+
+=== 0.0.2 / 2009-07-15
+
+* Added Top Level Parent support in output.
+
+=== 0.0.3 /  2009-08-20
+
+* Fixed rendering bug in gem server when the description contained the <tt><select></tt> tag
+* Converted History.txt to .rdoc
+* Improved the Rakefile docs output
+* Added support for custom SQL queries.
+
+
+=== 0.0.4 / 2009-10-30
+
+* Changed the output order of options array from [key, value] to [value, key] to link with options better.
+
+=== 0.0.5 / 2009-10-30
+
+* Somehow reintroduced the rendering bug in the gemspec description fixed in 0.0.3
+* Updated History.rdoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mats
+
+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,170 @@
+= dm-is-select
+
+A DataMapper plugin that makes getting the <tt><select></tt> options from a Model easier.
+
+
+== Installation
+
+  #  Add Gemcutter to your RubyGems sources 
+  $  gem sources -a http://gemcutter.com
+
+  $  (sudo)? gem install dm-is-select
+  
+=== Dependencies
+
+The plugin depends upon the following:
+
+* dm-core ( >= 0.10.0)
+* dm-more ( >= 0.10.0) [not really, but your code will depend upon it]
+
+
+<b>NB!</b> The plugin has been developed for and on DM's next branch[http://github.com/datamapper/dm-core/tree/next], so may NOT work on previous incarnations.
+
+
+
+== Getting Started
+
+Let's say you got a basic Category Model.
+
+  class Category
+    include DataMapper::Resource
+    property :id, Serial
+    property :name, String
+  
+    is :select, :name
+  
+  end
+    
+Through that simple declaration you get the following class method ..
+
+  Category.items_for_select_menu
+
+...which returns an Array with the Model items in a structured way, ready for use.
+
+  [
+    [nil, "Select Category"], 
+    ["nil", "  ------  "], 
+    [1, "Category 1"], 
+    [2, "Category 2"], 
+    [3, "Category 3"], 
+    [4, "Category 4"], 
+    [5, "Category 5"]
+  ]
+
+Great, but you don't want the prompt to say "Select Category", but 
+
+  Category.items_for_select_menu( :prompt => "Choose Whatever" )
+
+
+...which returns the Array with the prompt changed
+
+  [
+    [nil, "Choose Whatever"], 
+    ["nil", "  ------  "], 
+    [1, "Category 1"], 
+    ...<snip>...
+  ]
+
+
+OK, but you don't like the divider node (2nd in output above). That’s fine, you remove it like this:
+
+  Category.items_for_select_menu( :divider => false )
+
+
+...which returns the Array with the divider removed
+
+  [
+    [nil, "Select Category"], 
+    [1, "Category 1"], 
+    ...<snip>...
+  ]
+
+
+
+Hmm, fine, but I don't want either a prompt or a divider, you say. That's fine too.
+
+  Category.items_for_select_menu( :prompt => false )
+
+...which returns the Array with the prompt and divider removed
+
+  [
+    [1, "Category 1"], 
+    [1, "Category 2"], 
+    ...<snip>...
+  ]
+
+
+OK, that's smooth, but my Category model is a tree with parents, children and so on. This won't work with that.
+
+Sure, no problem, just do this when you declare the Model:
+
+  is :select, :name, :is_tree => true
+
+
+Then you can just use this
+
+  Category.items_for_select_menu( :prompt => "Choose Parent" )
+  
+...and you get this nicely formatted <tt><select></tt> options array
+
+  [
+    [nil, "Choose Parent"], 
+    ["nil", "  ------  "], 
+    [0, "Top Level Category"],
+    ["nil", "  ------  "], 
+    [1, "Parent-1"], 
+    [2, "-- Parent-1-Child"], 
+    [3, "-- -- Parent-1-Child-GrandChild"],
+    [4, "Parent-2"], 
+    [5, "-- Parent-2-Child"], 
+    [6, "-- -- Parent-2-Child-GrandChild"]
+  ]
+  
+<b>NB!</b> It only supports 3 levels at this point in time, as I think that's enough in most use cases, 
+but IF not, fix the code and let me know and I'll add it.
+
+Cool, but that "Top Level Category" node is a bit ugly, but easily fixed. 
+
+  Category.items_for_select_menu( :root_text => "1st Parent (root)" )
+
+...gives you:
+  
+  [
+    ...<snip>...
+    ["nil", "  ------  "], 
+    [0, "1st Parent (root)"],
+    ["nil", "  ------  "], 
+    ...<snip>...
+  ]
+
+You can even remove it all together by doing this:
+
+  Category.items_for_select_menu( :show_root => false )
+
+
+
+
+Obviously all the config options from above works with Tree models as well.
+
+== Last Few Words
+
+OK, I admit it, not the most impressive DM plugin there is, but hey, it sure helps keeping your model/views cleaner.
+
+
+== RTFM 
+
+For a better understanding of this gem/plugin, make sure you study the '<tt>dm-is-select/spec/integration/select_spec.rb</tt>' file.
+ 
+
+== Errors / Bugs
+
+If something is not behaving intuitively, it is a bug, and should be reported.
+Report it here: http://github.com/kematzy/dm-is-select/issues 
+
+== Credits
+
+Copyright (c) 2009-07-12 Kematzy [ kematzy gmail com ]
+
+== Licence
+
+Released under the MIT license.

data/Rakefile

@@ -0,0 +1,109 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-is-select"
+    # gem.version = IO.read('VERSION')
+    gem.summary = %Q{A DataMapper plugin that makes getting the <tt>select</tt> options from a Model easier.}
+    gem.description = gem.summary
+    gem.email = "kematzy@gmail.com"
+    gem.homepage = "http://github.com/kematzy/dm-is-select"
+    gem.authors = ["kematzy"]
+    gem.extra_rdoc_files = %w[ README.rdoc LICENSE TODO History.rdoc ]
+    gem.add_dependency('dm-core', '>= 0.10.0')
+    gem.add_dependency('dm-more', '>= 0.10.0')
+    # gem.add_dependency('dm-validations', '>= 0.10.0')
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific spec verbosely (SPEC=/path/2/file)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"] 
+  end
+  
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? IO.read('VERSION').chomp : "[Unknown]"
+  
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-is-select #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+desc 'Build the rdoc HTML Files'
+task :docs do
+  version = File.exist?('VERSION') ? IO.read('VERSION').chomp : "[Unknown]"
+  
+  sh "sdoc -N --title 'DM::Is::Select v#{version}' lib/dm-is-select README.rdoc"
+end
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_rdoc] do 
+    sh "rm -rf doc"
+  end
+  
+  desc 'Force a rebuild of the RDOC files'
+  task :rebuild => [:docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open => [:docs] do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end
+
+
+# kept just as a reference for now. 
+# 
+# def sudo_gem(cmd)
+#   sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+# end
+# 
+# desc "Install #{GEM_NAME} #{GEM_VERSION}"
+# task :install => [ :package ] do
+#   sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+# end
+# 
+# desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+# task :uninstall => [ :clobber ] do
+#   sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+# end

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/dm-is-select.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-is-select}
+  s.version = "0.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kematzy"]
+  s.date = %q{2009-10-30}
+  s.description = %q{A DataMapper plugin that makes getting the <tt>select</tt> options from a Model easier.}
+  s.email = %q{kematzy@gmail.com}
+  s.extra_rdoc_files = [
+    "History.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "dm-is-select.gemspec",
+     "lib/dm-is-select.rb",
+     "lib/dm-is-select/is/select.rb",
+     "lib/dm-is-select/is/version.rb",
+     "spec/integration/select_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kematzy/dm-is-select}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A DataMapper plugin that makes getting the <tt>select</tt> options from a Model easier.}
+  s.test_files = [
+    "spec/integration/select_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<dm-more>, [">= 0.10.0"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+      s.add_dependency(%q<dm-more>, [">= 0.10.0"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+    s.add_dependency(%q<dm-more>, [">= 0.10.0"])
+  end
+end

data/lib/dm-is-select.rb

@@ -0,0 +1,22 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core', '~> 0.10.0'
+require 'dm-core'
+# gem 'extlib', '~> 0.9.13'
+# require 'extlib'
+gem 'dm-is-tree', '~> 0.10.0'
+require 'dm-is-tree'
+
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-select' / 'is' / 'select.rb'
+
+DataMapper::Model.append_extensions(DataMapper::Is::Select)
+
+# If you wish to add methods to all DM Models, use this:
+# 
+# DataMapper::Model.append_inclusions(DataMapper::Is::Select::ResourceInstanceMethods)
+#

data/lib/dm-is-select/is/select.rb

@@ -0,0 +1,160 @@
+module DataMapper
+  module Is
+    
+    ##
+    # = dm-is-select
+    # 
+    # A DataMapper plugin that makes getting the <tt><select></tt> options from a Model easier.
+    # 
+    # 
+    # 
+    module Select
+      
+      ##
+      # Defines the field to use for the select menu
+      # 
+      # ==== Params 
+      # 
+      # * :field_name   => the name of the field values shown in select
+      # * :options  
+      #   * :is_tree  =>  whether if the current Model is an is :tree model. (Defaults to false)
+      # 
+      # ==== Examples
+      # 
+      #   
+      #   is :select, :name 
+      #     => creates a <select> options array on the :name attribute of the model 
+      #   
+      #   is :select, :name, :is_tree => true  
+      #       => creates a <select> options array with the results ordered in hierarchical order
+      #          parent > child > grandchild for each parent
+      #   
+      # 
+      # @api public
+      def is_select(select_field = :name, options = {})
+        raise ArgumentError, "The :select_field, must be an existing attribute in the Model. Got [ #{select_field.inspect} ]" unless properties.any?{ |p| p.name == select_field.to_sym }
+        
+        @select_options = {
+          # add specical features if we are working with Tree Model
+          :is_tree => false
+        }.merge(options)
+        
+        @select_field = select_field
+        
+        
+        # Add class & Instance methods
+        extend  DataMapper::Is::Select::ClassMethods
+        # include DataMapper::Is::Select::InstanceMethods
+        
+      end
+      
+      module ClassMethods
+        attr_reader :select_field, :select_options
+        
+        ##
+        # Provides the Model content in a ready to use <tt><select></tt> options array
+        # 
+        # ==== Params
+        # 
+        # * :options  
+        #   * :prompt [String/Boolean] =>  The text shown on the <tt><select></tt> field in the browser. (Defaults to "Select NameOfYourModel")
+        #   * :divider [Boolean] =>  Whether to add a divider/separator between the prompt and the main options. (Defaults to +true+)
+        #   * :order [Array]  =>  A normal DM order declaration.  (Defaults to [:name] or the name of the select_field declared)
+        #   * :show_root [Boolean] => Whether to add the Top Level Parent in the choices. (Defaults to +true+)
+        #   * :root_text [String] => The text to show as the Parent item in select list. (Defaults to "Top Level NameOfYourModel")
+        #  
+        # ==== Examples
+        # 
+        #   Category.items_for_select_menu  
+        #     => [ [nil, 'Select Category'], [nil, '---'], [1, 'Category 1'] ,....]
+        #   
+        #   Category.items_for_select_menu(:prompt => "Custom Prompt")  
+        #     => [ [nil, 'Custom Prompt'],...]
+        # 
+        #   Category.items_for_select_menu(:prompt => false)  
+        #     => [ [1, 'Category 1'] ,...]
+        # 
+        #   Category.items_for_select_menu(:divider => false )  
+        #     => array without the [nil, '---'] node
+        # 
+        #   Category.items_for_select_menu(:order => [ :id.desc ] )  
+        #     => array with the order reversed. (Prompts & divider always comes first)
+        # 
+        #   Category.items_for_select_menu(:publish_status => "on", :order => [ :id.desc ] )  
+        #     => returns only those items that matches the query params or just an empty Select Menu
+        # 
+        # If your model is a Tree:
+        # 
+        #   Category.items_for_select_menu(:root_text => "Custom Root Text")  # sets the text for the Top Level (root) Parent
+        #     => [ ..., [0, 'Custom Root Text'],...]
+        #   
+        #   Category.items_for_select_menu(:show_root => false)  # removes the Top Level (root) Parent from the
+        # 
+        # 
+        # @api public
+        def items_for_select_menu(options = {}) 
+          # clean out the various parts
+          html_options = options.only(:prompt, :divider, :show_root, :root_text)
+          sql_options = options.except(:prompt, :divider, :show_root, :root_text)
+          # puts "sql_options=[#{sql_options.inspect}] [#{__FILE__}:#{__LINE__}]"
+          # puts "html_options=[#{html_options.inspect}] [#{__FILE__}:#{__LINE__}]"
+          
+          options = {
+            :prompt => "Select #{self.name}",
+            :divider => true,
+            :show_root => true,
+            :root_text => "Top Level #{self.name}",
+          }.merge(html_options)
+          
+          sql_options = {
+            :order => [self.select_field.to_sym],
+          }.merge(sql_options)
+          
+          mi = self.select_options[:is_tree] ?  
+            all({ :parent_id => 0 }.merge(sql_options) ) :  
+            all(sql_options)
+          
+          res = []
+          if options[:prompt]
+            res << [nil, options[:prompt]] 
+            res << ['nil', "  ------  "] if options[:divider]
+            if self.select_options[:is_tree]
+              if options[:show_root]
+                res << [0, options[:root_text]] 
+                res << ['nil',"  ------  "] if options[:divider]
+              end
+            end
+          end
+          
+          if self.select_options[:is_tree]
+            mi.each do |x|
+              res << [x.id, x.send(self.select_field)]
+              unless x.children.blank?
+                x.children.each do |child|
+                  res << [child.id, "-- #{child.send(self.select_field)}"]
+                  child.children.each do |grand_child| 
+                    res << [ grand_child.id, "-- -- #{grand_child.send(self.select_field)}"] 
+                  end unless child.children.blank?
+                end
+              end
+            end
+          else
+            mi.each do |x|
+              res << [x.id, x.send(self.select_field)]
+            end
+          end
+          res
+        end
+        
+      end # ClassMethods
+      
+      # module InstanceMethods
+      #   
+      # end # InstanceMethods
+      
+    end # Select
+  end # Is
+  
+  Model.append_extensions(Is::Select)
+  
+end # DataMapper

data/lib/dm-is-select/is/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Is
+    module Select
+      VERSION = '0.0.5'
+    end
+  end
+end

data/spec/integration/select_spec.rb

@@ -0,0 +1,285 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::Is::Select' do
+    
+    class Category
+      include DataMapper::Resource
+      property :id, Serial
+      property :name, String
+      property :publish_status, String, :default => "on"
+      
+      is :select, :name
+      
+      auto_migrate!
+    end 
+    
+    class TreeCategory
+      include DataMapper::Resource
+      property :id, Serial
+      property :name, String
+      property :publish_status, String, :default => "on"
+      
+      is :tree, :order => :name
+      is :select, :name, :is_tree => true 
+      
+      auto_migrate!
+    end
+    
+    5.times do |n| 
+      Category.create(:name => "Category #{n+1}")
+    end
+    
+    2.times do |parent_id|
+      parent_id += 1
+      parent = TreeCategory.create(:name => "TreeCategory-#{parent_id}" , :parent_id => 0 )
+      child = TreeCategory.create(:name => "TreeCategory-#{parent_id}-Child" , :parent_id => parent.id )
+      grandchild = TreeCategory.create(:name => "TreeCategory-#{parent_id}-Child-GrandChild" , :parent_id => child.id )
+    end
+    
+    
+    describe "Class Methods" do 
+      
+      describe "is :select" do 
+        
+        it "should work with both strings & symbols as the fieldname provided" do 
+          lambda { 
+            class Dummy
+            include DataMapper::Resource
+            property :id, Serial
+            property :name, String
+            
+            is :select, 'name'
+            auto_migrate!
+          end 
+          
+          }.should_not raise_error(ArgumentError)
+        end
+        
+        it "should raise an ArgumentError if non-existant field is provided" do 
+          lambda { 
+            class Dummy
+            include DataMapper::Resource
+            property :id, Serial
+            property :name, String
+            
+            is :select, :does_not_exist
+            auto_migrate!
+          end 
+          
+          }.should raise_error(ArgumentError)
+        end
+        
+      end #/ is :select
+      
+      describe "#items_for_select_menu" do 
+        
+        describe "A Normal Model" do 
+          
+          it "should return the default select options when given no params" do 
+            Category.items_for_select_menu.should == [ 
+              [nil, "Select Category"], 
+              ["nil", "  ------  "], 
+              [1, "Category 1"], 
+              [2, "Category 2"], 
+              [3, "Category 3"], 
+              [4, "Category 4"], 
+              [5, "Category 5"]
+            ]
+          end
+          
+          it "should return the select options with custom prompt when given the  :prompt => ? " do 
+            Category.items_for_select_menu(:prompt => "Custom Prompt " ).should == [ 
+              [nil, "Custom Prompt "], 
+              ["nil", "  ------  "], 
+              [1, "Category 1"], 
+              [2, "Category 2"], 
+              [3, "Category 3"], 
+              [4, "Category 4"], 
+              [5, "Category 5"]
+            ]
+          end
+          
+          it "should return the select options without a prompt & divider when given :prompt => false" do 
+            Category.items_for_select_menu(:prompt => false ).should == [ 
+              [1, "Category 1"], 
+              [2, "Category 2"], 
+              [3, "Category 3"], 
+              [4, "Category 4"], 
+              [5, "Category 5"]
+            ]
+          end
+          
+          it "should return the select options without a prompt & divider when given :prompt => true" do 
+            #  TODO:: this should be reworked, but right now it's good enough 
+            Category.items_for_select_menu(:prompt => true ).should == [ 
+              [nil, true],
+              ["nil", "  ------  "],
+              [1, "Category 1"], 
+              [2, "Category 2"], 
+              [3, "Category 3"], 
+              [4, "Category 4"], 
+              [5, "Category 5"]
+            ]
+          end
+          
+          it "should return the select options without the divider when given :divider => false" do 
+            Category.items_for_select_menu(:divider => false ).should == [ 
+              [nil, "Select Category"], 
+              [1, "Category 1"], 
+              [2, "Category 2"], 
+              [3, "Category 3"], 
+              [4, "Category 4"], 
+              [5, "Category 5"]
+            ]
+          end
+          
+          it "should return the select options with reversed order when given :order => DESC" do 
+            Category.items_for_select_menu(:order => [ :id.desc ] ).should == [ 
+              [nil, "Select Category"], 
+              ["nil", "  ------  "], 
+              [5, "Category 5"],
+              [4, "Category 4"], 
+              [3, "Category 3"], 
+              [2, "Category 2"], 
+              [1, "Category 1"] 
+            ]
+          end
+          
+          it "should respect the SQL select options" do 
+            c = Category.get(1)
+            c.publish_status = 'off'
+            c.save
+            
+            Category.items_for_select_menu(:publish_status => "on", :order => [ :id.desc ] ).should == [ 
+              [nil, "Select Category"], 
+              ["nil", "  ------  "], 
+              [5, "Category 5"],
+              [4, "Category 4"], 
+              [3, "Category 3"], 
+              [2, "Category 2"], 
+              # [1, "Category 1"] 
+            ]
+          end
+          it "should handle invalid SQL select options" do 
+            Category.items_for_select_menu(:publish_status => "invalid", :order => [ :id.desc ] ).should == [ 
+              [nil, "Select Category"], 
+              ["nil", "  ------  "], 
+              # [5, "Category 5"],
+              # [4, "Category 4"], 
+              # [3, "Category 3"], 
+              # [2, "Category 2"], 
+              # [1, "Category 1"] 
+            ]
+          end
+          
+        end #/ Normal Model
+        
+        describe "Tree Model" do 
+          
+          it "should return the default select options when given no params" do 
+            TreeCategory.items_for_select_menu.should == [
+              [nil, "Select TreeCategory"], 
+              ["nil", "  ------  "], 
+              [0, "Top Level TreeCategory"],
+              ["nil", "  ------  "], 
+              [1, "TreeCategory-1"], 
+              [2, "-- TreeCategory-1-Child"], 
+              [3, "-- -- TreeCategory-1-Child-GrandChild"],
+              [4, "TreeCategory-2"], 
+              [5, "-- TreeCategory-2-Child"], 
+              [6, "-- -- TreeCategory-2-Child-GrandChild"]
+            ]
+          end
+          
+          it "should return the select options with reversed order when given :order => DESC" do 
+            TreeCategory.items_for_select_menu(:order => [ :id.desc ] ).should == [
+              [nil, "Select TreeCategory"], 
+              ["nil", "  ------  "], 
+              [0, "Top Level TreeCategory"],
+              ["nil", "  ------  "], 
+              [4, "TreeCategory-2"], 
+              [5, "-- TreeCategory-2-Child"], 
+              [6, "-- -- TreeCategory-2-Child-GrandChild"], 
+              [1, "TreeCategory-1"], 
+              [2, "-- TreeCategory-1-Child"], 
+              [3, "-- -- TreeCategory-1-Child-GrandChild"]
+            ]
+          end
+          
+          it "should return the select options without the Top Level Parent when given :show_root => false" do 
+            TreeCategory.items_for_select_menu(:show_root => false).should == [
+              [nil, "Select TreeCategory"], 
+              ["nil", "  ------  "], 
+              [1, "TreeCategory-1"], 
+              [2, "-- TreeCategory-1-Child"], 
+              [3, "-- -- TreeCategory-1-Child-GrandChild"],
+              [4, "TreeCategory-2"], 
+              [5, "-- TreeCategory-2-Child"], 
+              [6, "-- -- TreeCategory-2-Child-GrandChild"]
+            ]
+          end
+          
+          it "should return the select options with custom text for the Top Level Parent when given :root_text => ?" do 
+            TreeCategory.items_for_select_menu(:root_text => "Custom Top Level Text").should == [
+              [nil, "Select TreeCategory"], 
+              ["nil", "  ------  "], 
+              [0, "Custom Top Level Text"],
+              ["nil", "  ------  "], 
+              [1, "TreeCategory-1"], 
+              [2, "-- TreeCategory-1-Child"], 
+              [3, "-- -- TreeCategory-1-Child-GrandChild"],
+              [4, "TreeCategory-2"], 
+              [5, "-- TreeCategory-2-Child"], 
+              [6, "-- -- TreeCategory-2-Child-GrandChild"]
+            ]
+          end
+          
+          it "should respect the SQL select options" do 
+            c = TreeCategory.get(1)
+            c.publish_status = 'off'
+            c.save
+            
+            TreeCategory.items_for_select_menu( :publish_status => "on", :order => [ :id.desc ] ).should == [
+              [nil, "Select TreeCategory"], 
+              ["nil", "  ------  "], 
+              [0, "Top Level TreeCategory"],
+              ["nil", "  ------  "], 
+              [4, "TreeCategory-2"], 
+              [5, "-- TreeCategory-2-Child"], 
+              [6, "-- -- TreeCategory-2-Child-GrandChild"], 
+              # [1, "TreeCategory-1"], 
+              # [2, "-- TreeCategory-1-Child"], 
+              # [3, "-- -- TreeCategory-1-Child-GrandChild"]
+            ]
+          end
+          
+          it "should handle invalid SQL select options" do 
+            TreeCategory.items_for_select_menu( :publish_status => "invalid", :order => [ :id.desc ] ).should == [
+              [nil, "Select TreeCategory"], 
+              ["nil", "  ------  "], 
+              [0, "Top Level TreeCategory"],
+              ["nil", "  ------  "], 
+              # [4, "TreeCategory-2"], 
+              # [5, "-- TreeCategory-2-Child"], 
+              # [6, "-- -- TreeCategory-2-Child-GrandChild"], 
+              # [1, "TreeCategory-1"], 
+              # [2, "-- TreeCategory-1-Child"], 
+              # [3, "-- -- TreeCategory-1-Child-GrandChild"]
+            ]
+          end
+          
+        end #/ Tree Model
+        
+      end #/ #item_for_select_menu
+      
+    end #/ Class Methods
+    
+    # describe "Instance Methods" do 
+    #   
+    # end #/ Instance Methods
+    
+  end #/ DataMapper::Is::Select
+  
+end #/ if

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'rspec', '~>1.2.6'
+require 'spec'
+# gem 'dm-is-tree', '~>0.10.0'
+# require 'dm-is-tree'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-select'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  begin
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-select
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- kematzy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-30 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-more
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+    version: 
+description: A DataMapper plugin that makes getting the <tt>select</tt> options from a Model easier.
+email: kematzy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.rdoc
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .gitignore
+- History.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- dm-is-select.gemspec
+- lib/dm-is-select.rb
+- lib/dm-is-select/is/select.rb
+- lib/dm-is-select/is/version.rb
+- spec/integration/select_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kematzy/dm-is-select
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: A DataMapper plugin that makes getting the <tt>select</tt> options from a Model easier.
+test_files: 
+- spec/integration/select_spec.rb
+- spec/spec_helper.rb