enum_id 1.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Javier Goizueta
+
+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,82 @@
+=enum_id
+
+Defines an enumerated field (stored as an integral id).
+The field is defined by its name (which must be the column name without the _id suffix),
+and a hash which maps the id valid values of the field to symbolic constants.
+The hash can also contain options with symbolic keys; currently the only valid option is
+:required which checks for non-nil values at validation; if a value other than true is
+assigned to it, it should be a hash with options that will be relayed to validates_presence_of
+
+Example: (we assume that the table for X has an integer column named 'status_id')
+
+  class X < ActiveRecord::Base
+    enum_id :status, 1=>:first, 2=>:second, 3=>:third, :required=>true
+  end
+
+This is equivalent to:
+
+  class X < ActiveRecord::Base
+    # Return the symbolic status value
+    def status
+      X.status(status_id)
+    end
+    # Assigns the symbolic status value and also accepts status ids
+    def status=(st)
+      self.status_id = X.status_id(st)
+    end
+    # Returns the status description (must be provided as a translation)
+    def status_name
+      X.status_name(status_id)
+    end
+    ENUM_ID_status_SYMBOLS = {1=>:first, 2=>:second, 3=>:third}
+    ENUM_ID_status_IDS = {:first=>1, :second=>2, :third=>3}
+    # Return the symbolic status for a status id
+    def X.status(id)
+      id && (ENUM_ID_status_SYMBOLS[id.to_i] || raise("Invalid status id: #{id}"))
+    end
+    # Return the status id for a symbolic status (or status id)
+    def X.status_id(st)
+      st && if st.kind_of?(Integer)
+        raise "Invalid status id: #{st}" unless X.status_ids.include?(st)
+        st
+      elsif st.kind_of?(Symbol)
+        ENUM_ID_status_IDS[st.to_sym] || raise("Invalid status: #{st.inspect}")
+      else
+        raise TypeError,"Integer or Symbol argument expected (got a #{st.class.name})."
+      end
+    end
+    # Return the symbolic status given a status symbol or id
+    def X.status_symbol(st)
+      st && (st.kind_of?(Integer) ? status(st) : st.to_sym)
+    end
+    # Return the description of a status symbol or id
+    def X.status_name(st)
+      st = status_symbol(st)
+      st && I18n.t("enum_id.x.status.#{st}")
+    end
+    # Return all the valid status ids in an Array [1,2,3]
+    def X.status_ids
+      ENUM_ID_status_SYMBOLS.keys.sort
+    end
+    # Return all the valid status symbols in an Array: [:first, :second, :third]
+    def X.status_symbols
+      status_ids.map{|id| status_symbol(id)}
+    end
+    # Define accessors for all status values: first?, second?, third?
+    X.status_symbols.each do |stat|
+      define_method :"#{stat}?" do
+        status == :"#{stat}"
+      end
+    end
+    # Define validations
+    validates_inclusion_of :status_id, :in=>X.status_ids
+  end
+
+To use the _name methods we'd need to add this to config/locales/en.yml (and any other required languages):
+
+     enum_id:
+         x:
+           status:
+             first: "Description of first status"
+             second: "Description of second status"
+             third: "Description of third status"

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "enum_id"
+  gem.homepage = "http://github.com/jgoizueta/enum_id"
+  gem.license = "MIT"
+  gem.summary = %Q{Enumerated ActiveRecord fields }
+  gem.description = %Q{Enumerated ActiveRecord fields }
+  gem.email = "jgoizueta@gmail.com"
+  gem.authors = ["Javier Goizueta"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "enum_id #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1 @@
+Tests!

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1,5 @@
+require 'enum_id'
+
+if defined? ActiveRecord::Base
+  ActiveRecord::Base.extend EnumId
+end

data/lib/enum_id.rb

@@ -0,0 +1,99 @@
+# Defines an enumerated field (stored as an integral id).
+# The field is defined by its name (which must be the column name without the _id suffix),
+# and a hash which maps the id valid values of the field to symbolic constants.
+# The hash can also contain options with symbolic keys; currently the only valid option is
+# :required which checks for non-nil values at validation; if a value other than true is
+# assigned to it, it should be a hash with options that will be relayed to validates_presence_of
+module EnumId
+
+  def enum_id(name, options_and_enum_values)
+    options_and_enum_values = options_and_enum_values.group_by{|k,v| k.kind_of?(Integer) ? :values : :options}
+    options = (options_and_enum_values[:options]||[]).to_h
+    symbols_map = (options_and_enum_values[:values]||[]).to_h
+    ids_map = symbols_map.invert
+
+    required = options[:required]
+
+    name_id = :"#{name}_id"
+    symbols_const = :"ENUM_ID_#{name}_SYMBOLS"
+    ids_const = :"ENUM_ID_#{name}_IDS"
+
+    const_set symbols_const, symbols_map
+    const_set ids_const, ids_map
+
+    model_class = self
+
+    # Instance methods
+
+    # Access the enumerated value as a symbol.
+    define_method name do
+      # #{model_class.name}.#{name}(#{name}_id)
+      model_class.send name, self.send(name_id)
+    end
+
+    # Assigns the enumerated value as a symbol or id (integer)
+    define_method :"#{name}=" do |st|
+      # self.#{name}_id = #{model_class.name}.#{name}_id(st)
+      self.send :"#{name_id}=", model_class.send(name_id, st)
+    end
+
+    # Access the human-name of the (symbolic or integral id) value (translated)
+    define_method :"#{name}_name" do
+      # #{model_class.name}.#{name}_name(#{name}_id)
+      model_class.send :"#{name}_name", self.send(name_id)
+    end
+
+    symbols_map.values.each do |stat|
+      define_method :"#{stat}?" do
+        send(name) == stat
+      end
+    end
+
+    # Class methods
+
+    model_metaclass = class << model_class; self; end
+    model_metaclass.instance_eval do
+      define_method name do |id|
+        # id && (#{symbols_const}[id.to_i] || raise("Invalid status id: #{id}"))
+        id && (symbols_map[id.to_i] || raise("Invalid #{name} id: #{id}"))
+      end
+
+      define_method name_id do |st|
+        st && if st.kind_of?(Integer)
+          raise "Invalid #{name} id: #{st}" unless send(:"#{name}_ids").include?(st)
+          st
+        elsif st.kind_of?(Symbol)
+          ids_map[st.to_sym] || raise("Invalid #{name}: #{st.inspect}")
+        else
+          raise TypeError,"Integer or Symbol argument expected (got a #{st.class.name})."
+        end
+      end
+
+      define_method :"#{name}_symbol" do |st|
+        st && (st.kind_of?(Integer) ? send(name, st) : st.to_sym)
+      end
+
+      define_method :"#{name}_name" do |st|
+        st = send(:"#{name}_symbol", st)
+        st && I18n.t("enum_id.#{model_class.name.underscore}.#{name}.#{st}")
+      end
+
+      define_method :"#{name}_ids" do
+        symbols_map.keys.sort
+      end
+
+      define_method :"#{name}_symbols" do
+        send(:"#{name}_ids").map{|id| send(:"#{name}_symbol", id)}
+      end
+    end
+
+    # Define validations
+    if required == true
+      validates_inclusion_of name_id, :in=>model_class.send(:"#{name}_ids")
+    else
+      validates_inclusion_of name_id, :in=>model_class.send(:"#{name}_ids")+[nil]
+      validates_presence_of name_id, required if required
+    end
+  end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: enum_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Javier Goizueta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: ! 'Enumerated ActiveRecord fields '
+email: jgoizueta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+- TODO
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- init.rb
+- lib/enum_id.rb
+homepage: http://github.com/jgoizueta/enum_id
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2693429870970939883
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Enumerated ActiveRecord fields
+test_files: []