db-migrate-x 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8946c58a0fbd70adc0f1c92b27dcfc001ede4438379d1c90731c061c34ad79d
+  data.tar.gz: 804e612a9163f3692b2265b881b806800dbe13eeb2cb3ce6c1c36e0dbab36d09
+SHA512:
+  metadata.gz: c62649721fe87d70e29554f15f147bcba2a168b951d28834f340ba42363d7c6984d6b0b4fe0e16c5bbd879d0f3eb2ddeef63e9f91feee77611eadffe9702cc3c
+  data.tar.gz: ba5da48eaf8bf907a8e71f3264d71f8372426b67938ab28631185a02314f72d3b64cb57fd11063c27e7d59c10d9a25e925e4d261bfd6fd66f3d861ac32d94ca0

data/lib/db/migrate/create_index.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require_relative "drop_index"
+
+module DB
+	module Migrate
+		class CreateIndex
+			def initialize(name, table, columns = [], unique: false, drop_if_exists: false, if_not_exists: false, method: nil)
+				@name = name
+				@table = table
+				@columns = Array(columns)
+				
+				@unique = unique
+				@drop_if_exists = drop_if_exists
+				@if_not_exists = if_not_exists
+				@method = method
+			end
+			
+			def call(session)
+				if @drop_if_exists
+					DropIndex.new(@name, if_exists: true).call(session)
+				end
+				
+				if @unique
+					statement = session.clause("CREATE UNIQUE INDEX")
+				else
+					statement = session.clause("CREATE INDEX")
+				end
+				
+				if @if_not_exists
+					statement.clause("IF NOT EXISTS")
+				end
+				
+				statement.identifier(@name)
+				
+				statement.clause("ON")
+				statement.identifier(@table)
+				
+				if @method
+					statement.clause("USING")
+					statement.identifier(@method)
+				end
+				
+				statement.clause("(")
+				first = true
+				indexes = []
+				
+				@columns.each do |name|
+					if first
+						first = false
+					else
+						statement.clause(",")
+					end
+					
+					statement.identifier(name)
+				end
+				
+				statement.clause(")")
+				
+				Console.logger.info(self, statement)
+				statement.call
+			end
+		end
+	end
+end

data/lib/db/migrate/create_table.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require_relative "create_index"
+require_relative "drop_table"
+
+module DB
+	module Migrate
+		class CreateTable
+			def initialize(name, drop_if_exists: false, if_not_exists: false)
+				@name = name
+				@columns = []
+				@indexes = []
+				
+				@drop_if_exists = drop_if_exists
+				@if_not_exists = if_not_exists
+			end
+			
+			def drop_if_exists!
+				@drop_if_exists = true
+			end
+			
+			def if_not_exists!
+				@if_not_exists = true
+			end
+			
+			def primary_key(name = :id, **options)
+				options[:primary] = true
+				
+				@columns << [name, :key_column, options]
+			end
+			
+			def foreign_key(name, index: true, **options)
+				options[:primary] = false
+				
+				@columns << [name, :key_column, options]
+				
+				if index
+					@indexes << name
+				end
+			end
+			
+			def column(name, type, index: false, **options)
+				@columns << [name, type, options]
+				
+				if index
+					@indexes << name
+				end
+			end
+			
+			def timestamps
+				self.column :created_at, "TIMESTAMP"
+				self.column :updated_at, "TIMESTAMP"
+			end
+			
+			def call(session)
+				if @drop_if_exists
+					DropTable.new(@name, if_exists: true).call(session)
+				end
+				
+				statement = session.clause("CREATE TABLE")
+				
+				if @if_not_exists
+					statement.clause("IF NOT EXISTS")
+				end
+				
+				statement.identifier(@name)
+				
+				statement.clause("(")
+				first = true
+				
+				@columns.each do |name, type, options|
+					if first
+						first = false
+					else
+						statement.clause(",")
+					end
+						
+					if type == :key_column
+						statement.clause(session.connection.key_column(name, **options))
+					else
+						statement.identifier(name)
+						statement.clause(type)
+						
+						if !options[:null]
+							statement.clause("NOT NULL")
+						end
+						
+						if options.key?(:default)
+							statement.clause("DEFAULT").literal(options[:default])
+						end
+						
+						if unique = options[:unique]
+							statement.clause("UNIQUE")
+						end
+					end
+				end
+				
+				statement.clause(")")
+				
+				Console.logger.info(self, statement)
+				statement.call
+				
+				@indexes.each do |column|
+					name = "index_#{@name}_on_#{column}"
+					CreateIndex.new(name, @name, column, if_not_exists: @if_not_exists).call(session)
+				end
+			end
+		end
+	end
+end

data/lib/db/migrate/drop_index.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+module DB
+	module Migrate
+		class DropIndex
+			def initialize(name, if_exists: false)
+				@name = name
+				@if_exists = if_exists
+			end
+			
+			def if_exists!
+				@if_exists = true
+			end
+			
+			def call(session)
+				statement = session.clause("DROP INDEX")
+				
+				if @if_exists
+					statement.clause("IF EXISTS")
+				end
+				
+				statement.identifier(@name)
+				
+				Console.logger.info(self, statement)
+				statement.call
+			end
+		end
+	end
+end

data/lib/db/migrate/drop_table.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require_relative "create_index"
+
+module DB
+	module Migrate
+		class DropTable
+			def initialize(name, if_exists: false)
+				@name = name
+				@if_exists = if_exists
+			end
+			
+			def if_exists!
+				@if_exists = true
+			end
+			
+			def call(session)
+				statement = session.clause("DROP TABLE")
+				
+				if @if_exists
+					statement.clause("IF EXISTS")
+				end
+				
+				statement.identifier(@name)
+				
+				Console.logger.info(self, statement)
+				statement.call
+			end
+		end
+	end
+end

data/lib/db/migrate/information_schema.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+module DB
+	module Migrate
+		class InformationSchema
+			def initialize(session)
+				@session = session
+			end
+			
+			TABLES = DB::Identifier[:information_schema, :tables]
+			
+			def table_exist?(name)
+				statement = @session.clause("SELECT * FROM")
+				statement.identifier(TABLES)
+				statement.clause("WHERE")
+				statement.identifier(:table_name)
+				statement.clause("=")
+				statement.literal(name)
+				
+				return statement.call.to_a.any?
+			end
+		end
+	end
+end

data/lib/db/migrate/migration.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require "async"
+
+require_relative "create_table"
+require_relative "rename_table"
+require_relative "create_index"
+
+module DB
+	module Migrate
+		class Migration
+			def initialize(name, session)
+				@name = name
+				@session = session
+			end
+			
+			def call(&block)
+				create_table?(:migration) do
+					primary_key
+					column :name, "TEXT NOT NULL", unique: true, index: true
+					timestamps
+				end
+				
+				self.instance_eval(&block)
+			end
+			
+			def information_schema
+				@information_schema ||= InformationSchema.new(@session)
+			end
+			
+			def create_table(name, **options, &block)
+				create_table = CreateTable.new(name, **options)
+				create_table.instance_eval(&block)
+				create_table.call(@session)
+			end
+			
+			def create_table?(name, **options, &block)
+				options[:if_not_exists] = true
+				
+				create_table = CreateTable.new(name, **options)
+				create_table.instance_eval(&block)
+				create_table.call(@session)
+			end
+			
+			def rename_table(name, new_name)
+				rename_table = RenameTable.new(name, new_name)
+				rename_table.call(@session)
+			end
+			
+			def create_index(...)
+				create_index = CreateIndex.new(...)
+				create_index.call(@session)
+			end
+			
+			def drop_table(name, if_exists: false)
+				drop_table = DropTable.new(name, if_exists: if_exists)
+				drop_table.call(@session)
+			end
+		end
+		
+		def self.migrate(name, client, &block)
+			Sync do
+				client.transaction do |session|
+					Migration.new(name, session).call(&block)
+				end
+			end
+		end
+	end
+end

data/lib/db/migrate/rename_table.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require_relative "drop_index"
+
+module DB
+	module Migrate
+		class RenameTable
+			def initialize(name, new_name)
+				@name = name
+				@new_name = new_name
+			end
+			
+			def call(session)
+				statement = session.clause("ALTER TABLE")
+				statement.identifier(@name)
+				statement.clause("RENAME TO")
+				statement.identifier(@new_name)
+				
+				Console.logger.info(self, statement)
+				statement.call
+			end
+		end
+	end
+end

data/lib/db/migrate/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+module DB
+	module Migrate
+		VERSION = "0.2.0"
+	end
+end

data/lib/db/migrate.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require_relative "migrate/version"
+require_relative "migrate/migration"
+require_relative "migrate/information_schema"

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2021-2024, by Samuel Williams.  
+
+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,27 @@
+# DB::Migrate
+
+Provides convenient abstractions for creating tables, indexes and general database migrations.
+
+[![Development Status](https://github.com/socketry/db-migrate/workflows/Test/badge.svg)](https://github.com/socketry/db-migrate/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/db-migrate).
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: db-migrate-x
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: migrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/db/migrate.rb
+- lib/db/migrate/create_index.rb
+- lib/db/migrate/create_table.rb
+- lib/db/migrate/drop_index.rb
+- lib/db/migrate/drop_table.rb
+- lib/db/migrate/information_schema.rb
+- lib/db/migrate/migration.rb
+- lib/db/migrate/rename_table.rb
+- lib/db/migrate/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/db-migrate
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/db-migrate/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/db-migrate.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Database migrations.
+test_files: []