acts_as_enumable 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p290@acts_as_enumable --create

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_enumable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,78 @@
+# ActsAsEnumable
+
+Provide Enum functionality for Active Record.
+
+## Installation
+
+Add the following line to your Gemfile and run `bundle` command to install it.
+
+``` ruby
+gem 'acts_as_enumable'
+```
+
+*Requires Ruby 1.9.2 or later.*
+
+## Usage
+
+Call `acts_as_enumable` in an Active Record class and pass the name of the attribute as well as the enum values (and optionally a default value).
+
+``` ruby
+class User < ActiveRecord::Base
+  # assumes the column exists:
+  #   integer :role_enum
+
+  acts_as_enumable :role, %w(admin staff helper member), default: :member
+end
+```
+
+Available options are:
+
+``` text
+(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:
+
+``` ruby
+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"
+```
+## Development
+
+If you have any problems, please post them on the [issue tracker](https://github.com/peterwongpp/acts_as_enumable/issues).
+
+You can contribute changes by forking the project and submitting a pull request.
+
+You can ensure the tests passing by running bundle and rake.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/acts_as_enumable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_enumable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_enumable"
+  s.version     = ActsAsEnumable::VERSION
+  s.authors     = ["PeterWong"]
+  s.email       = ["peter@primitus.com"]
+  s.homepage    = "https://github.com/peterwongpp/acts_as_enumable"
+  s.summary     = %q{Provide Enum functionality for Active Record}
+  s.description = %q{Enum is to choose a value from a preset list}
+
+  s.rubyforge_project = "acts_as_enumable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "supermodel"
+end

data/lib/acts_as_enumable.rb

@@ -0,0 +1,6 @@
+require "acts_as_enumable/version"
+require "acts_as_enumable/model_additions"
+require "acts_as_enumable/railtie" if defined? Rails
+
+module ActsAsEnumable
+end

data/lib/acts_as_enumable/model_additions.rb

@@ -0,0 +1,46 @@
+module ActsAsEnumable
+  module ModelAdditions
+    def acts_as_enumable(attribute_name, enum_values, options={})
+      const_set(attribute_name.to_s.pluralize.upcase, enum_values)
+
+      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 <<-EOF
+def self.default_#{attribute_name}
+  #{options[:default].nil? ? "nil" : "\"#{options[:default]}\""}
+end
+EOF
+
+      class_eval <<-EOF
+def self.default_#{attribute_name}_enum
+  #{attribute_name.to_s.pluralize.upcase}.index(self.default_#{attribute_name})
+end
+EOF
+
+      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]
+      end
+      define_method "#{attribute_name}=" do |value|
+        value_index = self.class.const_get(attribute_name.to_s.pluralize.upcase).index(value.to_s)
+        send("#{attribute_name}_enum=", value_index)
+      end
+
+      define_method "#{attribute_name}_enum" do
+        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
+        value_index = (0...counts).include?(value_index) ? value_index : self.class.send("default_#{attribute_name}_enum")
+        write_attribute(:"#{attribute_name}_enum", value_index)
+      end
+    end
+  end
+end

data/lib/acts_as_enumable/railtie.rb

@@ -0,0 +1,9 @@
+module ActsAsEnumable
+  class Railtie < Rails::Railtie
+    initializer 'acts_as_enumable.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/acts_as_enumable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsEnumable
+  VERSION = "0.0.1"
+end

data/spec/acts_as_enumable/model_additions_spec.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+require "spec_helper"
+
+class User < SuperModel::Base
+  def role_enum
+    read_attribute(:role_enum)
+  end
+  def role_enum=(val)
+    write_attribute(:role_enum, val)
+  end
+  
+  extend ActsAsEnumable::ModelAdditions
+  acts_as_enumable :role, %w(admin staff helper member)
+  acts_as_enumable :status, %w(active inactive), default: "inactive"
+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)
+  end
+
+  it "returns an array to be used for select" do
+    User.roles_for_select("test.namespace").should == [{
+      key: "admin", value: I18n.t("test.namespace.admin")
+    }, {
+      key: "staff", value: I18n.t("test.namespace.staff")
+    }, {
+      key: "helper", value: I18n.t("test.namespace.helper")
+    }, {
+      key: "member", value: I18n.t("test.namespace.member")
+    }]
+
+    User.statuses_for_select("test.namespace").should == [{
+      key: "active", value: I18n.t("test.namespace.active")
+    }, {
+      key: "inactive", value: I18n.t("test.namespace.inactive")
+    }]
+  end
+
+  it "returns the default value" do
+    User.default_role.should be_nil
+    User.default_status.should == "inactive"
+  end
+
+  it "returns the default value index" do
+    User.default_role_enum.should be_nil
+    User.default_status_enum.should == 1
+  end
+
+  it "handles value correctly" do
+    user = User.new
+    user.role_enum.should be_nil
+    user.role.should be_nil
+    user.status_enum.should == 1
+    user.status.should == "inactive"
+
+    user.role_enum = 1
+    user.role_enum.should == 1
+    user.role.should == "staff"
+    user.status_enum = 0
+    user.status_enum.should == 0
+    user.status.should == "active"
+
+    user.role = "admin"
+    user.role_enum.should == 0
+    user.role.should == "admin"
+    user.status = "inactive"
+    user.status_enum.should == 1
+    user.status.should == "inactive"
+
+    # error cases
+
+    user.role = "not existing role"
+    user.role_enum.should be_nil # as nil is the default value for role
+    user.role.should be_nil
+    user.status = "not existing status"
+    user.status_enum.should == 1 # as 1 (i.e. inactive) is the default value for status
+    user.status.should == "inactive"
+
+    user.role_enum = 1234
+    user.role_enum.should be_nil # as nil is the default value for role
+    user.role.should be_nil
+    user.status_enum = 1234
+    user.status_enum.should == 1
+    user.status.should == "inactive"
+  end
+end

data/spec/acts_as_enumable_spec.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe ActsAsEnumable do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'acts_as_enumable'
+require 'supermodel'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_enumable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- PeterWong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70133557158680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133557158680
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  requirement: &70133553186400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133553186400
+description: Enum is to choose a value from a preset list
+email:
+- peter@primitus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- acts_as_enumable.gemspec
+- lib/acts_as_enumable.rb
+- lib/acts_as_enumable/model_additions.rb
+- lib/acts_as_enumable/railtie.rb
+- lib/acts_as_enumable/version.rb
+- spec/acts_as_enumable/model_additions_spec.rb
+- spec/acts_as_enumable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/peterwongpp/acts_as_enumable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: acts_as_enumable
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Provide Enum functionality for Active Record
+test_files:
+- spec/acts_as_enumable/model_additions_spec.rb
+- spec/acts_as_enumable_spec.rb
+- spec/spec_helper.rb