named_instances 0.1.0 → 1.0.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+test/test.db
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    named_instances (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    mail (2.2.7)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    mocha (0.9.8)
+      rake
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.3)
+    thoughtbot-shoulda (2.11.1)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  named_instances!
+  rails (= 3.0.0)
+  rake
+  sqlite3-ruby
+  thoughtbot-shoulda

data/README.rdoc

@@ -0,0 +1,20 @@
+= Named Instances
+
+Provides support for named instances in Rails.
+
+Quick usage:
+
+  class Diagnosis < ActiveRecord::Base
+    has_named_instances :name
+  end
+
+  Diagnosis.create :name => "Diabetes Mellitus"
+
+  >> Diagnosis.get(:diabetes_mellitus)
+  => #<Diagnosis id: 52, name: "Diabetes Mellitus", created_at: "2009-10-07 15:41:50", updated_at: "2009-10-07 15:41:50">
+
+Patches welcome, enjoy!
+
+== Copyright
+
+Copyright (c) 2009 - 2010 Jason Dew. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+desc "Run the tests"
+task :test do
+  system "ruby -Itest test/named_instances_test.rb"
+end

data/lib/named_instances.rb

@@ -1,69 +1,2 @@
-require "rails"
-
-module NamedInstances
-
-  class Railtie < Rails::Railtie
-    initializer "named_instances.initialize" do |app|
-      ActiveRecord::Base.send :extend, NamedInstances
-    end
-  end
-
-  def has_named_instances(name_method = :value, options={})
-    @named_instances_loaded = false
-    @named_instances_name_method = name_method
-    @find_options = options[:find_options]
-
-    after_save { self.class.load_named_instances }
-  end
-
-  def named_instances_loaded?
-    !! @named_instances_loaded
-  end
-
-  def name_method
-    @named_instances_name_method
-  end
-
-  def get *names
-    load_named_instances unless @named_instances_loaded
-
-    name = names.map {|n| n.to_s }.join "_"
-    key_name = "#{named_instances_prefix}_#{name}"
-    result = Rails.cache.read(key_name)
-
-    # gets are hard-coded and should always return something valid from the cache
-    raise(ArgumentError, "NamedInstance does not exist: #{key_name}") unless result
-
-    result
-  end
-
-  def named_instances_normalize name
-    name.downcase.gsub(/[^a-z0-9]+/, '_').gsub(/_$/, '')
-  end
-
-  def named_instances_prefix
-    "named_instances_#{self}"
-  end
-
-  def load_named_instances
-    begin
-      self.all(@find_options).each do |instance|
-        if (@named_instances_name_method.is_a? String) or (@named_instances_name_method.is_a? Symbol)
-          field_name = named_instances_normalize instance.send(@named_instances_name_method)
-          key_name = "#{named_instances_prefix}_#{field_name}"
-        else
-          key_name = @named_instances_name_method.inject(named_instances_prefix) do |key_name, name_method|
-            field_name = named_instances_normalize instance.send(name_method)
-            key_name + "_#{field_name}"
-          end
-        end
-
-        Rails.cache.write(key_name, instance)
-      end
-
-      @named_instances_loaded = true
-    rescue Exception => e
-      Rails.logger.error "Named Instances: exception ignored, class = #{self}, error = #{e.inspect}"
-    end
-  end
-end
+require "named_instances/base"
+require "named_instances/railtie" if defined?(Rails::Railtie)

data/lib/named_instances/base.rb

@@ -0,0 +1,84 @@
+module NamedInstances
+
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    module InstanceMethods
+      def normalized_name
+        self.class.named_instances_normalize send(self.class.name_method)
+      end
+    end
+
+    def has_named_instances(name_method = :value)
+      @named_instances_loaded = false
+      @named_instances_name_method = name_method
+
+      after_save {|model| model.class.load_named_instances }
+      include InstanceMethods
+    end
+
+    def named_instances_loaded?
+      !! @named_instances_loaded
+    end
+
+    def name_method
+      @named_instances_name_method
+    end
+
+    def get name_or_names
+      load_named_instances unless @named_instances_loaded
+
+      if not name_or_names.is_a?(String) and name_or_names.respond_to? :map
+        name_or_names.map {|name| get_one name }
+      else
+        get_one name_or_names
+      end
+    end
+
+    def get_one name
+      return if name.blank?
+      key_name = "#{named_instances_prefix}_#{name}"
+
+      begin
+        Rails.cache.read key_name
+      rescue
+        load_named_instances
+        Rails.cache.read key_name
+      end
+    end
+
+    def named_instances_normalize name
+      name.downcase.gsub(/[',]/, '').gsub(/[^a-z0-9_]+/, '_').gsub(/_$/, '')
+    end
+
+    def named_instances_prefix
+      "named_instances_#{self}"
+    end
+
+    def load_named_instances
+      begin
+        all.each do |instance|
+          if (@named_instances_name_method.is_a? String) or (@named_instances_name_method.is_a? Symbol)
+            field_name = named_instances_normalize instance.send(@named_instances_name_method)
+            key_name = "#{named_instances_prefix}_#{field_name}"
+          else
+            key_name = @named_instances_name_method.inject(named_instances_prefix) do |key_name, name_method|
+              field_name = named_instances_normalize instance.send(name_method)
+              key_name + "_#{field_name}"
+            end
+          end
+
+          Rails.cache.write(key_name, instance)
+        end
+
+        @named_instances_loaded = true
+      rescue Exception => e
+        Rails.logger.info "Named Instances: exception ignored, class = #{self}, error = #{e.inspect}"
+      end
+    end
+
+  end
+end

data/lib/named_instances/railtie.rb

@@ -0,0 +1,9 @@
+module NamedInstances
+
+  class Railtie < Rails::Railtie
+    initializer "named_instances.initialize" do |app|
+      ActiveRecord::Base.send :include, NamedInstances if defined?(ActiveRecord)
+    end
+  end
+
+end

data/lib/named_instances/version.rb

@@ -1,3 +1,3 @@
 module NamedInstances
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/named_instances.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "named_instances/version"
+
+Gem::Specification.new do |s|
+  s.name        = "named_instances"
+  s.version     = NamedInstances::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jason Dew"]
+  s.email       = ["jason.dew@gmail.com"]
+  s.homepage    = "http://github.com/jasondew/named_instances"
+  s.summary     = "Model.get(:name)"
+  s.description = "Give cached access to ActiveRecord models for quicker and more readable data-based logic."
+
+  s.rubyforge_project = "named_instances"
+
+  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_dependency "activesupport"
+  s.add_dependency "i18n"
+
+  s.add_development_dependency "thoughtbot-shoulda"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "sqlite3-ruby"
+end

data/test/fixtures/diagnosis.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+require "active_record"
+
+class Diagnosis < ActiveRecord::Base
+  include NamedInstances
+  has_named_instances :name
+end
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => 'test/test.db'
+
+ActiveRecord::Schema.define do
+  create_table :diagnoses, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  Diagnosis.create :name => "Hypertension"
+  Diagnosis.create :name => "Diabetes Mellitus"
+end

data/test/named_instances_test.rb

@@ -0,0 +1,71 @@
+require "test_helper"
+
+class NamedInstancesTest < Test::Unit::TestCase
+  context "Named instances of an AR model" do
+
+    should "be able get instances" do
+      result = Diagnosis.get(:diabetes_mellitus)
+      assert_equal Diagnosis.find_by_name("Diabetes Mellitus"), result
+    end
+
+    should "reload after a save" do
+      Diagnosis.get(:diabetes_mellitus)
+      new_behavior = Diagnosis.create(:name=>"test1")
+
+      result = Diagnosis.get(:test1)
+      assert_equal new_behavior, result
+    end
+
+    should "not raise an error if it doesn't exist" do
+      assert_nothing_raised do
+        Diagnosis.get(:does_not_exist)
+      end
+    end
+
+    should "find deleted instances as well" do
+      Diagnosis.get(:diabetes_mellitus).destroy
+      Diagnosis.load_named_instances
+
+      assert Diagnosis.get(:diabetes_mellitus)
+    end
+
+    should "maintain the same class object id on get" do
+      result = Diagnosis.get(:diabetes_mellitus)
+      assert_equal Diagnosis.object_id, result.class.object_id
+    end
+
+    should "return the method used for naming" do
+      assert_equal(:name, Diagnosis.name_method)
+    end
+
+    should "accept an array of naming methods" do
+      Foo = Struct.new(:bar, :baz)
+      Foo.send(:include, NamedInstances)
+
+      foo1 = Foo.new("abc", "def")
+      foo2 = Foo.new("xyz", "zzz")
+
+      Foo.expects(:after_save)
+      Foo.expects(:all).returns([foo1, foo2])
+
+      Rails.cache.expects(:write).with("named_instances_NamedInstancesTest::Foo_abc_def", foo1)
+      Rails.cache.expects(:write).with("named_instances_NamedInstancesTest::Foo_xyz_zzz", foo2)
+
+      Foo.has_named_instances [:bar, :baz]
+      assert Foo.load_named_instances
+    end
+
+    should "not crash if the instances can't be loaded immediately" do
+      BadFoo = Struct.new(:bar, :baz)
+      BadFoo.send(:include, NamedInstances)
+
+      BadFoo.expects(:after_save)
+      BadFoo.expects(:all).raises(Exception)
+
+      Rails.expects(:logger).returns(mock(:info))
+      BadFoo.has_named_instances [:bar, :baz]
+      BadFoo.load_named_instances
+    end
+
+  end
+end

data/test/rails_crutch.rb

@@ -0,0 +1,11 @@
+require "rails"
+require "active_support"
+require "active_support/cache"
+
+def Rails.cache
+  @cache ||= ActiveSupport::Cache::MemoryStore.new
+end
+
+def Rails.logger
+  @logger ||= Logger.new(STDOUT)
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'rails_crutch'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'fixtures'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'named_instances'
+require 'diagnosis'
+
+class Test::Unit::TestCase
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: named_instances
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jason Dew
@@ -15,10 +15,79 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-14 00:00:00 -04:00
+date: 2011-03-01 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        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 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: Give cached access to ActiveRecord models for quicker and more readable data-based logic.
 email: 
 - jason.dew@gmail.com
@@ -29,9 +98,21 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/named_instances/version.rb
-- lib/named_instances.rb
+- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
+- README.rdoc
+- Rakefile
+- lib/named_instances.rb
+- lib/named_instances/base.rb
+- lib/named_instances/railtie.rb
+- lib/named_instances/version.rb
+- named_instances.gemspec
+- test/fixtures/diagnosis.rb
+- test/named_instances_test.rb
+- test/rails_crutch.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/jasondew/named_instances
 licenses: []
@@ -55,18 +136,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: named_instances
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Model.get(:name)
-test_files: []
-
+test_files: 
+- test/fixtures/diagnosis.rb
+- test/named_instances_test.rb
+- test/rails_crutch.rb
+- test/test_helper.rb