lookup_by 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9abc479376127852eaf37e13d6f22beb0f1a999c
-  data.tar.gz: 408f965a099b14d4347e4e73325b523d8f4a5cd6
+  metadata.gz: 08f7517649396422ab4bc56217543fff26eb0606
+  data.tar.gz: 7c6c3843e075d0a8b78af06ce75e644b072446ad
 SHA512:
-  metadata.gz: 42434d1b8fd18acf4ebce529e9dabd6669fed6f7b25bf82b7acdd6239fad9fde4a17d24403c843f16cbf0ace8bc28fa1d72c96ae8f5761cc0a4ef3610c6a38f0
-  data.tar.gz: 25db84500203fb4084b6b518a578f8160ca349320059b1c8513b039629f4ce23f6dbefb97b17aea8b370af503ebb777382849b16407b7a664dfad60b88363749
+  metadata.gz: e07af94417290aad36f97135a2fb6295e77388b531d7ef8d97c9bf14238cc08c8230ef3ad1ccc308d977d1c94f02edc60fc1ab5764db7745ef2d2c1b37e6d4fd
+  data.tar.gz: 42114c0e2a352d15770d5564a2196cf279ff9a90d71ab59226ceea90e2ae20a7071011c46730b1c894ee0502410282aab8cebb2e3bafba5e51189a814a7ba1d0

data/.gitignore

@@ -9,3 +9,4 @@ spec/dummy/tmp/
 spec/dummy/.sass-cache
 coverage/
 Gemfile.lock
+tags

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.0
+ruby-2.1.1

data/.travis.yml

@@ -2,10 +2,10 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0-preview1
+  - 2.1.1
   - ruby-head
   - rbx
-  - rbx-2.2.1
+  - rbx-2.2.6
 services:
   - postgresql
 before_script:

data/Gemfile

@@ -18,25 +18,6 @@ group :development, :test do
   gem "pry",       require: false
   gem 'colored',   require: false
 
-  platform :rbx do
-    gem 'racc'
-    gem 'json'
-
-    # Simplecov and Coveralls
-    gem 'rubysl-coverage'
-    gem 'rubinius-coverage'
-
-    # Pry
-    gem 'rubysl-readline'
-
-    # Rails
-    gem 'rubysl-base64'
-    gem 'rubysl-benchmark'
-    gem 'rubysl-bigdecimal'
-    gem 'rubysl-digest'
-    gem 'rubysl-ipaddr'
-    gem 'rubysl-logger'
-    gem 'rubysl-mutex_m'
-    gem 'rubysl-singleton'
-  end
+  gem 'racc'
+  gem 'json'
 end

data/README.md

@@ -14,12 +14,13 @@
 [codeclimate]: https://codeclimate.com/github/companygardener/lookup_by
 [gittip]:      https://www.gittip.com/companygardener
 
-### Description
+# Overview
 
-LookupBy is a thread-safe lookup table cache for ActiveRecord that reduces normalization pains which features:
+LookupBy is a thread-safe lookup table cache for ActiveRecord that reduces normalization pains and supports:
 
-* a configurable lookup column
-* caching (read-through, write-through, Least Recently Used (LRU))
+* configurable column names
+* caching (read-through, write-through, least recently used (LRU))
+* symbols
 
 ### Dependencies
 
@@ -44,22 +45,24 @@ If you find a security bug, please **_do not_** use the issue tracker. Instead,
 
 Please create [Issues][issues] to submit bug reports and feature requests.
 
-_Provide a failing rspec test concisely demonstrates the issue._
+_Provide a failing rspec test that concisely demonstrates the issue._
 
-### Feature requests
+# Installation
 
-## Installation
+Add this line to your application's Gemfile:
 
-    # in Gemfile
     gem "lookup_by"
 
+And then execute:
+
     $ bundle
 
 Or install it manually:
 
     $ gem install lookup_by
 
-## Usage / Configuration
+
+# Usage
 
 ### ActiveRecord Plugin
 
@@ -78,13 +81,23 @@ lookup_for :status
 
 ```ruby
 # db/migrate/201301010012_create_statuses_table.rb
-create_table :statuses do |t|
-  t.string :status, null: false
+create_table :statuses, primary_key: :status_id do |t|
+  t.text :status, null: false
 end
 
 # Or use the shorthand
 create_lookup_table :statuses
 
+# UUID primary key
+#   options[:id]    = :uuid
+#
+# SMALLSERIAL primary key
+#   options[:small] = true
+#
+# Change the lookup column
+#   options[:lookup_column] = "phone_number"
+#   options[:lookup_type]   = :phone
+
 # app/models/status.rb
 class Status < ActiveRecord::Base
   lookup_by :status
@@ -94,7 +107,7 @@ end
 Status.new(name: "paid")
 ```
 
-### Associations / Foreign Keys
+### Define an association
 
 ```ruby
 # db/migrate/201301010123_create_orders_table.rb
@@ -108,7 +121,7 @@ class Order < ActiveRecord::Base
 end
 ```
 
-Provides accessors to use the `status` attribute transparently:
+LookupBy creates methods that use the `status` attribute transparently:
 
 ```ruby
 order = Order.new(status: "paid")
@@ -132,6 +145,8 @@ Order.column_names
 => ["order_id", "status_id"]
 ```
 
+# Configuration
+
 ### Symbolize
 
 Casts the attribute to a symbol. Enables the setter to take a symbol.
@@ -172,7 +187,7 @@ lookup_for :status, strict: false
 
 The default is no caching. You can also cache all records or use an LRU.
 
-_Note: caching is __per process__, make sure you think through the implications._
+_Note: caching is **per process**, make sure you think through the implications._
 
 ```ruby
 # No caching - Not very useful
@@ -194,7 +209,9 @@ lookup_by :column_name, cache: true
 lookup_by :column_name, cache: 50
 ```
 
-### Configure cache misses
+### Cache miss
+
+You can enable read-throughs using the `:find` option.
 
 ```ruby
 # Return nil
@@ -210,7 +227,11 @@ lookup_by :column_name, cache: 10
 lookup_by :column_name, cache: true, find: true
 ```
 
-### Configure database misses
+### DB miss
+
+You can enable write-throughs using the `:find_or_create` option.
+
+_Note: This will only work if the primary key is a sequence and all columns but the lookup column are optional._
 
 ```ruby
 # Return nil
@@ -220,8 +241,6 @@ lookup_by :column_name
 # Find or create
 #   Useful for user-submitted fields that grow over time
 #   e.g. user_agents, ip_addresses
-#
-#   Note: Only works if attributes are nullable
 lookup_by :column_name, cache: 20, find_or_create: true
 ```
 
@@ -281,23 +300,34 @@ To run the test suite:
     rake app:db:test:prepare
     rake
 
-# Giving Back
-
-### Contributing
-
-1. Fork
-2. Create a feature branch `git checkout -b new-hotness`
-3. Commit your changes `git commit -am 'Added some feature'`
-4. Push to the branch `git push origin new-hotness`
-5. Create a Pull Request
+# Contribute
 
-### Attribution
+  1. Fork
+  2. Create a feature branch `git checkout -b new-hotness`
+  3. Commit your changes `git commit -am 'Added some feature'`
+  4. Push to the branch `git push origin new-hotness`
+  5. Create a Pull Request
 
 A list of authors can be found on the [Contributors][] page.
 
+# License
+
 Copyright © 2014 Erik Peterson
 
-Released under the MIT License. See [MIT-LICENSE][license] file for more details.
+MIT License
+
+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.
 
 [development]:  http://github.com/companygardener/lookup_by "LookupBy Development"
 [issues]:       http://github.com/companygardener/lookup_by/issues "LookupBy Issues"

data/lib/lookup_by/lookup.rb

@@ -133,8 +133,12 @@ module LookupBy
         table_options = options.slice(:primary_key, :id)
         table_options[:primary_key] ||= table.singularize + '_id'
 
+        table_options[:id] = false if options[:small]
+
         create_table name, table_options do |t|
-          t.send lookup_type, lookup_column, null: false
+          t.column table_options[:primary_key], 'smallserial primary key' if options[:small]
+
+          t.column lookup_column, lookup_type, null: false
 
           yield t if block_given?
         end

data/lib/lookup_by/version.rb

@@ -1,3 +1,3 @@
 module LookupBy
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lookup_by.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.description    = %q(Use database lookup tables in AR models.)
 
   gem.authors        = ["Erik Peterson"]
-  gem.email          = ["erik@enova.com"]
+  gem.email          = ["thecompanygardener@gmail.com"]
 
   gem.homepage       = "https://www.github.com/companygardener/lookup_by"
   gem.license        = "MIT"

data/spec/dummy/db/migrate/20121019040009_create_tables.rb

@@ -6,7 +6,7 @@ class CreateTables < ActiveRecord::Migration
     create_lookup_table :email_addresses
 
     create_lookup_table :accounts
-    create_lookup_table :statuses
+    create_lookup_table :statuses, small: true
 
     create_lookup_table :ip_addresses, lookup_type: :inet
 

data/spec/dummy/db/structure.sql

@@ -270,7 +270,7 @@ ALTER SEQUENCE states_state_id_seq OWNED BY states.state_id;
 --
 
 CREATE TABLE statuses (
-    status_id integer NOT NULL,
+    status_id smallint NOT NULL,
     status text NOT NULL
 );
 

data/spec/lookup_by_spec.rb

@@ -42,6 +42,10 @@ describe LookupBy::Lookup do
 
       subject["  paid "].id.should == status.id
     end
+
+    it "has a small primary key" do
+      expect { Status.create(status_id: 100_000, status: "too_big") }.to raise_error
+    end
   end
 
   context "EmailAddress.lookup_by :column, find_or_create: true" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookup_by
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Erik Peterson
@@ -54,14 +54,13 @@ dependencies:
         version: '0'
 description: Use database lookup tables in AR models.
 email:
-- erik@enova.com
+- thecompanygardener@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
-- ".rvmrc"
 - ".travis.yml"
 - Gemfile
 - MIT-LICENSE

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-2.0.0-p353@lookup_by --create