haz_enum 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rake_tasks

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Galaxy Cats IT Consulting GmbH
+
+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,17 @@
+= haz_enum
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Galaxy Cats IT Consulting GmbH. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "haz_enum"
+    gem.summary = %Q{has_set and has_enum for ActiveRecord}
+    gem.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))}
+    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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "haz_enum #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/haz_enum.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{haz_enum}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["thyphoon"]
+  s.date = %q{2010-06-15}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "haz_enum.gemspec",
+     "lib/haz_enum.rb",
+     "lib/haz_enum/enum.rb",
+     "lib/haz_enum/set.rb",
+     "spec/enum_spec.rb",
+     "spec/set_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/galaxycats/haz_enum}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{has_set and has_enum for ActiveRecord}
+  s.test_files = [
+    "spec/enum_spec.rb",
+     "spec/set_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<activerecord>, [">= 3.0.0.beta3"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0.beta3"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/haz_enum/enum.rb

@@ -0,0 +1,38 @@
+module HazEnum
+  module Enum
+    def has_enum(enum_name, options={})
+      enum_name = enum_name.to_s
+      enum_column = options.has_key?(:column_name) ? options[:column_name].to_s : enum_name
+      enum_class = options.has_key?(:class_name) ? Object.const_get(options[:class_name].to_s.classify) : Object.const_get(enum_name.pluralize.camelize)
+      
+      self.attr_protected("#{enum_column}") if enum_name != enum_column
+      self.validate "#{enum_column}_check_for_valid_enum_value"
+      
+      define_method "#{enum_name}" do
+        begin
+          return enum_class.const_get(self["#{enum_column}"]) if self["#{enum_column}"]
+          return nil
+        rescue NameError => e
+          return nil
+        end
+      end
+      
+      define_method "#{enum_name}=" do |enum_to_set|
+        self["#{enum_column}"] = enum_to_set.name
+      end
+      
+      define_method "#{enum_name}_changed?" do
+        send("#{enum_column}_changed?")
+      end if enum_name != enum_column
+      
+      define_method "#{enum_column}_check_for_valid_enum_value" do
+        return true if self["#{enum_column}"].nil?
+        begin
+          enum_class.const_get(self["#{enum_column}"])
+        rescue NameError => e
+          self.errors.add("#{enum_name}".to_sym, I18n.t("activerecord.errors.messages.enum_value_invalid", :value => self["#{enum_column}"], :name => enum_name))
+        end
+      end
+    end
+  end
+end

data/lib/haz_enum/set.rb

@@ -0,0 +1,59 @@
+module HazEnum
+  module Set
+    def has_set(set_name, options={})
+      
+      field_type = options.has_key?(:field_type) ? options[:field_type].to_s : "bitfield"
+      set_column = options.has_key?(:column_name) ? options[:column_name].to_s : "#{set_name}_#{field_type}"
+      enum_class = options.has_key?(:class_name) ? Object.const_get(options[:class_name].to_s.camelize) : Object.const_get(set_name.to_s.camelize)
+      
+      after_find "initialize_#{set_name}_from_bitfield"
+      before_save "convert_#{set_name}_to_bitfield"
+      
+      enum_class.class_eval do
+        def bitfield_index
+          index + 1
+        end
+      end unless enum_class.method_defined?(:bitfield_index)
+      
+      define_method("#{set_name}") do
+        instance_variable_get("@#{set_name}")
+      end
+      
+      define_method("#{set_name}=") do |value|
+        class <<value
+          yield if block_given?
+        end
+        instance_variable_set("@#{set_name}", value)
+      end
+      
+      define_method("has_#{set_name.to_s.singularize}?") do |set_value|
+        send(set_name).include?(set_value)
+      end
+      
+      define_method("#{set_name}_changed?") do
+        send("convert_#{set_name}_to_bitfield")
+        send("#{set_column}_changed?")
+      end
+      
+      define_method("convert_#{set_name}_to_bitfield") do
+        self[set_column] = 0
+        if send(set_name)
+          send(set_name).each do |element|
+            2**element.bitfield_index & self[set_column] == 2**element.bitfield_index ? next : self[set_column] += 2**element.bitfield_index
+          end
+        end
+      end
+
+      define_method("initialize_#{set_name}_from_bitfield") do
+        if self[set_column]
+          set_elements = enum_class.values.collect do |enum_element|
+            enum_element if ((2**enum_element.bitfield_index & self[set_column]) == 2**enum_element.bitfield_index)
+          end.compact
+          send("#{set_name}=", set_elements)
+        else
+          self[set_column] = 0
+        end
+      end
+    end
+  end
+end

data/lib/haz_enum.rb

@@ -0,0 +1,8 @@
+require "haz_enum/enum"
+require "haz_enum/set"
+
+module HazEnum
+end
+
+ActiveRecord::Base.extend HazEnum::Enum
+ActiveRecord::Base.extend HazEnum::Set

data/spec/enum_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HazEnum" do
+  
+  describe "Enum" do
+    
+    before(:all) do
+      setup_db
+    end
+  
+    it "should have class method has_enum" do
+      ClassWithEnum.should respond_to(:has_enum)
+    end
+  
+    it "should be able to set enum-attribute via hash in initializer" do
+      ClassWithEnum.new(:product => Products::Silver).product.should be(Products::Silver)
+      ClassWithCustomNameEnum.new(:product => Products::Silver).product.should be(Products::Silver)
+    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)
+    end
+  
+    it "should have a enum_value attribute" do
+      ClassWithCustomNameEnum.new(:product => Products::Gold).custom_name.should be(Products::Gold.name)
+    end
+  
+    it "colum_name should be configurable" do
+      ClassWithCustomNameEnum.new(:product => Products::Gold).custom_name.should be(Products::Gold.name)
+    end
+  
+    it "should know if enum-attribute has changed" do
+      product_enum = ClassWithEnum.new(:product => Products::Silver)
+      product_enum.product_changed?.should be(true)
+      product_enum.save
+      product_enum.product_changed?.should be(false)
+      product_enum.product = Products::Gold
+      product_enum.product_changed?.should be(true)
+    end
+  
+    it "should know if enum-attribute has not really changed" do
+      product_enum = ClassWithEnum.new(:product => Products::Silver)
+      product_enum.save
+      product_enum.product = Products::Silver
+      product_enum.product_changed?.should be(false)
+    end
+  
+    it "should validate enum-value" do
+      enum_mixin = ClassWithEnum.new
+      platin = "Platin"
+      class <<platin; def name;"Platin";end;end
+      enum_mixin.product = platin
+      enum_mixin.valid?.should_not be(true)
+      enum_mixin.errors[:product].size.should > 0
+    end
+  
+    after(:all) do
+      teardown_db
+    end
+    
+  end
+end

data/spec/set_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HazEnum" do
+  
+  describe "Set" do
+    
+    before(:all) do
+      setup_db
+    end
+    
+    it "should have class method has_enum" do
+      ClassWithSet.should respond_to(:has_set)
+    end
+    
+    it "should be able to set set-values via hash in initializer" do
+      ClassWithSet.new(:roles => [Roles::User, Roles::Admin]).roles[0].should be(Roles::User)
+      ClassWithSet.new(:roles => [Roles::User, Roles::Admin]).roles[1].should be(Roles::Admin)
+    end
+    
+    it "should not be able to set set-values by colum-name via hash in initializer" do
+      lambda { ClassWithEnum.new(:roles_bitfield => 3) }.should raise_error
+    end
+    
+    it "colum_name should be configurable" do
+      ClassWithCustomNameSet.new(:roles => [Roles::Admin]).roles.first.should be(Roles::Admin)
+    end
+    
+    it "should know if set-attribute has changed" do
+      roles_set = ClassWithSet.new(:roles => [Roles::Admin])
+      roles_set.roles_changed?.should be(true)
+      roles_set.save
+      roles_set.roles_changed?.should be(false)
+      roles_set.roles = [Roles::Supervisor]
+      roles_set.roles_changed?.should be(true)
+    end
+  
+    it "should know if enum-attribute has not really changed" do
+      roles_set = ClassWithSet.new(:roles => [Roles::Admin])
+      roles_set.save
+      roles_set.roles = [Roles::Admin]
+      roles_set.roles_changed?.should be(false)
+    end
+    
+    it "should be able to add set-value" do
+      roles_set = ClassWithSet.new(:roles => [Roles::Admin])
+      roles_set.save
+      roles_set.roles << Roles::Supervisor
+      roles_set.save
+      roles_set.reload
+      roles_set.has_role?(Roles::Admin).should == true
+      roles_set.has_role?(Roles::Supervisor).should == true
+    end
+    
+    it "should be able to define association methods" do
+      extended = ClassWithSet.new(:extended_roles => [Roles::Admin, Roles::Supervisor, Roles::User])
+      extended.to_s.should == "Admin, Supervisor, User"
+    end
+    
+    after(:all) do
+      teardown_db
+    end
+    
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "rubygems"
+require "active_record"
+require 'renum'
+require 'haz_enum'
+require 'spec'
+require 'spec/autorun'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Migration.verbose = false
+
+def setup_db
+  ActiveRecord::Base.silence do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :class_with_enums do |t|
+        t.column :title, :string
+        t.column :product, :string
+        t.column :created_at, :datetime
+        t.column :updated_at, :datetime
+      end
+
+      create_table :class_with_custom_name_enums do |t|
+        t.column :title, :string
+        t.column :custom_name, :string
+        t.column :created_at, :datetime
+        t.column :updated_at, :datetime
+      end
+
+      create_table :class_with_sets do |t|
+        t.column :title, :string
+        t.column :roles_bitfield, :integer
+        t.column :created_at, :datetime
+        t.column :updated_at, :datetime
+      end
+
+      create_table :class_with_custom_name_sets do |t|
+        t.column :title, :string
+        t.column :custom_name, :string
+        t.column :created_at, :datetime
+        t.column :updated_at, :datetime
+      end
+
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+enum :Fakes, [:NOT_DEFINIED]
+enum :Products, [:Silver, :Gold, :Titanium]
+
+enum :Roles, [:Admin, :Supervisor, :User]
+
+setup_db # Init the database for class creation
+
+class ClassWithEnum < ActiveRecord::Base
+  has_enum :product
+end
+
+class ClassWithCustomNameEnum < ActiveRecord::Base
+  has_enum :product, :column_name => :custom_name
+end
+
+class ClassWithSet < ActiveRecord::Base
+  has_set :roles
+  has_set :extended_roles, :class_name => :roles do
+    def to_s
+      extended_roles.collect(&:name).join(", ")
+    end
+  end
+end
+
+class ClassWithCustomNameSet < ActiveRecord::Base
+  has_set :roles, :column_name => :custom_name
+end
+
+teardown_db # And drop them right afterwards
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: haz_enum
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- thyphoon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-15 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- haz_enum.gemspec
+- lib/haz_enum.rb
+- lib/haz_enum/enum.rb
+- lib/haz_enum/set.rb
+- spec/enum_spec.rb
+- spec/set_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/galaxycats/haz_enum
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: has_set and has_enum for ActiveRecord
+test_files: 
+- spec/enum_spec.rb
+- spec/set_spec.rb
+- spec/spec_helper.rb