sequel-sequence 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle
+
+## MAC OS
+.DS_Store
+
+## PROJECT::GENERAL
+coverage
+doc
+pkg
+tmp
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+<!--
+Prefix your message with one of the following:
+
+- [Added] for new features.
+- [Changed] for changes in existing functionality.
+- [Deprecated] for soon-to-be removed features.
+- [Removed] for now removed features.
+- [Fixed] for any bug fixes.
+- [Security] in case of vulnerabilities.
+-->
+
+## v0.1.0 - 2023-09-10
+
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+it.architect@yahoo.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing to sequel-sequence
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+The following is a set of guidelines for contributing to this project. These are
+mostly guidelines, not rules. Use your best judgment, and feel free to propose
+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).
+
+## Reporting bugs
+
+This section guides you through submitting a bug report. Following these
+guidelines helps maintainers and the community understand your report, reproduce
+the behavior, and find related reports.
+
+- Before creating bug reports, please check the open issues; somebody may
+  already have submitted something similar, and you may not need to create a new
+  one.
+- When you are creating a bug report, please include as many details as
+  possible, with an example reproducing the issue.
+
+## 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).
+
+When you're ready to make your pull request, follow checklist below to make sure
+your contribution is according to how this project works.
+
+1. [Fork](https://help.github.com/forking/) sequel-sequence
+2. Create a topic branch - `git checkout -b my_branch`
+3. Make your changes using [descriptive commit messages](#commit-messages)
+4. Update CHANGELOG.md describing your changes by adding an entry to the
+   "Unreleased" section. If this section is not available, create one right
+   before the last version.
+5. Push to your branch - `git push origin my_branch`
+6. [Create a pull request](https://docs.github.com/articles/creating-a-pull-request)
+7. That's it!
+
+## Styleguides
+
+### Commit messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+### Changelog
+
+- Add a message describing your changes to the "Unreleased" section. The
+  changelog message should follow the same style as the commit message.
+- Prefix your message with one of the following:
+  - `[Added]` for new features.
+  - `[Changed]` for changes in existing functionality.
+  - `[Deprecated]` for soon-to-be removed features.
+  - `[Removed]` for now removed features.
+  - `[Fixed]` for any bug fixes.
+  - `[Security]` in case of vulnerabilities.
+
+### Ruby code
+
+- 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`.
+- Do not change the library version. This will be done by the maintainer
+  whenever a new version is about to be released.
+
+### Ruby tests
+
+- Make sure you have a test PostgreSQL database:
+```bash
+sudo psql -U USER_NAME -d test
+test=# \dt
+          List of relations
+ Schema |  Name   | Type  |   Owner   
+--------+---------+-------+-----------
+ public | masters | table | USER_NAME
+ public | things  | table | USER_NAME
+(2 rows)
+```
+- If it doesn't exists, create one with a couple of tables:
+```bash
+sudo psql -U USER_NAME -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:
+```bash
+mysql
+MariaDB [(none)]> show databases;
+MariaDB [(none)]> USE test;
+MariaDB [test]> SHOW TABLES;
++----------------------+
+| Tables_in_test       |
++----------------------+
+| builders             |
+| wares                |
++----------------------+
+4 rows in set (0.001 sec)
+```
+- If it doesn't exists, create one with a couple of tables:
+```bash
+MariaDB [(none)]> CREATE DATABASE test;
+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:
+```bash
+bundle exec rake TEST=test/ar/postgresql_sequence_test.rb
+bundle exec rake TEST=test/ar/mysql_sequence_test.rb
+```

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2023 Nikolai Bocharov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# sequel-sequence
+
+[![Tests](https://github.com/oreol-group/sequel-sequence/workflows/Tests/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)
+
+Adds a useful interface and support for PostgreSQL and MySQL `SEQUENCE` on Sequel migrations
+
+## Installation
+
+```bash
+gem install sequel-sequence
+```
+
+Or add the following line to your project's Gemfile:
+
+```ruby
+gem "sequel-sequence"
+```
+
+## Usage
+
+To create a `SEQUENCE`, just use the method `create_sequence`.
+
+```ruby
+Sequel.migration do
+  up do
+    create_sequence :position
+  end
+
+  down do
+    drop_sequence :position
+  end
+end
+```
+
+You can also specify the initial value and increment:
+
+```ruby
+create_sequence :position, increment: 2
+create_sequence :position, start: 100
+```
+
+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_table(:things) do
+      primary_key :id
+      String :name, text: true
+
+      # PostgreSQL uses bigint as the sequence's default type.
+      Bignum :position, null: false
+
+      Time :created_at, null: false
+      Time :updated_at, null: false
+    end
+
+    set_column_default_nextval :things, :position, :position_id
+  end
+end
+```
+
+This gem also adds a few helpers to interact with `SEQUENCE`s.
+
+```ruby
+DB = Sequel.connect('...')
+# Advance sequence and return new value
+DB.nextval("position")
+
+# Return value most recently obtained with nextval for specified sequence, either
+DB.currval("position")
+# or
+DB.lastval("position")
+# Both options are acceptable in PostgreSQL and MySQL.
+
+# Set sequence's current value. It must be greater than lastval or currval.
+DB.setval("position", 1234)
+```
+
+## Maintainer
+
+- [Nikolai Bocharov](https://github.com/oreol-group)
+
+## Contributors
+
+- https://github.com/oreol-group/sequel-sequence/contributors
+
+## Contributing
+
+For more details about how to contribute, please read
+https://github.com/oreol-group/sequel-sequence/blob/main/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.
+
+## 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).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/sequel/error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sequel
+  class MethodNotAllowed < StandardError
+    METHOD_NOT_ALLOWED = 'Method not allowed'
+
+    # Initialize a new Error object
+    def initialize(message = '')
+      super(message)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,80 @@
+# 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

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

@@ -0,0 +1,96 @@
+# 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 PostgreSQL
+        SEQUENCE_COMMENT = 'created by sequel-sequence'
+
+        def quote_column_name(name)
+          PG::Connection.quote_ident(name).freeze
+        end
+
+        def quote_sequence_name(name)
+          PG::Connection.quote_connstr(name).freeze
+        end
+
+        def custom_sequence?(sequence_name)
+          out = ''
+          begin
+            fetch("SELECT obj_description('#{sequence_name}'::regclass, 'pg_class');") do |row|
+              out = row[:obj_description]
+            end
+          rescue Sequel::DatabaseError # PG::UndefinedTable
+            return false
+          end
+
+          out == SEQUENCE_COMMENT
+        end
+
+        def check_sequences
+          fetch('SELECT * FROM information_schema.sequences ORDER BY sequence_name').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 << ';'
+          sql << "COMMENT ON SEQUENCE #{name} IS '#{SEQUENCE_COMMENT}';"
+
+          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]
+          end
+          out
+        end
+
+        # for db.database_type = :postgres
+        def currval(name)
+          name = quote(name.to_s)
+          out = nil
+          fetch("SELECT currval(#{name})") do |row|
+            out = row[:currval]
+          end
+          out
+        end
+
+        # for db.database_type = :mysql2
+        alias lastval currval
+
+        def setval(name, value)
+          name = quote(name.to_s)
+          out = nil
+          fetch("SELECT setval(#{name}, #{value})") do |row|
+            out = row[:setval]
+          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}::regclass)"
+        end
+      end
+    end
+  end
+end

data/lib/sequel/sequence/database.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sequel
+  module Sequence
+    module Database
+      # def custom_sequence?(_sequence_name)
+      #   false
+      # end
+
+      def check_sequences
+        []
+      end
+
+      def create_sequence(_name, _options = {})
+        raise Sequel::MethodNotAllowed, Sequel::MethodNotAllowed::METHOD_NOT_ALLOWED
+      end
+
+      def drop_sequence(_name)
+        raise Sequel::MethodNotAllowed, Sequel::MethodNotAllowed::METHOD_NOT_ALLOWED
+      end
+
+      def quote_name(name)
+        name.to_s.split('.', 2).map { |part| quote_column_name(part) }.join('.')
+      end
+
+      def quote(name)
+        name.to_s.split('.', 2).map { |part| quote_sequence_name(part) }.join('.')
+      end
+
+      def nextval(_name)
+        raise Sequel::MethodNotAllowed, Sequel::MethodNotAllowed::METHOD_NOT_ALLOWED
+      end
+
+      # for connection.adapter_name = "PostgreSQL"
+      def currval(_name)
+        raise Sequel::MethodNotAllowed, Sequel::MethodNotAllowed::METHOD_NOT_ALLOWED
+      end
+
+      # for connection.adapter_name = "Mysql2"
+      alias lastval currval
+
+      def setval(_name, _value)
+        raise AR::MethodNotAllowed, AR::MethodNotAllowed::METHOD_NOT_ALLOWED
+      end
+    end
+  end
+end