sequel-sequence 0.2.0 → 0.4.0

data/test/sequel/sqlite_sequence_test.rb

@@ -0,0 +1,329 @@
+# frozen_string_literal: true
+
+require 'sqlite_test_helper'
+
+class SqliteSequenceTest < Minitest::Test
+  include SqliteTestHelper
+
+  setup do
+    recreate_table
+  end
+
+  test 'adds sequence with default values' do
+    with_migration do
+      def up
+        # create_sequence :position, {start: 1, increment: 1, numeric_label: 0} - default values
+        create_sequence :position
+      end
+    end.up
+
+    assert_equal 2, SQLiteDB.nextval(:position)
+    assert_equal 3, SQLiteDB.nextval(:position)
+  end
+
+  test 'adds sequence reader within model and its inherited class' do
+    with_migration do
+      def up
+        create_sequence :position
+      end
+    end.up
+
+    class Object < Sequel::Model; end
+
+    assert_equal 2, Object.db.nextval('position')
+    assert_equal 3, Object.db.nextval('position')
+
+    class InheritedObject < Object; end
+
+    assert_equal 4, InheritedObject.db.nextval(:position)
+    assert_equal 5, InheritedObject.db.nextval(:position)
+  end
+
+  test 'adds sequence starting at 100' do
+    with_migration do
+      def up
+        create_sequence :position, start: 100
+      end
+    end.up
+
+    assert_equal 101, SQLiteDB.nextval(:position)
+    assert_equal 102, SQLiteDB.nextval(:position)
+  end
+
+  test 'adds a sequence that we are trying to increase by a value greater than 1' do
+    @step = 4
+    with_migration do
+      def up
+        create_sequence :position, increment: 4
+      end
+    end.up
+
+    assert_equal 2, SQLiteDB.nextval(:position)
+    assert_equal 3, SQLiteDB.nextval(:position)
+    assert_operator (2 + @step), :>, SQLiteDB.nextval(:position)
+  end
+
+  test 'adds a sequence that we are trying to increase by a value greater than 1 (using :step alias)' do
+    @step = 4
+    with_migration do
+      def up
+        create_sequence :position, step: 4
+      end
+    end.up
+
+    assert_equal 2, SQLiteDB.nextval(:position)
+    assert_equal 3, SQLiteDB.nextval(:position)
+    assert_operator (2 + @step), :>, SQLiteDB.nextval(:position)
+  end
+
+  test "returns current/last sequence value, which doesn't increase by itself" do
+    with_migration do
+      def up
+        create_sequence :position
+      end
+    end.up
+
+    SQLiteDB.nextval(:position)
+    # changed value (=2) after default one (=1)
+
+    assert_equal 2, SQLiteDB.currval(:position)
+    assert_equal 2, SQLiteDB.lastval(:position)
+    assert_equal 2, SQLiteDB.currval(:position)
+    assert_equal 2, SQLiteDB.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 SQLiteDB.currval(:position), 1
+
+    SQLiteDB.nextval(:position)
+    assert_equal SQLiteDB.currval(:position), 2
+
+    SQLiteDB.setval(:position, 101)
+    assert_equal 101, SQLiteDB.lastval(:position)
+
+    SQLiteDB.nextval(:position)
+    assert_equal 102, SQLiteDB.lastval(:position)
+  end
+
+  test 'sets a new sequence value less than the current one' do
+    with_migration do
+      def up
+        create_sequence :position, start: 100
+      end
+    end.up
+
+    assert_equal SQLiteDB.currval(:position), 100
+
+    SQLiteDB.nextval(:position)
+    assert_equal SQLiteDB.currval(:position), 101
+
+    SQLiteDB.setval(:position, 1)
+    assert_equal 101, SQLiteDB.lastval(:position)
+
+    assert_equal 102, SQLiteDB.nextval(:position)
+  end
+
+  test 'sets a new sequence value with a label' do
+    with_migration do
+      def up
+        create_sequence :position
+      end
+    end.up
+
+    SQLiteDB.nextval(:position)
+    SQLiteDB.nextval_with_label(:position, 1)
+    SQLiteDB.nextval_with_label(:position, 1)
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position where fiction = 1;').all.size
+    assert_equal 2, fiction_set_size
+
+    # create_sequence + nextval
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position where fiction = 0;').all.size
+    assert_equal 2, fiction_set_size
+  end
+
+  test 'drops the sequence and the check_sequences' do
+    with_migration do
+      def up
+        create_sequence :position
+      end
+    end.up
+
+    sequence = SQLiteDB.check_sequences.find_all do |seq|
+      seq[:name] == 'position'
+    end
+
+    assert_equal 1, sequence.size
+
+    with_migration do
+      def down
+        drop_sequence :position
+      end
+    end.down
+
+    sequence = SQLiteDB.check_sequences.find do |seq|
+      seq[:name] == 'position'
+    end
+
+    assert_nil sequence
+  end
+
+  test 'drops the sequence with the parameter if_exists' do
+    with_migration do
+      def up
+        create_sequence :position
+      end
+    end.up
+
+    sequence = SQLiteDB.check_sequences.find_all do |seq|
+      seq[:name] == 'position'
+    end
+
+    assert_equal 1, sequence.size
+
+    with_migration do
+      def down
+        drop_sequence :position, if_exists: true
+      end
+    end.down
+
+    sequence = SQLiteDB.check_sequences.find do |seq|
+      seq[:name] == 'position'
+    end
+
+    assert_nil sequence
+  end
+
+  test 'orders sequences' do
+    list = SQLiteDB.check_sequences.map { |s| s[:name] }
+    assert !list.include?('a')
+    assert !list.include?('b')
+    assert !list.include?('c')
+
+    with_migration do
+      def up
+        drop_table :things, if_exists: true
+        create_sequence :c, { start: 1 }
+        create_sequence :a, { start: 3 }
+        create_sequence :b
+      end
+    end.up
+
+    list = SQLiteDB.check_sequences.map { |s| s[:name] }
+    assert list.include?('a')
+    assert list.include?('b')
+    assert list.include?('c')
+  end
+
+  test 'recreates the same sequence with the same start value' do
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 1
+      end
+    end.up
+
+    assert_equal 1, SQLiteDB.currval(:position_id)
+
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position_id where fiction = 0;').all.size
+    assert_equal 1, fiction_set_size
+
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 1
+      end
+    end.up
+
+    assert_equal 1, SQLiteDB.currval(:position_id)
+
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position_id where fiction = 0;').all.size
+    assert_equal 1, fiction_set_size
+  end
+
+  test 'recreates the same sequence with a smaller start value' do
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 100
+      end
+    end.up
+
+    assert_equal 100, SQLiteDB.currval(:position_id)
+
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position_id where fiction = 0;').all.size
+    assert_equal 1, fiction_set_size
+
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 1
+      end
+    end.up
+
+    assert_equal 100, SQLiteDB.currval(:position_id)
+
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position_id where fiction = 0;').all.size
+    assert_equal 1, fiction_set_size
+  end
+
+  test 'recreates the same sequence with a greater start value' do
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 1
+      end
+    end.up
+
+    assert_equal 1, SQLiteDB.currval(:position_id)
+
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position_id where fiction = 0;').all.size
+    assert_equal 1, fiction_set_size
+
+    with_migration do
+      def up
+        create_sequence :position_id, if_exists: false, start: 100
+      end
+    end.up
+
+    assert_equal 100, SQLiteDB.currval(:position_id)
+
+    fiction_set_size = SQLiteDB.fetch('SELECT * FROM position_id where fiction = 0;').all.size
+    assert_equal 2, fiction_set_size
+  end
+
+  test 'creates table that references sequence' do
+    with_migration do
+      def up
+        drop_table :apprentices, if_exists: true
+        create_sequence :position_id, if_exists: false, start: 1
+        create_table :apprentices do
+          primary_key :id
+          String :name, text: true
+          Bignum :position
+        end
+        set_column_default_nextval :apprentices, :position, :position_id
+      end
+    end.up
+
+    class Apprentice < Sequel::Model; end
+
+    apprentice1 = Apprentice.create(name: 'Apprentice 1')
+    pos1 = SQLiteDB.lastval(:position_id) - 1
+    assert_equal pos1, apprentice1.reload.position
+
+    apprentice2 = Apprentice.create(name: 'Apprentice 2')
+    pos2 = SQLiteDB.currval(:position_id) - 1
+    assert_equal pos2, apprentice2.reload.position
+
+    assert_equal pos2 - pos1, 1
+
+    SQLiteDB.nextval(:position_id)
+
+    apprentice4 = Apprentice.create(name: 'Apprentice 4')
+    pos4 = SQLiteDB.currval(:position_id) - 1
+    assert_equal pos4, apprentice4.reload.position
+
+    assert_equal pos4 - pos2, 2
+  end
+end

data/test/sqlite_test_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'logger'
+
+SQLiteDB = Sequel.connect(
+  "sqlite://#{ENV.fetch('TEST_SQLITE_DATABASE', nil) || 'db/test.sqlite3'}",
+  loggers: [Logger.new($stdout)]
+)
+
+module SqliteTestHelper
+  def recreate_table
+    SQLiteDB.drop_sequence :position
+    SQLiteDB.drop_sequence :position_id, if_exists: true
+    SQLiteDB.run 'DROP TABLE IF EXISTS objects'
+    SQLiteDB.drop_sequence 'a'
+    SQLiteDB.drop_sequence 'b'
+    SQLiteDB.drop_sequence 'c'
+    sql = 'CREATE TABLE objects (id INTEGER PRIMARY KEY AUTOINCREMENT, quantity INTEGER DEFAULT(0), slug VARCHAR(255));'
+    SQLiteDB.run sql
+  end
+
+  def with_migration(&block)
+    migration_class = Sequel::Migration
+
+    Sequel::Model.db = SQLiteDB
+
+    Class.new(migration_class, &block).new(SQLiteDB)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-sequence
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nikolai Bocharov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -142,9 +142,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 description: |2
       This gem provides a single interface for SEQUENCE functionality
-      in Postgresql and Mysql databases within the Sequel ORM.
+      in Postgresql and MariaDB DBMS within the Sequel ORM.
+      It also models the Sequences to meet the needs of SQLite and MySQL users.
 email:
 - it.architect@yahoo.com
 executables: []
@@ -171,15 +186,21 @@ files:
 - lib/sequel/error.rb
 - lib/sequel/sequence.rb
 - lib/sequel/sequence/database.rb
-- lib/sequel/sequence/database/mysql.rb
-- lib/sequel/sequence/database/mysql2.rb
 - lib/sequel/sequence/database/postgresql.rb
+- lib/sequel/sequence/database/server/mariadb.rb
+- lib/sequel/sequence/database/server/mysql.rb
+- lib/sequel/sequence/database/sqlite.rb
+- lib/sequel/sequence/database_ext_connection.rb
 - lib/sequel/sequence/version.rb
 - sequel-sequence.gemspec
+- test/mariadb_test_helper.rb
 - test/mysql_test_helper.rb
 - test/postgresql_test_helper.rb
+- test/sequel/mariadb_sequence_test.rb
 - test/sequel/mysql_sequence_test.rb
 - test/sequel/postgresql_sequence_test.rb
+- test/sequel/sqlite_sequence_test.rb
+- test/sqlite_test_helper.rb
 - test/test_helper.rb
 homepage: https://rubygems.org/gems/sequel-sequence
 licenses:
@@ -206,5 +227,6 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Add support for PostgreSQL's and MySQL's SEQUENCE on Sequel migrations.
+summary: Adds SEQUENCE support to Sequel for migrations to PostgreSQL, MariaDB, MySQL
+  and SQLite.
 test_files: []

data/lib/sequel/sequence/database/mysql.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Sequel
-  module Sequence
-    module Database
-      module Mysql
-      end
-    end
-  end
-end

data/lib/sequel/sequence/database/mysql2.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-# https://sequel.jeremyevans.net/rdoc/files/doc/sql_rdoc.html
-# https://github.com/jeremyevans/sequel/blob/master/lib/sequel/database/connecting.rb
-module Sequel
-  module Sequence
-    module Database
-      module Mysql2
-        def quote_column_name(name)
-          "`#{name.gsub('`', '``')}`"
-        end
-
-        def quote_sequence_name(name)
-          "`#{name.gsub(/[`"']/, '')}`"
-        end
-
-        def check_sequences
-          fetch("SHOW FULL TABLES WHERE Table_type = 'SEQUENCE';").all.to_a
-        end
-
-        def create_sequence(name, options = {})
-          increment = options[:increment] || options[:step]
-          name = quote_name(name.to_s)
-
-          sql = ["CREATE SEQUENCE IF NOT EXISTS #{name}"]
-          sql << "INCREMENT BY #{increment}" if increment
-          sql << "START WITH #{options[:start]}" if options[:start]
-          sql << ';'
-
-          run(sql.join("\n"))
-        end
-
-        def drop_sequence(name)
-          name = quote_name(name.to_s)
-          sql = "DROP SEQUENCE #{name}"
-          run(sql)
-        end
-
-        def nextval(name)
-          name = quote(name.to_s)
-          out = nil
-          fetch("SELECT nextval(#{name});") do |row|
-            out = row["nextval(#{name})".to_sym]
-          end
-          out
-        end
-
-        # for db.database_type = :mysql2
-        def lastval(name)
-          name = quote(name.to_s)
-          out = nil
-          fetch("SELECT lastval(#{name});") do |row|
-            out = row["lastval(#{name})".to_sym]
-          end
-          out
-        end
-
-        # for db.database_type = :postgres
-        alias currval lastval
-
-        def setval(name, value)
-          name = quote(name.to_s)
-          out = nil
-          fetch("SELECT setval(#{name}, #{value});") do |row|
-            out = row["setval(#{name}, #{value})".to_sym]
-          end
-          out
-        end
-
-        def set_column_default_nextval(table, column, sequence)
-          table = table.to_s
-          column = column.to_s
-          sequence = quote(sequence.to_s)
-          run "ALTER TABLE IF EXISTS #{table} " \
-              "ALTER COLUMN #{column} SET DEFAULT nextval(#{sequence});"
-        end
-      end
-    end
-  end
-end