RubyGems - better_structure_sql - Versions diffs - 0.1.0 - Mend

better_structure_sql 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +41 -0
data/LICENSE +21 -0
data/README.md +557 -0
data/app/controllers/better_structure_sql/application_controller.rb +61 -0
data/app/controllers/better_structure_sql/schema_versions_controller.rb +243 -0
data/app/helpers/better_structure_sql/schema_versions_helper.rb +46 -0
data/app/views/better_structure_sql/schema_versions/index.html.erb +110 -0
data/app/views/better_structure_sql/schema_versions/show.html.erb +186 -0
data/app/views/layouts/better_structure_sql/application.html.erb +105 -0
data/config/database.yml +3 -0
data/config/routes.rb +12 -0
data/lib/better_structure_sql/adapters/base_adapter.rb +234 -0
data/lib/better_structure_sql/adapters/mysql_adapter.rb +476 -0
data/lib/better_structure_sql/adapters/mysql_config.rb +32 -0
data/lib/better_structure_sql/adapters/postgresql_adapter.rb +646 -0
data/lib/better_structure_sql/adapters/postgresql_config.rb +25 -0
data/lib/better_structure_sql/adapters/registry.rb +115 -0
data/lib/better_structure_sql/adapters/sqlite_adapter.rb +644 -0
data/lib/better_structure_sql/adapters/sqlite_config.rb +26 -0
data/lib/better_structure_sql/configuration.rb +129 -0
data/lib/better_structure_sql/database_version.rb +46 -0
data/lib/better_structure_sql/dependency_resolver.rb +63 -0
data/lib/better_structure_sql/dumper.rb +544 -0
data/lib/better_structure_sql/engine.rb +28 -0
data/lib/better_structure_sql/file_writer.rb +180 -0
data/lib/better_structure_sql/formatter.rb +70 -0
data/lib/better_structure_sql/generators/base.rb +33 -0
data/lib/better_structure_sql/generators/domain_generator.rb +22 -0
data/lib/better_structure_sql/generators/extension_generator.rb +23 -0
data/lib/better_structure_sql/generators/foreign_key_generator.rb +43 -0
data/lib/better_structure_sql/generators/function_generator.rb +33 -0
data/lib/better_structure_sql/generators/index_generator.rb +50 -0
data/lib/better_structure_sql/generators/materialized_view_generator.rb +31 -0
data/lib/better_structure_sql/generators/pragma_generator.rb +23 -0
data/lib/better_structure_sql/generators/sequence_generator.rb +27 -0
data/lib/better_structure_sql/generators/table_generator.rb +126 -0
data/lib/better_structure_sql/generators/trigger_generator.rb +54 -0
data/lib/better_structure_sql/generators/type_generator.rb +47 -0
data/lib/better_structure_sql/generators/view_generator.rb +27 -0
data/lib/better_structure_sql/introspection/extensions.rb +29 -0
data/lib/better_structure_sql/introspection/foreign_keys.rb +29 -0
data/lib/better_structure_sql/introspection/functions.rb +29 -0
data/lib/better_structure_sql/introspection/indexes.rb +29 -0
data/lib/better_structure_sql/introspection/sequences.rb +29 -0
data/lib/better_structure_sql/introspection/tables.rb +29 -0
data/lib/better_structure_sql/introspection/triggers.rb +29 -0
data/lib/better_structure_sql/introspection/types.rb +37 -0
data/lib/better_structure_sql/introspection/views.rb +41 -0
data/lib/better_structure_sql/introspection.rb +31 -0
data/lib/better_structure_sql/manifest_generator.rb +65 -0
data/lib/better_structure_sql/migration_patch.rb +196 -0
data/lib/better_structure_sql/pg_version.rb +44 -0
data/lib/better_structure_sql/railtie.rb +124 -0
data/lib/better_structure_sql/schema_loader.rb +168 -0
data/lib/better_structure_sql/schema_version.rb +86 -0
data/lib/better_structure_sql/schema_versions.rb +213 -0
data/lib/better_structure_sql/version.rb +5 -0
data/lib/better_structure_sql/zip_generator.rb +81 -0
data/lib/better_structure_sql.rb +81 -0
data/lib/generators/better_structure_sql/install_generator.rb +44 -0
data/lib/generators/better_structure_sql/migration_generator.rb +34 -0
data/lib/generators/better_structure_sql/templates/README +49 -0
data/lib/generators/better_structure_sql/templates/add_metadata_migration.rb.erb +25 -0
data/lib/generators/better_structure_sql/templates/better_structure_sql.rb +46 -0
data/lib/generators/better_structure_sql/templates/migration.rb.erb +26 -0
data/lib/tasks/better_structure_sql.rake +190 -0
metadata +299 -0

data/app/views/layouts/better_structure_sql/application.html.erb ADDED Viewed

@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Schema Versions - BetterStructureSql</title>
+  <!-- Bootstrap 5.3 CSS from CDN -->
+  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous">
+  <!-- Bootstrap Icons from CDN -->
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.2/font/bootstrap-icons.min.css">
+  <style>
+    .code-block {
+      background: #f8f9fa;
+      border: 1px solid #dee2e6;
+      border-radius: 0.375rem;
+      padding: 1rem;
+      overflow-x: auto;
+      font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', 'Consolas', monospace;
+      font-size: 0.875rem;
+      line-height: 1.5;
+    }
+    .metadata-card {
+      background: #f8f9fa;
+      border-left: 4px solid #0d6efd;
+    }
+    .navbar-brand {
+      font-weight: 600;
+    }
+    .empty-state {
+      padding: 4rem 2rem;
+      text-align: center;
+      color: #6c757d;
+    }
+    .badge-format {
+      font-weight: 500;
+    }
+  </style>
+</head>
+<body>
+  <!-- Navigation -->
+  <nav class="navbar navbar-expand-lg navbar-dark bg-primary mb-4">
+    <div class="container-fluid">
+      <a class="navbar-brand" href="<%= better_structure_sql.schema_versions_path %>">
+        <i class="bi bi-database"></i>
+        BetterStructureSql
+      </a>
+      <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav">
+        <span class="navbar-toggler-icon"></span>
+      </button>
+      <div class="collapse navbar-collapse" id="navbarNav">
+        <ul class="navbar-nav ms-auto">
+          <li class="nav-item">
+            <a class="nav-link" href="<%= better_structure_sql.schema_versions_path %>">
+              <i class="bi bi-list-ul"></i>
+              All Versions
+            </a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </nav>
+  <!-- Flash Messages -->
+  <div class="container-fluid">
+    <% if flash[:notice] %>
+      <div class="alert alert-success alert-dismissible fade show" role="alert">
+        <%= flash[:notice] %>
+        <button type="button" class="btn-close" data-bs-dismiss="alert"></button>
+      </div>
+    <% end %>
+    <% if flash[:alert] %>
+      <div class="alert alert-danger alert-dismissible fade show" role="alert">
+        <%= flash[:alert] %>
+        <button type="button" class="btn-close" data-bs-dismiss="alert"></button>
+      </div>
+    <% end %>
+  </div>
+  <!-- Main Content -->
+  <main class="container-fluid">
+    <%= yield %>
+  </main>
+  <!-- Footer -->
+  <footer class="mt-5 py-4 bg-light border-top">
+    <div class="container-fluid text-center text-muted">
+      <small>
+        BetterStructureSql Engine &middot;
+        Clean PostgreSQL schema dumps for Rails
+      </small>
+    </div>
+  </footer>
+  <!-- Bootstrap JS Bundle from CDN -->
+  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-C6RzsynM9kWDrMNeT87bh95OGNyZPhcTNXj1NW7RuBCsyN/o0jlpcV8Qyq46cDfL" crossorigin="anonymous"></script>
+</body>
+</html>

data/config/database.yml ADDED Viewed

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+BetterStructureSql::Engine.routes.draw do
+  resources :schema_versions, only: %i[index show] do
+    member do
+      get :raw
+      get :download
+    end
+  end
+  root to: 'schema_versions#index'
+end

data/lib/better_structure_sql/adapters/base_adapter.rb ADDED Viewed

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+module BetterStructureSql
+  module Adapters
+    # Base adapter class defining the interface contract for database-specific adapters.
+    #
+    # All concrete adapters must inherit from this class and implement the abstract methods.
+    # This class provides the foundation for database introspection and SQL generation across
+    # different database systems (PostgreSQL, MySQL, SQLite).
+    #
+    # @abstract Subclasses must implement all abstract methods
+    class BaseAdapter
+      # @return [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      attr_reader :connection
+      # Initialize a new adapter instance
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      def initialize(connection)
+        @connection = connection
+      end
+      # Abstract introspection methods - must be implemented by subclasses
+      # Fetch database extensions
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of extension hashes with :name, :version, :schema
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_extensions(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_extensions"
+      end
+      # Fetch custom types (enums, composite types, domains)
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of type hashes with :name, :type, :schema, and type-specific attributes
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_custom_types(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_custom_types"
+      end
+      # Fetch tables with columns and constraints
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of table hashes with :name, :schema, :columns, :primary_key, :constraints
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_tables(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_tables"
+      end
+      # Fetch indexes
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of index hashes with :name, :table, :columns, :unique, :type
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_indexes(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_indexes"
+      end
+      # Fetch foreign keys
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of foreign key hashes with :table, :name, :column, :foreign_table, :foreign_column, :on_update, :on_delete
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_foreign_keys(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_foreign_keys"
+      end
+      # Fetch views
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of view hashes with :schema, :name, :definition
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_views(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_views"
+      end
+      # Fetch materialized views
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of materialized view hashes with :schema, :name, :definition, :indexes
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_materialized_views(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_materialized_views"
+      end
+      # Fetch functions
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of function hashes with :schema, :name, :definition
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_functions(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_functions"
+      end
+      # Fetch sequences
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of sequence hashes with :name, :schema, :start_value, :increment
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_sequences(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_sequences"
+      end
+      # Fetch triggers
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection
+      # @return [Array<Hash>] Array of trigger hashes with :schema, :name, :table_name, :definition
+      # @raise [NotImplementedError] If not implemented by subclass
+      def fetch_triggers(connection)
+        raise NotImplementedError, "#{self.class} must implement #fetch_triggers"
+      end
+      # Capability methods - indicate feature support
+      # Indicates whether this database supports extensions (like PostgreSQL extensions)
+      #
+      # @return [Boolean] True if extensions are supported, false otherwise
+      def supports_extensions?
+        false
+      end
+      # Indicates whether this database supports materialized views
+      #
+      # @return [Boolean] True if materialized views are supported, false otherwise
+      def supports_materialized_views?
+        false
+      end
+      # Indicates whether this database supports custom types (enums, composite types)
+      #
+      # @return [Boolean] True if custom types are supported, false otherwise
+      def supports_custom_types?
+        false
+      end
+      # Indicates whether this database supports domains
+      #
+      # @return [Boolean] True if domains are supported, false otherwise
+      def supports_domains?
+        false
+      end
+      # Indicates whether this database supports stored procedures/functions
+      #
+      # @return [Boolean] True if functions are supported, false otherwise
+      def supports_functions?
+        false
+      end
+      # Indicates whether this database supports triggers
+      #
+      # @return [Boolean] True if triggers are supported, false otherwise
+      def supports_triggers?
+        false
+      end
+      # Indicates whether this database supports sequences
+      #
+      # @return [Boolean] True if sequences are supported, false otherwise
+      def supports_sequences?
+        false
+      end
+      # Version detection
+      # Detect the database version
+      #
+      # @return [String] Normalized version string (e.g., "14.5" for PostgreSQL 14.5)
+      # @raise [NotImplementedError] If not implemented by subclass
+      def database_version
+        raise NotImplementedError, "#{self.class} must implement #database_version"
+      end
+      # Parse version string from database
+      #
+      # @param version_string [String] Raw version string from database
+      # @return [String] Normalized version (e.g., "14.5")
+      # @raise [NotImplementedError] If not implemented by subclass
+      def parse_version(version_string)
+        raise NotImplementedError, "#{self.class} must implement #parse_version"
+      end
+      # Utility methods for version comparison
+      # Extract major version number
+      #
+      # @param version_string [String] Version string (e.g., "14.5")
+      # @return [Integer] Major version (e.g., 14)
+      def major_version(version_string)
+        version_string.split('.').first.to_i
+      end
+      # Extract minor version number
+      #
+      # @param version_string [String] Version string (e.g., "14.5")
+      # @return [Integer] Minor version (e.g., 5), or 0 if not present
+      def minor_version(version_string)
+        parts = version_string.split('.')
+        parts.length > 1 ? parts[1].to_i : 0
+      end
+      # Compare two version strings
+      #
+      # @param version1 [String] First version to compare
+      # @param version2 [String] Second version to compare
+      # @return [Integer] -1 if version1 < version2, 0 if equal, 1 if version1 > version2
+      def compare_versions(version1, version2)
+        v1_parts = version1.split('.').map(&:to_i)
+        v2_parts = version2.split('.').map(&:to_i)
+        [v1_parts.length, v2_parts.length].max.times do |i|
+          v1 = v1_parts[i] || 0
+          v2 = v2_parts[i] || 0
+          return -1 if v1 < v2
+          return 1 if v1 > v2
+        end
+        0
+      end
+      # Check if version meets minimum requirement
+      #
+      # @param current_version [String] Current database version
+      # @param required_version [String] Required minimum version
+      # @return [Boolean] True if current version is greater than or equal to required version
+      def version_at_least?(current_version, required_version)
+        compare_versions(current_version, required_version) >= 0
+      end
+    end
+  end
+end