lookup_by 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea1f94799e8cd1ce83a24d9c91ce3ca5e84a9db2
-  data.tar.gz: b2b4a26d4f25ccaf5a3435d7a8c2436393472300
+  metadata.gz: 170c2ef2408cf8495f0cfe3f30cd4811ee17cd6f
+  data.tar.gz: 14e0c54b5ec327fa87cd0044b67cd921df3a002b
 SHA512:
-  metadata.gz: 3ddc4e6763d8886696d8f7967e79e9920984adf1ec569da6c5bf0dc2711e114371533b5c3abfbe96103146b84b139492d86d2fadf2ccb5fde94f557acd7795f2
-  data.tar.gz: 145ab131848f7fc9a62eb2be3e2367854f2d6485e04216e36527872b90cbf8c950e030200f496c089ecbde93e321945fe8f92e3c40d3341f967ddd3e85a498d9
+  metadata.gz: 258e5adbe68b2c181613e08e5cb59e6d8044e1b28cea20dffb282d3489826aa9061e884cd200844953e95a23cc4e9286595f0a3e849205faa4ba6a102bd27d71
+  data.tar.gz: 76c03e4a60019234ba204c47d65520076b5dad3705a765523be4706b9caa78ae5199d9f9f992dca7e7c3ef65a48f8dc0d1563bdaf666bcc970e5343e29f7b0fd

data/lib/lookup_by/cache.rb

@@ -1,30 +1,28 @@
 module LookupBy
   class Cache
-    attr_reader :klass, :primary_key
-    attr_reader :cache, :stats
-    attr_reader :field, :order, :type, :limit, :find, :write, :normalize
-
-    attr_accessor :enabled
+    attr_reader   :cache, :field, :stats
+    attr_accessor :testing
 
     def initialize(klass, options = {})
       @klass       = klass
       @primary_key = klass.primary_key
       @field       = options[:field].to_sym
       @cache       = {}
-      @order       = options[:order] || field
+      @order       = options[:order] || @field
       @read        = options[:find]
       @write       = options[:find_or_create]
       @normalize   = options[:normalize]
+      @testing     = false
       @enabled     = true
 
       @stats       = { db: Hash.new(0), cache: Hash.new(0) }
 
-      raise ArgumentError, %Q(unknown attribute "#{field}" for <#{klass}>) unless klass.column_names.include?(field.to_s)
+      raise ArgumentError, %Q(unknown attribute "#{@field}" for <#{klass}>) unless klass.column_names.include?(@field.to_s)
 
       case options[:cache]
       when true
-        @type   = :all
-        @read ||= false
+        @type    = :all
+        @read  ||= false
       when ::Fixnum
         raise ArgumentError, "`#{@klass}.lookup_by :#{@field}` options[:find] must be true when caching N" if @read == false
 
@@ -33,70 +31,87 @@ module LookupBy
         @cache   = Rails.configuration.allow_concurrency ? Caching::SafeLRU.new(@limit) : Caching::LRU.new(@limit)
         @read    = true
         @write ||= false
-        @enabled = false if Rails.env.test? && write?
+        @testing = true if Rails.env.test? && @write
       else
         @read    = true
       end
     end
 
     def reload
-      return unless cache_all?
+      return unless @type == :all
 
       clear
 
-      ::ActiveRecord::Base.connection.send :log, "", "#{klass.name} Load Cache All" do
-        klass.order(order).each do |i|
-          cache[i.id] = i
+      ::ActiveRecord::Base.connection.send :log, "", "#{@klass.name} Load Cache All" do
+        @klass.order(@order).each do |i|
+          @cache[i.id] = i
         end
       end
     end
 
     def clear
-      cache.clear if cache?
+      @cache.clear
     end
 
     def create!(*args, &block)
-      created = klass.create!(*args, &block)
-      cache[created.id] = created if cache?
+      created = @klass.create!(*args, &block)
+      @cache[created.id] = created if cache?
       created
     end
 
     def fetch(value)
       increment :cache, :get
 
-      value = clean(value)      if normalize?
+      value = normalize(value)      if @normalize && !value.is_a?(Fixnum)
 
       found = cache_read(value) if cache?
-      found ||= db_read(value)  if read_through?
+      found ||= db_read(value)  if @read
+      found ||= db_read(value)  if not @enabled
 
-      cache[found.id] = found   if found && cache?
+      @cache[found.id] = found  if found && cache?
 
-      found ||= db_write(value) if write?
+      found ||= db_write(value) if @write
 
       found
     end
 
     def has_cache?
-      !!type
+      @type && @enabled
     end
 
     def read_through?
       @read
     end
 
-  private
+    def enabled?
+      @enabled
+    end
 
-    def clean(value)
-      return value if value.is_a? Fixnum
+    def disabled?
+      !@enabled
+    end
 
-      klass.new(field => value).send(field)
+    def enable!
+      @enabled = true
+      reload
+    end
+
+    def disable!
+      @enabled = false
+      clear
+    end
+
+  private
+
+    def normalize(value)
+      @klass.new(@field => value).send(@field)
     end
 
     def cache_read(value)
       if value.is_a? Fixnum
-        found = cache[value]
+        found = @cache[value]
       else
-        found = cache.values.detect { |o| o.send(field) == value }
+        found = @cache.values.detect { |o| o.send(@field) == value }
       end
 
       increment :cache, found ? :hit : :miss
@@ -107,7 +122,7 @@ module LookupBy
     def db_read(value)
       increment :db, :get
 
-      found = klass.where(column_for(value) => value).first
+      found = @klass.where(column_for(value) => value).first
 
       increment :db, found ? :hit : :miss
 
@@ -118,32 +133,16 @@ module LookupBy
     def db_write(value)
       column = column_for(value)
 
-      found = klass.create!(column => value) if column != primary_key
+      found = @klass.create!(column => value) if column != @primary_key
       found
     end
 
     def column_for(value)
-      value.is_a?(Fixnum) ? primary_key : field
-    end
-
-    def enabled?
-      enabled
-    end
-
-    def cache_all?
-      type == :all
+      value.is_a?(Fixnum) ? @primary_key : @field
     end
 
     def cache?
-      !!type && enabled?
-    end
-
-    def write?
-      !!write
-    end
-
-    def normalize?
-      !!normalize
+      @type && @enabled && !@testing
     end
 
     def increment(type, stat)

data/lib/lookup_by/lookup.rb

@@ -2,14 +2,26 @@ module LookupBy
   module Lookup
     module MacroMethods
       def is_a_lookup?
-        is_a? LookupBy::Lookup::ClassMethods
+        is_a? Lookup::ClassMethods
+      end
+
+      def lookup_by_disable(*methods)
+        methods.each do |method|
+          instance_eval <<-"END", __FILE__, __LINE__ + 1
+            def self.#{method}(*args)
+              raise NotImplementedError, "#{name}.#{method} is not supported on cached lookup tables." if @lookup.has_cache?
+
+              super
+            end
+          END
+        end
       end
 
       def lookup_by(field, options = {})
         options.symbolize_keys!
         options.assert_valid_keys :order, :cache, :normalize, :find, :find_or_create, :raise
 
-        raise "#{self} already called lookup_by" if is_a? LookupBy::Lookup::ClassMethods
+        raise "#{self} already called lookup_by" if is_a? Lookup::ClassMethods
         raise "#{self} responds_to :[], needed for lookup_by"     if respond_to? :[]
         raise "#{self} responds_to :lookup, needed for lookup_by" if respond_to? :lookup
 
@@ -18,7 +30,11 @@ module LookupBy
         class_eval do
           include InstanceMethods
 
-          class << self; attr_reader :lookup; end
+          singleton_class.class_eval do
+            attr_reader :lookup
+          end
+
+          lookup_by_disable :destroy, :destroy_all, :delete, :delete_all
 
           # TODO: check for a db unique constraint or Rails validation
 
@@ -65,30 +81,6 @@ module LookupBy
         else raise TypeError, "#{name}[arg]: arg must be a String, Symbol, Fixnum, nil, or #{name}"
         end
       end
-
-      def destroy_all(conditions = nil)
-        raise NotImplementedError, "#{name}.destroy_all is not supported on cached lookup tables." if @lookup.has_cache?
-
-        super
-      end
-
-      def destroy(id)
-        raise NotImplementedError, "#{name}.destroy(arg) is not supported on cached lookup tables" if @lookup.has_cache?
-
-        super
-      end
-
-      def delete_all(conditions = nil)
-        raise NotImplementedError, "#{name}.delete_all is not supported on cached lookup tables." if @lookup.has_cache?
-
-        super
-      end
-
-      def delete(id_or_array)
-        raise NotImplementedError, "#{name}.delete(arg) is not supported on cached lookup tables." if @lookup.has_cache?
-
-        super
-      end
     end
 
     module InstanceMethods

data/lib/lookup_by/version.rb

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

data/spec/lookup_by_spec.rb

@@ -80,8 +80,8 @@ describe LookupBy::Lookup do
     it_behaves_like "a cache"
     it_behaves_like "a read-through cache"
 
-    it "enables the LRU" do
-      subject.lookup.enabled.should be_true
+    it "is not testing when not writing through the LRU" do
+      subject.lookup.testing.should be_false
     end
   end
 
@@ -93,8 +93,8 @@ describe LookupBy::Lookup do
     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
+    it "sets testing when RAILS_ENV=test" do
+      subject.lookup.testing.should be_true
     end
   end
 end

data/spec/support/shared_examples_for_a_lookup.rb

@@ -60,8 +60,8 @@ end
 
 shared_examples "a cache" do
   it "caches records" do
-    was_enabled = subject.lookup.enabled
-    subject.lookup.enabled = true
+    was_testing = subject.lookup.testing
+    subject.lookup.testing = false
 
     original = subject.create(name: "original")
 
@@ -71,7 +71,7 @@ shared_examples "a cache" do
     subject.update(original.id, subject.lookup.field => "updated")
     subject[original.id].name.should eq "original"
 
-    subject.lookup.enabled = was_enabled
+    subject.lookup.testing = was_testing
   end
 
   it "raises on .destroy_all" do
@@ -146,8 +146,8 @@ 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
+    was_testing = subject.lookup.testing
+    subject.lookup.testing = false
 
     created = subject.create(name: "cached")
 
@@ -157,7 +157,7 @@ shared_examples "a read-through cache" do
     subject.update(created.id, name: "changed")
     subject[created.id].name.should eq "cached"
 
-    subject.lookup.enabled = was_enabled
+    subject.lookup.testing = was_testing
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lookup_by
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Erik Peterson