sequel-rails 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ac0c145b51b35609a915883a48ecdb9ae674f19957d207afcc7b4cc2aae940
-  data.tar.gz: 7cd0b568d5dec00df8765f93ad4f3fbb78dd95bc011ac6c32c426af21817324d
+  metadata.gz: 2aff64f558081a4bd3fd000cdfd10d0f311f8df566191c10b9667854f3963318
+  data.tar.gz: 4893182c4f44909bacfc5addab1b7e57ad1d789e550b448ce4ef685be7630b81
 SHA512:
-  metadata.gz: e480c41227765090b3e7a3a658a423150f1396568eac643eafb515d7359f33541d88f2a30dd3fb59c5e43f0d3407bdcbacb06ff8dfa0cb79622dde4e602621c1
-  data.tar.gz: 9014c2201df4e0a829c3a86d7d81e50209a3b3b20a794ff78b86707b6698bac8e5635c4b9bb4eebc3876fcedc0da74187c333e4fe413511d86a7c371ddf0c0af
+  metadata.gz: 5857f2559c24d2f1c06d1b5f671a18f886614cae46a76c918b9a311e70c6680c0b36e740605847eef202cc8f0ada7d08670d27c64cc3fb5c5bf5b08de49b1e3a
+  data.tar.gz: 58af2a634a6d2483a686a99d7196a4250ff086b672e252409c5c15fd160a06bdaed16b47926209c6de63d6666a4c24fd24c20d255208aeb2367f4df1febc82ba

data/.github/workflows/ci.yml

@@ -39,10 +39,9 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - "5.2"
-          - "6.0"
           - "6.1"
           - "7.0"
+          - "7.1"
         sequel:
           - "~> 5.0"
         ruby:
@@ -50,24 +49,31 @@ jobs:
           - "2.7"
           - "3.0"
           - "3.1"
+          - "3.2"
           # - "jruby"
-        exclude:
-          - ruby: "2.7"
-            rails: "5.2"
-          - ruby: "3.0"
-            rails: "5.2"
-          - ruby: "3.1"
+        include:
+          - ruby: "2.6"
             rails: "5.2"
-          - ruby: "3.0"
+            sequel: "~> 5.0"
+          - ruby: "2.6"
             rails: "6.0"
-          - ruby: "3.1"
+            sequel: "~> 5.0"
+          - ruby: "2.7"
             rails: "6.0"
+            sequel: "~> 5.0"
+        exclude:
           - ruby: "3.1"
             rails: "6.1"
+          - ruby: "3.2"
+            rails: "6.1"
           - ruby: "2.6"
             rails: "7.0"
           - ruby: "jruby"
             rails: "7.0"
+          - ruby: "2.6"
+            rails: "7.1"
+          - ruby: "jruby"
+            rails: "7.1"
     name: Rails ${{ matrix.rails }}, Sequel ${{ matrix.sequel }}, Ruby ${{ matrix.ruby }}
 
     env:

data/.gitignore

@@ -35,3 +35,4 @@ Gemfile.lock
 *.gemfile.lock
 
 spec/internal/db/database.sqlite3
+.idea/*

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'actionpack'
-gem 'fakefs', '0.5.3', :require => 'fakefs/safe'
+gem 'fakefs', '>= 1.8.0', :require => 'fakefs/safe'
 
 gem 'pry'
 

data/History.md

@@ -1,3 +1,14 @@
+1.2.2 (2023-12-18)
+==================
+
+* Simplify `binds` handling in `LogSubscriber` to support bound variables and prepare statements (Jonathan Tron)
+  [#201](https://github.com/TalentBox/sequel-rails/pull/201)
+* Update CI to run against rails 7.1 & ruby 3.2, add spec for `db:rollback` (@PikachuEXE)
+  [#199](https://github.com/TalentBox/sequel-rails/pull/199)
+* Update instructions for Rails 7 (@opensourceame)
+  [#197](https://github.com/TalentBox/sequel-rails/pull/197)
+
+
 1.2.1 (2023-10-18)
 ==================
 

data/README.md

@@ -27,7 +27,7 @@ Since January 2013, we've become the official maintainers of the gem after
 Using sequel-rails
 ==================
 
-Using sequel with Rails (5.2.x, 6.x, 7.x) requires a couple minor changes.
+Using sequel with Rails (5.2.x, 6.x, 7.x) requires a few minor changes.
 
 First, add the following to your Gemfile (after the `Rails` lines):
 
@@ -50,35 +50,37 @@ The top of your `config/application.rb` will probably look something like:
 # require 'rails/all'
 
 # Instead of 'rails/all', require these:
-require "active_model/railtie"
-require "active_job/railtie"
-# require "active_record/railtie"
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "action_view/railtie"
-require "action_cable/engine"
-require "sprockets/railtie"
-require "rails/test_unit/railtie"
+%w(
+  action_cable/engine
+  action_controller/railtie
+  action_mailer/railtie
+  action_view/railtie
+  active_job/railtie
+  rails/test_unit/railtie
+).each do |railtie|
+  begin
+    require railtie
+  rescue LoadError
+  end
+end
 ```
 
-Then you need to get rid of `ActiveRecord` configurations, that is if you
+Then you need to get rid of `ActiveRecord` and `ActiveStorage` configurations, that is if you
 didn't generate the new app with `-O` (or the long form `--skip-active-record`):
 
-For example in a fresh `Rails 5.0.0.1`, you would need to remove those lines:
-
-```
-config/initializers/new_framework_defaults.rb
-line 18:  Rails.application.config.active_record.belongs_to_required_by_default = true
-```
+For example in a fresh `Rails 7`, you would need to remove those lines:
 
 ```
 config/environments/development.rb
-line 38:  config.active_record.migration_error = :page_load
+line 37:  # config.active_storage.service = :local
+line 54:  # config.active_record.migration_error = :page_load
+line 57:  # config.active_record.verbose_query_logs = true
 ```
 
 ```
 config/environments/production.rb
-line 85:  config.active_record.dump_schema_after_migration = false
+line 41:  # config.active_storage.service = :local
+line 92:  # config.active_record.dump_schema_after_migration = false
 ```
 
 Starting with sequel-rails 0.4.0.pre3 we don't change default Sequel behaviour
@@ -90,6 +92,22 @@ with content:
 require "sequel_rails/railties/legacy_model_config"
 ```
 
+## Rails 7
+
+Rake `db:*` mappings are currently not supported in Rails 7, so you'll need to use
+the `sequel:*` tasks instead. For example, to migrate your database, you'll need to
+run `rails sequel:migrate` instead of `rails db:migrate`.
+
+The rake command to create your db requires that Sequel does not attempt to connect
+to load models before creating the db. Add this to your `config/application.rb`
+
+```
+# config/application.rb
+if defined?(Rake.application)  && Rake.application.top_level_tasks.include?('sequel:create')
+  config.sequel.skip_connect = true
+end
+```
+
 After those changes, you should be good to go!
 
 Features provided by `sequel-rails`
@@ -458,6 +476,8 @@ Improvements have been made by those awesome contributors:
 * Yuri Smirnov (@tycooon)
 * Mickael Kurmann (@elbouillon)
 * Radoslaw Wojnarowski (@rwojnarowski)
+* David Kelly (@opensourceame)
+* PikachuEXE (@PikachuEXE)
 
 Credits
 =======

data/ci/rails-5.2.gemfile

@@ -8,7 +8,7 @@ gemspec :path => '../'
 
 gem 'sequel', "#{ENV['SEQUEL']}"
 
-gem 'fakefs', '0.11.2', :require => 'fakefs/safe'
+gem 'fakefs', '>= 1.8.0', :require => 'fakefs/safe'
 
 gem 'rspec-rails', '~> 5.0'
 

data/ci/rails-6.0.gemfile

@@ -8,7 +8,7 @@ gemspec :path => '../'
 
 gem 'sequel', "#{ENV['SEQUEL']}"
 
-gem 'fakefs', '0.11.2', :require => 'fakefs/safe'
+gem 'fakefs', '>= 1.8.0', :require => 'fakefs/safe'
 
 gem 'rspec-rails', '~> 5.0'
 

data/ci/rails-6.1.gemfile

@@ -8,7 +8,7 @@ gemspec :path => '../'
 
 gem 'sequel', "#{ENV['SEQUEL']}"
 
-gem 'fakefs', '0.11.2', :require => 'fakefs/safe'
+gem 'fakefs', '>= 1.8.0', :require => 'fakefs/safe'
 
 gem 'rspec-rails', '~> 5.0'
 

data/ci/rails-7.0.gemfile

@@ -8,7 +8,7 @@ gemspec :path => '../'
 
 gem 'sequel', "#{ENV['SEQUEL']}"
 
-gem 'fakefs', '0.11.2', :require => 'fakefs/safe'
+gem 'fakefs', '>= 1.8.0', :require => 'fakefs/safe'
 
 gem 'rspec-rails', '~> 5.0'
 

data/ci/rails-7.1.gemfile

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+
+gem 'railties', '~> 7.1.0'
+gem 'activemodel', '~> 7.1.0'
+gem 'actionpack', '~> 7.1.0'
+
+gemspec :path => '../'
+
+gem 'sequel', "#{ENV['SEQUEL']}"
+
+gem 'fakefs', '>= 1.8.0', :require => 'fakefs/safe'
+
+gem 'rspec-rails', '~> 5.0'
+
+# MRI/Rubinius Adapter Dependencies
+platform :ruby do
+  gem 'pg'
+  gem 'mysql2'
+  gem 'sqlite3'
+end
+
+# JRuby Adapter Dependencies
+platform :jruby do
+  gem 'jdbc-sqlite3'
+  gem 'jdbc-mysql'
+  gem 'jdbc-postgres'
+end

data/lib/sequel_rails/railties/log_subscriber.rb

@@ -38,13 +38,7 @@ module SequelRails
 
         name = format('%s (%.1fms)', payload[:name], event.duration)
         sql  = payload[:sql].squeeze(' ')
-        binds = nil
-
-        unless (payload[:binds] || []).empty?
-          binds = '  ' + payload[:binds].map do |col, v|
-            [col.name, v]
-          end.inspect
-        end
+        binds = " #{payload[:binds].inspect}" unless (payload[:binds] || []).empty?
 
         if odd?
           name = color(name, :cyan, :bold => true)

data/lib/sequel_rails/version.rb

@@ -1,3 +1,3 @@
 module SequelRails
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/spec/internal/Rakefile

@@ -6,5 +6,10 @@ end
 Bundler.require :default, :development, :test
 
 Combustion.path = ''
-Combustion.initialize! 'sequel_rails'
+Combustion.initialize! 'sequel_rails' do
+  if Rails.gem_version >= Gem::Version.new('7.1.0')
+    # Suppress warning about `cache_format_version`
+    config.active_support.cache_format_version = 7.1
+  end
+end
 Combustion::Application.load_tasks

data/spec/internal/db/migrate/1365762738_add_display_name_to_users.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table :users do
+      add_column :display_name, String, :text => true
+    end
+  end
+end

data/spec/internal/db/migrate/1365762739_add_github_username_to_users.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table :users do
+      add_column :github_username, String, :text => true
+    end
+  end
+end

data/spec/lib/sequel_rails/railties/database_rake_spec.rb

@@ -25,28 +25,36 @@ describe 'Database rake tasks', :no_transaction => true do
     it 'append the migration schema information if any' do
       Dir.chdir app_root do
         `rake db:migrate db:schema:dump`
-        sql = Sequel::Model.db.from(
-          :schema_migrations
-        ).insert_sql(:filename => '1273253849_add_twitter_handle_to_users.rb')
+        sqls = [
+          Sequel::Model.db.from(
+            :schema_migrations
+          ).insert_sql(:filename => '1273253849_add_twitter_handle_to_users.rb'),
+          Sequel::Model.db.from(
+            :schema_migrations
+          ).insert_sql(:filename => '1365762738_add_display_name_to_users.rb'),
+          Sequel::Model.db.from(
+            :schema_migrations
+          ).insert_sql(:filename => '1365762739_add_github_username_to_users.rb')
+        ]
         content = if ENV['TEST_ADAPTER'] == 'postgresql'
-                    <<-EOS.strip_heredoc
+                    <<-EOS
                       Sequel.migration do
                         change do
                           self << "SET search_path TO \\"$user\\", public"
-                          self << #{sql.inspect}
+                          #{sqls.map { |sql| "self << #{sql.inspect}" }.join("\n")}
                         end
                       end
                     EOS
                   else
-                    <<-EOS.strip_heredoc
+                    <<-EOS
                       Sequel.migration do
                         change do
-                          self << #{sql.inspect}
+                          #{sqls.map { |sql| "self << #{sql.inspect}" }.join("\n")}
                         end
                       end
                     EOS
-                  end
-        expect(File.read(schema)).to include content
+                  end.gsub(/^\s+/, '').strip
+        expect(File.read(schema).gsub(/^\s+/, '')).to include content
       end
     end
   end
@@ -74,19 +82,80 @@ describe 'Database rake tasks', :no_transaction => true do
   end
 
   describe 'db:rollback' do
+    let(:version) { nil }
+    let(:rake_task_call) do
+      if version
+        proc { `rake db:rollback VERSION=#{version}` }
+      else
+        proc { `rake db:rollback` }
+      end
+    end
+
     it 'revert latest migration' do
       Dir.chdir app_root do
         begin
           expect do
-            `rake db:rollback`
+            rake_task_call.call
           end.to change { SequelRails::Migrations.current_migration }.from(
-            '1273253849_add_twitter_handle_to_users.rb'
-          ).to(nil)
+            '1365762739_add_github_username_to_users.rb'
+          ).to('1365762738_add_display_name_to_users.rb')
         ensure
           SequelRails::Migrations.migrate_up!
         end
       end
     end
+
+    context 'when version supplied' do
+      context 'same as current version' do
+        let(:version) { '1365762739' }
+
+        it 'does not revert' do
+          Dir.chdir app_root do
+            begin
+              expect do
+                rake_task_call.call
+              end.not_to change { SequelRails::Migrations.current_migration }
+            ensure
+              SequelRails::Migrations.migrate_up!
+            end
+          end
+        end
+      end
+      context 'same as last version' do
+        let(:version) { '1365762738' }
+
+        it 'revert latest migration' do
+          Dir.chdir app_root do
+            begin
+              expect do
+                rake_task_call.call
+              end.to change { SequelRails::Migrations.current_migration }.from(
+                '1365762739_add_github_username_to_users.rb'
+              ).to('1365762738_add_display_name_to_users.rb')
+            ensure
+              SequelRails::Migrations.migrate_up!
+            end
+          end
+        end
+      end
+      context 'smaller than last version' do
+        let(:version) { '1273253849' }
+
+        it 'revert until migration specified by version' do
+          Dir.chdir app_root do
+            begin
+              expect do
+                rake_task_call.call
+              end.to change { SequelRails::Migrations.current_migration }.from(
+                '1365762739_add_github_username_to_users.rb'
+              ).to('1273253849_add_twitter_handle_to_users.rb')
+            ensure
+              SequelRails::Migrations.migrate_up!
+            end
+          end
+        end
+      end
+    end
   end
 
   describe 'db:migrate:redo' do

data/spec/lib/sequel_rails/railties/log_subscriber_spec.rb

@@ -14,20 +14,135 @@ describe SequelRails::Railties::LogSubscriber do
   end
   after { teardown }
 
-  it 'logs queries, runtime and count' do
-    expect(described_class.count).to eq 0
-    User.all
-    wait
-    expect(@logger.logged(:debug).last).to match(/SELECT \* FROM ("|`)users("|`)/)
-    expect(described_class.count).to be > 0
-  end
-
   it 'does not log query when logger level is not debug, but track runtime and count' do
     expect(described_class.count).to eq 0
-    @logger.level = :info
+    @logger.level = defined?(Logger::Severity) ? Logger::Severity::INFO : :info
     User.all
     wait
     expect(@logger.logged(:debug).size).to eq 0
     expect(described_class.count).to be > 0
   end
+
+  describe 'for postgresql', :postgres do
+    it 'logs queries, runtime and count' do
+      expect(described_class.count).to eq 0
+      User.all
+      User.where(:id => 1).select_map(:id)
+      wait
+      expect(@logger.logged(:debug)[-2]).to match(/SELECT \* FROM "users"/)
+      expect(@logger.logged(:debug)[-1]).to match(/SELECT "id" FROM "users" WHERE \("id" = 1\)/)
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with bound variables' do
+      ds = Sequel::Model.db[:users].where(:id => :$id)
+      ds.call(:select, :id => 1)
+      wait
+      expect(@logger.logged(:debug).last).to match(
+        /SELECT \* FROM "users" WHERE \("id" = \$1\) \[1\]/
+      )
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with prepared statements' do
+      ds = Sequel::Model.db[:users].where(:id => :$id).prepare(:select, :users_by_id)
+      ds.call(:id => 1)
+      wait
+      expect(@logger.logged(:debug)[-2]).to match(
+        /PREPARE users_by_id AS SELECT \* FROM "users" WHERE \("id" = \$1\)/
+      )
+      expect(@logger.logged(:debug)[-1]).to match(
+        /EXECUTE users_by_id \[1\]/
+      )
+      expect(described_class.count).to be > 0
+    end
+  end
+
+  describe 'for mysql', :mysql do
+    it 'logs queries, runtime and count' do
+      expect(described_class.count).to eq 0
+      User.all
+      User.where(:id => 1).select_map(:id)
+      wait
+      expect(@logger.logged(:debug)[-2]).to match(/SELECT \* FROM `users`/)
+      expect(@logger.logged(:debug)[-1]).to match(/SELECT `id` FROM `users` WHERE \(`id` = 1\)/)
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with plain queries', :mysql do
+      Sequel::Model.db[:users].where(:id => 1).to_a
+      wait
+      expect(@logger.logged(:debug).last).to match(
+        /SELECT \* FROM `users` WHERE \(`id` = 1\)/
+      )
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with bound variables' do
+      ds = Sequel::Model.db[:users].where(:id => :$id)
+      ds.call(:select, :id => 1)
+      wait
+      expect(@logger.logged(:debug).last).to match(
+        /Executing SELECT \* FROM `users` WHERE \(`id` = \?\) \[1\]/
+      )
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with prepared statements' do
+      ds = Sequel::Model.db[:users].where(:id => :$id).prepare(:select, :users_by_id)
+      ds.call(:id => 1)
+      wait
+      expect(@logger.logged(:debug)[-2]).to match(
+        /Preparing users_by_id: SELECT \* FROM `users` WHERE \(`id` = \?\)/
+      )
+      expect(@logger.logged(:debug)[-1]).to match(
+        /Executing users_by_id \[1\]/
+      )
+      expect(described_class.count).to be > 0
+    end
+  end
+
+  describe 'for sqlite', :sqlite do
+    it 'logs queries, runtime and count' do
+      expect(described_class.count).to eq 0
+      User.all
+      User.where(:id => 1).select_map(:id)
+      wait
+      expect(@logger.logged(:debug)[-2]).to match(/SELECT \* FROM `users`/)
+      expect(@logger.logged(:debug)[-1]).to match(/SELECT `id` FROM `users` WHERE \(`id` = 1\)/)
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with plain queries', :mysql do
+      Sequel::Model.db[:users].where(:id => 1).to_a
+      wait
+      expect(@logger.logged(:debug).last).to match(
+        /SELECT \* FROM `users` WHERE \(`id` = 1\)/
+      )
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with bound variables' do
+      ds = Sequel::Model.db[:users].where(:id => :$id)
+      ds.call(:select, :id => 1)
+      wait
+      expect(@logger.logged(:debug).last).to match(
+        /SELECT \* FROM `users` WHERE \(`id` = :id\) {"id"=>1}/
+      )
+      expect(described_class.count).to be > 0
+    end
+
+    it 'works with prepared statements' do
+      ds = Sequel::Model.db[:users].where(:id => :$id).prepare(:select, :users_by_id)
+      ds.call(:id => 1)
+      wait
+      expect(@logger.logged(:debug)[-2]).to match(
+        /PREPARE users_by_id: SELECT \* FROM `users` WHERE \(`id` = :id\)/
+      )
+      expect(@logger.logged(:debug)[-1]).to match(
+        /EXECUTE users_by_id {"id"=>1}/
+      )
+      expect(described_class.count).to be > 0
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Brasten Sager (brasten)
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -223,6 +223,7 @@ files:
 - ci/rails-6.0.gemfile
 - ci/rails-6.1.gemfile
 - ci/rails-7.0.gemfile
+- ci/rails-7.1.gemfile
 - config.ru
 - lib/action_dispatch/middleware/session/sequel_store.rb
 - lib/generators/sequel.rb
@@ -268,6 +269,8 @@ files:
 - spec/internal/config/initializers/session_store.rb
 - spec/internal/config/routes.rb
 - spec/internal/db/migrate/1273253849_add_twitter_handle_to_users.rb
+- spec/internal/db/migrate/1365762738_add_display_name_to_users.rb
+- spec/internal/db/migrate/1365762739_add_github_username_to_users.rb
 - spec/internal/db/schema.rb.init
 - spec/internal/public/favicon.ico
 - spec/lib/generators/sequel/migration_spec.rb
@@ -319,6 +322,8 @@ test_files:
 - spec/internal/config/initializers/session_store.rb
 - spec/internal/config/routes.rb
 - spec/internal/db/migrate/1273253849_add_twitter_handle_to_users.rb
+- spec/internal/db/migrate/1365762738_add_display_name_to_users.rb
+- spec/internal/db/migrate/1365762739_add_github_username_to_users.rb
 - spec/internal/db/schema.rb.init
 - spec/internal/public/favicon.ico
 - spec/lib/generators/sequel/migration_spec.rb