constant_cache 0.0.1

data/HISTORY

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-08
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 [name of plugin creator]
+
+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

@@ -0,0 +1,75 @@
+ConstantCache
+===============
+
+When your database has tables that store lookup data, there is a tendency 
+to provide those values as constants in the model.  If you have an
+account_statuses table with a corresponding model, your constants may look
+like this:
+
+  class AccountStatus
+    ACTIVE   = 1
+    PENDING  = 2
+    DISABLED = 3
+  end
+
+There are a couple of problems with this approach:
+
+As you add more lookup data to the table, you need to ensure that you're 
+updating your models along with the data.  
+
+The constants are stored as integer values and need to match up exactly 
+with the data that's in the table (not necessarily a bad thing), but this
+solution forces you to write code like this:
+
+Account.new(:username => 'preagan', :status => AccountStatus.find(AccountStatus::PENDING))
+
+This requires multiple calls to find and obfuscates the code a bit.  Since classes
+in Ruby are executable code, we can cache the objects from the database at runtime
+and use them in your application.
+
+Installation
+============
+
+This code is packaged as a gem, so simply use the `gem` command to install:
+
+  gem install constant_cache
+
+Example
+=======
+
+"Out of the box," the constant_cache gem assumes that you want to use the 'name' column to generate
+constants from a column called 'name' in your database table.  Assuming this schema:
+
+  create_table :account_statuses do |t|
+    t.string :name, :description
+  end
+
+  AccountStatus.create!(:name => 'Active',   :description => 'Active user account')
+  AccountStatus.create!(:name => 'Pending',  :description => 'Pending user account')
+  AccountStatus.create!(:name => 'Disabled', :description => 'Disabled user account')
+
+We can use the plugin to cache the data in the table:
+
+  class AccountStatus
+    caches_constants
+  end
+
+Now you can write code that's a little cleaner and not use multiple unnecessary find calls:
+
+  Account.new(:username => 'preagan', :status => AccountStatus::PENDING)
+
+If the column you want to use as the constant isn't 'name', you can set that in the model. If
+we have :name, :slug, and :description, we can use 'slug' instead:
+
+  class AccountStatus
+    caches_constants :key => :slug
+  end
+  
+The value for the constant is truncated at 64 characters by default, but you can adjust this as
+well:
+
+  class AccountStatus
+    caches_constants :limit => 16
+  end
+
+Copyright (c) 2007 Patrick Reagan of Viget Labs (patrick.reagan@viget.com), released under the MIT license

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+require 'lib/constant_cache/version'
+
+GEM = "constant_cache"
+AUTHOR = "Patrick Reagan"
+EMAIL = "patrick.reagan@viget.com"
+HOMEPAGE = "http://www.viget.com/extend/"
+SUMMARY = "Patches active record to add a caches_constants class method that will cache lookup data for your application."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = ConstantCache::VERSION::STRING
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w(README MIT-LICENSE HISTORY)
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  s.add_dependency('activerecord', '>= 2.0.2')
+  s.add_dependency('activesupport', '>= 2.0.2')
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(MIT-LICENSE README Rakefile HISTORY) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{VERSION}}
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/examples/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+  t.spec_opts = ['--format', 'specdoc']
+end

data/lib/constant_cache.rb

@@ -0,0 +1,6 @@
+require 'constant_cache/format'
+require 'constant_cache/cache_methods'
+
+String.send(:include, ConstantCache::Format)
+ActiveRecord::Base.send(:extend, ConstantCache::CacheMethods::ClassMethods)
+ActiveRecord::Base.send(:include, ConstantCache::CacheMethods::InstanceMethods)

data/lib/constant_cache/cache_methods.rb

@@ -0,0 +1,44 @@
+module ConstantCache
+  
+  class DuplicateConstantError < StandardError; end
+  class InvalidLimitError < StandardError; end
+  
+  module CacheMethods
+
+    module ClassMethods
+      def caches_constants(additional_options = {})
+        cattr_accessor :cache_options
+
+        self.cache_options = {:key => :name, :limit => 64}.merge(additional_options)
+        
+        raise ConstantCache::InvalidLimitError, "Limit of #{self.cache_options[:limit]} is invalid" if self.cache_options[:limit] < 1        
+        find(:all).each {|model| model.set_instance_as_constant }
+      end
+    end
+
+    module InstanceMethods
+
+      def constant_name
+        constant_name = self.send(self.class.cache_options[:key].to_sym).constant_name
+        constant_name = constant_name[0, self.class.cache_options[:limit]] unless constant_name.blank?
+        constant_name
+      end
+
+      def set_instance_as_constant
+        const = constant_name
+        if !const.blank?
+          raise ConstantCache::DuplicateConstantError, "Constant #{self.class.to_s}::#{const} has already been defined" if self.class.const_defined?(const)
+          self.class.const_set(const, self) if !const.blank?
+        end
+      end
+
+      # TODO: do we want this behavior?
+      # def constant_cache_destroy
+      #   constant_name = constant_name()
+      #   self.class.send(:remove_const, constant_name) if self.class.const_defined?(constant_name)
+      # end
+
+    end
+    
+  end
+end

data/lib/constant_cache/format.rb

@@ -0,0 +1,9 @@
+module ConstantCache
+  module Format
+    def constant_name
+      value = self.strip.gsub(/\s+/, '_').gsub(/[^\w_]/, '').gsub(/_{2,}/, '_').upcase
+      value = nil if value.blank?
+      value
+    end
+  end
+end

data/lib/constant_cache/version.rb

@@ -0,0 +1,11 @@
+module ConstantCache
+  
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+  
+end

data/spec/examples/constant_cache/cache_methods_spec.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SimpleClass, "with constant_cache mix-in" do
+
+  before { @value = 'pony' }
+
+  it "should set some default options" do
+    enable_caching(SimpleClass)
+    SimpleClass.cache_options.should == {:key => :name, :limit => 64}
+  end
+  
+  it "should overwrite default options when passed new ones" do
+    additional_options = {:key => :new_key, :limit => 100}
+
+    enable_caching(SimpleClass, [], additional_options)
+    SimpleClass.cache_options.should == additional_options
+  end
+  
+  it "should use name as the default constant key" do
+    enable_caching(SimpleClass, [{:name => 'one', :value => @value}])
+    SimpleClass::ONE.value.should == @value
+  end
+  
+  it "should not set constant when value is nil" do
+    proc = lambda { enable_caching(SimpleClass, [{:name => '?', :value => @pony}]) }
+    proc.should_not change(SimpleClass.constants, :size)
+  end
+  
+  it "should raise an exception with message when encountering a duplicate constant" do
+    proc = lambda { enable_caching(SimpleClass, [{:name => 'duplicate'}, {:name => 'duplicate'}]) }
+    proc.should raise_error(ConstantCache::DuplicateConstantError, 'Constant SimpleClass::DUPLICATE has already been defined')
+  end
+  
+  it "should truncate long constant names" do
+    enable_caching(SimpleClass, [{:name => 'a' * 65, :value => @value}])
+    SimpleClass.const_get('A' * 64).value.should == @value
+  end
+
+  it "should honor configuration of truncation point" do
+    enable_caching(SimpleClass, [{:name => 'abcdef', :value => @value}], {:limit => 3})
+    SimpleClass::ABC.value.should == @value
+  end
+  
+  it "should raise an exception when truncated constant names collide" do
+    proc = lambda { enable_caching(SimpleClass, [{:name => 'abcd'}, {:name => 'abef'}], {:limit => 2}) }
+    proc.should raise_error(ConstantCache::DuplicateConstantError)
+  end
+  
+  it "should raise an exception when an invalid limit is set" do
+    limit = 0
+    proc = lambda { SimpleClass.caches_constants(:limit => limit) }
+    proc.should raise_error(ConstantCache::InvalidLimitError, "Limit of #{limit} is invalid")
+  end
+end
+
+describe AlternateClass, "with constant_cache mix-in" do
+
+  it "should allow override of key" do
+    enable_caching(AlternateClass, [{:name2 => 'foo bar', :value => @value}], {:key => :name2})
+    AlternateClass::FOO_BAR.value.should == @value
+  end
+
+end

data/spec/examples/constant_cache/format_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe String, "with constant_name method" do
+  
+  before { String.send(:include, ConstantCache::Format) }
+  
+  it "should upcase its characters" do
+    'test'.constant_name.should == 'TEST'
+  end
+  
+  it "should replace whitespace with a single underscore" do
+    "test this \tformat\nplease.".constant_name.should == 'TEST_THIS_FORMAT_PLEASE'
+  end
+  
+  it "should remove leading and trailing whitespace" do
+    ' test '.constant_name.should == 'TEST'
+  end
+  
+  it "should remove non-word characters" do
+    '!test?'.constant_name.should == 'TEST'
+  end
+  
+  it "should not singularize plural name" do
+    'tests'.constant_name.should == 'TESTS'
+  end
+  
+  it "should return nil when all characters are removed" do
+    '?'.constant_name.should be_nil
+  end
+  
+  it "should collapse multiple underscores" do
+    'test__me'.constant_name.should == 'TEST_ME'
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'spec'
+require 'mocha'
+
+require 'activesupport'
+require 'activerecord'
+
+
+
+lib_dir = File.join(File.dirname(__FILE__), %w(.. lib constant_cache))
+
+Dir.glob("#{lib_dir}/*.rb").each {|file| require file }
+
+module ConstantCache
+  module SpecHelper
+    
+    def enable_caching(klass, values = [], additional_options = {})
+      return_values = values.empty? ? [] : values.map {|params| klass.new(params) }
+
+      klass.expects(:find).with(:all).returns(return_values)
+      klass.caches_constants(additional_options)
+    end
+    
+  end
+end
+
+Spec::Runner.configuration.mock_with :mocha
+Spec::Runner.configuration.include ConstantCache::SpecHelper
+
+String.send(:include, ConstantCache::Format)
+ActiveRecord::Base.send(:include, ConstantCache::CacheMethods::InstanceMethods)
+ActiveRecord::Base.send(:extend, ConstantCache::CacheMethods::ClassMethods)
+
+class BaseClass < ActiveRecord::Base
+  def self.columns; []; end
+end
+
+class SimpleClass < BaseClass
+  PREDEFINED = 'foo'
+  attr_accessor :name, :value
+end
+
+class AlternateClass < BaseClass; 
+  attr_accessor :name2, :value
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: constant_cache
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Patrick Reagan
+autorequire: constant_cache
+bindir: bin
+cert_chain: []
+
+date: 2008-04-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+description: Patches active record to add a caches_constants class method that will cache lookup data for your application.
+email: patrick.reagan@viget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+- HISTORY
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- HISTORY
+- lib/constant_cache
+- lib/constant_cache/cache_methods.rb
+- lib/constant_cache/format.rb
+- lib/constant_cache/version.rb
+- lib/constant_cache.rb
+- spec/examples
+- spec/examples/constant_cache
+- spec/examples/constant_cache/cache_methods_spec.rb
+- spec/examples/constant_cache/format_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.viget.com/extend/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.0
+signing_key: 
+specification_version: 2
+summary: Patches active record to add a caches_constants class method that will cache lookup data for your application.
+test_files: []
+