offline_lookup 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 214a550c54e40d9f718478920e4f9ec0a4a8be16
+  data.tar.gz: 834b7a4a9b81da79a8fb10f23a0fe6a001c93579
+SHA512:
+  metadata.gz: 7d2994fff30186971db79cbf00d7e9f8cb6dbca51ade19522e73e7a74f765b1e4e798a982a3a98f1a9ed189b0fc33b7d710cc143e847601e483c619f2131cffc
+  data.tar.gz: 716e5f920f9492a1f3951eb5dc476625b4c2f031e875166602969c912577da1a65803462962cdd8ba69ccb7cc065b5a2f4c564afae7d98539e00d2d623833da7

data/lib/offline_lookup.rb

@@ -0,0 +1,162 @@
+# 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)
+      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
+
+      include OfflineLookup::Base
+    end
+  end
+
+  class Builder
+    def initialize(options)
+      @field = options[:field]
+      @key = options[:key]
+    end
+
+    def sanitize(string)
+      #:methodize went away. Where did it go?
+      #1. Replace illegal chars and _ boundaries with " " boundary
+      string = string.gsub(/[^a-zA-Z\d]+/," ").strip
+      #2. Insert " " boundary at snake-case boundaries
+      string.gsub!(/([a-z])([A-Z])/){|s| "#{$1} #{$2}"}
+      #3. underscore
+      string.gsub!(/\s+/, "_")
+      string.downcase!
+      #4. Append underscore if name begins with digit
+      string = "_#{string}" if string.length == 0 || string[0] =~ /\d/
+      return string
+    end
+
+    # e.g., :two_hour_id
+    def key_method_name(value)
+      sanitize "#{value}_#{@key}"
+    end
+
+    def lookup_method_name(value)
+      sanitize value.to_s
+    end
+
+    # e.g., :two_hour?
+    def indentiy_method_name(value)
+      lookup_method_name(value) + "?"
+    end
+
+    # e.g. :name_for_id(id)
+    def field_for_key_method_name
+      sanitize "#{@field}_for_#{@key}"
+    end
+
+    # e.g. :id_for_name(name)
+    def key_for_field_method_name
+      sanitize "#{@key}_for_#{@field}"
+    end
+
+  end
+
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      builder = OfflineLookup::Builder.new(self.offline_lookup_options)
+
+      ### define value-named methods such as :two_hour_id and :two_hour?
+
+      self.offline_lookup_values.each do |key, value|
+        define_singleton_method(builder.key_method_name(value)) do
+          key
+        end
+
+        define_singleton_method(builder.indentiy_method_name(value)) do
+          self.attributes[self.offline_lookup_options[:key]] == key
+        end
+
+        # not "Offline", but lookup by indexed key. Also, synactic sugar.
+        if self.offline_lookup_options[:lookup_methods]
+          define_singleton_method(builder.lookup_method_name(value)) do
+            key = self.offline_lookup_values.find{|k, v| v.to_s == value.to_s}.first
+            find(key)
+          end
+        end
+      end
+  
+
+      ### define statically-named methods where you pass in the named value, e.g., id_for_name(:two_hour)
+
+      define_singleton_method(builder.field_for_key_method_name) do |key_value|
+        self.offline_lookup_values[key_value]
+      end
+
+      define_singleton_method(builder.key_for_field_method_name) do |field_value|
+        self.offline_lookup_values.find{|k, v| v.to_s == field_value.to_s}.first
+      end
+
+    end
+
+    module ClassMethods
+      def quick_lookup(value)
+        key = self.offline_lookup_values.find{|k, v| v.to_s == value.to_s}.first
+        find(key)
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.extend OfflineLookup::ActiveRecord

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: offline_lookup
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Andrew Schwartz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-13 00:00:00.000000000 Z
+dependencies: []
+description: Offline indexing of small tables for speed & convenience
+email: ozydingo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/offline_lookup.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Offline lookup
+test_files: []