constantize 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    constantize (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    awesome_print (0.2.1)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    i18n (0.4.2)
+    mocha (0.9.9)
+      rake
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    sqlite3 (0.1.1)
+      ffi (>= 0.6.3)
+    tzinfo (0.3.23)
+    wirble (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  awesome_print
+  constantize!
+  mocha
+  rspec
+  sqlite3
+  wirble

data/README.md

@@ -0,0 +1,153 @@
+# constantize
+
+## Description
+
+Simple, dynamic and efficient activerecord model constants.
+
+Ever wanted to be able to be able to do something like:
+
+<pre>
+case buoy.buoy_type
+when BuoyType::NOAA
+..
+when BuoyType::SCRIPPS
+..
+end
+</pre>
+
+or
+
+<pre>
+User.create(:login => :foo, :user_status => UserStatus::ACTIVE)
+</pre>
+
+but weren't sure the best / most efficient way to implement?
+
+One way would be to do something like:
+
+    class BuoyType < ActiveRecord::Base
+      NOAA = find_by_name('noaa')
+      ..
+    end
+
+which would work but in a production environment could result in a non-trivial amount
+of unecessary db queries.
+
+Another way would be to dynamically create the constants for all the rows in the given
+table at rails start.  However, for models w/hundreds of rows, e.g., Country, City,
+this wouldn't be very efficient either.
+
+This gem minimizes the db calls by memoizing the finder that is used to look up the constant
+values.  So, it depends on your app server but only the first refernece to a given constant
+should require a db query (see the code and specs for more details).
+
+## Install
+
+### Manual Install
+
+Standard gem install:
+
+<pre>
+gem install constantize
+</pre>
+
+After installing the gem you would need to require it:
+
+<pre>
+require 'constantize'
+</pre>
+
+### Rails 2.x / No Bundler
+
+In a Rails 2.x project you can add this to your environment.rb:
+
+<pre>
+config.gem 'constantize'
+</pre>
+
+followed by:
+
+<pre>
+rake gems:install
+</pre>
+
+### Rails 3.x / Bundler
+
+In Rails 3.x add this to your Gemfile:
+
+<pre>
+gem 'constantize'
+</pre>
+
+followed by:
+
+<pre>
+bundle install
+</pre>
+
+## Usage
+
+In the model that you will be "constantizing" simply add the following to the top:
+
+constantize :key
+
+where :key is the name of the field that will be used to build the finder.
+
+E.g., 
+
+    class AccountStatus < ActiveRecord::Base
+      constantize :name
+      ..
+    end
+
+this would assume that your account_statuses table looked something like:
+
+    +----+---------+
+    | id | name    |
+    +----+---------+
+    |  1 | active  |
+    |    ..        |
+    +----+---------+
+
+if your table used a different field, say :title, rather than :name:
+
+    +----+---------+
+    | id | title   |
+    +----+---------+
+    |  1 | active  |
+    |    ..        |
+    +----+---------+
+
+then your model definition would look like:
+
+    class AccountStatus < ActiveRecord::Base
+      constantize :title
+      ..
+    end
+
+Finally, if you wanted only the :id to be returned from the constant call (rather than
+the entire model) you could do:
+
+
+    class AccountStatus < ActiveRecord::Base
+      constantize :name, :id
+      ..
+    end
+
+and your call to AccountStatus::ACTIVE would return only the interger :id value (1 in this
+case).
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Adam Weller. See LICENSE for details.
+

data/Rakefile

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

data/constantize.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "constantize/version"
+
+Gem::Specification.new do |s|
+  s.name        = "constantize"
+  s.version     = Constantize::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Adam Weller"]
+  s.email       = ["mincheastwood@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/constantize"
+  s.summary     = %q{Simple, dynamic and efficient activerecord model constants.}
+  s.description = %q{This gem provides dynamically created constants for activerecord models}
+
+  s.rubyforge_project = "constantize"
+
+  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 "activerecord"
+	s.add_development_dependency "sqlite3"
+	s.add_development_dependency "mocha"
+	s.add_development_dependency "wirble"
+	s.add_development_dependency "awesome_print"
+end

data/lib/constantize.rb

@@ -0,0 +1,40 @@
+module Constantize
+  def self.included(base)  
+    base.extend ClassMethods  
+  end  
+
+  module ClassMethods
+    extend ActiveSupport::Memoizable
+
+    # :key => the field name that we are going to use to build the finder
+    # :field => only return this field of data (optional, default is the entire object)
+    def constantize(key, field = nil)
+      # Yes, those are instance variables at the class level
+      @key = key
+      @field = field
+    end
+
+    def const_missing(*args)
+      if args.size == 1
+        value = args[0].to_s.downcase
+        value = constant_for(@key, value, @field)
+        return value if value
+      end
+
+      super(*args)
+    end
+
+    def constant_for(key, value, field = nil)
+      method = "find_by_#{key}"
+      value = self.send(method, value) rescue nil
+      return unless value
+
+      field ? value.send(field) : value
+    end
+    memoize :constant_for
+  end
+end
+
+class ActiveRecord::Base
+  include Constantize
+end

data/lib/constantize/version.rb

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

data/spec/constantize_spec.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+require 'constantize'
+
+describe Constantize do
+
+  context "returning model" do
+    it "should set key to constantize" do
+      BuoyType.instance_variable_get(:@key).should == :name
+    end
+
+    it "should memoize constants" do
+      buoy_type = BuoyType.create(:name => 'noaa')
+      BuoyType.expects(:find_by_name).with('noaa').returns(buoy_type)
+      BuoyType::NOAA.id.should == 1
+
+      # The following should fail unless memoization is working
+      # because :find_by_name has already met the expectation above
+      BuoyType::NOAA.id.should == 1
+    end
+
+    it "should not break const_missing for missing constants" do
+      lambda { BuoyType::FOO }.should raise_error(NameError)
+    end
+  end
+
+  context "returning :id" do
+    it "should set key to constantize" do
+      UserStatus.instance_variable_get(:@key).should == :name
+    end
+
+    it "should set field to constantize" do
+      UserStatus.instance_variable_get(:@field).should == :id
+    end
+
+    it "should memoize constants" do
+      buoy_type = UserStatus.create(:name => 'active')
+      UserStatus.expects(:find_by_name).with('active').returns(buoy_type)
+      UserStatus::ACTIVE.should == 1
+
+      # The following should fail unless memoization is working
+      # because :find_by_name has already met the expectation above
+      UserStatus::ACTIVE.should == 1
+    end
+
+    it "should not break const_missing for missing constants" do
+      lambda { UserStatus::FOO }.should raise_error(NameError)
+    end
+  end
+end

data/spec/libs/buoy_type.rb

@@ -0,0 +1,7 @@
+class BuoyType < ActiveRecord::Base
+  validates_presence_of :name
+
+  require 'constantize'
+
+  constantize :name
+end

data/spec/libs/user_status.rb

@@ -0,0 +1,7 @@
+class UserStatus < ActiveRecord::Base
+  validates_presence_of :name
+
+  require 'constantize'
+
+  constantize :name, :id
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require "active_record"
+require "mocha"
+
+#ActiveRecord::Schema.verbose = false
+
+begin
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+rescue ArgumentError
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+end
+
+ActiveRecord::Base.configurations = true
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :buoy_types do |t|
+    t.string    :name
+    t.datetime  :created_at
+    t.datetime  :updated_at
+  end
+
+  create_table :user_statuses do |t|
+    t.string    :name
+    t.datetime  :created_at
+    t.datetime  :updated_at
+  end
+end
+
+require File.dirname(__FILE__) + '/libs/buoy_type'
+require File.dirname(__FILE__) + '/libs/user_status'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: constantize
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Weller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: wirble
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: This gem provides dynamically created constants for activerecord models
+email: 
+- mincheastwood@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- constantize.gemspec
+- lib/constantize.rb
+- lib/constantize/version.rb
+- spec/constantize_spec.rb
+- spec/libs/buoy_type.rb
+- spec/libs/user_status.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/constantize
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: constantize
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple, dynamic and efficient activerecord model constants.
+test_files: 
+- spec/constantize_spec.rb
+- spec/libs/buoy_type.rb
+- spec/libs/user_status.rb
+- spec/spec_helper.rb