better_structure_sql 0.1.0

data/lib/tasks/better_structure_sql.rake

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+# Clear tasks on reload to avoid duplicate task errors
+if defined?(BETTER_STRUCTURE_SQL_TASKS_LOADED)
+  %w[
+    db:schema:dump_better
+    db:schema:load_better
+    db:schema:store
+    db:schema:versions
+    db:schema:cleanup
+    db:schema:restore
+  ].each do |task_name|
+    Rake::Task[task_name].clear if Rake::Task.task_defined?(task_name)
+  end
+else
+  BETTER_STRUCTURE_SQL_TASKS_LOADED = true
+end
+
+namespace :db do
+  namespace :schema do
+    desc 'Dump the database schema to db/structure.sql using BetterStructureSql'
+    task dump_better: :environment do
+      require 'better_structure_sql'
+
+      dumper = BetterStructureSql::Dumper.new
+      output = dumper.dump(store_version: false)
+
+      puts "Schema dumped to #{BetterStructureSql.configuration.output_path}"
+
+      if output.is_a?(Hash)
+        # Multi-file mode
+        total_files = output.size
+        total_size = output.values.sum(&:bytesize)
+        puts "Total files: #{total_files}"
+        puts "Total size: #{format_bytes(total_size)}"
+      else
+        # Single-file mode
+        puts "Total size: #{format_bytes(output.bytesize)}"
+      end
+    end
+
+    # Formats byte count as human-readable string
+    #
+    # @param bytes [Integer] Byte count
+    # @return [String] Formatted string (e.g., "1.5 MB")
+    def format_bytes(bytes)
+      units = %w[B KB MB GB]
+      return "#{bytes} B" if bytes < 1024
+
+      exp = (Math.log(bytes) / Math.log(1024)).floor
+      exp = [exp, units.length - 1].min
+      size = bytes / (1024.0**exp)
+
+      format('%.2f %s', size, units[exp])
+    end
+
+    desc 'Load the database schema from db/structure.sql or directory (BetterStructureSql format)'
+    task load_better: %i[load_config check_protected_environments] do
+      require 'better_structure_sql'
+
+      config = BetterStructureSql.configuration
+      loader = BetterStructureSql::SchemaLoader.new(config)
+
+      begin
+        loader.load
+      rescue BetterStructureSql::SchemaLoader::LoadError => e
+        puts "Error loading schema: #{e.message}"
+        exit 1
+      end
+    end
+
+    desc 'Store current schema as a version in the database'
+    task store: :environment do
+      require 'better_structure_sql'
+
+      unless BetterStructureSql.configuration.enable_schema_versions
+        puts 'Schema versioning is not enabled.'
+        puts 'Enable it in config/initializers/better_structure_sql.rb:'
+        puts '  config.enable_schema_versions = true'
+        exit 1
+      end
+
+      version = BetterStructureSql::SchemaVersions.store_current
+
+      if version
+        puts 'Schema version stored successfully'
+        puts "  ID: #{version.id}"
+        puts "  Format: #{version.format_type}"
+        puts "  Mode: #{version.output_mode}"
+        puts "  Files: #{version.file_count || 1}"
+        puts "  PostgreSQL: #{version.pg_version}"
+        puts "  Size: #{version.formatted_size}"
+        puts "  Total versions: #{BetterStructureSql::SchemaVersions.count}"
+      else
+        puts 'No schema file found to store'
+        exit 1
+      end
+    end
+
+    desc 'List all stored schema versions'
+    task versions: :environment do
+      require 'better_structure_sql'
+
+      unless BetterStructureSql.configuration.enable_schema_versions
+        puts 'Schema versioning is not enabled.'
+        exit 1
+      end
+
+      versions = BetterStructureSql::SchemaVersions.all_versions
+      if versions.empty?
+        puts 'No schema versions stored yet'
+      else
+        puts "Total versions: #{versions.count}"
+        puts "\nID     Format  Mode          Files   PostgreSQL      Created              Size"
+        puts '-' * 95
+        versions.each do |version|
+          puts format('%-6d %-7s %-13s %-7s %-15s %-20s %s',
+                      version.id,
+                      version.format_type,
+                      version.output_mode,
+                      version.file_count || 1,
+                      version.pg_version,
+                      version.created_at.strftime('%Y-%m-%d %H:%M:%S'),
+                      version.formatted_size)
+        end
+      end
+    end
+
+    desc 'Cleanup old schema versions based on retention limit'
+    task cleanup: :environment do
+      require 'better_structure_sql'
+
+      unless BetterStructureSql.configuration.enable_schema_versions
+        puts 'Schema versioning is not enabled.'
+        exit 1
+      end
+
+      config = BetterStructureSql.configuration
+      if config.schema_versions_limit.zero?
+        puts 'Retention limit is set to unlimited (0). No cleanup needed.'
+        exit 0
+      end
+
+      deleted_count = BetterStructureSql::SchemaVersions.cleanup!
+      puts "Deleted #{deleted_count} old version(s)"
+      puts "Retained #{BetterStructureSql::SchemaVersions.count} version(s)"
+      puts "Retention limit: #{config.schema_versions_limit}"
+    end
+
+    desc 'Restore schema from stored version'
+    task :restore, [:version_id] => :environment do |_t, args|
+      require 'better_structure_sql'
+
+      version_id = args[:version_id] || ENV.fetch('VERSION_ID', nil)
+      raise 'Usage: rails db:schema:restore[VERSION_ID]' unless version_id
+
+      version = BetterStructureSql::SchemaVersions.find(version_id)
+      raise "Version #{version_id} not found" unless version
+
+      connection = ActiveRecord::Base.connection
+      connection.execute('SET client_min_messages TO warning')
+
+      if version.multi_file?
+        # Extract ZIP to temp directory
+        temp_dir = Rails.root.join('tmp', "schema_restore_#{version.id}")
+        FileUtils.rm_rf(temp_dir)
+
+        BetterStructureSql::ZipGenerator.extract_to_directory(version.zip_archive, temp_dir)
+
+        # Load from temp directory
+        loader = BetterStructureSql::SchemaLoader.new
+        loader.load(temp_dir)
+
+        # Cleanup
+        FileUtils.rm_rf(temp_dir)
+
+        puts "Schema version #{version.id} restored from #{version.file_count} files"
+      else
+        # Single file - load from content
+        connection.execute(version.content)
+
+        puts "Schema version #{version.id} restored"
+      end
+
+      puts "  Format: #{version.format_type}"
+      puts "  PostgreSQL: #{version.pg_version}"
+      puts "  Size: #{version.formatted_size}"
+    end
+  end
+end

metadata

@@ -0,0 +1,299 @@
+--- !ruby/object:Gem::Specification
+name: better_structure_sql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sebyx07
+bindir: exe
+cert_chain: []
+date: 2025-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: |
+  Pure Ruby database schema dumper for Rails applications supporting PostgreSQL, MySQL, and SQLite.
+  Generates clean, deterministic structure.sql files without pg_dump/mysqldump/sqlite3 CLI dependencies.
+  Supports both single-file and multi-file output for massive schemas with tens of thousands
+  of database objects. Includes schema versioning with ZIP storage and web UI for browsing versions.
+email:
+- sebyx07.pro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/controllers/better_structure_sql/application_controller.rb
+- app/controllers/better_structure_sql/schema_versions_controller.rb
+- app/helpers/better_structure_sql/schema_versions_helper.rb
+- app/views/better_structure_sql/schema_versions/index.html.erb
+- app/views/better_structure_sql/schema_versions/show.html.erb
+- app/views/layouts/better_structure_sql/application.html.erb
+- config/database.yml
+- config/routes.rb
+- lib/better_structure_sql.rb
+- lib/better_structure_sql/adapters/base_adapter.rb
+- lib/better_structure_sql/adapters/mysql_adapter.rb
+- lib/better_structure_sql/adapters/mysql_config.rb
+- lib/better_structure_sql/adapters/postgresql_adapter.rb
+- lib/better_structure_sql/adapters/postgresql_config.rb
+- lib/better_structure_sql/adapters/registry.rb
+- lib/better_structure_sql/adapters/sqlite_adapter.rb
+- lib/better_structure_sql/adapters/sqlite_config.rb
+- lib/better_structure_sql/configuration.rb
+- lib/better_structure_sql/database_version.rb
+- lib/better_structure_sql/dependency_resolver.rb
+- lib/better_structure_sql/dumper.rb
+- lib/better_structure_sql/engine.rb
+- lib/better_structure_sql/file_writer.rb
+- lib/better_structure_sql/formatter.rb
+- lib/better_structure_sql/generators/base.rb
+- lib/better_structure_sql/generators/domain_generator.rb
+- lib/better_structure_sql/generators/extension_generator.rb
+- lib/better_structure_sql/generators/foreign_key_generator.rb
+- lib/better_structure_sql/generators/function_generator.rb
+- lib/better_structure_sql/generators/index_generator.rb
+- lib/better_structure_sql/generators/materialized_view_generator.rb
+- lib/better_structure_sql/generators/pragma_generator.rb
+- lib/better_structure_sql/generators/sequence_generator.rb
+- lib/better_structure_sql/generators/table_generator.rb
+- lib/better_structure_sql/generators/trigger_generator.rb
+- lib/better_structure_sql/generators/type_generator.rb
+- lib/better_structure_sql/generators/view_generator.rb
+- lib/better_structure_sql/introspection.rb
+- lib/better_structure_sql/introspection/extensions.rb
+- lib/better_structure_sql/introspection/foreign_keys.rb
+- lib/better_structure_sql/introspection/functions.rb
+- lib/better_structure_sql/introspection/indexes.rb
+- lib/better_structure_sql/introspection/sequences.rb
+- lib/better_structure_sql/introspection/tables.rb
+- lib/better_structure_sql/introspection/triggers.rb
+- lib/better_structure_sql/introspection/types.rb
+- lib/better_structure_sql/introspection/views.rb
+- lib/better_structure_sql/manifest_generator.rb
+- lib/better_structure_sql/migration_patch.rb
+- lib/better_structure_sql/pg_version.rb
+- lib/better_structure_sql/railtie.rb
+- lib/better_structure_sql/schema_loader.rb
+- lib/better_structure_sql/schema_version.rb
+- lib/better_structure_sql/schema_versions.rb
+- lib/better_structure_sql/version.rb
+- lib/better_structure_sql/zip_generator.rb
+- lib/generators/better_structure_sql/install_generator.rb
+- lib/generators/better_structure_sql/migration_generator.rb
+- lib/generators/better_structure_sql/templates/README
+- lib/generators/better_structure_sql/templates/add_metadata_migration.rb.erb
+- lib/generators/better_structure_sql/templates/better_structure_sql.rb
+- lib/generators/better_structure_sql/templates/migration.rb.erb
+- lib/tasks/better_structure_sql.rake
+homepage: https://sebyx07.github.io/better_structure_sql/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://sebyx07.github.io/better_structure_sql/
+  source_code_uri: https://github.com/sebyx07/better_structure_sql
+  documentation_uri: https://sebyx07.github.io/better_structure_sql/
+  changelog_uri: https://github.com/sebyx07/better_structure_sql/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/sebyx07/better_structure_sql/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Clean database schema dumps for Rails (PostgreSQL, MySQL, SQLite) without
+  external tool dependencies
+test_files: []