sequel-sequence 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10902f0e1d1afb59a3461ea44138203c9ddf3f0455b49ffe811c7b23aadc8ede
-  data.tar.gz: 6e928d7c8827d2cc67c32d4fe28156490b99b187cbf6cbc19f546c2706e55087
+  metadata.gz: c7012e03aa326861bef294edcf042850f662f9122664da409aa0dd764d9375d9
+  data.tar.gz: b309b36a931be17ee7cb628c21083ef8543bb60139a249aa9fd1d42378321297
 SHA512:
-  metadata.gz: 545bb293f276fd0f92441941fa9efc7dc432fd1b1a5131bb10a7465aba833db72f2ca2e29abc3f6cc427b958df3bc47354abf1d9d420efa77d1d610de85e2166
-  data.tar.gz: 20273fe64a4e90fd2f8345ea8b08d96819bb4c52ff26684b2e67d49674c0360fc0926a66c565041b6a16f8e49d348133cca80cc629c4c14614a1116eb3e6dc60
+  metadata.gz: 7c13a9a6e000990aaee2bdcca4d3d7519a7164c3217d4164f35e40e43deb76f652215169396647568cb03cf111d2a103f2f0f5d5f45e174b8107588e4be1808f
+  data.tar.gz: e9483ab69ea26d780164a4e4683d75c2bd86d8c5d92983b506645c5544a3ebc277f25f12a463b1f959f675f0e780eaf3b22a82b9560e247f16f2a895518d0e53

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: 'Bug: '
+labels: 'Status: Unconfirmed'
+
+---
+
+<!--
+  - Please provide a clear and concise description of what the bug is.
+  - If possible, add an example reproducing your issue.
+  - Please test using the latest version of ar-sequence
+    to make sure your issue has not already been fixed.
+-->
+
+## Description
+
+[Add bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Software:
+
+- Gem version: [Add gem version here]
+- Ruby version: [Add version here]
+
+## Full backtrace
+
+```text
+[Paste full backtrace here]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "💡 Feature request"
+about: Have an idea that may be useful? Make a suggestion!
+title: 'Feature Request: '
+labels: 'Feature request'
+
+---
+
+## Description
+
+_A clear and concise description of what the problem is._
+
+## Describe the solution
+
+_A clear and concise description of what you want to happen._
+
+## Alternatives you considered
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+## Additional context
+
+_Add any other context, screenshots, links, etc about the feature request here._

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+If you're making a doc PR or something tiny where the below is irrelevant,
+delete this template and use a short description, but in your description aim to
+include both what the change is, and why it is being made, with enough context
+for anyone to understand.
+-->
+
+<details>
+  <summary>PR Checklist</summary>
+
+### PR Structure
+
+- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
+      PRs).
+- [ ] This PR avoids mixing refactoring changes with feature changes (split into
+      two PRs otherwise).
+- [ ] This PR's title starts is concise and descriptive.
+
+### Thoroughness
+
+- [ ] This PR adds tests for the most critical parts of the new functionality or
+      fixes.
+- [ ] I've updated any docs, `.md` files, etc… affected by this change.
+
+</details>
+
+### What
+
+[TODO: Short statement about what is changing.]
+
+### Why
+
+[TODO: Why this change is being made. Include any context required to understand
+the why.]
+
+### Known limitations
+
+[TODO or N/A]

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# Documentation:
+# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/ci.yml

@@ -0,0 +1,97 @@
+name: CI
+
+on:
+  workflow_dispatch:
+    inputs: {}
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-latest']
+        sequel: ['~>5.28']
+        ruby: ['3.2', '3.1', '3.0', '2.7']
+        gemfile: ['Gemfile']
+    runs-on: ${{ matrix.os }}
+    name: Tests with Ruby ${{ matrix.ruby }}
+
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+        - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      mysql:
+        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 }}
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - 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'"
+          env PGPASSWORD=postgres psql -h localhost -p ${{ job.services.postgres.ports[5432] }} -U postgres -l
+          sqlite3 --version
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - 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
+
+      - name: Create PostgreSQL database
+        env:
+          PGPASSWORD: postgres
+        run: |
+          psql -c 'create database "test";' -U postgres -h localhost -p ${{ job.services.postgres.ports[5432] }}
+
+      - name: Create SQLite database
+        run: |
+          mkdir ./db && touch ./db/test.sqlite3 && sqlite3 ./db/test.sqlite3
+
+      - name: Run Tests
+        run: bundle exec rake test
+        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
+          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_SQLITE_DATABASE: "db/test.sqlite3"
+
+      - name: Run Rubocop
+        run: bundle exec rake rubocop

data/.gitignore

@@ -1,11 +1,17 @@
-.bundle
-
 ## MAC OS
 .DS_Store
 
 ## PROJECT::GENERAL
 coverage
+rdoc
 doc
 pkg
 tmp
+log
+db
+
+## PROJECT::SPECIFIC
+.bundle
+.byebug_history
 Gemfile.lock
+*.gem

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions:
+    rubocop-rake: false
+
+Naming/FileName:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Style/Documentation:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - test/**/*

data/CHANGELOG.md

@@ -11,6 +11,20 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## 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.
+- [Fixed] README.md
+- [Changed] Unit tests.
+- [Fixed] Sequel::Sequence::Database exceptions.
+
 ## v0.1.0 - 2023-09-10
 
 - Initial release.

data/CONTRIBUTING.md

@@ -9,7 +9,7 @@ changes to this document in a pull request.
 ## Code of Conduct
 
 Everyone interacting in this project's codebases, issue trackers, chat rooms and
-mailing lists is expected to follow the [code of conduct](https://github.com/fnando/sequel-sequence/blob/main/CODE_OF_CONDUCT.md).
+mailing lists is expected to follow the [code of conduct](https://github.com/oreol-group/sequel-sequence/blob/master/CODE_OF_CONDUCT.md).
 
 ## Reporting bugs
 
@@ -26,7 +26,7 @@ the behavior, and find related reports.
 ## Contributing with code
 
 Before making any radicals changes, please make sure you discuss your intention
-by [opening an issue on Github](https://github.com/fnando/sequel-sequence/issues).
+by [opening an issue on Github](https://github.com/oreol-group/sequel-sequence/issues).
 
 When you're ready to make your pull request, follow checklist below to make sure
 your contribution is according to how this project works.
@@ -81,11 +81,22 @@ test=# \dt
 --------+---------+-------+-----------
  public | masters | table | USER_NAME
  public | things  | table | USER_NAME
-(2 rows)
 ```
-- If it doesn't exists, create one with a couple of tables:
+and role `postgres`
+```bash
+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';"
+```
+and database with a couple of tables:
+
 ```bash
-sudo psql -U USER_NAME -d postgres
+sudo psql -U postgres -d postgres
 postgres=# CREATE DATABASE test;
 postgres=# \c test
 test=# CREATE TABLE IF NOT EXISTS things ();
@@ -104,7 +115,6 @@ MariaDB [test]> SHOW TABLES;
 | builders             |
 | wares                |
 +----------------------+
-4 rows in set (0.001 sec)
 ```
 - If it doesn't exists, create one with a couple of tables:
 ```bash
@@ -113,8 +123,19 @@ 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));
 ```
+- 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);
+```
 - Run the tests separately:
 ```bash
-bundle exec rake TEST=test/ar/postgresql_sequence_test.rb
-bundle exec rake TEST=test/ar/mysql_sequence_test.rb
+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/sqlite_sequence_test.rb
 ```

data/README.md

@@ -1,10 +1,11 @@
 # sequel-sequence
 
-[![Tests](https://github.com/oreol-group/sequel-sequence/workflows/Tests/badge.svg)](https://github.com/oreol-group/sequel-sequence)
+[![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/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 and support for PostgreSQL and MySQL `SEQUENCE` on Sequel migrations. Gem includes functionality to cover the needs of SQLite users as well.
 
 ## Installation
 
@@ -18,14 +19,14 @@ 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`.
 
 ```ruby
 Sequel.migration do
   up do
-    create_sequence :position
+    create_sequence :position, if_exists: false
   end
 
   down do
@@ -39,22 +40,22 @@ You can also specify the initial value and increment:
 ```ruby
 create_sequence :position, increment: 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:
+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: 1
 
     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 +83,24 @@ DB.lastval("position")
 DB.setval("position", 1234)
 ```
 
+## Usage with SQLite
+
+In SQLite, the sequence functionality 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 one 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
+DB.nextval_with_label("position", 1)
+```
+
+By default, `fiction` has a zero value.
+
+Otherwise, the operation of this gem for SQLite is identical to the ways of using Sequence in more advanced databases.
+
 ## Maintainer
 
 - [Nikolai Bocharov](https://github.com/oreol-group)
@@ -93,16 +112,16 @@ DB.setval("position", 1234)
 ## Contributing
 
 For more details about how to contribute, please read
-https://github.com/oreol-group/sequel-sequence/blob/main/CONTRIBUTING.md.
+https://github.com/oreol-group/sequel-sequence/blob/master/CONTRIBUTING.md.
 
 ## License
 
 The gem is available as open source under the terms of the
 [MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
-found at https://github.com/oreol-group/sequel-sequence/blob/main/LICENSE.md.
+found at https://github.com/oreol-group/sequel-sequence/blob/master/LICENSE.md.
 
 ## Code of Conduct
 
 Everyone interacting in the sequel-sequence project's codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the
-[code of conduct](https://github.com/oreol-group/sequel-sequence/blob/main/CODE_OF_CONDUCT.md).
+[code of conduct](https://github.com/oreol-group/sequel-sequence/blob/master/CODE_OF_CONDUCT.md).

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

@@ -20,9 +20,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 << ';'
@@ -32,7 +33,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
 

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

@@ -35,9 +35,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 +49,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
 

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

@@ -0,0 +1,132 @@
+# 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 SQLite
+        def check_sequences
+          fetch('SELECT * FROM `sqlite_sequence`;').all.to_a
+        end
+
+        def create_sequence(name, options = {})
+          check_options(options)
+          if_exists = build_exists_condition(options[:if_exists])
+          start_option = options[:start] || 1
+          sql = [create_sequence_table(stringify(name), if_exists)]
+          sql << insert_into_sqlite_sequence(stringify(name), start_option)
+          run(sql.join("\n"))
+        end
+
+        def drop_sequence(name, options = {})
+          if_exists = build_exists_condition(options[:if_exists])
+          run(drop_sequence_table(stringify(name), if_exists))
+        end
+
+        def nextval(name)
+          run(insert_into_sequence_table(stringify(name), 0))
+          take_seq(name)
+        end
+
+        def nextval_with_label(name, num_label = 0)
+          run(insert_into_sequence_table(stringify(name), num_label))
+          take_seq(name)
+        end
+
+        def lastval(name)
+          take_seq(stringify(name))
+        end
+
+        alias currval lastval
+
+        def setval(name, value)
+          current = lastval(stringify(name))
+          if current.nil?
+            create_sequence(stringify(name), { start: value })
+          elsif value < current
+            # sql = [delete_from_sqlite_sequence(name)]
+            # sql << drop_sequence_table(name)
+            # sql << insert_into_sqlite_sequence(name, value)
+            # run(sql.join("\n"))
+            log_info DANGER_OPT_ID
+            value = current
+          else
+            run(insert_into_sqlite_sequence(stringify(name), value))
+          end
+          value
+        end
+
+        def set_column_default_nextval(table, column, sequence)
+          run(create_sequenced_column(stringify(table),
+                                      stringify(column),
+                                      stringify(sequence)))
+        end
+
+        private
+
+        def stringify(name)
+          @name ||= {}
+          @name.fetch(name, nil) || (@name[name] = name.to_s)
+        end
+
+        def take_seq(name)
+          out = nil
+          fetch(select_max_seq(name)) do |row|
+            out = row[:id]
+          end
+          out
+        end
+
+        def create_sequence_table(name, if_exists = nil)
+          %(
+            CREATE TABLE #{if_exists || IF_NOT_EXISTS} #{name}
+            (id integer primary key autoincrement, fiction integer);
+          )
+        end
+
+        def insert_into_sequence_table(name, num_label)
+          "INSERT INTO #{name} (fiction) VALUES (#{num_label});"
+        end
+
+        def insert_into_sqlite_sequence(name, value)
+          current = take_seq(name)
+          if current.nil?
+            "INSERT INTO sqlite_sequence (name, seq) VALUES ('#{name}', #{value});"
+          else
+            %(
+              UPDATE sqlite_sequence
+              SET seq = #{[current, value].max}
+              WHERE name = '#{name}';
+            )
+          end
+        end
+
+        def delete_from_sqlite_sequence(name)
+          "DELETE FROM sqlite_sequence WHERE name = '#{name}';"
+        end
+
+        def drop_sequence_table(name, if_exists = nil)
+          "DROP TABLE #{if_exists || IF_EXISTS} #{name};"
+        end
+
+        def select_max_seq(name)
+          "SELECT MAX(seq) AS id FROM sqlite_sequence WHERE name = '#{name}';"
+        end
+
+        def create_sequenced_column(table, column, sequence)
+          %(
+            CREATE TRIGGER IF NOT EXISTS #{table}_#{sequence} AFTER INSERT
+            ON #{table}
+            BEGIN
+              INSERT INTO #{sequence}(fiction) VALUES (0);
+              UPDATE #{table}
+              SET #{column} = (SELECT MAX(seq) FROM sqlite_sequence WHERE name = '#{sequence}')
+              WHERE rowid = NEW.rowid;
+            END;
+          )
+        end
+      end
+    end
+  end
+end