kematzy-dm-is-select 0.0.2 → 0.0.3

data/.gitignore

@@ -10,6 +10,7 @@ tmtags
 coverage
 rdoc
 pkg
+doc
 
 ## PROJECT::SPECIFIC
 

data/Rakefile

@@ -11,7 +11,7 @@ begin
     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.txt ]
+    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')
@@ -56,18 +56,42 @@ task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = IO.read('VERSION').chomp
-  else
-    version = "[Unknown]"
-  end
-
+  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)

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/dm-is-select.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-is-select}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kematzy"]
-  s.date = %q{2009-07-15}
+  s.date = %q{2009-08-20}
   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.txt",
+    "History.rdoc",
      "LICENSE",
      "README.rdoc",
      "TODO"
   ]
   s.files = [
     ".gitignore",
-     "History.txt",
+     "History.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",

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

@@ -17,7 +17,7 @@ module DataMapper
       # 
       # * :field_name   => the name of the field values shown in select
       # * :options  
-      #   * :is_tree  =>  whether if the current Model is an is :tree model
+      #   * :is_tree  =>  whether if the current Model is an is :tree model. (Defaults to false)
       # 
       # ==== Examples
       # 
@@ -36,7 +36,7 @@ module DataMapper
         
         @select_options = {
           # add specical features if we are working with Tree Model
-          :is_tree => false, 
+          :is_tree => false
         }.merge(options)
         
         @select_field = select_field
@@ -80,6 +80,9 @@ module DataMapper
         #   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
@@ -89,18 +92,27 @@ module DataMapper
         # 
         # 
         # @api public
-        def items_for_select_menu(options={}) 
+        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,
-            :order => [self.select_field.to_sym],
             :show_root => true,
             :root_text => "Top Level #{self.name}",
-          }.merge(options)
+          }.merge(html_options)
+          
+          sql_options = {
+            :order => [self.select_field.to_sym],
+          }.merge(sql_options)
           
           mi = self.select_options[:is_tree] ?  
-            all(:parent_id => 0, :order => options[:order] ) :  
-            all(:order => options[:order])
+            all({ :parent_id => 0 }.merge(sql_options) ) :  
+            all(sql_options)
           
           res = []
           if options[:prompt]

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

@@ -1,7 +1,7 @@
 module DataMapper
   module Is
     module Select
-      VERSION = '0.0.2'
+      VERSION = '0.0.3'
     end
   end
 end

data/spec/integration/select_spec.rb

@@ -8,6 +8,7 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       include DataMapper::Resource
       property :id, Serial
       property :name, String
+      property :publish_status, String, :default => "on"
       
       is :select, :name
       
@@ -18,6 +19,7 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       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 
@@ -25,7 +27,6 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       auto_migrate!
     end
     
-    
     5.times do |n| 
       Category.create(:name => "Category #{n+1}")
     end
@@ -146,6 +147,33 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
             ]
           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 == [ 
+              ["Select Category", nil], 
+              ["  ------  ", "nil"], 
+              ["Category 5", 5],
+              ["Category 4", 4], 
+              ["Category 3", 3], 
+              ["Category 2", 2], 
+              # ["Category 1", 1] 
+            ]
+          end
+          it "should handle invalid SQL select options" do 
+            Category.items_for_select_menu(:publish_status => "invalid", :order => [ :id.desc ] ).should == [ 
+              ["Select Category", nil], 
+              ["  ------  ", "nil"], 
+              # ["Category 5", 5],
+              # ["Category 4", 4], 
+              # ["Category 3", 3], 
+              # ["Category 2", 2], 
+              # ["Category 1", 1] 
+            ]
+          end
+          
         end #/ Normal Model
         
         describe "Tree Model" do 
@@ -208,6 +236,40 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
             ]
           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 == [
+              ["Select TreeCategory", nil], 
+              ["  ------  ", "nil"], 
+              ["Top Level TreeCategory", 0],
+              ["  ------  ", "nil"], 
+              ["TreeCategory-2", 4], 
+              ["-- TreeCategory-2-Child", 5], 
+              ["-- -- TreeCategory-2-Child-GrandChild", 6], 
+              # ["TreeCategory-1", 1], 
+              # ["-- TreeCategory-1-Child", 2], 
+              # ["-- -- TreeCategory-1-Child-GrandChild", 3]
+            ]
+          end
+          
+          it "should handle invalid SQL select options" do 
+            TreeCategory.items_for_select_menu( :publish_status => "invalid", :order => [ :id.desc ] ).should == [
+              ["Select TreeCategory", nil], 
+              ["  ------  ", "nil"], 
+              ["Top Level TreeCategory", 0],
+              ["  ------  ", "nil"], 
+              # ["TreeCategory-2", 4], 
+              # ["-- TreeCategory-2-Child", 5], 
+              # ["-- -- TreeCategory-2-Child-GrandChild", 6], 
+              # ["TreeCategory-1", 1], 
+              # ["-- TreeCategory-1-Child", 2], 
+              # ["-- -- TreeCategory-1-Child-GrandChild", 3]
+            ]
+          end
+          
         end #/ Tree Model
         
       end #/ #item_for_select_menu

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kematzy-dm-is-select
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - kematzy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-15 00:00:00 -07:00
+date: 2009-08-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,13 +39,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
+- History.rdoc
 - LICENSE
 - README.rdoc
 - TODO
 files: 
 - .gitignore
-- History.txt
+- History.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -60,6 +60,7 @@ files:
 - spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/kematzy/dm-is-select
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+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.