belongs_to_enum 0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format doc

data/Gemfile

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

data/README

@@ -0,0 +1,2 @@
+Adds support for transparent enums to ActiveRecord.
+Adds a belongs_to_enum to ActiveRecord that takes an array of possible values.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/belongs_to_enum.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "belongs_to_enum/version"
+
+Gem::Specification.new do |s|
+  s.name        = "belongs_to_enum"
+  s.version     = BelongsToEnum::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeremy walker"]
+  s.email       = ["jez.walker@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Adds support for transparent enums to ActiveRecord}
+  s.description = %q{Adds a belongs_to_enum to ActiveRecord that takes an array of possible values.}
+
+  s.rubyforge_project = "belongs_to_enum"
+  
+  s.add_dependency "rails"
+  s.add_development_dependency "rspec-rails"
+  
+  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"]
+end

data/lib/belongs_to_enum/enum.rb

@@ -0,0 +1,78 @@
+module BelongsToEnum
+  class Enum
+    def Enum.add_item(key,value)
+      @hash ||= {}
+      @hash[key]=value
+    end
+
+    def Enum.method_missing(key, *args)
+      @hash[key] || super
+    end
+    
+    def Enum.respond_to?(key)
+      return true if super(key)
+      return @hash && @hash[key]
+    end
+
+    def Enum.each
+      @hash.each {|key,value| yield(key,value)}
+    end
+
+    def Enum.map
+      @hash.map {|key,value| yield(key,value)}
+    end
+
+    def Enum.keys
+      @hash.values
+    end
+
+    def Enum.pretty_items
+      @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
+    end
+
+    def Enum.get(value)
+      @hash.key(value)
+    end
+
+    def Enum.display(value)
+      get(value).to_s.gsub("_", " ").titleize
+    end
+
+    def Enum.raw_hash
+      @hash
+    end
+
+    def self.create(name, parent, keys)
+      
+      # Check to see if this has already been defined...
+      return if parent.const_defined?(name.to_s.camelize)
+
+      klass = Class.new(Enum)
+      parent.const_set(name.to_s.camelize, klass)
+
+      if keys.respond_to? :raw_hash
+        keys.raw_hash.each do |k,v|
+          klass.add_item(k,v)
+        end
+
+      elsif(keys.is_a? Hash)
+        keys.each do |k,v|
+          klass.add_item(k,v)
+        end
+      #elsif(keys.respond_to? :raw_hash)
+      #  keys.send(:raw_hash).each do |k,v|
+      #    klass.add_item(k,v)
+      #  end
+      else
+        keys.each_with_index do |key, index|
+          klass.add_item(key, index + 1)
+        end
+      end
+    end
+  end
+end

data/lib/belongs_to_enum/hook.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), "enum")
+
+module BelongsToEnum
+  module Hook
+    def belongs_to_enum(name, keys)
+      BelongsToEnum::Enum.create(name, self, keys)
+      name = name.to_s
+      class_eval <<-EOS
+        def #{name}?
+          #{name}_id.to_i > 0
+        end
+
+        def #{name}
+          #{name.camelize}.display(#{name}_id)
+        end
+      EOS
+    end
+  end
+end

data/lib/belongs_to_enum/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'belongs_to_enum'
+
+module BelongsToEnum
+  class Railtie < Rails::Railtie
+    railtie_name :belongs_to_enum
+    
+    config.to_prepare do
+      ActiveRecord::Base.send(:extend, BelongsToEnum::Hook)
+    end
+  end
+end

data/lib/belongs_to_enum/version.rb

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

data/lib/belongs_to_enum.rb

@@ -0,0 +1,3 @@
+require 'active_support/core_ext'
+require File.join(File.dirname(__FILE__), "belongs_to_enum/hook")
+require File.join(File.dirname(__FILE__), "belongs_to_enum/railtie")

data/spec/belongs_to_enum.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe "Belongs To Enum models" do
+
+  it "constants should be set" do
+    User.const_defined?("Role").should be_true
+  end
+  
+  it "constant has keys" do
+    User::Role.should respond_to(:admin)
+  end
+  
+  it "keys should start at 1" do
+    User::Role.normal.should == 1
+  end
+
+  it "keys should respect hash values" do
+    Vehicle::Make.honda.should == 10
+  end
+  
+  it "keys can be iterated through" do
+    User::Role.each do |role, role_id|
+      role.should == :normal
+      role_id.should == 1
+      break
+    end
+  end
+  
+  it "has pretty items" do
+    User::Role.pretty_items.first[0].should == "Normal"
+    User::Role.pretty_items.first[1].should == 1
+  end
+  
+  it "has depreciated items method that maps to pretty_items" do
+    User::Role.items.first[0].should == "Normal"
+    User::Role.items.first[1].should == 1
+  end
+  
+  it "can get item from id" do
+    User::Role.get(1).should == :normal
+  end
+
+  it "pretty displays item" do
+    User::Role.display(1).should == "Normal"
+  end
+  
+  it "can access raw hash" do
+    User::Role.raw_hash.is_a?(Hash)
+    User::Role.raw_hash.keys[0].should == :normal
+    User::Role.raw_hash.values[0].should == 1
+  end
+  
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rails'
+require 'rspec-rails'
+require 'active_record'
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+# Thie first line isn't working so I have added the second...
+require File.dirname(__FILE__) + '/../lib/belongs_to_enum'
+ActiveRecord::Base.send(:extend, BelongsToEnum::Hook)
+ 
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ 
+# AR keeps printing annoying schema statements
+$stdout = StringIO.new
+
+ActiveRecord::Base.logger
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.integer :role_id, :null => false
+  end
+end
+
+require 'test_classes'

data/spec/test_classes.rb

@@ -0,0 +1,7 @@
+class User < ActiveRecord::Base
+  belongs_to_enum :role, [:normal, :admin, :superadmin, :suspended]
+end
+
+class Vehicle < ActiveRecord::Base
+  belongs_to_enum :make, {:honda => 10, :toyota => 20, :ford => 30}
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: belongs_to_enum
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- Jeremy walker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Adds a belongs_to_enum to ActiveRecord that takes an array of possible values.
+email: 
+- jez.walker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README
+- Rakefile
+- belongs_to_enum.gemspec
+- lib/belongs_to_enum.rb
+- lib/belongs_to_enum/enum.rb
+- lib/belongs_to_enum/hook.rb
+- lib/belongs_to_enum/railtie.rb
+- lib/belongs_to_enum/version.rb
+- spec/belongs_to_enum.rb
+- spec/spec_helper.rb
+- spec/test_classes.rb
+has_rdoc: true
+homepage: ""
+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: belongs_to_enum
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Adds support for transparent enums to ActiveRecord
+test_files: 
+- spec/belongs_to_enum.rb
+- spec/spec_helper.rb
+- spec/test_classes.rb