named_instances 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Dew
+
+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.rdoc

@@ -0,0 +1,18 @@
+= Named Instances
+
+Provides support for named instances in Rails.
+
+Quick usage:
+
+  class Diagnosis < ActiveRecord::Base
+    has_named_instances :name
+  end
+
+  >> 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 Jason Dew. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "named_instances"
+    gem.summary = %Q{Named instances for ActiveRecord}
+    gem.description = %Q{Give cached access to ActiveRecord models for quicker and more readable data-based logic.}
+    gem.email = "jason.dew@gmail.com"
+    gem.homepage = "http://github.com/jasondew/named_instances"
+    gem.authors = ["Jason Dew"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "activesupport"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "named_instances #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/named_instances.rb

@@ -0,0 +1,72 @@
+module NamedInstances
+
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    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 do
+        Rails.logger.info("Reloading #{self} named instances because of a save")
+        self.load_named_instances
+      end
+    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
+        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.info "Named Instances: exception ignored, class = #{self}, error = #{e.inspect}"
+      end
+    end
+
+  end
+end

data/named_instances.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{named_instances}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Dew"]
+  s.date = %q{2009-10-08}
+  s.description = %q{Give cached access to ActiveRecord models for quicker and more readable data-based logic.}
+  s.email = %q{jason.dew@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/named_instances.rb",
+     "named_instances.gemspec",
+     "test/fixtures/diagnosis.rb",
+     "test/named_instances_test.rb",
+     "test/rails_crutch.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jasondew/named_instances}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Named instances for ActiveRecord}
+  s.test_files = [
+    "test/fixtures/diagnosis.rb",
+     "test/named_instances_test.rb",
+     "test/rails_crutch.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+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,70 @@
+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 "raise an error if it doesn't exist at all" do
+      assert_raise ArgumentError do
+        Diagnosis.get(:test2)
+      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)
+
+      BadFoo.has_named_instances [:bar, :baz]
+      assert_match /exception/, BadFoo.load_named_instances
+    end
+
+  end
+end

data/test/rails_crutch.rb

@@ -0,0 +1,12 @@
+require 'active_support'
+require 'active_support/cache'
+
+class Rails
+  def self.cache
+    @@cache ||= ActiveSupport::Cache::MemoryStore.new
+  end
+
+  def self.logger
+    @@logger ||= ActiveSupport::BufferedLogger.new(STDOUT)
+  end
+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

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: named_instances
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Dew
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Give cached access to ActiveRecord models for quicker and more readable data-based logic.
+email: jason.dew@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/named_instances.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: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Named instances for ActiveRecord
+test_files: 
+- test/fixtures/diagnosis.rb
+- test/named_instances_test.rb
+- test/rails_crutch.rb
+- test/test_helper.rb