enumerations 1.0.1 → 1.1.0

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/Readme.md

@@ -0,0 +1,73 @@
+Enumerations
+==========
+
+Rails plugin for enumerations in ActiveRecord models.
+
+Install
+=======
+
+If you are using Bundler (and you should be), just add it as a gem.
+
+    gem 'enumerations'
+
+If not, then install it as a plugin.
+    
+    rails plugin install git://github.com/infinum/enumerations.git
+
+Usage
+=====
+
+Create a model for your enumerations
+
+    class Status < Enumeration::Base
+      values :draft => {:id => 1, :name => 'Draft'},
+             :review_pending => {:id => 2, :name => 'Review pending'},
+             :published => {:id => 3, :name => 'Published'}  
+    end
+
+Include enumerations for integer fields in other models
+
+    class Post < ActiveRecord::Base
+      enumeration :status
+      validates_presence_of :body, :title, :status_id
+    end
+
+Set enumerations, find enumerations by symbol
+
+    @post = Post.first
+    @post.status = Status.find(:draft)
+    @post.save
+
+Find enumerations by id
+
+    @post.status = Status.find(2) # => Review pending
+    @post.save
+
+Compare enumerations
+
+    @post.status == :published                  # => true
+    @post.status == 3                           # => true
+    @post.status == Status.find(:published)     # => true
+    @post.status.published?                     # => true
+
+Get all enumerations
+
+    Status.all
+
+Use in forms
+
+    %p
+      = f.label :status_id
+      %br
+      = f.collection_select :status_id, Status.all, :id, :name
+
+TODO
+====
+
+* support for object values (not just symbols and strings)
+
+Author
+======
+
+Copyright (c) 2010 Tomislav Car, Infinum
+

data/enumerations.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'enumerations'
+  s.version     = '1.1.0'
+  s.date        = '2010-08-20'
+  s.summary     = "Enumerations for ActiveRecord!"
+  s.description = "Extends ActiveRecord with enumeration capabilites."
+  s.authors     = ["Tomislav Car", "Nikica Jokic", "Nikola Santic"]
+  s.email       = ["tomislav@infinum.hr", "nikica.jokic@infinum.hr", "nikola.santic@infinum.hr"]
+  s.homepage    = 'https://github.com/infinum/enumerations'
+  
+  s.add_dependency 'activerecord'
+  s.add_dependency 'activesupport'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")  
+end

data/lib/enumerations.rb

@@ -1,30 +1,9 @@
-# i want to be able to write
-# DogType < Enumeration
-#   enumerate_values :pekinezer, :bulldog, :jack_russell
-#
-#   enumerate_values :pekinezer => 'Jako lijepi pekinezer'
-# end
-#
-# DogType.all => [DogType, DogType, DogType]
-# DogType.find(id) => DogType
-# 
-# if something == DogType.pekinezer # => <#DogType>
-# if something == DogType::Pekinezer # => <#DogType> # => TODO
-# if something == DogType[:pekinezer] # => <#DogType> # => TODO
-#
-# So we have
-# * id (numeric). used in database
-# * lookup method (for comparison), symbol basically, used in source code
-# * name. used in user interface
-#
-# Status.draft?
-# Status.review_pending?
-#
-# TODO 
-# - http://github.com/binarylogic/enumlogic/blob/master/lib/enumlogic.rb
-# - http://github.com/eeng/ar-enums
-# - think about storing strings, not integers
+require 'active_support/core_ext/class/attribute.rb'
+require 'active_support/core_ext/string/inflections.rb'
+
 module Enumeration
+  VERSION = "1.1"
+  
   def self.included(receiver)
     receiver.extend ClassMethods
   end
@@ -44,9 +23,29 @@ module Enumeration
       define_method "#{name}=" do |other|
         send("#{options[:foreign_key]}=", other.id)
       end
+      
+      # store a list of used enumerations
+      @_all_enumerations ||= []
+      @_all_enumerations << EnumerationReflection.new(name, options)            
+    end
+
+    # output all the enumerations that this model has defined
+    def reflect_on_all_enumerations
+      @_all_enumerations
     end
   end
   
+  class EnumerationReflection < Struct.new(:name, :options)
+    def class_name
+      options[:class_name]
+    end
+    
+    def foreign_key
+      options[:foreign_key]
+    end
+  end  
+  
+  # used as a base class for enumeration classes
   class Base < Struct.new(:id, :name, :symbol)
     class_attribute :all, :id_index, :symbol_index
     
@@ -120,7 +119,7 @@ module Enumeration
     
     def method_missing(method_name, *args)
       symbol = method_name.to_s.gsub(/[?]$/, '')
-      if self.class.find(symbol) && method_name.to_s.last=="?"
+      if self.class.find(symbol) && method_name =~ /[?]$/
         self.symbol == symbol.to_sym
       else
         super(method_name, args)
@@ -130,4 +129,4 @@ module Enumeration
 end
 
 # Extend ActiveRecord with Enumeration capabilites
-ActiveRecord::Base.send(:include, Enumeration)
+ActiveRecord::Base.send(:include, Enumeration) if defined? ActiveRecord

data/test/enumerations_test.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class EnumerationsTest < Test::Unit::TestCase
+  
+  def test_lookup_by_symbol
+    status = Status.find(:draft)
+    
+    assert_equal :draft, status.symbol
+  end
+  
+  def test_lookup_fail_by_symbol
+    status = Status.find(:draft)
+    
+    assert_not_equal :published, status.symbol
+  end                 
+  
+  def test_all
+    statuses = Status.all
+
+    assert_equal 3, statuses.size
+    assert_equal statuses.first, Status.draft
+  end
+  
+  def test_reflections
+    enumerations = Post.reflect_on_all_enumerations
+
+    assert_equal 2, enumerations.size
+    assert_equal :status, enumerations.first.name
+    assert_equal 'Status', enumerations.first.class_name
+    
+    assert_equal :some_other_status_id, enumerations[1].foreign_key
+  end
+  
+  def test_model_enumeration_assignment
+    p = Post.new
+    p.status = Status.draft    
+    
+    assert_equal "Draft", p.status.to_s
+  end
+  
+  def test_model_via_id_assignment
+    p = Post.new    
+    p.some_other_status_id = Status.published.id
+    
+    assert_equal "Published", p.different_status.to_s
+  end
+  
+  def test_boolean_lookup
+    p = Post.new
+    p.status = Status.draft
+    
+    assert_equal true, p.status.draft?
+  end
+  
+  def test_false_boolean_lookup
+    p = Post.new
+    p.status = Status.draft
+    
+    assert_equal false, p.status.published?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+#require 'rubygems' # not sure if i need this
+
+require 'test/unit'
+require 'enumerations'             
+
+# faking activerecord
+class MockActiveRecordBase
+  include Enumeration
+end
+
+class Status < Enumeration::Base
+  values :draft => {:id => 1, :name => 'Draft'},
+         :review_pending => {:id => 2, :name => 'Review pending'},
+         :published => {:id => 3, :name => 'Published'}  
+end
+
+class Post < MockActiveRecordBase
+  attr_accessor :status_id, :some_other_status_id
+  
+  enumeration :status
+  enumeration :different_status, :foreign_key => :some_other_status_id, :class_name => 'Status'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2010-04-28 00:00:00.000000000 Z
+date: 2010-08-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70144752765260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,12 +23,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70144752765260
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70144752764520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144752764520
 description: Extends ActiveRecord with enumeration capabilites.
 email:
 - tomislav@infinum.hr
@@ -38,7 +44,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Rakefile
+- Readme.md
+- enumerations.gemspec
 - lib/enumerations.rb
+- test/enumerations_test.rb
+- test/test_helper.rb
 homepage: https://github.com/infinum/enumerations
 licenses: []
 post_install_message: 
@@ -59,8 +71,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Enumerations for activerecord!
-test_files: []
+summary: Enumerations for ActiveRecord!
+test_files:
+- test/enumerations_test.rb
+- test/test_helper.rb