dynamic_migrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0a6f800da284a67951749b309cfd74aff4a769ce0c60bfc6798b07dd0108f5d
+  data.tar.gz: 5e07832f150f6362aaf982bcd701739747347d48d5d63176bd7c4f00e43b38a2
+SHA512:
+  metadata.gz: 192e7713b23050b8087218e741dc5204141bdee1783015c2d100a4a8935584ba365fb9e34200c359128763ed619f93fa4289ba01f7f33c79c463745fef64f70a
+  data.tar.gz: 4c02f5f6ec71c1d0795ad0f57d899a8bdd311809055e390959e80d9fc75ee98adf59ea5bcb7c44a60b460367ed9bb1a2f2642d1e70fc4d3d6a3ed30e05d7e929

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 1.0.0 (2023-07-05)
+
+
+### Features
+
+* added table and column comments and column metadata ([84d798a](https://github.com/craigulliott/dynamic_migrations/commit/84d798aae35c259545f73dbbd7d076d8ceaa8739))
+* basic representation of schema either configured or loaded from a real database ([7fc9ebb](https://github.com/craigulliott/dynamic_migrations/commit/7fc9ebbe5a8e5faa4e6017deec9bc66f7ba15f16))
+* recursively load and builds a representation of current database schema, and find differences between configured and loaded representations of the database structure ([978e122](https://github.com/craigulliott/dynamic_migrations/commit/978e12279760709f1511dc7c6d9fe7ff57b54f3e))
+* renaming the current version of constraints to validations, because its a more descriptive name, especially when considering we are going to expose multiple types of postgres constraint ([2f17af6](https://github.com/craigulliott/dynamic_migrations/commit/2f17af665028ed6f49d8bdd9b7ff6a52339206db))
+* support for table constraints and added caches for database structure and constraints ([f68bbb2](https://github.com/craigulliott/dynamic_migrations/commit/f68bbb20a25fab149ed4b3b9c591fde1a6ff628e))
+* table keys and indexes and a more robust database configured/loaded comparison class ([b4a0925](https://github.com/craigulliott/dynamic_migrations/commit/b4a092535e4e59d0fb9b97efc3d210289346b454))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 craigulliott@gmail.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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Craig Ulliott
+
+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,71 @@
+# DynamicMigrations
+
+Monitor and generate database migrations based on difference between current schema and configuration.
+
+[![Gem Version](https://badge.fury.io/rb/dynamic_migrations.svg)](https://badge.fury.io/rb/dynamic_migrations)
+[![Specs](https://github.com/craigulliott/dynamic_migrations/actions/workflows/specs.yml/badge.svg)](https://github.com/craigulliott/dynamic_migrations/actions/workflows/specs.yml)
+[![Types](https://github.com/craigulliott/dynamic_migrations/actions/workflows/types.yml/badge.svg)](https://github.com/craigulliott/dynamic_migrations/actions/workflows/types.yml)
+[![Coding Style](https://github.com/craigulliott/dynamic_migrations/actions/workflows/linter.yml/badge.svg)](https://github.com/craigulliott/dynamic_migrations/actions/workflows/linter.yml)
+
+## Key Features
+
+* Supports complex validations via constraints
+* Supports stored procedures
+* Supports complex indexes and multi column foreign keys
+* Supports postgis types
+* Supports multiple postgres schemas
+* Generates your database migrations
+* Compares/validates actual database schema against desired configuration
+
+## Installation
+
+Install the gem by executing:
+
+    $ gem install dynamic_migrations
+
+Create your new platform:
+
+    $ dynamic_migrations create my_platform_name
+
+Note, this gem depends on the postgres gem `pg`, which depends on the `libpq` package. On Apple Silicon you can run the following commands before installation to prepare your system.
+
+```
+# required for pg gem on apple silicon
+brew install libpq
+export PATH="/opt/homebrew/opt/libpq/bin:$PATH"
+``
+
+## Getting Started
+
+Todo
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+We use [Conventional Commit Messages](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13).
+
+Code should be linted and formatted according to [Ruby Standard](https://github.com/standardrb/standard).
+
+Publishing is automated via github actions and Googles [Release Please](https://github.com/google-github-actions/release-please-action) github action
+
+We prefer using squash-merges when merging pull requests because it helps keep a linear git history and allows more fine grained control of commit messages which get sent to release-please and ultimately show up in the changelog.
+
+Type checking is enabled for this project. You can find the corresponding `rbs` files in the sig folder.
+
+Install types for the packages used in development (such as `rspec`) by running
+
+    $ rbs collection install
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/craigulliott/dynamic_migrations. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/craigulliott/dynamic_migrations/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This software is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DynamicMigrations project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/craigulliott/dynamic_migrations/blob/master/CODE_OF_CONDUCT.md).

data/lib/dynamic_migrations/expected_boolean_error.rb

@@ -0,0 +1,4 @@
+module DynamicMigrations
+  class ExpectedBooleanError < StandardError
+  end
+end

data/lib/dynamic_migrations/expected_integer_error.rb

@@ -0,0 +1,4 @@
+module DynamicMigrations
+  class ExpectedIntegerError < StandardError
+  end
+end

data/lib/dynamic_migrations/expected_string_error.rb

@@ -0,0 +1,4 @@
+module DynamicMigrations
+  class ExpectedStringError < StandardError
+  end
+end

data/lib/dynamic_migrations/expected_symbol_error.rb

@@ -0,0 +1,4 @@
+module DynamicMigrations
+  class ExpectedSymbolError < StandardError
+  end
+end

data/lib/dynamic_migrations/invalid_source_error.rb

@@ -0,0 +1,7 @@
+module DynamicMigrations
+  class InvalidSourceError < StandardError
+    def initialize source
+      super "expected :configuration or :database but got #{source}"
+    end
+  end
+end

data/lib/dynamic_migrations/module_included_into_unexpected_target_error.rb

@@ -0,0 +1,4 @@
+module DynamicMigrations
+  class ModuleIncludedIntoUnexpectedTargetError < StandardError
+  end
+end

data/lib/dynamic_migrations/postgres/connections.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  module Postgres
+    module Connections
+      @connections = {}
+
+      def self.create_connection host, port, username, password, database
+        connection = PG.connect(
+          host: host,
+          port: port,
+          user: username,
+          password: password,
+          dbname: database,
+          sslmode: "prefer"
+        )
+        @connections[connection] = true
+        connection
+      end
+
+      def self.connections
+        @connections.keys
+      end
+
+      def self.disconnect connection
+        if @connections[connection]
+          connection.close
+          @connections.delete connection
+          true
+        else
+          false
+        end
+      end
+
+      def self.disconnect_all
+        @connections.keys.each do |connection|
+          disconnect connection
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_migrations/postgres/data_types.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  module Postgres
+    module DataTypes
+      class MissingRequiredAttributeError < StandardError
+        def initialize data_type, attribute
+          super "Missing required attribute `#{attribute}` for data_type `#{data_type}`"
+        end
+      end
+
+      class UnexpectedPropertyError < StandardError
+        def initialize data_type, attribute, value
+          super "Unexpected property `#{attribute}` with value `#{value}` for data_type `#{data_type}`"
+        end
+      end
+
+      class UnsupportedTypeError < StandardError
+        def initialize data_type
+          super "Unsupported type `#{data_type}`"
+        end
+      end
+
+      DATA_TYPES = {
+        ARRAY: {
+          description: "binary data (“byte array”)",
+          required: [
+            :udt_schema,
+            :udt_name
+          ]
+        },
+        "USER-DEFINED": {
+          description: "binary data (“byte array”)",
+          required: [
+            :udt_schema,
+            :udt_name
+          ]
+        },
+        bigint: {
+          description: "signed eight-byte integer",
+          required: [
+            :numeric_precision,
+            :numeric_precision_radix,
+            :numeric_scale
+          ]
+        },
+        # skipping this, in my tests it automatically turned into a bigint
+        # bigserial: {
+        #   description: "autoincrementing eight-byte integer"
+        # },
+        bit: {
+          description: "fixed-length bit string",
+          args: "[ (n) ]",
+          required: [
+            :character_maximum_length
+          ]
+        },
+        "bit varying": {
+          description: "variable-length bit string",
+          args: "[ (n) ]"
+        },
+        boolean: {
+          description: "logical Boolean (true/false)",
+          required: []
+        },
+        box: {
+          description: "rectangular box on a plane"
+        },
+        bytea: {
+          description: "binary data (“byte array”)"
+        },
+        character: {
+          description: "fixed-length character string",
+          args: "[ (n) ]",
+          required: [
+            :character_maximum_length,
+            :character_octet_length
+          ]
+        },
+        "character varying": {
+          description: "variable-length character string",
+          args: "[ (n) ]",
+          required: [
+            :character_octet_length
+          ]
+        },
+        cidr: {
+          description: "IPv4 or IPv6 network address"
+        },
+        circle: {
+          description: "circle on a plane"
+        },
+        date: {
+          description: "calendar date (year, month, day)",
+          required: [
+            :datetime_precision
+          ]
+        },
+        "double precision": {
+          description: "double precision floating-point number (8 bytes)",
+          required: [
+            :numeric_precision,
+            :numeric_precision_radix
+          ]
+        },
+        inet: {
+          description: "IPv4 or IPv6 host address"
+        },
+        integer: {
+          description: "signed four-byte integer",
+          required: [
+            :numeric_precision,
+            :numeric_precision_radix,
+            :numeric_scale
+          ]
+        },
+        interval: {
+          description: "time span",
+          args: "[ fields ] [ (p) ]",
+          required: [
+            :datetime_precision
+          ]
+        },
+        json: {
+          description: "textual JSON data"
+        },
+        jsonb: {
+          description: "binary JSON data, decomposed"
+        },
+        line: {
+          description: "infinite line on a plane"
+        },
+        lseg: {
+          description: "line segment on a plane"
+        },
+        macaddr: {
+          description: "MAC (Media Access Control) address"
+        },
+        macaddr8: {
+          description: "MAC (Media Access Control) address (EUI-64 format)"
+        },
+        money: {
+          description: "currency amount"
+        },
+        numeric: {
+          description: "exact numeric of selectable precision",
+          args: "[ (p, s) ]",
+          required: [
+            :numeric_precision_radix
+          ],
+          optional: [
+            :numeric_precision,
+            :numeric_scale
+          ]
+        },
+        path: {
+          description: "geometric path on a plane"
+        },
+        pg_lsn: {
+          description: "PostgreSQL Log Sequence Number"
+        },
+        pg_snapshot: {
+          description: "user-level transaction ID snapshot"
+        },
+        point: {
+          description: "geometric point on a plane"
+        },
+        polygon: {
+          description: "closed geometric path on a plane"
+        },
+        real: {
+          description: "single precision floating-point number (4 bytes)",
+          required: [
+            :numeric_precision,
+            :numeric_precision_radix
+          ]
+        },
+        smallint: {
+          description: "signed two-byte",
+          required: [
+            :numeric_precision,
+            :numeric_precision_radix,
+            :numeric_scale
+          ]
+        },
+        smallserial: {
+          description: "autoincrementing two-byte"
+        },
+        serial: {
+          description: "autoincrementing four-byte"
+        },
+        text: {
+          description: "variable-length character string",
+          required: [
+            :character_octet_length
+          ]
+        },
+        "time without time zone": {
+          description: "time of day (no time zone)",
+          args: "[ (p) ]",
+          required: [
+            :datetime_precision
+          ]
+        },
+        "time with time zone": {
+          description: "time of day, including time zone",
+          args: "[ (p) ]",
+          required: [
+            :datetime_precision
+          ]
+        },
+        "timestamp without time zone": {
+          description: "date and time (no time zone)",
+          args: "[ (p) ]",
+          required: [
+            :datetime_precision
+          ]
+        },
+        "timestamp with time zone": {
+          description: "date and time, including time zone",
+          args: "[ (p) ]",
+          required: [
+            :datetime_precision
+          ]
+        },
+        tsquery: {
+          description: "text search query"
+        },
+        tsvector: {
+          description: "text search document"
+        },
+        txid_snapshot: {
+          description: "user-level transaction ID snapshot (deprecated; see pg_snapshot)"
+        },
+        uuid: {
+          description: "universally unique identifier"
+        },
+        xml: {
+          description: "XML data"
+        }
+      }
+
+      def self.validate_type_exists! data_type
+        raise ExpectedSymbolError, data_type unless data_type.is_a? Symbol
+        raise UnsupportedTypeError, data_type unless DATA_TYPES.key? data_type
+        true
+      end
+
+      def self.validate_column_properties! data_type, **column_options
+        validate_type_exists! data_type
+
+        required_attributes = DATA_TYPES[data_type][:required] || []
+        optional_attributes = DATA_TYPES[data_type][:optional] || []
+        possible_attributes = required_attributes + optional_attributes
+
+        # assert all required attributes are present
+        required_attributes.each do |attribute|
+          unless column_options.key?(attribute) && !column_options[attribute].nil?
+            raise MissingRequiredAttributeError.new data_type, attribute
+          end
+        end
+
+        # assert no unexpected attributes are present
+        column_options.each do |key, value|
+          unless value.nil? || possible_attributes.include?(key)
+            raise UnexpectedPropertyError.new data_type, key, value
+          end
+        end
+        true
+      end
+    end
+  end
+end

data/lib/dynamic_migrations/postgres/server/database/configured_schemas.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  module Postgres
+    class Server
+      class Database
+        module ConfiguredSchemas
+          class ConfiguredSchemaAlreadyExistsError < StandardError
+          end
+
+          class ConfiguredSchemaDoesNotExistError < StandardError
+          end
+
+          # adds a new configured schema for this database
+          def add_configured_schema schema_name
+            raise ExpectedSymbolError, schema_name unless schema_name.is_a? Symbol
+            if has_configured_schema? schema_name
+              raise(ConfiguredSchemaAlreadyExistsError, "Configured schema #{schema_name} already exists")
+            end
+            included_target = self
+            if included_target.is_a? Database
+              @configured_schemas[schema_name] = Schema.new :configuration, included_target, schema_name
+            else
+              raise ModuleIncludedIntoUnexpectedTargetError, included_target
+            end
+          end
+
+          # returns the configured schema object for the provided schema name, and raises an
+          # error if the schema does not exist
+          def configured_schema schema_name
+            raise ExpectedSymbolError, schema_name unless schema_name.is_a? Symbol
+            raise ConfiguredSchemaDoesNotExistError unless has_configured_schema? schema_name
+            @configured_schemas[schema_name]
+          end
+
+          # returns true if this table has a configured schema with the provided name, otherwise false
+          def has_configured_schema? schema_name
+            raise ExpectedSymbolError, schema_name unless schema_name.is_a? Symbol
+            @configured_schemas.key? schema_name
+          end
+
+          # returns an array of this tables configured schemas
+          def configured_schemas
+            @configured_schemas.values
+          end
+
+          # returns a hash of this tables configured schemas, keyed by schema name
+          def configured_schemas_hash
+            @configured_schemas
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_migrations/postgres/server/database/connection.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  module Postgres
+    class Server
+      class Database
+        module Connection
+          class NotConnectedError < StandardError
+          end
+
+          class MissingDatabaseNameError < StandardError
+          end
+
+          class AlreadyConnectedError < StandardError
+          end
+
+          def connect
+            raise MissingDatabaseNameError unless database_name
+            raise AlreadyConnectedError if @connection
+            @connection = Postgres::Connections.create_connection server.host, server.port, server.username, server.password, database_name
+          end
+
+          def connection
+            @connection || raise(NotConnectedError)
+          end
+
+          def disconnect
+            if (conn = @connection)
+              Postgres::Connections.disconnect conn
+              @connection = nil
+            else
+              raise NotConnectedError
+            end
+          end
+        end
+      end
+    end
+  end
+end