pkwde-has_set 0.0.2 → 0.0.4

data/Rakefile

@@ -8,8 +8,8 @@ $hoe = Hoe.new('has_set', HasSet::VERSION) do |p|
   p.developer('pkw.de Dev Team', 'dev@pkw.de')
   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.extra_deps         = [
-    ['activerecord', '= 2.2.2'],
-    ['activesupport', '= 2.2.2']
+    ['activerecord', '>= 2.3.2'],
+    ['activesupport', '>= 2.3.2']
   ]
   p.extra_dev_deps = [
     ['newgem', ">= #{::Newgem::VERSION}"],

data/has_set.gemspec

@@ -2,39 +2,69 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_set}
-  s.version = "0.0.2"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["pkw.de Dev Team"]
-  s.date = %q{2009-04-16}
-  s.description = %q{A simple Gem to enable any `ActiveRecord::Base` object to store a set of attributes in a set like structure represented through a bitfield on the database level.  You only have to specify the name of the set to hold the attributes in question an the rest is done for you through some fine selected Ruby magic. Here is a simple example of how you could use the gem:  class Person < ActiveRecord::Base has_set :interests end  To get this to work you need some additional work done first:  1. You need an unsigned 8-Byte integer column in your database to store the bitfield. It is expected that the column is named after the name of the set with the suffix `_bitfield` appended (e.g. `interests_bitfield`). You can change that default behavior by providing the option `:column_name` (e.g. `has_set :interests, :column_name => :my_custom_column`). 2. You need a class that provides the valid values to be stored within the set and map the single bits back to something meaningful. The class should be named after the name of the set (you can change this through the `:enum_class` option). This class could be seen as an enumeration and must implement the following simple interface: * There must be a class method `values` to return all valid enumerators in the defined enumeration. * Each enumerator must implement a `name` method to return a literal representation for identification. The literal must be of the type `String`. * Each enumerator must implement a `bitfield_index` method to return the exponent of the number 2 for calculation the position of this enumerator in the bitfield. **Attention** Changing this index afterwards will destroy your data integrity.  Here is a simple example of how to implement such a enumeration type while using the the `renum` gem for simplicity. You are free to use anything else that matches the described interface.  enum :Interests do attr_reader :bitfield_index  Art(0) Golf(1) Sleeping(2) Drinking(3) Dating(4) Shopping(5)  def init(bitfield_index) @bitfield_index = bitfield_index end end}
+  s.date = %q{2009-05-13}
+  s.description = %q{A simple Gem to enable any `ActiveRecord::Base` object to store a set of attributes in a set like structure represented through a bitfield on the database level.
+
+You only have to specify the name of the set to hold the attributes in question an the rest is done for you through some fine selected Ruby magic. Here is a simple example of how you could use the gem:
+
+    class Person < ActiveRecord::Base
+      has_set :interests
+    end
+
+To get this to work you need some additional work done first:
+
+  1. You need an unsigned 8-Byte integer column in your database to store the bitfield. It is expected that the column is named after the name of the set with the suffix `_bitfield` appended (e.g. `interests_bitfield`). You can change that default behavior by providing the option `:column_name` (e.g. `has_set :interests, :column_name => :my_custom_column`).
+  2. You need a class that provides the valid values to be stored within the set and map the single bits back to something meaningful. The class should be named after the name of the set (you can change this through the `:enum_class` option). This class could be seen as an enumeration and must implement the following simple interface:
+    * There must be a class method `values` to return all valid enumerators in the defined enumeration.
+    * Each enumerator must implement a `name` method to return a literal representation for identification. The literal must be of the type `String`.
+    * Each enumerator must implement a `bitfield_index` method to return the exponent of the number 2 for calculation the position of this enumerator in the bitfield. **Attention** Changing this index afterwards will destroy your data integrity.
+
+Here is a simple example of how to implement such a enumeration type while using the the `renum` gem for simplicity. You are free to use anything else that matches the described interface.
+    
+    enum :Interests do
+      attr_reader :bitfield_index
+
+      Art(0)
+      Golf(1)
+      Sleeping(2)
+      Drinking(3)
+      Dating(4)
+      Shopping(5)
+
+      def init(bitfield_index)
+        @bitfield_index = bitfield_index
+      end
+    end}
   s.email = ["dev@pkw.de"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
   s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "has_set.gemspec", "lib/has_set.rb", "script/console", "script/destroy", "script/generate", "test/has_set_test.rb", "test/test_helper.rb"]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/pkwde/has_set}
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{has_set}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{A Gem that enables ActiveRecord models to have a set of values defined in a certain class and stored in an integer bitfield on the database level.}
   s.test_files = ["test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, ["= 2.2.2"])
-      s.add_runtime_dependency(%q<activesupport>, ["= 2.2.2"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
       s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<pkwde-renum>, [">= 0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
     else
-      s.add_dependency(%q<activerecord>, ["= 2.2.2"])
-      s.add_dependency(%q<activesupport>, ["= 2.2.2"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.2"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
       s.add_dependency(%q<newgem>, [">= 1.3.0"])
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<pkwde-renum>, [">= 0"])
@@ -42,8 +72,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<hoe>, [">= 1.8.0"])
     end
   else
-    s.add_dependency(%q<activerecord>, ["= 2.2.2"])
-    s.add_dependency(%q<activesupport>, ["= 2.2.2"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.2"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
     s.add_dependency(%q<newgem>, [">= 1.3.0"])
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<pkwde-renum>, [">= 0"])

data/lib/has_set.rb

@@ -5,7 +5,7 @@ require 'activesupport'
 require 'activerecord'
 
 module HasSet
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
   
   module ClassMethods
     
@@ -24,10 +24,16 @@ module HasSet
         raise NameError, "There ist no class to take the set entries from (#{ne.message})."
       end
       
+      # Extend enum_class with field_name method
+      enum_class.class_eval <<-EOF
+        def field_name
+          '#{set_name.to_s.singularize}_' + self.name.underscore
+        end
+      EOF
+      
       define_method("#{set_name}=") do |set_elements|
-        if set_elements.blank?
-          self[set_column] = 0
-        else
+        self[set_column] = 0
+        unless set_elements.blank?
           if set_elements.kind_of? String
             set_elements = set_elements.split(",").collect do |element|
               element.strip!
@@ -48,18 +54,32 @@ module HasSet
         if self[set_column] == 0
           return []
         else
-          enum_class.values.inject([]) do |set_elements, enum_element|
+          set_elements = enum_class.values.inject([]) do |set_elements, enum_element|
             set_elements << enum_element if send("#{set_name.to_s.singularize}_#{enum_element.name.underscore}?")
             set_elements
           end
+          # special to_s method for element-array
+          class <<set_elements
+            def to_s
+              self.collect { |element| "#{element.name}" }.join(", ")
+            end
+          end
+          return set_elements
         end
       end
       
+      # TODO: This should be a class method
+      define_method("available_#{set_name.to_s}") do
+        self.methods.grep(/#{set_name.to_s.singularize}_\w+[^\?=]$/).sort
+      end
+      
       enum_class.values.each do |enum|
         define_method("#{set_name.to_s.singularize}_#{enum.name.underscore}?") do
           2**enum.bitfield_index & self[set_column] == 2**enum.bitfield_index ? true : false
         end
         
+        alias_method :"#{set_name.to_s.singularize}_#{enum.name.underscore}", :"#{set_name.to_s.singularize}_#{enum.name.underscore}?"
+        
         define_method("#{set_name.to_s.singularize}_#{enum.name.underscore}=") do |true_or_false|
           current_value = (2**enum.bitfield_index & self[set_column] == 2**enum.bitfield_index)
           true_or_false = true  if true_or_false.to_s == "true" || (true_or_false.respond_to?(:to_i) && true_or_false.to_i == 1)

data/test/has_set_test.rb

@@ -57,6 +57,12 @@ class HasSetTest < Test::Unit::TestCase
     assert_equal [Interests::Dating, Interests::Shopping], person.interests
   end
   
+  def test_should_reset_values_if_setter_is_used
+    person = Person.new(:fullname => "Jessie Summers", :interests => [Interests::Dating])
+    person.interests = Interests::Shopping
+    assert_equal [Interests::Shopping], person.interests
+  end
+  
   def test_should_set_elements_by_string_names
     person = Person.new(:fullname => "Jessie Summers", :interests => "Dating, Shopping")
     assert_equal [Interests::Dating, Interests::Shopping], person.interests
@@ -76,9 +82,15 @@ class HasSetTest < Test::Unit::TestCase
     assert party.save, "Party should save!"
     party.reload
     assert party.drink_beer?, "Party should offer beer."
+    assert party.drink_beer, "Party should offer beer."
     assert party.drink_cuba_libre?, "Party should offer cuba libre."
   end
   
+  def test_should_have_to_s_method
+    party = Party.new(:location => "Beach House", :drinks => [Drinks::Beer, Drinks::CubaLibre])
+    assert_equal "Beer, CubaLibre", party.drinks.to_s
+  end
+  
   def test_should_provide_the_name_of_the_enum_class
     Party.has_set :music, :enum_class => MusicStyles
 
@@ -93,4 +105,14 @@ class HasSetTest < Test::Unit::TestCase
     assert_raise(ArgumentError) { person.interests = Drinks::Beer }
   end
   
+  def test_should_list_all_available_enum_elements
+    assert_equal ["drink_beer", "drink_cuba_libre", "drink_wine"], Party.new.available_drinks
+  end
+  
+  def test_should_extend_enum_with_fieldname_method
+    assert_equal "drink_cuba_libre", Drinks::CubaLibre.field_name
+    assert_equal "drink_beer", Drinks::Beer.field_name
+    assert_equal "drink_wine", Drinks::Wine.field_name
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pkwde-has_set
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors: 
 - pkw.de Dev Team
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-16 00:00:00 -07:00
+date: 2009-05-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,9 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.2.2
+        version: 2.3.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -28,9 +28,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.2.2
+        version: 2.3.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: newgem
@@ -105,7 +105,7 @@ files:
 - script/generate
 - test/has_set_test.rb
 - test/test_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/pkwde/has_set
 post_install_message: 
 rdoc_options: 
@@ -130,7 +130,7 @@ requirements: []
 rubyforge_project: has_set
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A Gem that enables ActiveRecord models to have a set of values defined in a certain class and stored in an integer bitfield on the database level.
 test_files: 
 - test/test_helper.rb