haz_enum 0.4.3 → 0.5.0

data/README.rdoc

@@ -1,6 +1,108 @@
 = haz_enum
 
-Description goes here.
+haz_enum is a ActiveRecord extension to allow associations to enumerations.  
+
+== Installation
+  
+haz_enum is hostet on rubygems.org, so yoou can just do
+  
+  gem install haz_enum
+  
+or if you use bundler, just add the following line to your Gemfile:
+  
+  gem "haz_enum"
+  
+
+== Example with renum
+
+renum is a perfect library for enumerations in ruby (see http://github.com/duelinmarkers/renum). Here is a simple renum definition:
+
+  enum :Roles do
+    Admin()
+    Supervisor()
+    ContentManager()
+  end
+
+in your AR-model you can now write
+
+  class User < ActiveRecord
+    has_enum :role
+  end
+
+what you need is a column in your db named <code>role</code> with type <code>string</code>.
+
+  user = User.create(:role => Roles::Admin)
+  user.has_role?(Roles::Admin) => true
+  user.has_role?(Roles::Supervisor) => false
+  
+The example above realizes one role per user. But what if you want to have multiple Roles per user? Just change <code>has_enum</code> to <code>has_set</code> and rename the column to <code>roles</code>:
+  
+  class User < ActiveRecord
+    has_set :roles
+  end
+
+  user = User.create(:roles => Roles::Admin)
+  user.has_role?(Roles::Admin) => true
+  user.has_role?(Roles::Supervisor) => false
+
+or
+  
+  user = User.create(:roles => [Roles::Admin, Roles::Supervisor])
+  user.has_role?(Roles::Admin) => true
+  user.has_role?(Roles::Supervisor) => true
+  
+now <code>roles</code> behaves just like an array, so you can also do
+
+  user = User.create(:roles => Roles::Admin)
+  user.roles << Roles::Supervisor
+  user.has_role?(Roles::Admin) => true
+  user.has_role?(Roles::Supervisor) => true
+
+== Using bitfields
+
+If you have an enum with many possible values you can switch from :yml to field_type :bitfield. 
+
+  class User < ActiveRecord
+    has_set :roles, :field_type => :bitfield
+  end
+
+Your db-column has to be an integer for field_type bitfield. If you use mysql with int(11) you are able to have up to 64 different values in your enumeration.
+
+== You do not need renum
+
+...but it really makes sense to use this library. If you really do not want to use it you have to implement against an interface. Here is a simple ruby module example to get the same results as above for has_enum:
+
+  module Roles
+    class Admin; def self.name; "Admin"; end; end
+    class Supervisor; def self.name; "Supervisor"; end; end
+    class ContentManager; def self.name; "ContentManager"; end; end
+  end
+
+You cannot use this for <code>has_set</code> and <code>field_type :yml</code> since you cannot dump anonymous classes. But you can use <code>field_type :bitfield</code>. Then your class could look something like that:
+
+  module Roles
+    class Admin
+      def self.bitfield_index; 1; end
+    end
+    class Supervisor
+      def self.bitfield_index; 2; end
+    end
+    class ContentManager
+      def self.bitfield_index; 3; end
+    end
+    class <<self
+      def values
+        Roles.constants.collect { |c| Roles.const_get(c) }
+      end
+    end
+  end
+
+As you can see, your classes have to respond to <code>bitfield_index</code> and your wrapping module has to respond to values and return all available classes. So now you could do:
+
+  class User < ActiveRecord
+    has_enum :role, :field_type => :bitfield
+  end
+
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -10,8 +10,9 @@ begin
     gem.email = "andi@galaxycats.com"
     gem.homepage = "http://github.com/galaxycats/haz_enum"
     gem.authors = ["thyphoon"]
-    gem.add_dependency "activerecord", ">= 3.0.0.beta3"
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "activerecord", "~> 3.0.0"
+    gem.add_development_dependency "rspec", "~> 1.3.0"
+    gem.add_development_dependency "renum", "~> 1.3.1"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/haz_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{haz_enum}
-  s.version = "0.4.3"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["thyphoon"]
-  s.date = %q{2010-06-29}
+  s.date = %q{2010-09-16}
   s.description = %q{use has_set and has_enum in your ActiveRecord models if you want to have one (has_enum) value from a defined enumeration or more (has_set))}
   s.email = %q{andi@galaxycats.com}
   s.extra_rdoc_files = [
@@ -49,15 +49,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<renum>, ["~> 1.3.1"])
     else
-      s.add_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_dependency(%q<renum>, ["~> 1.3.1"])
     end
   else
-    s.add_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    s.add_dependency(%q<renum>, ["~> 1.3.1"])
   end
 end
 

data/lib/haz_enum/enum.rb

@@ -25,6 +25,10 @@ module HazEnum
         end
       end
       
+      define_method "has_#{enum_name}?" do |enum|
+        send(enum_name) == enum
+      end
+      
       define_method "#{enum_name}_changed?" do
         send("#{enum_column}_changed?")
       end if enum_name != enum_column

data/lib/haz_enum/set.rb

@@ -2,7 +2,7 @@ module HazEnum
   module Set
     def has_set(set_name, options={})
       
-      field_type = options.has_key?(:field_type) ? options[:field_type].to_s : "bitfield"
+      field_type = options.has_key?(:field_type) ? options[:field_type].to_s : "yml"
       set_column = options.has_key?(:column_name) ? options[:column_name].to_s : "#{set_name}_#{field_type}"
       enum_class = options.has_key?(:class_name) ? options[:class_name].to_s.camelize.constantize : set_name.to_s.camelize.constantize
       separator = options.has_key?(:separator) ? options[:separator].to_s : ", "
@@ -15,11 +15,14 @@ module HazEnum
       end
       
       define_method("#{set_name}=") do |value|
+        value = [value].flatten
         value.collect! { |val| val.is_a?(String) ? val.constantize : val }.compact! if value.is_a?(Array)
         value.instance_variable_set("@separator", separator)
         class <<value
-          define_method :to_s do
-            self.join(@separator)
+          define_method :human do
+            self.collect do |enum|
+              enum.respond_to?(:model_name) ? enum.model_name.human : enum.name
+            end.join(@separator)
           end
           yield if block_given?
         end

data/lib/haz_enum.rb

@@ -2,6 +2,11 @@ require "haz_enum/enum"
 require "haz_enum/set"
 
 module HazEnum
+  class <<self
+    def available_field_types_for_sets
+      [:yml, :bitfield]
+    end
+  end
 end
 
 ActiveRecord::Base.extend HazEnum::Enum

data/spec/enum_spec.rb

@@ -21,6 +21,12 @@ describe "HazEnum" do
       ClassWithEnum.new(:product => "Silver").product.should be(Products::Silver)
     end
     
+    it "should have has_<association>? method" do
+      class_with_enum = ClassWithEnum.new(:product => "Silver")
+      class_with_enum.has_product?(Products::Silver).should == true
+      class_with_enum.has_product?(Products::Gold).should == false
+    end
+    
     it "should not be able to set enum-attribute by colum-name via hash in initializer" do
       ClassWithCustomNameEnum.new(:custom_name => Products::Silver).product.should_not be(Products::Silver)
       ClassWithCustomNameEnum.new(:custom_name => Products::Silver.name).product.should_not be(Products::Silver)
@@ -59,6 +65,11 @@ describe "HazEnum" do
       enum_mixin.errors[:product].size.should > 0
     end
     
+    it "should work without renum (just ruby module with classes)" do
+      role_enum = ClassWithEnum.new(:module_role => ModuleRoles::Admin)
+      role_enum.has_module_role?(ModuleRoles::Admin).should == true
+    end
+    
     after(:all) do
       teardown_db
     end

data/spec/set_spec.rb

@@ -21,6 +21,12 @@ describe "HazEnum" do
       ClassWithSet.new.roles.should == []
     end
     
+    it "should have has_<association>? method" do
+      class_with_enum = ClassWithSet.new(:roles => Roles::Admin)
+      class_with_enum.has_role?(Roles::Admin).should == true
+      class_with_enum.has_role?(Roles::User).should == false
+    end
+    
     it "should be able to save values as yml" do
       YmlSet.new(:roles => [Roles::User, Roles::Admin]).roles[1].should be(Roles::Admin)
       yml_set = YmlSet.create(:roles => [Roles::User, Roles::Admin])
@@ -67,6 +73,16 @@ describe "HazEnum" do
       extended.to_s.should == "Admin, Supervisor, User"
     end
     
+    it "should be able to work without renum and bitfield" do
+      roles_set = ClassWithSet.new(:module_bitfield_roles => [ModuleBitfieldRoles::Admin, ModuleBitfieldRoles::Supervisor])
+      roles_set.has_module_bitfield_role?(ModuleBitfieldRoles::Admin).should == true
+      roles_set.has_module_bitfield_role?(ModuleBitfieldRoles::Supervisor).should == true
+      roles_set.save
+      roles_set.reload
+      roles_set.has_module_bitfield_role?(ModuleBitfieldRoles::Admin).should == true
+      roles_set.has_module_bitfield_role?(ModuleBitfieldRoles::Supervisor).should == true
+    end
+    
     after(:all) do
       teardown_db
     end

data/spec/spec_helper.rb

@@ -54,13 +54,36 @@ end
 
 enum :Fakes, [:NOT_DEFINIED]
 enum :Products, [:Silver, :Gold, :Titanium]
-
 enum :Roles, [:Admin, :Supervisor, :User]
 
+module ModuleRoles
+  class Admin; def self.name; "Admin"; end; end
+  class Supervisor; def self.name; "Supervisor"; end; end
+  class ContentManager; def self.name; "ContentManager"; end; end
+end
+
+module ModuleBitfieldRoles
+  class Admin
+    def self.bitfield_index; 1; end
+  end
+  class Supervisor
+    def self.bitfield_index; 2; end
+  end
+  class ContentManager
+    def self.bitfield_index; 3; end
+  end
+  class <<self
+    def values
+      ModuleBitfieldRoles.constants.collect { |c| ModuleBitfieldRoles.const_get(c) }
+    end
+  end
+end
+
 setup_db # Init the database for class creation
 
 class ClassWithEnum < ActiveRecord::Base
   has_enum :product
+  has_enum :module_role
 end
 
 class ClassWithCustomNameEnum < ActiveRecord::Base
@@ -74,6 +97,8 @@ class ClassWithSet < ActiveRecord::Base
       extended_roles.collect(&:name).join(", ")
     end
   end
+  has_set :module_roles
+  has_set :module_bitfield_roles, :field_type => :bitfield
 end
 
 class YmlSet < ActiveRecord::Base

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 3
-  version: 0.4.3
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - thyphoon
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-29 00:00:00 +02:00
+date: 2010-09-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,14 +22,13 @@ dependencies:
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 3
         - 0
         - 0
-        - beta3
-        version: 3.0.0.beta3
+        version: 3.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -37,15 +36,29 @@ dependencies:
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 1
-        - 2
-        - 9
-        version: 1.2.9
+        - 3
+        - 0
+        version: 1.3.0
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: renum
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id003
 description: use has_set and has_enum in your ActiveRecord models if you want to have one (has_enum) value from a defined enumeration or more (has_set))
 email: andi@galaxycats.com
 executables: []