offline_lookup 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2db35bb5e31d4cfde77e91c6f67988c5cdf6dfe9
-  data.tar.gz: 7743e8b15d2f1c93f121b99f5cb9cca0d302a2ce
+  metadata.gz: 887ba1b39a9ba252abb2a69d9ac652a8f9b3ded8
+  data.tar.gz: 8b0d2fc3a6d65b605fd951255e4a796c02dd58f3
 SHA512:
-  metadata.gz: 0c1f72f28029f3d4e7d9bcad89996e3fc962147e886f9cdad6262b2e86b4fc3725aff4cfc6116e18a61312ed0d578f9cd0f29943da7c30f95a33b34a27161846
-  data.tar.gz: c426d15af5a5a675f28aada0d1acb760ec3e68f83bc521f3b8e565d6df4f73310ab643f8f0fc342dc7a83af23dd33fc8943333af1e66c4501d9b00290b784a3c
+  metadata.gz: e1e931dc2e984e21823e18cbbfcb56c6ff8d441a04ad6c8ee90bd618333345de655afa40852c2474cd65e3a819f9b4a66bae68907d97318845645bcb2ac32368
+  data.tar.gz: 9afcc20a56a0e6aec6c79cfa1a92ab36ea8c3f9928cb93fee8d07ecc502f65dcdf2920bf838a214265e9df398ea5a07e64cbecffad93b43b9d8c55b64e217d82

data/README.md

@@ -0,0 +1,61 @@
+##Offline Lookup
+
+Alhpa (0.0.2). Use at your own risk.
+
+IMPORTANT: don't use this for models that have a lot of data!!
+This is basically a in-memory pseudo-index intended to speed up quick, repeated
+finds of index table values without trips to an external db machine.
+It's also nicer syntax, e.g:
+
+```
+TurnaroundLevel.two_hour_id
+TurnaroundLevel.quick_lookup("Two Hour")
+Service.last.turnaround_level.two_hour?
+```
+
+In any ActiveRecord::Base subclass, use:
+
+`use_offline_id_lookup column_name`
+
+to define class methods that can convert between id and the corresponding
+value in `column_name` for the class, without going to the database
+
+`column_name` defaults to `:name`, but can be any column of the table
+use the `:key` keyword arg if you're interested in a key colun other than `:id`
+Usage example:
+
+```
+class TurnaroundLevel < ActiveRecord::Base
+  use_offline_lookup :level
+  ...
+end
+```
+
+If, for example, the first row of the turnaround_levels table has a `:level` of `"Same Day"`, this gives you
+
+```
+TurnaroundLevel.same_day_id
+#=> 1
+TurnaroundLevel.name_for_id(1)
+#=> 'Same Day'
+TurnaroundLevel.id_for_name('Same Day')
+#=> 1
+TurnaroundLevel.first.same_day?
+#=> true
+TurnaroundLevel.same_day
+#=> <#TurnaroundLevel id: 1, level: "Same Day", ...>
+```
+
+The last of these methods is the "lookup" method, and is not quite offline. This is because we only store the key - name mappings, not the entire objects, in memory when we declare a new offline_lookup model. However it is included by default for convenient syntax (and it uses a lookup on what is usually the primary key of the table, in case the extra few ms matter to you). You can disable it by using
+
+`use_offline_lookup :level, lookup_methods: false`
+
+You can also disable the identity methods (e.g. `TurnaroundLevel.first.same_day?`) by using
+
+`use_offline_lookup :level, identity_methods: false`
+
+(And yes, the keywords can be combined, they're all optional keyword args)
+
+## Known Issues
+
+If two entries in the table have the same value in the specified field, all but one will get overwritten. In a future version, I plan to allow multiple-column specificaion, e.g. `use_offline_lookup [:firstname, :lastname]`

data/lib/offline_lookup.rb

@@ -1,61 +1,10 @@
-# IMPORTANT: don't use this for models that have a lot of data!!
-#
-# This is basically a in-memory pseudo-index intended to speed up quick, repeated
-# finds of index table values without trips to an external db machine.
-# It's also nicer syntax, e.g:
-# TurnaroundLevel.two_hour_id
-# TurnaroundLevel.quick_lookup("Two Hour")
-# Service.last.turnaround_level.two_hour?
-#
-# In any ActiveRecord::Base subclass, use:
-# >> use_offline_id_lookup column_name
-# to define class methods that can convert between id and the corresponding
-# value in column_name for the class, without going to the database
-# 
-# column_name defaults to :name, but can be any column of the table
-# use the :key keyword arg if you're interested in a key colun other than :id
-#
-# Usage example:
-# class JobType < ActiveRecord::Base
-#   use_offline_id_lookup
-#   ...
-# end
-#
-# This gives you:
-# JobType.editing_id
-# #=> 1
-# JobType.name_for_id(1)
-# #=> 'Editing'
-# JobType.id_for_name('Editing')
-# #=> 1
-# with no db queries.
-#
-# You can use this on multiple column names (currently 
-# need to call use_offline_id_lookup once for each column name)
-# class InvoiceLineItemType < ActiveRecord::Base
-#   use_offline_id_lookup :name
-#   use_offline_id_lookup :accounting_label
-#   ...
-#
-# You get InvoiceLineItemType.name_for_id(id) and 
-# InvoiceLineItemType.account_label_for_id(id), etc.
-# Beware that if any value occurs more than once, 
-# either in the same column or different columns for 
-# which use_offline_id_lookup was called, the <name>_id 
-# method will only use the last column for which it was observed.
-
-
-#!!!
-# TODO: requires :methodize
-#!!!
-
 # TODO: provide multiple column names in a single call (e.g. firstname, lastname)
 # TODO: support multiple offline lookups per model
 # TODO: support scope arg in use_offline_lookup (partial index)
 
 module OfflineLookup
   module ActiveRecord
-    def use_offline_lookup(field = :name, key: :id, lookup_methods: true)
+    def use_offline_lookup(field = :name, key: :id, identiyy_methods: true, lookup_methods: true)
       class_attribute :offline_lookup_values, :offline_lookup_options
       self.offline_lookup_options = {field: field.to_s, key: key.to_s, lookup_methods: lookup_methods}.freeze
       self.offline_lookup_values = self.all.pluck(key, field).to_h.freeze
@@ -125,10 +74,12 @@ module OfflineLookup
         end
 
         # instance method: true if instance is of named type (e.g. FooType.first.bar?)
-        define_method(builder.indentiy_method_name(value)) do
-          self.attributes[self.offline_lookup_options[:key]] == key
+        if self.offline_lookup_options[:identiyy_methods]
+          define_method(builder.indentiy_method_name(value)) do
+            self.attributes[self.offline_lookup_options[:key]] == key
+          end
         end
-
+        
         # class method: get instance by named method (e.g. FooType.bar)
         # not "Offline", but lookup by indexed key. Also, synactic sugar.
         if self.offline_lookup_options[:lookup_methods]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: offline_lookup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Schwartz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies: []
 description: Offline indexing of small tables for speed & convenience
 email: ozydingo@gmail.com
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/offline_lookup.rb
 homepage: 
 licenses: