lookup_by 0.1.0

data/spec/dummy/db/schema.rb

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20121019040009) do
+
+  create_table "accounts", :primary_key => "account_id", :force => true do |t|
+    t.text "account", :null => false
+  end
+
+  add_index "accounts", ["account"], :name => "index_accounts_on_account", :unique => true
+
+  create_table "addresses", :primary_key => "address_id", :force => true do |t|
+    t.integer "city_id"
+    t.integer "state_id"
+    t.integer "postal_code_id"
+    t.integer "street_id"
+  end
+
+  create_table "cities", :primary_key => "city_id", :force => true do |t|
+    t.text "city", :null => false
+  end
+
+  add_index "cities", ["city"], :name => "index_cities_on_city", :unique => true
+
+  create_table "email_addresses", :primary_key => "email_address_id", :force => true do |t|
+    t.text "email_address", :null => false
+  end
+
+  add_index "email_addresses", ["email_address"], :name => "index_email_addresses_on_email_address", :unique => true
+
+  create_table "ip_addresses", :primary_key => "ip_address_id", :force => true do |t|
+    t.text "ip_address", :null => false
+  end
+
+  add_index "ip_addresses", ["ip_address"], :name => "index_ip_addresses_on_ip_address", :unique => true
+
+  create_table "postal_codes", :primary_key => "postal_code_id", :force => true do |t|
+    t.text "postal_code", :null => false
+  end
+
+  add_index "postal_codes", ["postal_code"], :name => "index_postal_codes_on_postal_code", :unique => true
+
+  create_table "states", :primary_key => "state_id", :force => true do |t|
+    t.text "state", :null => false
+  end
+
+  add_index "states", ["state"], :name => "index_states_on_state", :unique => true
+
+  create_table "statuses", :primary_key => "status_id", :force => true do |t|
+    t.text "status", :null => false
+  end
+
+  add_index "statuses", ["status"], :name => "index_statuses_on_status", :unique => true
+
+  create_table "streets", :primary_key => "street_id", :force => true do |t|
+    t.text "street", :null => false
+  end
+
+  add_index "streets", ["street"], :name => "index_streets_on_street", :unique => true
+
+end

data/spec/dummy/lib/missing.rb

@@ -0,0 +1,3 @@
+class Missing < ActiveRecord::Base
+  lookup_for :city
+end

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/lookup_by_spec.rb

@@ -0,0 +1,100 @@
+require "spec_helper"
+require "lookup_by"
+require "pry"
+
+describe ::ActiveRecord::Base do
+  describe "macro methods" do
+    subject { described_class }
+
+    it { should respond_to :lookup_by    }
+    it { should respond_to :is_a_lookup? }
+  end
+
+  describe "instance methods" do
+    subject { Status.new }
+
+    it { should respond_to :name }
+  end
+end
+
+describe LookupBy::Lookup do
+  context "City.lookup_by :column" do
+    subject { City }
+
+    it_behaves_like "a lookup"
+    it_behaves_like "a proxy"
+    it_behaves_like "a read-through proxy"
+
+    it "returns nil on db miss" do
+      subject["foo"].should be_nil
+    end
+  end
+
+  context "Status.lookup_by :column, normalize: true" do
+    subject { Status }
+
+    it_behaves_like "a lookup"
+    it_behaves_like "a proxy"
+    it_behaves_like "a read-through proxy"
+
+    it "normalizes the lookup field" do
+      status = subject.create(subject.lookup.field => "paid")
+
+      subject["  paid "].id.should == status.id
+    end
+  end
+
+  context "EmailAddress.lookup_by :column, find_or_create: true" do
+    subject { EmailAddress }
+
+    it_behaves_like "a lookup"
+    it_behaves_like "a proxy"
+    it_behaves_like "a read-through proxy"
+    it_behaves_like "a write-through proxy"
+  end
+
+  context "State.lookup_by :column, cache: true" do
+    subject { State }
+
+    it_behaves_like "a lookup"
+    it_behaves_like "a cache"
+    it_behaves_like "a strict cache"
+
+    it "preloads the cache" do
+      subject.lookup.cache.should_not be_empty
+    end
+  end
+
+  context "Account.lookup_by :column, cache: true, strict: false" do
+    subject { Account }
+
+    it_behaves_like "a lookup"
+    it_behaves_like "a cache"
+    it_behaves_like "a read-through cache"
+  end
+
+  context "PostalCode.lookup_by :column, cache: N" do
+    subject { PostalCode }
+
+    it_behaves_like "a lookup"
+    it_behaves_like "a cache"
+    it_behaves_like "a read-through cache"
+
+    it "enables the LRU" do
+      subject.lookup.enabled.should be_true
+    end
+  end
+
+  context "IpAddress.lookup_by :column, cache: N, find_or_create: true" do
+    subject { IpAddress }
+
+    it_behaves_like "a lookup"
+    it_behaves_like "a cache"
+    it_behaves_like "a read-through cache"
+    it_behaves_like "a write-through cache"
+
+    it "disables the LRU when RAILS_ENV=test" do
+      subject.lookup.enabled.should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+
+GC.disable if defined?(GC) && GC.respond_to?(:disable)
+
+if ENV["COV"]
+  require "simplecov"
+  SimpleCov.start
+end
+
+begin
+  require File.expand_path("../../config/environment", __FILE__)
+rescue LoadError
+  require File.expand_path("../dummy/config/environment", __FILE__)
+end
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("../support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

data/spec/support/shared_examples_for_a_lookup.rb

@@ -0,0 +1,163 @@
+shared_examples "a lookup" do
+  it { should respond_to :[] }
+  it { should respond_to :lookup }
+  it { should respond_to :lookup_by  }
+  it { should respond_to :lookup_for }
+  its(:is_a_lookup?) { should be_true }
+
+  it "returns nil for nil" do
+    subject[nil].should be_nil
+  end
+
+  it "returns nil for empty strings" do
+    subject[""].should be_nil
+  end
+
+  it "returns itself" do
+    first = subject.first
+    subject[first].should eq first if first
+  end
+
+  it "rejects other argument types" do
+    [1.00, true, false, Address.new].each do |value|
+      expect { subject[value] }.to raise_error TypeError
+    end
+  end
+
+  it "proxies create!" do
+    expect { subject.lookup.create!(name: "add to cache") }.to change(subject, :count).by(1)
+  end
+end
+
+shared_examples "a proxy" do
+  it "does not cache records" do
+    original = subject.create(name: "original")
+
+    subject.lookup.reload
+
+    subject[original.name]
+    subject.update(original.id, name: "updated")
+    subject[original.id].name.should_not eq original.name
+  end
+end
+
+shared_examples "a cache" do
+  it "caches records" do
+    was_enabled = subject.lookup.enabled
+    subject.lookup.enabled = true
+
+    original = subject.create(name: "original")
+
+    subject.lookup.reload
+    subject[original.name]
+
+    subject.update(original.id, subject.lookup.field => "updated")
+    subject[original.id].name.should eq "original"
+
+    subject.lookup.enabled = was_enabled
+  end
+end
+
+shared_examples "a strict cache" do
+  it "caches .count" do
+    expect { subject.create(name: "new") }.to_not change(subject, :count)
+  end
+
+  it "caches .all" do
+    expect { subject.create(name: "add") }.to_not change(subject, :all)
+  end
+
+  it "caches .pluck" do
+    subject.create(name: "pluck this")
+    subject.pluck(:name).should_not include("pluck this")
+  end
+
+  it "returns nil on miss" do
+    subject["foo"].should be_nil
+  end
+
+  it "ignores new records" do
+    subject.create(name: "new record")
+
+    subject["new record"].should be_nil
+  end
+end
+
+shared_examples "a read-through proxy" do
+  it "reloads .count" do
+    expect { subject.create(name: "new") }.to change(subject, :count)
+  end
+
+  it "reloads .all" do
+    expect { subject.create(name: "add") }.to change(subject, :all)
+  end
+
+  it "reloads .pluck" do
+    subject.create(name: "pluck this")
+    subject.pluck(subject.lookup.field).should include("pluck this")
+  end
+
+  it "finds new records" do
+    created = subject.create(name: "new record")
+    subject["new record"].id.should eq created.id
+  end
+end
+
+shared_examples "a read-through cache" do
+  it_behaves_like "a read-through proxy"
+
+  it "caches new records" do
+    was_enabled = subject.lookup.enabled
+    subject.lookup.enabled = true
+
+    created = subject.create(name: "cached")
+
+    subject.lookup.reload
+    subject[created.name]
+
+    subject.update(created.id, name: "changed")
+    subject[created.id].name.should eq "cached"
+
+    subject.lookup.enabled = was_enabled
+  end
+end
+
+shared_examples "a write-through proxy" do
+  it "creates missing records" do
+    expect { subject["not found"] }.to change(subject, :count)
+  end
+end
+
+shared_examples "a write-through cache" do
+  it_behaves_like "a write-through proxy"
+
+  it "does not cache new records" do
+    subject.lookup.reload
+    found = subject["found"]
+
+    subject.update(found.id, name: "missing")
+    subject[found.id].name.should eq "missing"
+  end
+end
+
+shared_examples "a lookup for" do |field|
+  it { should respond_to field }
+  it { should respond_to "#{field}=" }
+  it { should respond_to "raw_#{field}" }
+  it { should respond_to "#{field}_before_type_cast" }
+
+  it "accepts nil" do
+    expect { subject.send "#{field}=", nil }.to_not raise_error
+  end
+
+  it "converts empty strings to nil" do
+    subject.send "#{field}=",  ""
+    subject.send(field).should be_nil
+  end
+
+  it "rejects other argument types" do
+    [1.00, true, false, Address.new].each do |value|
+      expect { subject.send "#{field}=", value  }.to raise_error TypeError
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: lookup_by
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Peterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+  name: rails
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+description: Use database lookup tables in AR models.
+email:
+- erik@enova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- lib/lookup_by.rb
+- lib/lookup_by/association.rb
+- lib/lookup_by/cache.rb
+- lib/lookup_by/caching/lru.rb
+- lib/lookup_by/caching/safe_lru.rb
+- lib/lookup_by/cucumber.rb
+- lib/lookup_by/hooks/cucumber.rb
+- lib/lookup_by/hooks/formtastic.rb
+- lib/lookup_by/hooks/simple_form.rb
+- lib/lookup_by/lookup.rb
+- lib/lookup_by/railtie.rb
+- lib/lookup_by/version.rb
+- lookup_by.gemspec
+- spec/association_spec.rb
+- spec/caching/lru_spec.rb
+- spec/dummy/.rspec
+- spec/dummy/Rakefile
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/account.rb
+- spec/dummy/app/models/address.rb
+- spec/dummy/app/models/city.rb
+- spec/dummy/app/models/email_address.rb
+- spec/dummy/app/models/ip_address.rb
+- spec/dummy/app/models/postal_code.rb
+- spec/dummy/app/models/state.rb
+- spec/dummy/app/models/status.rb
+- spec/dummy/app/models/street.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/db/migrate/20121019040009_create_tables.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/missing.rb
+- spec/dummy/log/.gitkeep
+- spec/dummy/script/rails
+- spec/lookup_by_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples_for_a_lookup.rb
+homepage: http://www.github.com/companygardener/lookup_by
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A thread-safe lookup table cache for ActiveRecord
+test_files:
+- spec/association_spec.rb
+- spec/caching/lru_spec.rb
+- spec/dummy/.rspec
+- spec/dummy/Rakefile
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/account.rb
+- spec/dummy/app/models/address.rb
+- spec/dummy/app/models/city.rb
+- spec/dummy/app/models/email_address.rb
+- spec/dummy/app/models/ip_address.rb
+- spec/dummy/app/models/postal_code.rb
+- spec/dummy/app/models/state.rb
+- spec/dummy/app/models/status.rb
+- spec/dummy/app/models/street.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/db/migrate/20121019040009_create_tables.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/missing.rb
+- spec/dummy/log/.gitkeep
+- spec/dummy/script/rails
+- spec/lookup_by_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples_for_a_lookup.rb