sequel-sequence 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39e70601cb32fc0e4240423134984c665c0691ebb68aa2b1038b43ea0e978176
-  data.tar.gz: ad285adcee5907a0d40d3ecd7d4e2bb67d3711876c75687276a58f71304cf48a
+  metadata.gz: ba4270613514ab8a88b24fa9034314333feba102dff7719a8e238ca1c84e67d1
+  data.tar.gz: 950c6494e0c9f55f6465beee78209649c784508c9c9c0dab1b9817576cbf3a7c
 SHA512:
-  metadata.gz: 0b97dc0b9a8b1c531d3863de2c52fde8ae2f0013aca027035fef391e2977db84520e6a00b059118a7c62ce77c57f7333abbfab56dad13d0b425d2ff4f923c02f
-  data.tar.gz: e35322803655e71d7118c3ec3e63e554ffaa73e0669e3d0947ad386d277d8b465c66b677ee9aa9bc14843062fef0331865682df769e2b2aa3fa136bca8e7029c
+  metadata.gz: ed1505fd942d5247ea8ad64b47e1caa9cc420826ace83e4f8c075db257090576772219aa9f48007a0c9d84793f127ec82604a310688717b18ece0ceec8824d66
+  data.tar.gz: c781c917e87029eec161ae656bb331552e6e0f531ceb8c6f3df8b836686f9f1bc7a4f277f81c15a9c515f2861624ed73f978a7be7b7db35d29a32c09aef277f5

data/.github/workflows/ci.yml

@@ -34,16 +34,27 @@ jobs:
           --health-timeout 5s
           --health-retries 5
       mysql:
-        image: mariadb:11.1
+        image: mysql:latest
         env:
-          MARIADB_ROOT_PASSWORD: root
+          MYSQL_ROOT_PASSWORD: rootroot
         ports:
         - 3306:3306
         options: >-
-          --health-cmd="healthcheck.sh --connect --innodb_initialized"
+          --health-cmd="mysqladmin ping"
           --health-interval 10s
           --health-timeout 5s
           --health-retries 3
+      # mariadb:
+      #   image: mariadb:11.1
+      #   env:
+      #     MARIADB_ROOT_PASSWORD: root
+      #   ports:
+      #   - 3306:3306
+      #   options: >-
+      #     --health-cmd="healthcheck.sh --connect --innodb_initialized"
+      #     --health-interval 10s
+      #     --health-timeout 5s
+      #     --health-retries 3
 
     env:
       SEQUEL: ${{ matrix.sequel }}
@@ -54,8 +65,10 @@ jobs:
       - name: Install db dependencies and check connections
         run: |
           DEBIAN_FRONTEND="noninteractive" sudo apt-get install -yqq mysql-client libmysqlclient-dev postgresql-client libpq-dev
-          mysql --host 127.0.0.1 --port ${{ job.services.mysql.ports[3306] }} -uroot -proot -e "SHOW GRANTS FOR 'root'@'localhost'"
+          mysql --host 127.0.0.1 --port ${{ job.services.mysql.ports[3306] }} -uroot -prootroot -e "SHOW GRANTS FOR 'root'@'localhost'"
           env PGPASSWORD=postgres psql -h localhost -p ${{ job.services.postgres.ports[5432] }} -U postgres -l
+          sqlite3 --version
+        # mysql --host 127.0.0.1 --port ${{ job.services.mariadb.ports[3306] }} -uroot -proot -e "SHOW GRANTS FOR 'root'@'localhost'"
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -65,7 +78,11 @@ jobs:
 
       - name: Create MySQL database
         run: |
-          mysql -e 'create database test; use test; create table if not exists wares(id int auto_increment, primary key(id)); create table if not exists builders(id int auto_increment, primary key(id));' --host 127.0.0.1 --port ${{ job.services.mysql.ports[3306] }} -uroot -proot
+          mysql -e 'create database test;' --host 127.0.0.1 --port ${{ job.services.mysql.ports[3306] }} -uroot -prootroot
+
+      # - name: Create MariaDB database
+      #   run: |
+      #     mysql -e 'create database test; use test; create table if not exists wares(id int auto_increment, primary key(id)); create table if not exists builders(id int auto_increment, primary key(id));' --host 127.0.0.1 --port ${{ job.services.mariadb.ports[3306] }} -uroot -proot
 
       - name: Create PostgreSQL database
         env:
@@ -73,19 +90,41 @@ jobs:
         run: |
           psql -c 'create database "test";' -U postgres -h localhost -p ${{ job.services.postgres.ports[5432] }}
 
-      - name: Run Tests
-        run: bundle exec rake test
+      - name: Create SQLite database
+        run: |
+          mkdir ./db && touch ./db/test.sqlite3 && sqlite3 ./db/test.sqlite3
+
+      # - name: Run MariaDB Tests
+      #   run: bundle exec rake TEST=test/sequel/mariadb_sequence_test.rb
+      #   env:
+      #     TEST_MARIA_DATABASE: test
+      #     TEST_MARIA_HOST: 127.0.0.1
+      #     TEST_MARIA_PORT: ${{ job.services.mariadb.ports[3306] }}
+      #     TEST_MARIA_USERNAME: root
+      #     TEST_MARIA_PASSWORD: root
+
+      - name: Run PostgreSQL Tests
+        run: bundle exec rake TEST=test/sequel/postgresql_sequence_test.rb
         env:
           TEST_POSTGRES_DATABASE: test
           TEST_POSTGRES_HOST: localhost
           TEST_POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
           TEST_POSTGRES_USERNAME: postgres
           TEST_POSTGRES_PASSWORD: postgres
+
+      - name: Run MySQL Tests
+        run: bundle exec rake TEST=test/sequel/mysql_sequence_test.rb
+        env:
           TEST_MYSQL_DATABASE: test
           TEST_MYSQL_HOST: 127.0.0.1
           TEST_MYSQL_PORT: ${{ job.services.mysql.ports[3306] }}
           TEST_MYSQL_USERNAME: root
-          TEST_MYSQL_PASSWORD: root
+          TEST_MYSQL_PASSWORD: rootroot
+
+      - name: Run SQLite Tests
+        run: bundle exec rake TEST=test/sequel/sqlite_sequence_test.rb
+        env:
+          TEST_SQLITE_DATABASE: "db/test.sqlite3"
 
       - name: Run Rubocop
         run: bundle exec rake rubocop

data/.gitignore

@@ -8,7 +8,10 @@ doc
 pkg
 tmp
 log
+db
 
 ## PROJECT::SPECIFIC
 .bundle
+.byebug_history
 Gemfile.lock
+*.gem

data/.rubocop.yml

@@ -35,3 +35,6 @@ Style/Documentation:
 Lint/ConstantDefinitionInBlock:
   Exclude:
     - test/**/*
+
+Metrics/ModuleLength:
+  Max: 150

data/CHANGELOG.md

@@ -11,6 +11,20 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.4.0 - 2023-09-26
+
+- [Fixed] Differences between MySQL and MariaDB.
+- [Added] Gem API support for MySQL databases.
+- [Changed] README.md, CONTRIBUTING.md and .gemspec description.
+- [Fixed] Some API support for SQLite databases.
+
+## v0.3.0 - 2023-09-21
+
+- [Added] A parametrized 'IF EXISTS' condition into the drop_sequence.
+- [Added] A parametrized 'IF NOT EXISTS' condition into the create_sequence.
+- [Added] Gem API support for SQLite databases.
+- [Fixed] Tests for the Mysql database.
+
 ## v0.2.0 - 2023-09-14
 
 - [Added] CI features based on GitHub Actions.

data/CONTRIBUTING.md

@@ -67,14 +67,21 @@ your contribution is according to how this project works.
 - This project uses [Rubocop](https://rubocop.org) to enforce code style. Before
   submitting your changes, make sure your tests are passing and code conforms to
   the expected style by running `rake`.
+```bash
+$ bundle exec rake rubocop
+```
 - Do not change the library version. This will be done by the maintainer
   whenever a new version is about to be released.
 
-### Ruby tests
+## Ruby tests
+
+Key points in preparing RDBMS and using tests.
+
+### Preparing a PostgreSQL database
 
 - Make sure you have a test PostgreSQL database:
 ```bash
-sudo psql -U USER_NAME -d test
+$ sudo psql -U USER_NAME -d test
 test=# \dt
           List of relations
  Schema |  Name   | Type  |   Owner   
@@ -84,28 +91,31 @@ test=# \dt
 ```
 and role `postgres`
 ```bash
-psql -d test -c 'SELECT rolname FROM pg_roles;'
+$ psql -d test -c 'SELECT rolname FROM pg_roles;'
           rolname          
 ---------------------------
  postgres
 ```
 - If none of them exist, create role
 ```bash
-psql -d postgres -c "create role postgres superuser createdb login password 'postgres';"
+$ psql -d postgres -c "create role postgres superuser createdb login password 'postgres';"
 ```
 and database with a couple of tables:
 
 ```bash
-sudo psql -U postgres -d postgres
+$ sudo psql -U postgres -d postgres
 postgres=# CREATE DATABASE test;
 postgres=# \c test
 test=# CREATE TABLE IF NOT EXISTS things ();
 test=# CREATE TABLE IF NOT EXISTS masters ();
 test=# \q
 ```
-- Make sure you have a test MySQL database:
+
+### Preparing a MariaDB database
+
+- Make sure you have a test MariaDB database:
 ```bash
-mysql
+$ mysql
 MariaDB [(none)]> show databases;
 MariaDB [(none)]> USE test;
 MariaDB [test]> SHOW TABLES;
@@ -123,8 +133,106 @@ MariaDB [(none)]> USE test;
 MariaDB [test]> CREATE TABLE IF NOT EXISTS wares(id int auto_increment, primary key(id));
 MariaDB [test]> CREATE TABLE IF NOT EXISTS builders(id int auto_increment, primary key(id));
 ```
-- Run the tests separately:
+
+### Preparing a MySQL database
+
+The optimal way to share Mysql and MariaDB on the same computer is to utilize docker containers.
+
+- Check the local availability of a Mysql container:
+```bash
+$ docker image ls
+REPOSITORY          TAG             IMAGE ID       CREATED         SIZE
+mysql               latest          3503aa5f0751   2 days ago      599MB
+```
+- If there is no distribution package download the docker container with Mysql to the local computer:
+```bash
+$ docker run -p 3360:3306 --name test_mysql  -e MYSQL_ROOT_PASSWORD=rootroot -d mysql:latest
+```
+- Show running containers:
+```bash
+$ docker container ls      
+CONTAINER ID   IMAGE          COMMAND                  CREATED          STATUS          PORTS                               NAMES
+a0d3476699f4   mysql:latest   "docker-entrypoint.s…"   17 minutes ago   Up 11 seconds   33060/tcp, 0.0.0.0:3360->3306/tcp   test_mysql
+```
+- Launch the MySQL container if it is still not running:
+```bash
+$ docker start test_mysql
+```
+
+To create a new database for tests, you could run the MySQL client in the terminal as follows:
+
+- Check the IP address of the running MySQL server:
+```bash
+$ docker inspect test_mysql
+...
+  "IPAddress": "172.17.0.2",
+...
+```
+- Run the MySQL client:
+```bash
+$ docker run -e MYSQL_ROOT_PASSWORD=rootroot -it mysql /bin/bash
+bash-4.4#
+```
+- Launch the MySQL shell:
+```bash
+bash-4.4# mysql -h 172.17.0.2 -u root  -p
+Enter password: 
+Welcome to the MySQL monitor.  Commands end with ; or \g.
+Your MySQL connection id is 8
+Server version: 8.1.0 MySQL Community Server - GPL
+
+Copyright (c) 2000, 2023, Oracle and/or its affiliates.
+
+Oracle is a registered trademark of Oracle Corporation and/or its
+affiliates. Other names may be trademarks of their respective
+owners.
+
+Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+
+mysql>
+```
+- Make sure that the test database is available:
+```bash
+mysql> show schemas;
++--------------------+
+| Database           |
++--------------------+
+| information_schema |
+| mysql              |
+| performance_schema |
+| sys                |
+| test               |
++--------------------+
+```
+- If the test danabase doesn't exists, create it:
+```bash
+mysql> CREATE DATABASE test;
+```
+- Create a couple of tables:
+```bash
+mysql> USE test;
+mysql> CREATE TABLE IF NOT EXISTS stuffs(id int auto_increment, primary key(id));
+mysql> CREATE TABLE IF NOT EXISTS creators(id int auto_increment, primary key(id));
+```
+
+### Preparing a SQLite database
+
+- Add a test SQLite database:
+```bash
+$ mkdir db && touch db/test.sqlite3
+```
+- Add a couple of tables in the SQLite database:
+```bash
+$ sqlite3 db/test.sqlite3
+sqlite> create table objects(id integer primary key autoincrement);
+sqlite> create table apprentices(id integer primary key autoincrement);
+```
+
+### Running tests:
+
 ```bash
-bundle exec rake TEST=test/sequel/postgresql_sequence_test.rb
-bundle exec rake TEST=test/sequel/mysql_sequence_test.rb
+$ bundle exec rake TEST=test/sequel/postgresql_sequence_test.rb
+$ bundle exec rake TEST=test/sequel/mariadb_sequence_test.rb
+$ bundle exec rake TEST=test/sequel/mysql_sequence_test.rb
+$ bundle exec rake TEST=test/sequel/sqlite_sequence_test.rb
 ```

data/README.md

@@ -3,8 +3,9 @@
 [![CI](https://github.com/oreol-group/sequel-sequence/actions/workflows/ci.yml/badge.svg)](https://github.com/oreol-group/sequel-sequence)
 [![Gem](https://img.shields.io/gem/v/sequel-sequence.svg)](https://rubygems.org/gems/sequel-sequence)
 [![Downloads total](https://img.shields.io/gem/dt/sequel-sequence.svg)](https://rubygems.org/profiles/it_architect)
+[![Code Climate](https://codeclimate.com/github/Oreol-Group/sequel-sequence.svg)](https://codeclimate.com/github/Oreol-Group/sequel-sequence)
 
-Adds a useful interface and support for PostgreSQL and MySQL `SEQUENCE` on Sequel migrations
+Adds a useful interface for PostgreSQL and MariaDB `SEQUENCE` on Sequel migrations. This Gem includes functionality to meet the needs of MySQL and SQLite users as well.
 
 ## Installation
 
@@ -18,10 +19,23 @@ Or add the following line to your project's Gemfile:
 gem "sequel-sequence"
 ```
 
-## Usage
+## Usage with PostgreSQL and MariaDB
 
-To create a `SEQUENCE`, just use the method `create_sequence`.
+To create and delete a `SEQUENCE`, simply use the `create_sequence` and `drop_sequence` methods.
 
+```ruby
+Sequel.migration do
+  up do
+    create_sequence :position, if_exists: false
+  end
+
+  down do
+    drop_sequence :position, if_exists: true
+  end
+end
+```
+
+It would also be correct to write:
 ```ruby
 Sequel.migration do
   up do
@@ -38,23 +52,26 @@ You can also specify the initial value and increment:
 
 ```ruby
 create_sequence :position, increment: 2
+create_sequence :position, step: 2
 create_sequence :position, start: 100
+create_sequence :position, if_exists: false
 ```
 
-To define a column that has a sequence as its default value, use something like
-the following:
+The `increment` and `step` parameters have the same meaning. By default their values are 1. The default value of `start` is 1 as well.
+
+To define a column that has a sequence as its default value, use something like the following:
 
 ```ruby
 Sequel.migration do
   change do
-    create_sequence :position_id
+    create_sequence :position_id, if_exists: false, start: 1000
 
     create_table(:things) do
       primary_key :id
       String :name, text: true
 
       # PostgreSQL uses bigint as the sequence's default type.
-      Bignum :position, null: false
+      Bignum :position
 
       Time :created_at, null: false
       Time :updated_at, null: false
@@ -82,6 +99,27 @@ DB.lastval("position")
 DB.setval("position", 1234)
 ```
 
+## Usage with SQLite and MySQL
+
+The sequence functionality for SQLite or MySQL databases is implemented by registering tables in the database with a primary key of `id` and an additional integer field `fiction`.
+```sql
+CREATE TABLE `name_of_your_sequence_table`
+(id integer primary key autoincrement, fiction integer);
+```
+
+You might utilize the last field as a numeric label to collect statistics on the operation of the end-to-end counter `"name_of_your_sequence_table".id` within the application. 
+```ruby
+create_sequence :position, if_exists: false, start: 1000, numeric_label: 1
+```
+and
+```ruby
+DB.nextval_with_label(:position, 1)
+```
+
+By default, `fiction` has a zero value.
+
+Otherwise, the operation of this gem for SQLite and MySQL is similar to the ways of using Sequence in more advanced RDBMS. There is only one difference here, you won't be able to change the increment value from 1 to another using the `increment` or `step` parameter.
+
 ## Maintainer
 
 - [Nikolai Bocharov](https://github.com/oreol-group)

data/Rakefile

@@ -7,7 +7,15 @@ require 'rubocop/rake_task'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/sequel/postgresql_sequence_test.rb',
+                          'test/sequel/mariadb_sequence_test.rb',
+                          'test/sequel/sqlite_sequence_test.rb']
+end
+
+Rake::TestTask.new(:mysql) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/sequel/mysql_sequence_test.rb']
 end
 
 RuboCop::RakeTask.new

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

@@ -2,6 +2,7 @@
 
 # https://sequel.jeremyevans.net/rdoc/files/doc/sql_rdoc.html
 # https://github.com/jeremyevans/sequel/blob/master/lib/sequel/database/connecting.rb
+# See information about  disable_insert_returning in https://github.com/jeremyevans/sequel/blob/master/doc/release_notes/4.9.0.txt
 module Sequel
   module Sequence
     module Database
@@ -35,9 +36,10 @@ module Sequel
 
         def create_sequence(name, options = {})
           increment = options[:increment] || options[:step]
+          if_exists = build_exists_condition(options[:if_exists])
           name = quote_name(name.to_s)
 
-          sql = ["CREATE SEQUENCE IF NOT EXISTS #{name}"]
+          sql = ["CREATE SEQUENCE #{if_exists} #{name}"]
           sql << "INCREMENT BY #{increment}" if increment
           sql << "START WITH #{options[:start]}" if options[:start]
           sql << ';'
@@ -48,7 +50,7 @@ module Sequel
 
         def drop_sequence(name)
           name = quote_name(name.to_s)
-          sql = "DROP SEQUENCE #{name}"
+          sql = "DROP SEQUENCE IF EXISTS #{name}"
           run(sql)
         end
 
@@ -61,7 +63,7 @@ module Sequel
           out
         end
 
-        # for db.database_type = :postgres
+        # for Postgres
         def currval(name)
           name = quote(name.to_s)
           out = nil
@@ -71,7 +73,7 @@ module Sequel
           out
         end
 
-        # for db.database_type = :mysql2
+        # for MariaDB
         alias lastval currval
 
         def setval(name, value)

data/lib/sequel/sequence/database/server/mariadb.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Mariadb
+  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]
+    if_exists = build_exists_condition(options[:if_exists])
+    name = quote_name(name.to_s)
+
+    sql = ["CREATE SEQUENCE #{if_exists || Sequel::Database::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 IF EXISTS #{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
+
+  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
+
+  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