constant_table_saver 5.1.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd0a0f0466a9358d62172e153ae85c8a88a0e9a9
-  data.tar.gz: b6d62a665e5a4b179101924c320e3ca2dd773e35
+SHA256:
+  metadata.gz: 3439491d2c0407e721feb9f068213d83278391d6fca8c93c29ca3fc147902c37
+  data.tar.gz: 2fa2009f42c977f20eedf9fa3e11e841249250afc388f49e23d1f172b75a0d11
 SHA512:
-  metadata.gz: 350eef086260e755159c68fa837515eff1c50f79b90a6044fb3ecdc806b78955faa9ba5716e73ad0b92827e7bad2c3e11666a0914a872e7df086a195c9f7b205
-  data.tar.gz: 0d9a1eed230c95df417727e8693da32e9168b8dd428a49aee3cbf6d08e73e650824c9d453878d01a7de2461e31ad4b40792c142bf3a6267b0bd3c548de3ad4c9
+  metadata.gz: 62723639d7273610e9210e411be9be75a1a50c52e995d54ed4d4a8933e127d29ce9ed30f3521a9ae4d97dc7f6b68b1ca0535a33c64afae9d4d36c1523f90da5f
+  data.tar.gz: 3f3a6ae939f87669cc844e83d586d5dd224356344bc5f7a5c9a19b7c00be76468d65c146d13c6614defa9b79001b6481331e2f22b37bd7cc8c2f222bc6abf108

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+dist: bionic
+rvm:
+  - 2.6
+services:
+  - postgresql
+  - mysql
+before_script:
+  - createdb -U postgres columns_on_demand_test
+  - mysqladmin -u root create columns_on_demand_test
+script: ./test_all.sh

data/Dockerfile

@@ -0,0 +1,49 @@
+# this Dockerfile is used only to get a consistent environment in which to run the tests (test_all.rb),
+# it has nothing to do with the actual gem that gets published.
+
+# use an older version of ubuntu so that we get a version of postgresql so is supported by the older rails
+# versions, or we won't be able to test out support for them.
+FROM ubuntu:16.04
+
+RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
+	apt-get install -y software-properties-common && \
+	apt-add-repository ppa:brightbox/ruby-ng && \
+	DEBIAN_FRONTEND=noninteractive apt-get update && \
+	DEBIAN_FRONTEND=noninteractive apt-get upgrade -y && \
+	DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential git \
+		mysql-server libmysqlclient-dev postgresql-9.5 libpq-dev libsqlite3-dev \
+		ruby2.5 ruby2.5-dev && \
+	rm -f /etc/apt/apt.conf.d/20auto-upgrades && \
+	apt-get clean -y && \
+	rm -rf /var/cache/apt/archives/*
+
+RUN ln -sf /usr/bin/ruby2.5 /usr/bin/ruby
+RUN ln -sf /usr/bin/gem2.5 /usr/bin/gem
+RUN gem install bundler -v 1.16.4 --no-ri --no-rdoc
+
+# install a version of mysql2 that the older versions of rails are compatible with
+RUN gem install mysql2 -v 0.4.10
+
+WORKDIR /tmp
+ADD Gemfile Gemfile
+ADD constant_table_saver.gemspec constant_table_saver.gemspec
+ADD lib/constant_table_saver/version.rb lib/constant_table_saver/version.rb
+RUN bundle install -j 4
+
+ADD . .
+RUN echo 'starting postgresql' && \
+	service postgresql start && \
+	echo 'creating postgresql database' && \
+	su postgres -c 'createdb --encoding unicode --template template0 constant_table_saver_test' && \
+	echo 'creating postgresql user' && \
+	su postgres -c 'createuser --superuser root' && \
+	echo 'starting mysql' && \
+	mkdir -p /var/run/mysqld && \
+	chown mysql:mysql /var/run/mysqld && \
+	(/usr/sbin/mysqld --skip-grant-tables &) && \
+	echo 'waiting for mysql to start' && \
+	mysqladmin --wait=30 ping && \
+	echo 'creating mysql database' && \
+	mysqladmin create constant_table_saver_test && \
+	echo 'running tests' && \
+	./test_all.rb

data/Gemfile

@@ -10,6 +10,9 @@ gemspec
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
 
-# To use debugger
-# gem 'ruby-debug19', :require => 'ruby-debug'
-# gem 'ruby-debug'
+gem 'rails', ENV['RAILS_VERSION']
+
+# see notes in the gemspec
+if ENV['RAILS_VERSION'] =~ /^5\.0/
+  gem "sqlite3", "~> 1.3.6"
+end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Will Bryant, Sekuda Ltd
+Copyright (c) 2010-2018 Will Bryant, Sekuda Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -11,9 +11,7 @@ named after the name field you specify.
 Compatibility
 =============
 
-Currently tested against Rails 5.1 (5.1.0beta2) and 5.0 (up to 5.0.2) and 4.2 (up to 4.2.7), on Ruby 2.3.4.
-
-For earlier versions of Rails, use an older version of the gem.
+Currently tested against Rails 6.1.0.rc1, 6.0.3.4, 5.2.4.4, 5.1.7, and 5.0.7.2, with older gem versions compatible with earlier Rails versions.
 
 
 Example
@@ -82,4 +80,9 @@ Means you will also have methods returning those records:
 Optionally, you can specify a `:name_prefix` and/or `:name_suffix`.
 
 
-Copyright (c) 2010-2017 Will Bryant, Sekuda Ltd, released under the MIT license
+Thanks
+======
+
+* Marc Shaw (@marcshaw)
+
+Copyright (c) 2010-2018 Will Bryant, Sekuda Ltd, released under the MIT license

data/Rakefile

@@ -13,4 +13,5 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/*_test.rb'
   t.verbose = true
+  t.warning = false
 end

data/constant_table_saver.gemspec

@@ -11,16 +11,7 @@ cached (and frozen) records for all find calls.
 
 Optionally, creates class-level methods you can use to grab the records,
 named after the name field you specify.
-
-
-Compatibility
-=============
-
-Currently tested against Rails 5.1 (5.1.0beta2) and 5.0 (up to 5.0.2) and 4.2 (up to 4.2.7), on Ruby 2.3.4.
-
-For earlier versions of Rails, use an older version of the gem.
 EOF
-  gem.has_rdoc     = false
   gem.author       = "Will Bryant"
   gem.email        = "will.bryant@gmail.com"
   gem.homepage     = "http://github.com/willbryant/constant_table_saver"
@@ -33,5 +24,8 @@ EOF
 
   gem.add_dependency "activerecord"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "mysql2"  # you probably want 0.4.10 if testing with old versions of rails, but this gem doesn't care
+  gem.add_development_dependency "pg"      # you probably want 0.21.0 if testing with old versions of rails, but this gem doesn't care
+  gem.add_development_dependency "sqlite3" # you probably want 1.3.6 if testing with old versions of rails, but this gem doesn't care
+  gem.add_development_dependency "byebug"
 end

data/lib/constant_table_saver.rb

@@ -12,8 +12,10 @@ module ConstantTableSaver
       
       if ActiveRecord::VERSION::MAJOR == 4
         extend ActiveRecord4ClassMethods
-      else
+      elsif ActiveRecord::VERSION::MAJOR == 5 && (ActiveRecord::VERSION::MINOR == 0 || ActiveRecord::VERSION::MINOR == 1)
         extend ActiveRecord5ClassMethods
+      else
+        extend ActiveRecord52ClassMethods
       end
       extend ClassMethods
       extend NameClassMethods if constant_table_options[:name]
@@ -52,16 +54,6 @@ module ConstantTableSaver
       @cached_records = @cached_records_by_id = @constant_record_methods = @cached_blank_scope = @find_by_sql = nil
     end
 
-    def _to_sql_with_binds(sql, binds)
-      if sql.respond_to?(:to_sql)
-        # an arel object
-        connection.to_sql(sql, binds)
-      else
-        # a plain string
-        sql
-      end
-    end
-
     def relation
       super.tap do |s|
         class << s
@@ -77,10 +69,46 @@ module ConstantTableSaver
     end
   end
 
+  module ActiveRecord52ClassMethods
+    def find_by_sql(sql, binds = [], preparable: nil, &block)
+      @cached_records ||= super(relation.to_sql, &nil).each(&:freeze).freeze
+
+      # to_sql_and_binds returns [sql, binds] prior to 6.1, and [sql, binds, preparable] on 6.1. we take the [0..1] slice
+      # to ignore the preparable flag, which is useful metadata for adapters but not required for us to match statements.
+      @cached_results ||= @cached_records.each_with_object({
+        # matches .all queries:
+        to_sql_and_binds(relation)[0..1] => @cached_records,
+
+        # matches .first queries:
+        to_sql_and_binds(relation.order(relation.table[primary_key].asc).limit(1).arel)[0..1] => [@cached_records.first].compact,
+
+        # matches .last queries:
+        to_sql_and_binds(relation.order(relation.table[primary_key].desc).limit(1).arel)[0..1] => [@cached_records.last].compact,
+      }) do |record, results|
+        results[to_sql_and_binds(relation.where(relation.table[primary_key].eq(relation.predicate_builder.build_bind_attribute(primary_key, record.id))).limit(1).arel)[0..1]] = [record]
+      end.freeze
+
+      sql_and_binds = to_sql_and_binds(sql, binds)[0..1]
+      sql_and_binds = [sql_and_binds.first, []] unless connection.prepared_statements
+
+      if results = @cached_results[sql_and_binds]
+        results
+      else
+        super(sql, binds, preparable: preparable, &block)
+      end
+    end
+
+  private
+    def to_sql_and_binds(sql, binds = [])
+      sql = sql.arel if sql.respond_to?(:arel)
+      connection.send(:to_sql_and_binds, sql, binds)
+    end
+  end
+
   module ActiveRecord5ClassMethods
     def find_by_sql(sql, binds = [], preparable: nil, &block)
       @find_by_sql ||= {
-        :all   => all.to_sql,
+        :all   => relation.to_sql,
         :id    => relation.where(relation.table[primary_key].eq(Arel::Nodes::BindParam.new)).limit(1).arel,
         :first => relation.order(relation.table[primary_key].asc).limit(1).arel,
         :last  => relation.order(relation.table[primary_key].desc).limit(1).arel,
@@ -114,12 +142,22 @@ module ConstantTableSaver
 
       super(sql, binds, preparable: preparable, &block)
     end
+
+    def _to_sql_with_binds(sql, binds)
+      if sql.respond_to?(:to_sql)
+        # an arel object
+        connection.to_sql(sql, binds)
+      else
+        # a plain string
+        sql
+      end
+    end
   end
 
   module ActiveRecord4ClassMethods
     def find_by_sql(sql, binds = [])
       @find_by_sql ||= {
-        :all   => all.to_sql,
+        :all   => relation.to_sql,
         :id    => relation.where(relation.table[primary_key].eq(connection.substitute_at(columns_hash[primary_key], 0))).limit(1).
                     tap {|r| r.bind_values += [[columns_hash[primary_key], :undefined]]}. # work around AR 4.1.9-4.1.x (but not 4.2.x) calling nil.first if there's no bind_values
                     arel,
@@ -148,6 +186,16 @@ module ConstantTableSaver
 
       super
     end
+
+    def _to_sql_with_binds(sql, binds)
+      if sql.respond_to?(:to_sql)
+        # an arel object
+        connection.to_sql(sql, binds)
+      else
+        # a plain string
+        sql
+      end
+    end
   end
 
   module NameClassMethods

data/lib/constant_table_saver/version.rb

@@ -1,3 +1,3 @@
 module ConstantTableSaver
-  VERSION = '5.1.1'
+  VERSION = '6.1.0'
 end

data/test/constant_table_saver_test.rb

@@ -8,12 +8,18 @@ end
 class ConstantPie < ActiveRecord::Base
   set_table_name "pies"
   constant_table
+
+  has_one :ingredient, class_name: "IngredientForConstantPie", foreign_key: 'pie_id'
   
   scope :filled_with_unicorn, -> { where(:filling => 'unicorn') }
   
   def self.with_unicorn_filling_scope
     with_scope(:find => {:conditions => {:filling => 'unicorn'}}) { yield }
   end
+
+  def self.retrieve_pies
+    all.map { |x| x }
+  end
 end
 
 class ConstantNamedPie < ActiveRecord::Base
@@ -148,6 +154,7 @@ class ConstantTableSaverTest < ActiveSupport::TestCase
     @pies = StandardPie.select("id").all.to_a
     @pie = StandardPie.select("id").find(1)
     @second_pie = StandardPie.select("id").find(2)
+    ConstantPie.first
     assert_queries(3) do
       assert_equal @pies.collect(&:attributes), ConstantPie.select("id").all.collect(&:attributes)
       assert_equal @pie.attributes, ConstantPie.select("id").find(1).attributes
@@ -160,6 +167,26 @@ class ConstantTableSaverTest < ActiveSupport::TestCase
     end
   end
   
+  test "it doesn't cache find queries on scoped methods, even when no binds are set, if the records have been cached" do
+    ConstantPie.all.to_a
+    assert_queries(1) do
+      @pies = ConstantPie.where(:filling => ["Tasty beef steak"]).retrieve_pies
+    end
+    assert_equal 1, @pies.size
+  end
+
+  test "it doesn't cache find queries on scoped methods, even when no binds are set, if the records have not been cached" do
+    # these two lines are needed to fix random test order failures when nothing has hit the ConstantPie schema before
+    ConstantPie.all.to_a
+    ConstantPie.reset_constant_record_cache!
+
+    # retrieve_pies here is to test the behavior of scoped class methods:
+    @pies = ConstantPie.where(:filling => ["Tasty beef steak"]).retrieve_pies
+    assert_equal 1, @pies.size
+
+    assert_equal StandardPie.count, ConstantPie.all.to_a.size
+  end
+
   test "it passes the options preventing caching to the underlying query methods" do
     assert_nil ConstantPie.where(:filling => 'unicorn').first
     assert_equal [],  ConstantPie.where(:filling => 'unicorn').all
@@ -209,4 +236,11 @@ class ConstantTableSaverTest < ActiveSupport::TestCase
       ConstantPie.find([max_id, max_id + 1])
     end
   end
+
+  test "it correctly loads when includes are used" do
+    IngredientForConstantPie.includes(:pie).find_by(:id => 3)
+    assert_queries(2) do
+      IngredientForConstantPie.includes(:pie).find_by(:id => 3)
+    end
+  end  
 end

data/test/database.yml

@@ -1,10 +1,6 @@
 sqlite3:
   adapter: sqlite3
   database: test/constant_table_saver.db
-mysql:
-  adapter: mysql
-  database: constant_table_saver_test
-  username: root
 mysql2:
   adapter: mysql2
   database: constant_table_saver_test

data/test/test_helper.rb

@@ -11,7 +11,7 @@ require 'active_support'
 require 'active_support/test_case'
 require 'active_record'
 require 'active_record/fixtures'
-require 'byebug' rescue nil
+require 'byebug'
 
 RAILS_ENV = ENV['RAILS_ENV'] ||= 'sqlite3'
 

data/test_all.rb

@@ -2,12 +2,15 @@
 
 require 'yaml'
 
-rails_versions = ["4.2.0".."4.2.3", "4.1.07".."4.1.12", "4.0.13", "3.2.18"].flat_map {|spec| Array(spec).collect {|v| v.gsub /.0(\d)/, '.\\1'}}
+rails_versions = ["6.1.0.rc1", "6.0.3.4 ", "5.2.4.4", "5.1.7", "5.0.7.2"].flat_map {|spec| Array(spec).collect {|v| v.gsub /.0(\d)/, '.\\1'}}
 rails_envs = YAML.load(File.read("test/database.yml")).keys
 
-rails_envs.each do |env|
-  rails_versions.each do |version|
-    puts "*"*40
-    system "RAILS_ENV=#{env} RAILS_VERSION=#{version} rake" or exit(1)
+rails_versions.each do |version|
+  puts "*"*40
+  system "RAILS_VERSION=#{version} bundle update" or exit(1)
+
+  rails_envs.each do |env|
+    puts "Rails #{version}, #{env}"
+    system "RAILS_ENV=#{env} bundle exec rake" or exit(2)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constant_table_saver
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Will Bryant
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -52,26 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Loads all records from the table on first use, and thereafter returns the
   cached (and frozen) records for all find calls.
 
   Optionally, creates class-level methods you can use to grab the records,
   named after the name field you specify.
-
-
-  Compatibility
-  =============
-
-  Currently tested against Rails 5.1 (5.1.0beta2) and 5.0 (up to 5.0.2) and 4.2 (up to 4.2.7), on Ruby 2.3.4.
-
-  For earlier versions of Rails, use an older version of the gem.
 email: will.bryant@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- Dockerfile
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -92,7 +128,7 @@ homepage: http://github.com/willbryant/constant_table_saver
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,9 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Caches the records from fixed tables, and provides convenience methods to
   get them.