dynamic_migrations 1.0.0

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  module Postgres
+    class Server
+      class Database
+        module ValidationsLoader
+          def create_database_validations_cache
+            connection.exec(<<~SQL)
+              CREATE MATERIALIZED VIEW public.dynamic_migrations_validations_cache as
+                SELECT table_constraints.table_schema as schema_name,
+                  table_constraints.table_name,
+                  array_agg(col.column_name ORDER BY col.column_name) AS columns,
+                  table_constraints.constraint_name as validation_name,
+                  check_constraints.check_clause,
+                  1 as table_version
+                FROM information_schema.table_constraints
+                JOIN information_schema.check_constraints
+                  ON table_constraints.constraint_schema = check_constraints.constraint_schema
+                  AND table_constraints.constraint_name = check_constraints.constraint_name
+                JOIN pg_namespace nsp ON nsp.nspname = check_constraints.constraint_schema
+                JOIN pg_constraint pgc ON pgc.conname = check_constraints.constraint_name
+                  AND pgc.connamespace = nsp.oid
+                  AND pgc.contype = 'c'
+                JOIN information_schema.columns col
+                  ON col.table_schema = table_constraints.table_schema
+                  AND col.table_name = table_constraints.table_name
+                  AND col.ordinal_position = ANY(pgc.conkey)
+                WHERE table_constraints.constraint_schema != 'information_schema'
+                  AND table_constraints.constraint_schema != 'postgis'
+                  AND left(table_constraints.constraint_schema, 3) != 'pg_'
+                GROUP BY
+                  table_constraints.table_schema,
+                  table_constraints.table_name,
+                  table_constraints.constraint_name,
+                  check_constraints.check_clause;
+            SQL
+            connection.exec(<<~SQL)
+              CREATE UNIQUE INDEX dynamic_migrations_validations_cache_index ON public.dynamic_migrations_validations_cache (schema_name, table_name, validation_name);
+            SQL
+            connection.exec(<<~SQL)
+              COMMENT ON MATERIALIZED VIEW public.dynamic_migrations_validations_cache IS 'A cached representation of the database validations. This is used by the dynamic migrations library and is created automatically and updated automatically after migrations have run.';
+            SQL
+          end
+
+          # fetch all columns from the database and build and return a
+          # useful hash representing the validations of your database
+          def fetch_validations
+            begin
+              rows = connection.exec_params(<<~SQL)
+                SELECT * FROM public.dynamic_migrations_validations_cache
+              SQL
+            rescue PG::UndefinedTable
+              create_database_validations_cache
+              rows = connection.exec_params(<<~SQL)
+                SELECT * FROM public.dynamic_migrations_validations_cache
+              SQL
+            end
+
+            schemas = {}
+            rows.each do |row|
+              schema_name = row["schema_name"].to_sym
+              schema = schemas[schema_name] ||= {}
+
+              table_name = row["table_name"].to_sym
+              table = schema[table_name] ||= {}
+
+              validation_name = row["validation_name"].to_sym
+
+              table[validation_name] = {
+                columns: row["columns"].gsub(/\A\{/, "").gsub(/\}\Z/, "").split(",").map { |column_name| column_name.to_sym },
+                check_clause: row["check_clause"]
+              }
+            end
+            schemas
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  module Postgres
+    class Server
+      # This class represents a postgres database. A database can contain many different
+      # schemas.
+      class Database
+        class ExpectedServerError < StandardError
+        end
+
+        include Connection
+        include StructureLoader
+        include ValidationsLoader
+        include KeysAndUniqueConstraintsLoader
+        include LoadedSchemas
+        include ConfiguredSchemas
+        include LoadedSchemasBuilder
+
+        attr_reader :server
+        attr_reader :database_name
+
+        # initialize a new object to represent a postgres database
+        def initialize server, database_name
+          raise ExpectedServerError, server unless server.is_a? Server
+          raise ExpectedSymbolError, database_name unless database_name.is_a? Symbol
+          @server = server
+          @database_name = database_name
+          @configured_schemas = {}
+          @loaded_schemas = {}
+        end
+
+        # if `source` is :configuration then returns the configured schema with
+        # the provided name, if `source` is :database then returns the loaded
+        # schema with the provided name, errors are raised if the requested
+        # schema does not exist or an unexpected `source` value is provided
+        def schema schema_name, source
+          case source
+          when :configuration
+            configured_schema schema_name
+          when :database
+            loaded_schema schema_name
+          else
+            raise InvalidSourceError, source
+          end
+        end
+
+        def differences
+          Differences.new(self).to_h
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_migrations/postgres/server.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  module Postgres
+    # This class represents a postgres server. A server can contain many databases.
+    class Server
+      attr_reader :host, :port, :username, :password
+
+      # initialize a new object to represent a postgres server
+      def initialize host, port, username, password
+        @host = host
+        @port = port
+        @username = username
+        @password = password
+        @databases = {}
+      end
+
+      def add_database database_name
+        raise ExpectedSymbolError, database_name unless database_name.is_a? Symbol
+        @databases[database_name] = Database.new self, database_name
+      end
+
+      def database database_name
+        raise ExpectedSymbolError, database_name unless database_name.is_a? Symbol
+        @databases[database_name]
+      end
+
+      def databases
+        @databases.values
+      end
+    end
+  end
+end

data/lib/dynamic_migrations/postgres.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  # This module exists only to namespace Postgres functionality and
+  # make it possible to add other database/storage types in the futur.
+  module Postgres
+  end
+end

data/lib/dynamic_migrations/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DynamicMigrations
+  VERSION = "1.0.0"
+end

data/lib/dynamic_migrations.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "pg"
+
+require "dynamic_migrations/version"
+require "dynamic_migrations/invalid_source_error"
+require "dynamic_migrations/expected_symbol_error"
+require "dynamic_migrations/expected_string_error"
+require "dynamic_migrations/expected_integer_error"
+require "dynamic_migrations/expected_boolean_error"
+require "dynamic_migrations/module_included_into_unexpected_target_error"
+
+require "dynamic_migrations/postgres/server/database/connection"
+require "dynamic_migrations/postgres/server/database/structure_loader"
+require "dynamic_migrations/postgres/server/database/validations_loader"
+require "dynamic_migrations/postgres/server/database/keys_and_unique_constraints_loader"
+require "dynamic_migrations/postgres/server/database/loaded_schemas_builder"
+require "dynamic_migrations/postgres/server/database/differences"
+require "dynamic_migrations/postgres/server/database/loaded_schemas"
+require "dynamic_migrations/postgres/server/database/configured_schemas"
+require "dynamic_migrations/postgres/server/database"
+require "dynamic_migrations/postgres/server/database/source"
+require "dynamic_migrations/postgres/server/database/schema"
+require "dynamic_migrations/postgres/server/database/schema/table/validations"
+require "dynamic_migrations/postgres/server/database/schema/table/indexes"
+require "dynamic_migrations/postgres/server/database/schema/table/foreign_key_constraints"
+require "dynamic_migrations/postgres/server/database/schema/table/unique_constraints"
+require "dynamic_migrations/postgres/server/database/schema/table/columns"
+require "dynamic_migrations/postgres/server/database/schema/table"
+require "dynamic_migrations/postgres/server/database/schema/table/column"
+require "dynamic_migrations/postgres/server/database/schema/table/validation"
+require "dynamic_migrations/postgres/server/database/schema/table/foreign_key_constraint"
+require "dynamic_migrations/postgres/server/database/schema/table/index"
+require "dynamic_migrations/postgres/server/database/schema/table/primary_key"
+require "dynamic_migrations/postgres/server/database/schema/table/unique_constraint"
+
+require "dynamic_migrations/postgres/server"
+require "dynamic_migrations/postgres/connections"
+require "dynamic_migrations/postgres/data_types"
+
+module DynamicMigrations
+  class Error < StandardError
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: dynamic_migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Craig Ulliott
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Monitor and generate database migrations based on difference between
+  current schema and configuration
+email:
+- craigulliott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/dynamic_migrations.rb
+- lib/dynamic_migrations/expected_boolean_error.rb
+- lib/dynamic_migrations/expected_integer_error.rb
+- lib/dynamic_migrations/expected_string_error.rb
+- lib/dynamic_migrations/expected_symbol_error.rb
+- lib/dynamic_migrations/invalid_source_error.rb
+- lib/dynamic_migrations/module_included_into_unexpected_target_error.rb
+- lib/dynamic_migrations/postgres.rb
+- lib/dynamic_migrations/postgres/connections.rb
+- lib/dynamic_migrations/postgres/data_types.rb
+- lib/dynamic_migrations/postgres/server.rb
+- lib/dynamic_migrations/postgres/server/database.rb
+- lib/dynamic_migrations/postgres/server/database/configured_schemas.rb
+- lib/dynamic_migrations/postgres/server/database/connection.rb
+- lib/dynamic_migrations/postgres/server/database/differences.rb
+- lib/dynamic_migrations/postgres/server/database/keys_and_unique_constraints_loader.rb
+- lib/dynamic_migrations/postgres/server/database/loaded_schemas.rb
+- lib/dynamic_migrations/postgres/server/database/loaded_schemas_builder.rb
+- lib/dynamic_migrations/postgres/server/database/schema.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/column.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/columns.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/foreign_key_constraint.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/foreign_key_constraints.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/index.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/indexes.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/primary_key.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/unique_constraint.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/unique_constraints.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/validation.rb
+- lib/dynamic_migrations/postgres/server/database/schema/table/validations.rb
+- lib/dynamic_migrations/postgres/server/database/source.rb
+- lib/dynamic_migrations/postgres/server/database/structure_loader.rb
+- lib/dynamic_migrations/postgres/server/database/validations_loader.rb
+- lib/dynamic_migrations/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/craigulliott/dynamic_migrations/
+  changelog_uri: https://github.com/craigulliott/dynamic_migrations/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Manage your database schema through configuration
+test_files: []