lookup_by 0.10.9 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 355a248ab95bea93cf3a8699d345152225be7c4f
-  data.tar.gz: ce156dc5c175049034b04de0e4cee2ba4a080aea
+SHA256:
+  metadata.gz: 4c1d5aaec4ced07731c227dfb1ae27903fed94b0feb28cecb6f1e3a27e55eb3c
+  data.tar.gz: a7185879dbfc9bff84bf7b8795913731f577254925c760e9bc096bc4091493e2
 SHA512:
-  metadata.gz: 30288404d1e8b43cb885caaeb83a71ac6cb8d557fecce56cb54ee76cc5c2e9372cc1a525384032d411bf61b1c75b228cd1f1cd41cb11f6c3c7d8422be3378cdc
-  data.tar.gz: 7186d2cfa8894e8f20ebd299eaf3f558f52efb5590b161859160fd8601e6f8381abfb3521f8cb39bc7c3243afed8f65922bcc1d06c0b5c3a12afebed2da9cbea
+  metadata.gz: abfa6b7b5053fd41e61f419c873a02a05b833ae96f104101858f86331d96d7f598b7d09d4b3812637a964ab23ce89c1ead6137ca0d11220b93af592af7197aa9
+  data.tar.gz: 067763d23e4a3e6fa1dfa9b0e27e3fd90bc7f69710a7dd129a2fa00a26131af2632eabe0b208ac9733440fe89240285d273600c787afe235d21a8788bd13a59f

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.0
+ruby-3.1.2

data/.travis.yml

@@ -1,16 +1,24 @@
 language: ruby
+
+cache:
+  bundler: true
+
 rvm:
-  - 1.9.3-p551
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - rbx-3.19
+  - 2.2.2
+  - 2.2.5
+  - 2.3.1
+
 services:
   - postgresql
-before_script:
-  - psql -c 'create database lookup_by_test' -U postgres
+
+# Travis defaults to PostgreSQL 9.1
+addons:
+  postgresql: "9.4"
+
 script:
-  - bundle exec rake app:db:test:prepare
   - bundle exec appraisal install
   - bundle exec appraisal rake
+
+general:
+  artifacts:
+    - coverage

data/Appraisals

@@ -1,11 +1,11 @@
-appraise 'rails-4.0' do
-  gem 'rails', '~> 4.0.0'
+appraise 'rails-6.0' do
+  gem 'activerecord', '~> 6.0.0'
 end
 
-appraise 'rails-4.1' do
-  gem 'rails', '~> 4.1.0'
+appraise 'rails-6.1' do
+  gem 'activerecord', '~> 6.1.0'
 end
 
-appraise 'rails-4.2' do
-  gem 'rails', '~> 4.2.0'
+appraise 'rails-7.0' do
+  gem 'activerecord', '~> 7.0.0'
 end

data/CHANGELOG.md

@@ -0,0 +1,58 @@
+### [v0.12.0](https://github.com/companygardener/lookup_by/compare/v0.11.2...v0.12.0)
+
+Require ruby 2.7. Support ruby 3.1
+
+* Appraisal: remove rails 5.0, 5.1, and 5.2
+* Appraisal: add rails 7.0
+* Dev: .ruby-version 3.1.2
+
+### [v0.11.2](https://github.com/companygardener/lookup_by/compare/v0.11.1...v0.11.2)
+
+Merged a few PRs. Shouldn't break anything.
+
+* Appraisal: add rails 5.1 and 5.2
+* Appraisal: bundle update
+* Fix: alias_method_chain was deprecated a long time ago
+* Fix: clearing the cache will also clear the reverse lookup cache
+* Dev: .ruby-version 2.6.1
+* Doc: docs for :scope and :inverse_scope options on `lookup_for` method
+* Doc: add changelog
+
+### [v0.11.1](https://github.com/companygardener/lookup_by/compare/v0.11.0...v0.11.1)
+
+#### Fix .all on lookup models
+
+Version 0.11.0 breaks Model.where(field: 'value').first_or_create! when
+Model is configured with `lookup_by :field, cache: true`.
+
+### [v0.11.0](https://github.com/companygardener/lookup_by/compare/v0.10.9...v0.11.0)
+
+#### Rails 5.0.0 support
+
+Update .count signature to support Rails 5.
+
+- Require ruby 2.2.2+
+- PostgreSQL 9.2+
+- Drop support for JRuby
+
+#### Default to a threadsafe cache
+
+### [v0.10.9](https://github.com/companygardener/lookup_by/compare/v0.10.8...v0.10.9)
+
+### [v0.10.8](https://github.com/companygardener/lookup_by/compare/v0.10.7...v0.10.8)
+
+### [v0.10.7](https://github.com/companygardener/lookup_by/compare/v0.10.6...v0.10.7)
+
+### [v0.10.6](https://github.com/companygardener/lookup_by/compare/v0.10.5...v0.10.6)
+
+### [v0.10.5](https://github.com/companygardener/lookup_by/compare/v0.10.4...v0.10.5)
+
+### [v0.10.4](https://github.com/companygardener/lookup_by/compare/v0.10.3...v0.10.4)
+
+### [v0.10.3](https://github.com/companygardener/lookup_by/compare/v0.10.2...v0.10.3)
+
+### [v0.10.2](https://github.com/companygardener/lookup_by/compare/v0.10.1...v0.10.2)
+
+### [v0.10.1](https://github.com/companygardener/lookup_by/compare/v0.10.0...v0.10.1)
+
+### [v0.10.0](https://github.com/companygardener/lookup_by/compare/v0.9.1...v0.10.0)

data/Gemfile

@@ -6,21 +6,17 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem 'appraisal', '~> 2.1.0', require: false
+  gem 'appraisal', "~> 2.4.1", require: false
+
+  gem 'combustion'
 
   gem 'rspec'
-  gem 'rspec-its'
   gem 'rspec-rails'
 
   gem "pg", platform: :ruby
-  gem "activerecord-jdbcpostgresql-adapter", platform: :jruby
-
-  gem "simplecov", require: false
-  gem 'coveralls', require: false
+  # gem "activerecord-jdbcpostgresql-adapter", platform: :jruby
 
-  gem "pry",       require: false
-  gem 'colored',   require: false
+  gem "simplecov", "~> 0.21.2", require: false
 
-  gem 'racc'
-  gem 'json'
+  gem "pry", require: false
 end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2014 Erik Peterson
+Copyright © 2014–2020 Erik Peterson
 
 MIT License
 

data/README.md

@@ -1,33 +1,35 @@
-# LookupBy
 
 [![Gem Version](https://badge.fury.io/rb/lookup_by.png)][rubygems]
-[![Build Status](https://secure.travis-ci.org/companygardener/lookup_by.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/companygardener/lookup_by.png)][gemnasium]
-[![Coverage Status](https://coveralls.io/repos/companygardener/lookup_by/badge.png?branch=master)][coveralls]
 [![Code Climate](https://codeclimate.com/github/companygardener/lookup_by.png)][codeclimate]
-[![Gittip](http://img.shields.io/gittip/companygardener.png)][gittip]
 
 [rubygems]:    https://rubygems.org/gems/lookup_by
-[travis]:      http://travis-ci.org/companygardener/lookup_by
-[gemnasium]:   https://gemnasium.com/companygardener/lookup_by
-[coveralls]:   https://coveralls.io/r/companygardener/lookup_by?branch=master
 [codeclimate]: https://codeclimate.com/github/companygardener/lookup_by
-[gittip]:      https://www.gittip.com/companygardener
 
-# Overview
+# LookupBy
 
 LookupBy is a thread-safe lookup table cache for ActiveRecord that reduces normalization pains.
 
 * Configurable lookup column
-* Caching (read-through, write-through, least recently used (LRU))
+* Caching (read-through, write-through, least-recently used (LRU))
 * Symbolized values
 * Normalized values, _e.g. canonicalizing UTF-8 before lookup_
 
 ### Dependencies
 
-* Rails 4.0+ (_tested on Rails 4.0, 4.1, and 4.2_)
-* Ruby 1.9.3+ (_tested on Ruby 1.9.3, 2.0, 2.1, 2.2, 2.3 and Rubinius 3.19_)
-* PostgreSQL
+* Rails 6.0+ (_tested on Rails 6.0, 6.1, and 7.0_)
+* Ruby 2.7+ (_tested on Ruby 2.7, 3.0, 3.1_)
+* PostgreSQL 9.2+ (tested on 14.2)
+
+### Deprecations
+
+- Rails <= 5.2 (5.x breaks test suite on ruby 3.1; 4.x is incompatible with bundler 2.x, too hard to maintain)
+- Ruby <= 2.6 (end of life; may depend on openssl@1.0, which is also end of life)
+
+If you must use an old version of Ruby, good luck to you. You could try:
+
+    brew install rbenv/tap/openssl@1.0
+    brew install ruby-install
+    ruby-install ruby 2.2.10 --no-install-deps -- --with-openssl-dir=$(brew --prefix openssl@1.0) --disable-install-doc
 
 ### Development
 
@@ -41,7 +43,7 @@ LookupBy is a thread-safe lookup table cache for ActiveRecord that reduces norma
 
 Please create [Issues][] to submit bug reports and feature requests. However, I ask that you'd kindly review [these bug reporting guidelines](https://github.com/companygardener/lookup_by/wiki/Bug-Reports) first.
 
-_If you find a security bug, **_do not_** use the public issue tracker. Instead, send an email to: thecompanygardener@gmail.com._
+_If you find a security bug, **do not** use the public issue tracker. Instead, send an email to: thecompanygardener[removethisifnotspam]@gmail.com._
 
 # Installation
 
@@ -75,6 +77,11 @@ class ExampleObject < ActiveRecord::Base
   # Defines #status and #status= instance methods that transparently reference the lookup table.
   # Defines .with_status(*names) and .without_status(*names) scopes on the model.
 end
+
+class Address < ActiveRecord::Base
+  # scopes can be renamed
+  lookup_for :city, scope: :inside_city, inverse_scope: :outside_city
+end
 ```
 
 ### Define the lookup model
@@ -223,11 +230,10 @@ lookup_by :column_name
 # Cache all
 #   Use for a small finite list (e.g. status codes, US states)
 #
-#   Defaults to no read-through
-#     options[:find] = false
+#   Defaults to no read-through, e.g. options[:find] = false
 lookup_by :column_name, cache: true
 
-# Cache N (with LRU eviction)
+# Cache N records, evicting the least-recently used (LRU)
 #   Use for large sets with uneven distribution (e.g. email domain, city)
 #
 #   Requires read-through
@@ -290,7 +296,7 @@ lookup_by :column_name, cache: true, find: true, raise: true
 
 ```ruby
 # Normalize
-#   Run through the your attribute's setter
+#   Call the attribute's setter
 lookup_by :column_name, normalize: true
 ```
 
@@ -306,14 +312,11 @@ lookup_by :column_name, allow_blank: true
 
 ### Threadsafety
 
-Force the LRU to be threadsafe (used to test the SafeLRU).
-
-With Rails 4, the Safe LRU is selected automatically in production-like environments.
+Disable threadsafety using the `:safe` option.
 
 ```ruby
-# Safe
-#   Use threadsafe cache
-lookup_by :column_name, cache: 10, safe: true
+# Default: true
+lookup_by :column_name, cache: 10, safe: false
 ```
 
 # Integration
@@ -343,7 +346,7 @@ This provides: `Given I reload the cache for $plural_class_name`
   = f.input :status, :as => :radio
 ```
 
-## Testing
+# Testing
 
 This plugin uses rspec and pry for testing. Make sure you have them installed:
 
@@ -366,7 +369,7 @@ A list of authors can be found on the [Contributors][] page.
 
 # License
 
-Copyright © 2014 Erik Peterson
+Copyright © 2014–2022 Erik Peterson
 
 MIT License
 

data/Rakefile

@@ -5,12 +5,30 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
+require 'combustion'
 
 Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'Start a console'
+task :console do
+  Combustion.initialize! :active_record
+
+  ARGV.clear
+
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+  require 'pry'
+  Pry.start
+end
+
+namespace :db do
+  desc 'Setup db'
+  task :setup do
+    Combustion.initialize! :active_record
+  end
+end
+
 task :default => :spec

data/circle.yml

@@ -2,8 +2,10 @@ dependencies:
   post:
     - bundle exec appraisal install
 
+database:
+  override:
+    - echo "Skipping default"
+
 test:
-  pre:
-    - bundle exec rake app:db:test:prepare
   override:
     - bundle exec appraisal rake

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+
+group :development, :test do
+  gem "appraisal", "~> 2.4.1", require: false
+  gem "combustion"
+  gem "rspec"
+  gem "rspec-rails"
+  gem "pg", platform: :ruby
+  gem "simplecov", "~> 0.21.2", require: false
+  gem "pry", require: false
+end
+
+gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1.0"
+
+group :development, :test do
+  gem "appraisal", "~> 2.4.1", require: false
+  gem "combustion"
+  gem "rspec"
+  gem "rspec-rails"
+  gem "pg", platform: :ruby
+  gem "simplecov", "~> 0.21.2", require: false
+  gem "pry", require: false
+end
+
+gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 7.0.0"
+
+group :development, :test do
+  gem "appraisal", "~> 2.4.1", require: false
+  gem "combustion"
+  gem "rspec"
+  gem "rspec-rails"
+  gem "pg", platform: :ruby
+  gem "simplecov", "~> 0.21.2", require: false
+  gem "pry", require: false
+end
+
+gemspec path: "../"

data/lib/lookup_by/association.rb

@@ -23,7 +23,7 @@ module LookupBy
         end
 
         options.symbolize_keys!
-        options.assert_valid_keys(:class_name, :foreign_key, :symbolize, :strict, :scope, :inverse_scope)
+        options.assert_valid_keys(:class_name, :foreign_key, :symbolize, :strict, :scope, :inverse_scope, :belongs_to)
 
         field = field.to_sym
 
@@ -80,8 +80,11 @@ module LookupBy
 
         Rails.logger.error "foreign key `#{foreign_key}` is required on #{self}" unless attribute_names.include?(foreign_key.to_s)
 
-        strict = options[:strict]
-        strict = true if strict.nil?
+        belongs = options[:belongs_to] || false
+
+        class_eval <<-BELONGS_TO, __FILE__, __LINE__.next if belongs
+          belongs_to :#{field}, class_name: "#{class_name}", foreign_key: :#{foreign_key}, autosave: false, optional: true
+        BELONGS_TO
 
         class_eval <<-SCOPES, __FILE__, __LINE__.next if scope_name
           scope :#{scope_name}, ->(*names) { where(#{foreign_key}: #{class_name}[*names]) }
@@ -102,6 +105,9 @@ module LookupBy
         lookup_field  = klass.lookup.field
         lookup_object = "#{class_name}[#{foreign_key}]"
 
+        strict = options[:strict]
+        strict = true if strict.nil?
+
         class_eval <<-METHODS, __FILE__, __LINE__.next
           def raw_#{field}
             #{lookup_object}

data/lib/lookup_by/cache.rb

@@ -1,6 +1,7 @@
 module LookupBy
   class Cache
-    attr_reader   :cache, :field, :stats
+    attr_reader   :cache, :reverse, :field, :stats
+
     attr_accessor :testing
 
     def initialize(klass, options = {})
@@ -18,7 +19,7 @@ module LookupBy
       @raise_on_miss    = options[:raise] || false
       @testing          = false
       @enabled          = true
-      @safe             = options[:safe] || concurrent?
+      @safe             = options.fetch(:safe, true)
       @mutex            = Mutex.new if @safe
 
       @stats            = { db: Hash.new(0), cache: Hash.new(0) }
@@ -51,36 +52,36 @@ module LookupBy
       end
     end
 
-    def reload
+    def load
       return unless @type == :all
 
-      clear
-
       ::ActiveRecord::Base.connection.send :log, "", "#{@klass.name} Load Cache All" do
-        @klass.order(@order).each do |object|
+        @klass.order(@order).readonly.each do |object|
           cache_write(object)
         end
       end
     end
 
+    def reload
+      clear
+      load
+    end
+
     def clear
       @cache.clear
+      @reverse.clear
     end
 
     def create(*args, &block)
-      created = @klass.create(*args, &block)
-
-      cache_write(created) if cache?
-
-      created
+      @klass.create(*args, &block).tap do |created|
+        cache_write(created) if cache?
+      end
     end
 
     def create!(*args, &block)
-      created = @klass.create!(*args, &block)
-
-      cache_write(created) if cache?
-
-      created
+      @klass.create!(*args, &block).tap do |created|
+        cache_write(created) if cache?
+      end
     end
 
     def seed(*values)
@@ -154,11 +155,6 @@ module LookupBy
 
   private
 
-    # RAILS_ENV=test will not use the SafeLRU
-    def concurrent?
-      Rails.configuration.cache_classes && Rails.configuration.eager_load
-    end
-
     def primary_key?(value)
       case @primary_key_type
       when :integer

data/lib/lookup_by/caching/safe_lru.rb

@@ -1,4 +1,4 @@
-# TODO: Evaluate using ThreadSafe::Hash and ThreadSafe::Array.
+# @todo: Evaluate using ThreadSafe::Hash and ThreadSafe::Array.
 
 require "mutex_m"
 

data/lib/lookup_by/hooks/formtastic.rb

@@ -6,7 +6,8 @@ module LookupBy
       extend ActiveSupport::Concern
 
       included do
-        alias_method_chain :input, :lookup
+        alias_method :input_without_lookup, :input
+        alias_method :input, :input_with_lookup
       end
 
       def input_with_lookup(method, options = {})

data/lib/lookup_by/hooks/simple_form.rb

@@ -6,7 +6,8 @@ module LookupBy
       extend ActiveSupport::Concern
 
       included do
-        alias_method_chain :input, :lookup
+        alias_method :input_without_lookup, :input
+        alias_method :input, :input_with_lookup
       end
 
       def input_with_lookup(method, options = {}, &block)

data/lib/lookup_by/lookup.rb

@@ -55,7 +55,7 @@ module LookupBy
           end
 
           @lookup = Cache.new(self, options.merge(field: field))
-          @lookup.reload
+          @lookup.load
         end
 
         LookupBy.register self
@@ -63,22 +63,36 @@ module LookupBy
     end
 
     module ClassMethods
-      # TODO: Rails 4 needs to return a proxy object here
-      def all(*args)
-        return super if Rails::VERSION::MAJOR >= 4
+      # Rails 4.1, 4.2, 5.0+
+      def all
+        return super if current_scope
+
         return super if @lookup.read_through?
+        return super if @lookup.cache.empty?
         return super if @lookup.disabled?
-        return super if args.any?
 
-        @lookup.cache.values
+        relation.tap do |rel|
+          rel.instance_variable_set(:@records, @lookup.cache.values)
+          rel.instance_variable_set(:@loaded, true)
+        end
       end
 
-      def count(column_name = nil, options = {})
-        return super if @lookup.read_through?
-        return super if @lookup.disabled?
-        return super if column_name
+      if Rails::VERSION::MAJOR <= 4
+        # Rails 4.1, 4.2
+        def count(column_name = nil, options = {})
+          return super if @lookup.read_through?
+          return super if column_name
 
-        @lookup.cache.size
+          @lookup.cache.size
+        end
+      else
+        # Rails 5.0+
+        def count(column_name = nil)
+          return super if @lookup.read_through?
+          return super if column_name
+
+          @lookup.cache.size
+        end
       end
 
       def pluck(*column_names)
@@ -103,7 +117,7 @@ module LookupBy
           when self    then arg
           else raise TypeError, "#{name}[*args]: args must be at least one String, Symbol, Integer, IPAddr, nil, or #{name}"
           end
-        else return args.map { |arg| self[arg] } 
+        else return args.map { |arg| self[arg] }
         end
       end
 
@@ -166,7 +180,7 @@ module LookupBy
 
         table_options[:id] = false if options[:small]
 
-        create_table name, table_options do |t|
+        create_table name, **table_options do |t|
           t.column table_options[:primary_key], 'smallserial primary key' if options[:small]
 
           t.column lookup_column, lookup_type, null: false

data/lib/lookup_by/version.rb

@@ -1,3 +1,3 @@
 module LookupBy
-  VERSION = "0.10.9"
+  VERSION = "0.12.0"
 end

data/lib/lookup_by.rb

@@ -1,6 +1,8 @@
 require "lookup_by/version"
 require "lookup_by/railtie" if defined? Rails
 
+require 'active_support'
+
 module LookupBy
   class Error < StandardError; end
 

data/lookup_by.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |gem|
   gem.test_files     = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "activerecord",  ">= 4.0.0"
+  gem.add_dependency "activerecord",  ">= 6.0.0"
 
-  gem.add_development_dependency "bundler", ">= 1.7.0"
+  gem.add_development_dependency "bundler", ">= 2.3.3"
   gem.add_development_dependency "rake"
 end

data/spec/association_spec.rb

@@ -113,6 +113,7 @@ describe LookupBy::Association do
     end
   end
 
+  # spec/internal/lib/missing.rb
   context "Missing.lookup_for :city" do
     it "does not raise foreign key error when table hasn't been created" do
       expect { require "missing" }.to_not raise_error

data/spec/cache_spec.rb

@@ -9,6 +9,11 @@ describe LookupBy::Cache do
       expect { subject.clear }.to     change(subject.cache, :size).from(1).to(0)
       expect { subject.clear }.not_to change(subject.cache, :size)
     end
+
+    it "clears the reverse cache" do
+      expect { subject.clear }.to     change(subject.reverse, :size).from(1).to(0)
+      expect { subject.clear }.not_to change(subject.reverse, :size)
+    end
   end
 
   describe "#reload" do
@@ -18,6 +23,11 @@ describe LookupBy::Cache do
       expect { subject.reload }.to     change(subject.cache, :size).from(0).to(1)
       expect { subject.reload }.not_to change(subject.cache, :size)
     end
+
+    it "loads the reverse cache" do
+      expect { subject.reload }.to     change(subject.reverse, :size).from(0).to(1)
+      expect { subject.reload }.not_to change(subject.reverse, :size)
+    end
   end
 
   describe "#disable!" do