lookup_by 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faef63af11f71cb58ed963cb274535be04ee72a1
-  data.tar.gz: 52faac6d69885248e29fb4292433786c73ba4d9f
+  metadata.gz: ea1f94799e8cd1ce83a24d9c91ce3ca5e84a9db2
+  data.tar.gz: b2b4a26d4f25ccaf5a3435d7a8c2436393472300
 SHA512:
-  metadata.gz: 141b39d68b61dc72c1bcb12f87a192ffbc41d312649b88ccd6e996db19003f65e051ec41412fa16462f59bd30ac9555175fd682e7b3475a5ff9ecbe80db92c06
-  data.tar.gz: b0ccddd30f0245895891cd39f4152c1a9a17aceb1e3c945b74a06057d4fc8c6cf084dd3ba73a28eb35cbbda4ffbf38503a7284503115271987eaa6a5612349dc
+  metadata.gz: 3ddc4e6763d8886696d8f7967e79e9920984adf1ec569da6c5bf0dc2711e114371533b5c3abfbe96103146b84b139492d86d2fadf2ccb5fde94f557acd7795f2
+  data.tar.gz: 145ab131848f7fc9a62eb2be3e2367854f2d6485e04216e36527872b90cbf8c950e030200f496c089ecbde93e321945fe8f92e3c40d3341f967ddd3e85a498d9

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.3-p194@lookup_by --create
+rvm use 2.0.0-p0@lookup_by --create

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0-p0
   - rbx-19mode
   - ruby-head
 services:

data/README.md

@@ -5,16 +5,7 @@
 
 ### Description
 
-LookupBy is a thread-safe lookup table cache for ActiveRecord. It
-reduces normalization pains.
-
-LookupBy adds two macro methods to ActiveRecord:
-
-`lookup_by :column` — defines `.[]`, `.lookup`, and `.is_a_lookup?`
-methods on the class.
-
-`lookup_for :column` — defines `column` and `column=` accessors that
-transparently reference the lookup table.
+LookupBy is a thread-safe lookup table cache for ActiveRecord that reduces normalization pains.
 
 ### Features
 
@@ -36,56 +27,82 @@ transparently reference the lookup table.
 
 ### Issues
 
-Please submit issues to this Github project in the [Issues
-tab][issues]. _Provide a failing rspec test that works with the
-existing test suite_.
+Please submit issues to this Github project in the [Issues tab][issues]. _Provide a failing rspec test that works with the existing test suite_.
 
-Installation
-------------
+## Installation
 
-Add this line to your application's Gemfile:
+```
+# in Gemfile
+gem "lookup_by"
 
-    gem "lookup_by"
+$ bundle
+```
 
-And then execute:
+Or install it manually:
 
-    $ bundle
+    $ gem install lookup_by
 
-Or install it yourself:
+# Usage / Configuration
 
-    $ gem install lookup_by
+### ActiveRecord Plugin
+
+LookupBy adds 2 macro methods to `ActiveRecord::Base`
 
-Usage / Configuration
-=====================
+```ruby
+lookup_by :column_name
+# Defines .[], .lookup, and .is_a_lookup? class methods.
+
+lookup_for :column_name
+# Defines #column_name and #column_name= accessors that transparently reference the lookup table.
+```
 
 ### Define the lookup model
 
-    class Status < ActiveRecord::Base
-      lookup_by :column
-    end
+```ruby
+# db/migrate/201301010012_create_statuses_table.rb
+create_table :statuses do |t|
+  t.string :status, null: false
+end
+
+# app/models/status.rb
+class Status < ActiveRecord::Base
+  lookup_by :status # Replace :status with the name of your lookup column
+end
 
-    # Aliases the `:column` attribute to `:name`.
-    Status.new(name: "paid")
+# Aliases the lookup attribute to :name.
+Status.new(name: "paid")
+```
 
 ### Associations / Foreign Keys
 
-    class Order < ActiveRecord::Base
-      lookup_for :status
-    end
+```ruby
+# db/migrate/201301010123_create_orders_table.rb
+create_table :orders do |t|
+  t.belongs_to :status
+end
+
+# app/models/order.rb
+class Order < ActiveRecord::Base
+  lookup_for :status
+end
+```
 
 Creates accessors to use the `status` attribute transparently:
 
-    order = Order.new(status: "paid")
+```ruby
+order = Order.new(status: "paid")
 
-    order.status
-    => "paid"
+order.status
+=> "paid"
 
-    order.raw_status
-    => <#Status id: 1, status: "paid">
+# Access the lookup object
+order.raw_status
+=> <#Status id: 1, status: "paid">
 
-    # Access to the lookup value before type casting
-    order.status_before_type_cast
-    => "paid"
+# Access the lookup value before type casting
+order.status_before_type_cast
+=> "paid"
+```
 
 ### Symbolize
 
@@ -94,110 +111,125 @@ Casts the attribute to a symbol. Enables the setter to take a symbol.
 _This is a bad idea if the set of lookup values is large. Symbols are
 never garbage collected._
 
-    class Order < ActiveRecord::Base
-      lookup_for :status, symbolize: true
-    end
+```ruby
+class Order < ActiveRecord::Base
+  lookup_for :status, symbolize: true
+end
 
-    order = Order.new(status: "paid")
+order = Order.new(status: "paid")
 
-    order.status
-    => :paid
+order.status
+=> :paid
 
-    order.status = :shipped
-    => :shipped
+order.status = :shipped
+=> :shipped
+```
 
 ### Strict
 
-    # Raise
-    #   Default
-    lookup_for :status
+Do you want missing lookup values to raise an error?
 
-    # this will raise a LookupBy::Error
-    Order.status = "non-existent status"
+```ruby
+# Raise
+#   Default
+lookup_for :status
 
-    # Error
-    lookup_for :status, strict: false
+# this will raise a LookupBy::Error
+Order.status = "non-existent status"
+
+# Set to nil
+lookup_for :status, strict: false
+```
 
 ### Caching
 
-    # No caching - Not very useful
-    #   Default
-    lookup_by :column_name
+```ruby
+# No caching - Not very useful
+#   Default
+lookup_by :column_name
 
-    # Cache all
-    #   Use for a small finite list (e.g. status codes, US states)
-    #
-    #   find: false DEFAULT
-    lookup_by :column_name, cache: true
+# Cache all
+#   Use for a small finite list (e.g. status codes, US states)
+#
+#   find: false DEFAULT
+lookup_by :column_name, cache: true
 
-    # Cache N (with LRU eviction)
-    #   Use for a large list with uneven distribution (e.g. email domain, city)
-    #
-    #   find: true DEFAULT and REQUIRED
-    lookup_by :column_name, cache: 50
+# Cache N (with LRU eviction)
+#   Use for a large list with uneven distribution (e.g. email domain, city)
+#
+#   find: true DEFAULT and REQUIRED
+lookup_by :column_name, cache: 50
+```
 
 ### Configure cache misses
 
-    # Return nil
-    #   Default when caching all records
-    #
-    #   Skips the database for these methods:
-    #     .all, .count, .pluck
-    lookup_by :column_name, cache: true
+```ruby
+# Return nil
+#   Default when caching all records
+#
+#   Skips the database for these methods:
+#     .all, .count, .pluck
+lookup_by :column_name, cache: true
 
-    # Find (read-through)
-    #   Required when caching N records
-    lookup_by :column_name, cache: 10
-    lookup_by :column_name, cache: true, find: true
+# Find (read-through)
+#   Required when caching N records
+lookup_by :column_name, cache: 10
+lookup_by :column_name, cache: true, find: true
+```
 
 ### Configure database misses
 
-    # Return nil
-    #   Default
-    lookup_by :column_name
+```ruby
+# Return nil
+#   Default
+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 its attributes are nullable
-    lookup_by :column_name, cache: 20, find_or_create: true
+# 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
+```
 
 ### Normalizing values
 
-    # Normalize
-    #   Run through the your attribute's setter
-    lookup_by :column_name, normalize: true
+```ruby
+# Normalize
+#   Run through the your attribute's setter
+lookup_by :column_name, normalize: true
+```
 
-Integration
-===========
+# Integration
 
 ### Cucumber
 
-LookupBy comes with a few cucumber steps. To use, `require` them
-from one of the ruby files under `features/support` (e.g. `env.rb`)
-
-    require 'lookup_by/cucumber'
+```ruby
+# features/support/env.rb
+require 'lookup_by/cucumber'
+```
 
-This provides `Given I reload the cache for $plural_class_name`.
+This provides: `Given I reload the cache for $plural_class_name`
 
 ### SimpleForm
 
-    = simple_form_for @order do |f|
-      = f.input :status
-      = f.input :status, :as => :radio_buttons
+```haml
+= simple_form_for @order do |f|
+  = f.input :status
+  = f.input :status, :as => :radio_buttons
+```
 
 ### Formtastic
 
-    = semantic_form_for @order do |f|
-      = f.input :status
-      = f.input :status, :as => :radio
+```haml
+= semantic_form_for @order do |f|
+  = f.input :status
+  = f.input :status, :as => :radio
+```
 
-Testing
--------
+## Testing
 
-This plugin uses rspec and pry for testing. Make sure you have them
-installed:
+This plugin uses rspec and pry for testing. Make sure you have them installed:
 
     bundle
 
@@ -205,8 +237,7 @@ To run the test suite:
 
     rake
 
-Giving Back
-===========
+# Giving Back
 
 ### Contributing
 

data/lib/lookup_by/cache.rb

@@ -42,7 +42,7 @@ module LookupBy
     def reload
       return unless cache_all?
 
-      cache.clear
+      clear
 
       ::ActiveRecord::Base.connection.send :log, "", "#{klass.name} Load Cache All" do
         klass.order(order).each do |i|

data/lib/lookup_by/lookup.rb

@@ -20,7 +20,7 @@ module LookupBy
 
           class << self; attr_reader :lookup; end
 
-          # validates field, presence: true, uniqueness: true
+          # TODO: check for a db unique constraint or Rails validation
 
           unless field == :name || column_names.include?("name")
             alias_attribute :name, field

data/lib/lookup_by/version.rb

@@ -1,3 +1,3 @@
 module LookupBy
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookup_by
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Erik Peterson
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".rvmrc"
 - ".travis.yml"
 - Gemfile