acts_as_enumable 0.0.1 → 0.0.2.alpha

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - ruby-head

data/README.md

@@ -1,4 +1,4 @@
-# ActsAsEnumable
+# ActsAsEnumable [![Build Status](https://secure.travis-ci.org/peterwongpp/acts_as_enumable.png)](http://travis-ci.org/peterwongpp/acts_as_enumable)
 
 Provide Enum functionality for Active Record.
 
@@ -40,7 +40,7 @@ This enables the following methods:
 ``` ruby
 user = User.first
     
-User::ROLES
+User.roles
 # ["admin", "staff", "helper", "member"]
     
 User.roles_for_select("users.roles")
@@ -69,6 +69,19 @@ user.role_enum = 0
 user.role
 # "admin"
 ```
+
+## Todo
+
+* ActiveRecord scope support
+  * `User.having_roles_of(["admin", "staff"])`
+  * `User.having_status_of("active")`
+  * ...
+* Shorthand checking
+  * `user.admin?`
+  * `user.has_status?("active")`
+  * `user.in_roles?(["admin", "staff"])`
+* Code refactoring
+
 ## Development
 
 If you have any problems, please post them on the [issue tracker](https://github.com/peterwongpp/acts_as_enumable/issues).

data/acts_as_enumable.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "supermodel"
 end

data/lib/acts_as_enumable/model_additions.rb

@@ -1,35 +1,90 @@
 module ActsAsEnumable
   module ModelAdditions
+    # To make the attribute an enum.
+    #
+    #   class User < ActiveRecord::Base
+    #     # assumes the column exists:
+    #     #   integer :role_enum
+    #
+    #     acts_as_enumable(:role, %w(admin staff helper member), defaul: "member")
+    #   end
+    #
+    # Available options are:
+    #
+    #   (optional) default: String / Symbol
+    #     default value, will be set to nil if it is not provided or it does not match the preset list
+    #     eg.
+    #     acts_as_enumable :role, %w(admin staff), default: :something_not_exist # set the default value to nil
+    #     acts_as_enumable :role, %w(admin staff), default: "staff" # set the defaut value to "staff"
+    #
+    # This enables the following methods:
+    #
+    #   user = User.first
+    #   User.roles
+    #   # ["admin", "staff", "helper", "member"]
+    #
+    #   User.roles_for_select("users.roles")
+    #   # [
+    #   #   { key: "admin", value: I18n.t("users.roles.admin") },
+    #   #   { key: "staff", value: I18n.t("users.roles.staff") }, ...
+    #   # ]
+    #
+    #   User.default_role
+    #   # "member"
+    #
+    #   User.default_role_enum
+    #   # 3
+    #
+    #   user.role
+    #   # "member"
+    #
+    #   user.role = "staff" # or user.role = :staff
+    #   user.role
+    #   # "staff"
+    #
+    #   user.role_enum # if user.role == "staff"
+    #   # 1
+    #
+    #   user.role_enum = 0
+    #   user.role
+    #   # "admin"
     def acts_as_enumable(attribute_name, enum_values, options={})
-      const_set(attribute_name.to_s.pluralize.upcase, enum_values)
+      attribute = attribute_name.to_s
+      options[:default] ||= nil
 
-      class_eval <<-EOF
-def self.#{attribute_name.to_s.pluralize}_for_select(i18n_namespace)
-  #{attribute_name.to_s.pluralize.upcase}.map do |value|
-    { key: value, value: I18n.t("\#{i18n_namespace}.\#{value}") }
-  end
-end
-EOF
+      class_eval %Q{
+        def self.#{attribute.pluralize}
+          #{enum_values}
+        end
+      }
+
+      class_eval %Q{
+        def self.#{attribute.pluralize}_for_select(i18n_namespace)
+          #{attribute.pluralize}.map do |value|
+            { key: value, value: I18n.t("\#{i18n_namespace}.\#{value}") }
+          end
+        end
+      }
 
-      class_eval <<-EOF
-def self.default_#{attribute_name}
-  #{options[:default].nil? ? "nil" : "\"#{options[:default]}\""}
-end
-EOF
+      class_eval %Q{
+        def self.default_#{attribute}
+          #{options[:default].nil? ? "nil" : "\"#{options[:default]}\""}
+        end
+      }
 
-      class_eval <<-EOF
-def self.default_#{attribute_name}_enum
-  #{attribute_name.to_s.pluralize.upcase}.index(self.default_#{attribute_name})
-end
-EOF
+      class_eval %Q{
+        def self.default_#{attribute}_enum
+          #{attribute.pluralize}.index(default_#{attribute})
+        end
+      }
 
       define_method attribute_name do
         index = send("#{attribute_name}_enum")
         return nil if index.nil?
-        self.class.const_get(attribute_name.to_s.pluralize.upcase)[index]
+        self.class.send(attribute.pluralize)[index]
       end
       define_method "#{attribute_name}=" do |value|
-        value_index = self.class.const_get(attribute_name.to_s.pluralize.upcase).index(value.to_s)
+        value_index = self.class.send(attribute.pluralize).index(value.to_s)
         send("#{attribute_name}_enum=", value_index)
       end
 
@@ -37,7 +92,7 @@ EOF
         read_attribute(:"#{attribute_name}_enum") || self.class.send("default_#{attribute_name}_enum")
       end
       define_method "#{attribute_name}_enum=" do |value_index|
-        counts = self.class.const_get(attribute_name.to_s.pluralize.upcase).count
+        counts = self.class.send(attribute.pluralize).count
         value_index = (0...counts).include?(value_index) ? value_index : self.class.send("default_#{attribute_name}_enum")
         write_attribute(:"#{attribute_name}_enum", value_index)
       end

data/lib/acts_as_enumable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsEnumable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2.alpha"
 end

data/spec/acts_as_enumable/model_additions_spec.rb

@@ -16,8 +16,12 @@ end
 
 describe ActsAsEnumable::ModelAdditions do
   it "creates a constant given the attribute name and values" do
-    User::ROLES.should == %w(admin staff helper member)
-    User::STATUSES.should == %w(active inactive)
+    User.roles.should == %w(admin staff helper member)
+    User.statuses.should == %w(active inactive)
+  end
+
+  it "is a testing function..." do
+    User.roles.should == %w(admin staff helper member)
   end
 
   it "returns an array to be used for select" do

metadata

@@ -1,19 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_enumable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2.alpha
+  prerelease: 6
 platform: ruby
 authors:
 - PeterWong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000Z
+date: 2012-01-31 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70184002699440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70184002699440
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70133557158680 !ruby/object:Gem::Requirement
+  requirement: &70184002699020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133557158680
+  version_requirements: *70184002699020
 - !ruby/object:Gem::Dependency
   name: supermodel
-  requirement: &70133553186400 !ruby/object:Gem::Requirement
+  requirement: &70184002698600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133553186400
+  version_requirements: *70184002698600
 description: Enum is to choose a value from a preset list
 email:
 - peter@primitus.com
@@ -43,6 +54,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -70,9 +82,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: acts_as_enumable
 rubygems_version: 1.8.6