belongs_to_enum 0.1 → 0.2

data/README

@@ -1,2 +1,42 @@
 Adds support for transparent enums to ActiveRecord.
-Adds a belongs_to_enum to ActiveRecord that takes an array of possible values.
+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:
+gem "belongs_to_enum"
+
+Tests
+---------
+Uses rspec for testing.
+Run tests with rspec spec/*
+
+Todo
+---------
+* Add scopes
+
+Example
+---------
+
+Usage:
+
+    In models:
+        scope :admin, where(:role_id => User::Role.admin)
+    
+    In views:
+        =f.select(:role, User::Role.pretty_items)
+        -User::Role.each do |role_title, role_id|
+            #{role_title} (#{role_id})
+        
+Classes:
+    class User < ActiveRecord::Base
+      belongs_to_enum :role, [:normal, :admin, :superadmin, :suspended]
+    end
+
+Database Schema:
+
+    create_table :users do |t|
+      t.float :role_id
+    end

data/lib/belongs_to_enum/enum.rb

@@ -26,13 +26,13 @@ module BelongsToEnum
       @hash.values
     end
 
-    def Enum.pretty_items
+    def Enum.items_for_select
       @hash.sort{|a,b| a[1]<=>b[1]}.map{|i|[i[0].to_s.gsub("_", " ").capitalize,i[1]]}
     end
     
     def Enum.items
       warn "DEPRECIATED belongs_to_enum: Use pretty items instead"
-      pretty_items
+      items_for_select
     end
 
     def Enum.get(value)

data/lib/belongs_to_enum/version.rb

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

data/spec/belongs_to_enum.rb

@@ -26,12 +26,12 @@ describe "Belongs To Enum models" do
     end
   end
   
-  it "has pretty items" do
-    User::Role.pretty_items.first[0].should == "Normal"
-    User::Role.pretty_items.first[1].should == 1
+  it "has items_for_select" do
+    User::Role.items_for_select.first[0].should == "Normal"
+    User::Role.items_for_select.first[1].should == 1
   end
   
-  it "has depreciated items method that maps to pretty_items" do
+  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
   end

metadata

@@ -2,7 +2,7 @@
 name: belongs_to_enum
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Jeremy walker
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-17 00:00:00 +01:00
+date: 2011-05-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency