belongs_to_enum 0.2 → 0.3

data/README

@@ -1,8 +1,6 @@
 Adds support for transparent enums to ActiveRecord.
 Adds a belongs_to_enum to ActiveRecord that takes an array of possible values.
 
-Adds an add_extra_data method to ActiveRecord that invisibly includes an extra data table. Use with STI to keep your database clean. It removes the need to have lots of nullable columns.
-
 Usage
 ---------
 Use in Rails 3 app. Add to bundler:

data/belongs_to_enum.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["jez.walker@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{Adds support for transparent enums to ActiveRecord}
-  s.description = %q{Adds a belongs_to_enum to ActiveRecord that takes an array of possible values.}
+  s.description = %q{Adds belongs_to_enum method to ActiveRecord::Base, allowing enums to be created with associated scopes and more.}
 
   s.rubyforge_project = "belongs_to_enum"
   

data/lib/belongs_to_enum/enum.rb

@@ -31,7 +31,7 @@ module BelongsToEnum
     end
     
     def Enum.items
-      warn "DEPRECIATED belongs_to_enum: Use pretty items instead"
+      warn "DEPRECIATED belongs_to_enum: Use items_for_select instead"
       items_for_select
     end
 
@@ -47,7 +47,15 @@ module BelongsToEnum
       @hash
     end
 
-    def self.create(name, parent, keys)
+    def Enum.valid?(value)
+      @hash.has_value?(value.to_i)
+    end
+
+    def Enum.default
+      @hash.values.first
+    end
+
+    def self.create(name, parent, keys, options = {})
       
       # Check to see if this has already been defined...
       return if parent.const_defined?(name.to_s.camelize)
@@ -64,15 +72,20 @@ module BelongsToEnum
         keys.each do |k,v|
           klass.add_item(k,v)
         end
-      #elsif(keys.respond_to? :raw_hash)
-      #  keys.send(:raw_hash).each do |k,v|
-      #    klass.add_item(k,v)
-      #  end
       else
         keys.each_with_index do |key, index|
           klass.add_item(key, index + 1)
         end
       end
+      
+      # Create scopes if required
+      if options[:create_scopes]
+        klass.raw_hash.each do |key, value|
+          parent.instance_exec do
+            scope key.to_s.pluralize, where("#{name.to_s.underscore}_id" == value)
+          end
+        end
+      end
     end
   end
 end

data/lib/belongs_to_enum/hook.rb

@@ -2,8 +2,8 @@ require File.join(File.dirname(__FILE__), "enum")
 
 module BelongsToEnum
   module Hook
-    def belongs_to_enum(name, keys)
-      BelongsToEnum::Enum.create(name, self, keys)
+    def belongs_to_enum(name, keys, options = {})
+      BelongsToEnum::Enum.create(name, self, keys, options)
       name = name.to_s
       class_eval <<-EOS
         def #{name}?

data/lib/belongs_to_enum/version.rb

@@ -1,3 +1,3 @@
 module BelongsToEnum
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/spec/belongs_to_enum.rb

@@ -3,51 +3,135 @@ require 'spec_helper'
 describe "Belongs To Enum models" do
 
   it "constants should be set" do
-    User.const_defined?("Role").should be_true
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    
+    klass.const_defined?("Role").should be_true
   end
   
   it "constant has keys" do
-    User::Role.should respond_to(:admin)
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.should respond_to(:normal)
   end
   
   it "keys should start at 1" do
-    User::Role.normal.should == 1
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.normal.should == 1
+  end
+  
+  it "can check to see if a key is valid" do
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.valid?(1).should be_true
+    klass::Role.valid?(2).should be_false
+  end
+  
+  it "has a default value" do
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role1, [:normal]
+      belongs_to_enum :role2, {:normal => 10}
+    end
+    klass::Role1.default.should == 1
+    klass::Role2.default.should == 10
   end
 
   it "keys should respect hash values" do
-    Vehicle::Make.honda.should == 10
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, {:normal => 10, :admin => 20}
+    end
+    klass::Role.normal.should == 10
+    klass::Role.admin.should == 20
   end
   
   it "keys can be iterated through" do
-    User::Role.each do |role, role_id|
-      role.should == :normal
-      role_id.should == 1
-      break
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal, :admin]
+    end
+    i = 1
+    klass::Role.each do |role, role_id|
+      role.should == (i == 1 ? :normal : :admin)
+      role_id.should == i
+      i += 1
     end
   end
   
   it "has items_for_select" do
-    User::Role.items_for_select.first[0].should == "Normal"
-    User::Role.items_for_select.first[1].should == 1
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.items_for_select.first[0].should == "Normal"
+    klass::Role.items_for_select.first[1].should == 1
   end
   
   it "has depreciated items method that maps to items_for_select" do
-    User::Role.items.first[0].should == "Normal"
-    User::Role.items.first[1].should == 1
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.items.first[0].should == "Normal"
+    klass::Role.items.first[1].should == 1
   end
   
   it "can get item from id" do
-    User::Role.get(1).should == :normal
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.get(1).should == :normal
   end
 
   it "pretty displays item" do
-    User::Role.display(1).should == "Normal"
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.display(1).should == "Normal"
   end
   
   it "can access raw hash" do
-    User::Role.raw_hash.is_a?(Hash)
-    User::Role.raw_hash.keys[0].should == :normal
-    User::Role.raw_hash.values[0].should == 1
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      belongs_to_enum :role, [:normal]
+    end
+    klass::Role.raw_hash.is_a?(Hash)
+    klass::Role.raw_hash.keys[0].should == :normal
+    klass::Role.raw_hash.values[0].should == 1
+  end
+  
+  it "can create scopes when requested" do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :scope_checkers do |t|
+        t.integer :role_id, :null => false
+      end
+    end
+
+    klass = Class.new(ActiveRecord::Base)
+    klass.class_exec do
+      set_table_name "scope_checkers"
+      scope :sanity_scope, where(:sanity_scope_id => 1)
+      belongs_to_enum :role1, [:normal], :create_scopes => true
+      belongs_to_enum :role2, [:admin]
+    end
+    klass.should respond_to("sanity_scope")
+    klass.should respond_to("normals")
+    klass.should_not respond_to("admins")
+    
+    klass.method("normals").source_location.should == klass.method("sanity_scope").source_location
+    klass.send("normals").to_sql.strip.should == 'SELECT "scope_checkers".* FROM "scope_checkers"'
   end
   
 

data/spec/spec_helper.rb

@@ -13,13 +13,4 @@ ActiveRecord::Base.send(:extend, BelongsToEnum::Hook)
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
  
 # AR keeps printing annoying schema statements
-$stdout = StringIO.new
-
-ActiveRecord::Base.logger
-ActiveRecord::Schema.define(:version => 1) do
-  create_table :users do |t|
-    t.integer :role_id, :null => false
-  end
-end
-
-require 'test_classes'
+$stdout = StringIO.new

metadata

@@ -2,7 +2,7 @@
 name: belongs_to_enum
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - Jeremy walker
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 +01:00
-default_executable: 
+date: 2011-06-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -35,7 +34,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: Adds a belongs_to_enum to ActiveRecord that takes an array of possible values.
+description: Adds belongs_to_enum method to ActiveRecord::Base, allowing enums to be created with associated scopes and more.
 email: 
 - jez.walker@gmail.com
 executables: []
@@ -58,8 +57,6 @@ files:
 - lib/belongs_to_enum/version.rb
 - spec/belongs_to_enum.rb
 - spec/spec_helper.rb
-- spec/test_classes.rb
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -83,11 +80,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: belongs_to_enum
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Adds support for transparent enums to ActiveRecord
 test_files: 
 - spec/belongs_to_enum.rb
 - spec/spec_helper.rb
-- spec/test_classes.rb

data/spec/test_classes.rb

@@ -1,7 +0,0 @@
-class User < ActiveRecord::Base
-  belongs_to_enum :role, [:normal, :admin, :superadmin, :suspended]
-end
-
-class Vehicle < ActiveRecord::Base
-  belongs_to_enum :make, {:honda => 10, :toyota => 20, :ford => 30}
-end