sequel-sequence 0.4.1 → 0.5.0

data/lib/sequel/sequence.rb

@@ -1,29 +1,61 @@
 # frozen_string_literal: true
 
 require 'sequel/database'
-require 'sequel/adapters/postgres'
-require 'sequel/adapters/mysql2'
-require 'sequel/adapters/sqlite'
 require 'sequel/error'
 require 'sequel/sequence/database_ext_connection'
 
 module Sequel
   module Sequence
     require 'sequel/sequence/database'
-
-    module Database
-      require 'sequel/sequence/database/postgresql'
-      require 'sequel/sequence/database/sqlite'
-    end
   end
 end
 
 Sequel::Database.include(
   Sequel::Sequence::Database
 )
-Sequel::Postgres::Database.include(
-  Sequel::Sequence::Database::PostgreSQL
-)
-Sequel::SQLite::Database.include(
-  Sequel::Sequence::Database::SQLite
-)
+
+begin
+  if Gem::Specification.find_by_name('pg')
+    require 'sequel/adapters/postgres'
+
+    module Sequel
+      module Sequence
+        module Database
+          require 'sequel/sequence/database/postgresql'
+        end
+      end
+    end
+
+    Sequel::Postgres::Database.include(
+      Sequel::Sequence::Database::PostgreSQL
+    )
+  end
+rescue Gem::LoadError
+  # do nothing
+end
+
+begin
+  require 'sequel/adapters/mysql2' if Gem::Specification.find_by_name('mysql2')
+rescue Gem::LoadError
+  # do nothing
+end
+
+begin
+  if Gem::Specification.find_by_name('sqlite3')
+    require 'sequel/adapters/sqlite'
+
+    module Sequel
+      module Sequence
+        module Database
+          require 'sequel/sequence/database/sqlite'
+        end
+      end
+    end
+
+    Sequel::SQLite::Database.include(
+      Sequel::Sequence::Database::SQLite
+    )
+  end
+rescue Gem::LoadError
+  # do nothing
+end

data/sequel-sequence.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary               = \
     'Adds SEQUENCE support to Sequel for migrations to PostgreSQL, MariaDB, MySQL and SQLite.'
   spec.description           = <<-DES
-    This gem provides a single interface for SEQUENCE functionality
+    This gem provides a single user-friendly interface for SEQUENCE functionality
     in Postgresql and MariaDB DBMS within the Sequel ORM.
     It also models the Sequences to meet the needs of SQLite and MySQL users.
   DES
@@ -27,22 +27,22 @@ Gem::Specification.new do |spec|
   spec.platform              = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.7.0'
 
-  spec.add_dependency 'sequel', '>= 5.28', '<5.73'
+  spec.add_dependency 'sequel', '>= 5.28', '<6.0'
   spec.add_development_dependency 'bundler', '>= 2.2.4'
   spec.add_development_dependency 'minitest-utils', '~> 0.4.6'
   spec.add_development_dependency 'pry-byebug', '~> 3.10.1'
   spec.add_development_dependency 'rake', '~> 13.0.2'
   spec.add_development_dependency 'rubocop', '~> 1.56.3'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
-  if RUBY_ENGINE == 'jruby'
-    # JRuby Adapter Dependencies
-    spec.add_development_dependency 'jdbc-mysql', '~> 8.0.17'
-    spec.add_development_dependency 'jdbc-postgres', '~> 42.2.14'
-    spec.add_development_dependency 'jdbc-sqlite3', '~> 3.42'
-  else
-    # MRI/Rubinius Adapter Dependencies
-    spec.add_development_dependency 'mysql2', '~> 0.5.3'
-    spec.add_development_dependency 'pg', '~> 1.5.4'
-    spec.add_development_dependency 'sqlite3', '~> 1.6.0'
-  end
+  # if RUBY_ENGINE == 'jruby'
+  #   # JRuby Adapter Dependencies
+  #   spec.add_development_dependency 'jdbc-mysql', '~> 8.0.17'
+  #   spec.add_development_dependency 'jdbc-postgres', '~> 42.2.14'
+  #   spec.add_development_dependency 'jdbc-sqlite3', '~> 3.42'
+  # else
+  #   # MRI/Rubinius Adapter Dependencies
+  #   spec.add_development_dependency 'mysql2', '~> 0.5.3'
+  #   spec.add_development_dependency 'pg', '~> 1.5.4'
+  #   spec.add_development_dependency 'sqlite3', '~> 1.6.0'
+  # end
 end

data/test/mariadb_test_helper.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'test_helper'
+# require 'logger'
 
 MariaDB = Sequel.connect(
+  # loggers: [Logger.new($stdout)],
   adapter: 'mysql2',
   user: ENV['TEST_MARIA_USERNAME'] || 'root',
   password: ENV['TEST_MARIA_PASSWORD'] || 'root',
@@ -13,7 +15,9 @@ MariaDB = Sequel.connect(
 
 module MariadbTestHelper
   def recreate_table
+    MariaDB.run 'DROP TABLE IF EXISTS builders'
     MariaDB.run 'DROP SEQUENCE IF EXISTS position'
+    MariaDB.run 'DROP SEQUENCE IF EXISTS position_id'
     MariaDB.run 'DROP TABLE IF EXISTS wares'
     MariaDB.run 'DROP SEQUENCE IF EXISTS a'
     MariaDB.run 'DROP SEQUENCE IF EXISTS b'

data/test/mysql_test_helper.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'test_helper'
+# require 'logger'
 
 MysqlDB = Sequel.connect(
+  # loggers: [Logger.new($stdout)],
   adapter: 'mysql2',
   user: ENV['TEST_MYSQL_USERNAME'] || 'root',
   password: ENV['TEST_MYSQL_PASSWORD'] || 'rootroot',

data/test/postgresql_test_helper.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'test_helper'
+# require 'logger'
 
 PostgresqlDB = Sequel.connect(
+  # loggers: [Logger.new($stdout)],
   adapter: 'postgres',
   user: ENV['TEST_POSTGRES_USERNAME'] || 'postgres',
   password: ENV['TEST_POSTGRES_PASSWORD'] || 'postgres',
@@ -13,8 +15,10 @@ PostgresqlDB = Sequel.connect(
 
 module PostgresqlTestHelper
   def recreate_table
-    PostgresqlDB.run 'DROP TABLE IF EXISTS things'
+    PostgresqlDB.run 'DROP TABLE IF EXISTS masters'
     PostgresqlDB.run 'DROP SEQUENCE IF EXISTS position'
+    PostgresqlDB.run 'DROP SEQUENCE IF EXISTS position_id'
+    PostgresqlDB.run 'DROP TABLE IF EXISTS things'
     PostgresqlDB.run 'DROP SEQUENCE IF EXISTS a'
     PostgresqlDB.run 'DROP SEQUENCE IF EXISTS b'
     PostgresqlDB.run 'DROP SEQUENCE IF EXISTS c'

data/test/sequel/mariadb_sequence_test.rb

@@ -72,40 +72,77 @@ class MariadbSequenceTest < Minitest::Test
     assert_equal 3, MariaDB.nextval(:position)
   end
 
-  test "returns current/last sequence value, which doesn't increase by itself" do
+  test %( returns current/last sequence value, which doesn't increase by itself
+          for migration WITHOUT 'start' or 'increment' values ) do
     with_migration do
       def up
         create_sequence :position
       end
     end.up
 
-    MariaDB.nextval(:position)
-
-    assert_equal 1, MariaDB.currval(:position)
-    assert_equal 1, MariaDB.lastval(:position)
     assert_equal 1, MariaDB.currval(:position)
     assert_equal 1, MariaDB.lastval(:position)
+
+    MariaDB.nextval(:position)
+
+    assert_equal 2, MariaDB.currval(:position)
+    assert_equal 2, MariaDB.lastval(:position)
   end
 
-  test 'sets sequence value' do
+  test %( returns current/last sequence value, which doesn't increase by itself
+          for migration WITH 'start' and 'increment' values ) do
     with_migration do
       def up
-        create_sequence :position
+        create_sequence :position, start: 2, increment: 3
       end
     end.up
 
+    assert_equal 2, MariaDB.currval(:position)
+    assert_equal 2, MariaDB.lastval(:position)
+
     MariaDB.nextval(:position)
+
+    assert_equal 5, MariaDB.currval(:position)
+    assert_equal 5, MariaDB.lastval(:position)
+  end
+
+  test 'sets a new sequence value greater than the current one' do
+    with_migration do
+      def up
+        create_sequence :position
+      end
+    end.up
+
     assert_equal MariaDB.currval(:position), 1
 
     MariaDB.setval(:position, 101)
-    # in MariaDB, 'lastval' only works after 'nextval' rather than  'setval'
-    assert_equal 1, MariaDB.lastval(:position)
+    # assert_equal 1, MariaDB.lastval(:position)
+    # we observe the modified behavior of the method
+    assert_equal 101, MariaDB.lastval(:position)
 
     MariaDB.nextval(:position)
-    # now the value is correct
+    # the value is correct in any case
     assert_equal 102, MariaDB.lastval(:position)
   end
 
+  test 'sets a new sequence value less than the current one (does not change the value)' do
+    with_migration do
+      def up
+        create_sequence :position, start: 100
+      end
+    end.up
+
+    assert_equal MariaDB.currval(:position), 100
+
+    MariaDB.nextval(:position)
+    assert_equal MariaDB.currval(:position), 101
+
+    MariaDB.setval(:position, 1)
+    assert_equal 101, MariaDB.lastval(:position)
+
+    assert_equal 102, MariaDB.nextval(:position)
+  end
+
   test 'drops sequence and check_sequences' do
     with_migration do
       def up
@@ -125,14 +162,18 @@ class MariadbSequenceTest < Minitest::Test
       end
     end.down
 
-    sequence = MariaDB.check_sequences.find do |seq|
-      seq[:Tables_in_test] == 'position'
-    end
+    sequence = MariaDB.check_sequences
 
-    assert_nil sequence
+    assert_equal 0, sequence.size
   end
 
   test 'orders sequences' do
+    with_migration do
+      def up
+        drop_table :wares, if_exists: true
+      end
+    end.up
+
     list = MariaDB.check_sequences.map { |s| s[:Tables_in_test] }
     assert !list.include?('a')
     assert !list.include?('b')
@@ -140,7 +181,6 @@ class MariadbSequenceTest < Minitest::Test
 
     with_migration do
       def up
-        drop_table :things, if_exists: true
         create_sequence :c
         create_sequence :a
         create_sequence :b
@@ -153,10 +193,21 @@ class MariadbSequenceTest < Minitest::Test
     assert list.include?('c')
   end
 
+  test 'checks custom sequence generated from code' do
+    assert_equal MariaDB.custom_sequence?(:c), false
+
+    with_migration do
+      def up
+        create_sequence :c
+      end
+    end.up
+
+    assert_equal MariaDB.custom_sequence?(:c), true
+  end
+
   test 'creates table that references sequence' do
     with_migration do
       def up
-        drop_table :builders, if_exists: true
         create_sequence :position_id, if_exists: false, start: 1
         create_table :builders do
           primary_key :id
@@ -179,4 +230,100 @@ class MariadbSequenceTest < Minitest::Test
 
     assert_equal pos2 - pos1, 1
   end
+
+  test 'checks exception for delete_to_currval method' do
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 1
+      end
+    end.up
+
+    assert_equal 1, MariaDB.currval(:position_id)
+
+    assert_raises Sequel::MethodNotAllowed do
+      MariaDB.delete_to_currval(:position_id)
+    end
+  end
+
+  test 'deletes sequences by "drop_sequence?"' do
+    with_migration do
+      def up
+        create_sequence :a
+        create_sequence :b
+        create_sequence :c
+      end
+    end.up
+
+    assert MariaDB.custom_sequence?(:a)
+    assert MariaDB.custom_sequence?(:b)
+    assert MariaDB.custom_sequence?(:c)
+
+    MariaDB.drop_sequence?(:a, :b, :c, :d)
+
+    assert !MariaDB.custom_sequence?(:a)
+    assert !MariaDB.custom_sequence?(:b)
+    assert !MariaDB.custom_sequence?(:c)
+  end
+
+  test 'deletes if exists before creating! the sequence' do
+    with_migration do
+      def up
+        create_sequence! :position, { start: 1000, increment: 10 }
+      end
+    end.up
+
+    assert_equal 1000, MariaDB.currval(:position)
+
+    10.times { MariaDB.nextval(:position) }
+    assert_equal 1100, MariaDB.currval(:position)
+
+    MariaDB.create_sequence!(:position, { start: 1, increment: 1 })
+
+    assert_equal 1, MariaDB.currval(:position)
+
+    10.times { MariaDB.nextval(:position) }
+    assert_equal 11, MariaDB.currval(:position)
+  end
+
+  test 'checks the BIGINT primery key for a sequence table' do
+    with_migration do
+      def up
+        create_sequence :position, { start: 9_223_372_036_854_775_800 }
+      end
+    end.up
+
+    assert_equal 9_223_372_036_854_775_800, MariaDB.currval(:position)
+    assert_equal 9_223_372_036_854_775_801, MariaDB.nextval(:position)
+  end
+
+  test 'checks the BIGINT primery key with negative value for a sequence table' do
+    with_migration do
+      def up
+        create_sequence :position, { minvalue: -9_223_372_036_854_775_807 }
+      end
+    end.up
+
+    assert_equal(-9_223_372_036_854_775_807, MariaDB.currval(:position))
+    assert_equal(-9_223_372_036_854_775_806, MariaDB.nextval(:position))
+  end
+
+  # https://mariadb.com/kb/en/create-sequence/#arguments-to-create
+  test 'adds sequence with ext. params' do
+    with_migration do
+      def up
+        create_sequence :position, {
+          minvalue: -250,
+          maxvalue: 250,
+          start: -1,
+          cache: 3,
+          cycle: 'CYCLE',
+          increment: 2,
+          if_exists: false
+        }
+      end
+    end.up
+
+    assert_equal(-1, MariaDB.nextval('position'))
+    assert_equal 1, MariaDB.nextval('position')
+  end
 end

data/test/sequel/mock_sequence_test.rb

@@ -20,7 +20,7 @@ class MockSequenceTest < Minitest::Test
     mocked_method.verify
   end
 
-  test 'checks custom_sequence?' do
+  test 'checks "custom_sequence?"' do
     assert_raises Sequel::MethodNotAllowed do
       MockDB.custom_sequence?(:position)
     end
@@ -97,4 +97,22 @@ class MockSequenceTest < Minitest::Test
   test 'checks build_exists_condition for a non boolean condition' do
     assert_nil MockDB.build_exists_condition('')
   end
+
+  test 'checks delete_to_currval' do
+    assert_raises Sequel::MethodNotAllowed do
+      MockDB.delete_to_currval(:position)
+    end
+  end
+
+  test 'checks "drop_sequence?"' do
+    assert_raises Sequel::MethodNotAllowed do
+      MockDB.drop_sequence?(:position)
+    end
+  end
+
+  test 'checks "create_sequence!"' do
+    assert_raises Sequel::MethodNotAllowed do
+      MockDB.create_sequence!(:position)
+    end
+  end
 end

data/test/sequel/mysql_sequence_test.rb

@@ -91,20 +91,41 @@ class MysqlSequenceTest < Minitest::Test
     assert_operator (2 + @step), :>, MysqlDB.nextval(:position)
   end
 
-  test "returns current/last sequence value, which doesn't increase by itself" do
+  test %( returns current/last sequence value, which doesn't increase by itself
+          for migration WITHOUT 'start' or 'increment' values ) do
     with_migration do
       def up
         create_sequence :position
       end
     end.up
 
+    # catch the 'start' value 'by default
+    assert_equal 1, MysqlDB.currval(:position)
+    assert_equal 1, MysqlDB.lastval(:position)
+
     MysqlDB.nextval(:position)
-    # changed value (=2) after default one (=1)
 
     assert_equal 2, MysqlDB.currval(:position)
     assert_equal 2, MysqlDB.lastval(:position)
+  end
+
+  test %( returns current/last sequence value, which doesn't increase by itself
+          for migration WITH 'start' and 'increment' values ) do
+    with_migration do
+      def up
+        create_sequence :position, start: 2, increment: 3
+      end
+    end.up
+
+    # catch the 'start' value
     assert_equal 2, MysqlDB.currval(:position)
     assert_equal 2, MysqlDB.lastval(:position)
+
+    MysqlDB.nextval(:position)
+
+    # Doesn't support 'increment' value
+    assert_equal 3, MysqlDB.currval(:position)
+    assert_equal 3, MysqlDB.lastval(:position)
   end
 
   test 'sets a new sequence value greater than the current one' do
@@ -125,7 +146,7 @@ class MysqlSequenceTest < Minitest::Test
     assert_equal 102, MysqlDB.nextval(:position)
   end
 
-  test 'sets a new sequence value less than the current one' do
+  test 'sets a new sequence value less than the current one (does not change the value)' do
     with_migration do
       def up
         create_sequence :position, start: 100
@@ -215,6 +236,12 @@ class MysqlSequenceTest < Minitest::Test
   end
 
   test 'orders sequences' do
+    with_migration do
+      def up
+        drop_table :stuffs, if_exists: true
+      end
+    end.up
+
     list = MysqlDB.check_sequences.map { |s| s[:name] }
     assert !list.include?('a')
     assert !list.include?('b')
@@ -222,7 +249,6 @@ class MysqlSequenceTest < Minitest::Test
 
     with_migration do
       def up
-        drop_table :things, if_exists: true
         create_sequence :c, { start: 1 }
         create_sequence :a, { start: 3 }
         create_sequence :b
@@ -235,18 +261,6 @@ class MysqlSequenceTest < Minitest::Test
     assert list.include?('c')
   end
 
-  test 'checks custom sequence generated from code' do
-    assert_equal MysqlDB.custom_sequence?(:c), false
-
-    with_migration do
-      def up
-        create_sequence :c
-      end
-    end.up
-
-    assert_equal MysqlDB.custom_sequence?(:c), true
-  end
-
   test 'recreates the same sequence with the same start value' do
     with_migration do
       def up
@@ -353,6 +367,18 @@ class MysqlSequenceTest < Minitest::Test
     assert_equal pos4 - pos2, 2
   end
 
+  test 'checks custom sequence generated from code' do
+    assert_equal MysqlDB.custom_sequence?(:c), false
+
+    with_migration do
+      def up
+        create_sequence :c
+      end
+    end.up
+
+    assert_equal MysqlDB.custom_sequence?(:c), true
+  end
+
   test "catches a Mysql2::Error: «Table mysql_sequence doesn't exist»" do
     assert !sequence_table_exists?('position')
 
@@ -368,4 +394,95 @@ class MysqlSequenceTest < Minitest::Test
     MysqlDB.setval(:position, 100)
     assert_equal 100, MysqlDB.currval(:position)
   end
+
+  test 'deletes history from the sequence_table' do
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 1
+      end
+    end.up
+
+    assert_equal 1, MysqlDB.currval(:position_id)
+
+    sequence_table_size = MysqlDB.fetch('SELECT count(*) as len FROM position_id;').first[:len]
+    assert_equal 1, sequence_table_size
+
+    10.times { MysqlDB.nextval(:position_id) }
+
+    assert_equal 11, MysqlDB.currval(:position_id)
+
+    sequence_table_size = MysqlDB.fetch('SELECT count(*) as len FROM position_id;').first[:len]
+    assert_equal 11, sequence_table_size
+
+    MysqlDB.delete_to_currval(:position_id)
+
+    assert_equal 11, MysqlDB.currval(:position_id)
+
+    sequence_table_size = MysqlDB.fetch('SELECT count(*) as len FROM position_id;').first[:len]
+    assert_equal 1, sequence_table_size
+  end
+
+  test 'deletes sequences by "drop_sequence?"' do
+    with_migration do
+      def up
+        create_sequence :a
+        create_sequence :b
+        create_sequence :c
+      end
+    end.up
+
+    assert MysqlDB.custom_sequence?(:a)
+    assert MysqlDB.custom_sequence?(:b)
+    assert MysqlDB.custom_sequence?(:c)
+
+    MysqlDB.drop_sequence?(:a, :b, :c, :d)
+
+    assert !MysqlDB.custom_sequence?(:a)
+    assert !MysqlDB.custom_sequence?(:b)
+    assert !MysqlDB.custom_sequence?(:c)
+  end
+
+  test 'deletes if exists before creating! the sequence' do
+    with_migration do
+      def up
+        create_sequence! :position, { start: 1000, increment: 10 }
+      end
+    end.up
+
+    assert_equal 1000, MysqlDB.currval(:position)
+
+    10.times { MysqlDB.nextval(:position) }
+    assert_equal 1010, MysqlDB.currval(:position)
+
+    MysqlDB.create_sequence!(:position, { start: 1, increment: 1 })
+
+    assert_equal 1, MysqlDB.currval(:position)
+
+    10.times { MysqlDB.nextval(:position) }
+    assert_equal 11, MysqlDB.currval(:position)
+  end
+
+  test 'checks the BIGINT primery key for a sequence table' do
+    with_migration do
+      def up
+        create_sequence :position, { start: 9_223_372_036_854_775_800 }
+      end
+    end.up
+
+    assert_equal 9_223_372_036_854_775_800, MysqlDB.currval(:position)
+    assert_equal 9_223_372_036_854_775_801, MysqlDB.nextval(:position)
+  end
+
+  test 'checks the BIGINT primery key with negative value for a sequence table (does not support)' do
+    with_migration do
+      def up
+        create_sequence :position, { start: -9_223_372_036_854_775_807 }
+      end
+    end.up
+
+    assert_equal(-9_223_372_036_854_775_807, MysqlDB.currval(:position))
+    # https://www.cockroachlabs.com/docs/stable/serial#generated-values-for-modes-rowid-and-virtual_sequence
+    # "...negative values are not returned."
+    assert_equal 1, MysqlDB.nextval(:position)
+  end
 end