exwiw 0.9.21 → 0.9.23

data/lib/exwiw/schema_check.rb

@@ -9,7 +9,13 @@ module Exwiw
   # Reports how the committed schema config differs from what the application
   # would generate now, plus the columns still waiting for a masking decision.
   # Regenerating into a copy rather than over the config directory lets it run
-  # on a working tree it must not modify (CI). ActiveRecord only.
+  # on a working tree it must not modify (CI).
+  #
+  # The diff/report side is source-agnostic (it reads JSON config files); what
+  # varies per schema source is only how to regenerate, injected as
+  # `regenerator` — a callable that receives a directory pre-seeded with a copy
+  # of the committed config and rewrites it the way `generate!` + `tidy!`
+  # would. `models:` remains as the ActiveRecord shorthand for it.
   class SchemaCheck
     CATEGORIES = %w[
       added_tables added_columns removed_tables removed_columns changed_tables needs_mask_decision
@@ -20,9 +26,39 @@ module Exwiw
       new(models: ActiveRecord::Base.descendants, schema_dir: schema_dir)
     end
 
-    def initialize(models:, schema_dir:)
-      @models = models
+    # The Mongoid counterpart. `Mongoid.models` registers only the base class of
+    # an inheritance hierarchy, which is exactly what MongoidSchemaGenerator
+    # expects (it expands descendants itself), so the same source the generate
+    # task introspects is used here.
+    def self.from_mongoid_application(schema_dir:)
+      Rails.application.eager_load!
+      new(schema_dir: schema_dir, regenerator: mongoid_regenerator(::Mongoid.models))
+    end
+
+    # The regeneration step `from_mongoid_application` injects, exposed so a
+    # caller (and the specs) can run the check against an explicit model list
+    # without a Rails application — and so what they exercise is the very lambda
+    # production uses.
+    #
+    # `skip_unsupported` is deliberately left off: this runs as a CI gate, and a
+    # newly added construct exwiw cannot represent has to fail the task with the
+    # generator's actionable message rather than quietly become an `ignore: true`
+    # config that reports clean while the collection stops being dumped.
+    def self.mongoid_regenerator(models)
+      lambda do |tmp_dir|
+        # Explicit: safe mode is not optional here, whatever the library default is.
+        MongoidSchemaGenerator.new(models: models, output_dir: tmp_dir, safe_new_columns: true).generate!
+        MongoidSchemaGenerator.new(models: models, output_dir: tmp_dir).tidy!
+      end
+    end
+
+    def initialize(schema_dir:, models: nil, regenerator: nil)
+      if models.nil? && regenerator.nil?
+        raise ArgumentError, "SchemaCheck requires either models: or regenerator:"
+      end
+
       @schema_dir = schema_dir
+      @regenerator = regenerator || active_record_regenerator(models)
     end
 
     # The report as a plain Hash. Every list is sorted, so a given state always
@@ -47,9 +83,15 @@ module Exwiw
 
     private def regenerate_into(tmp_dir)
       FileUtils.cp_r(File.join(@schema_dir, "."), tmp_dir) if Dir.exist?(@schema_dir)
-      # Explicit: safe mode is not optional here, whatever the library default is.
-      SchemaGenerator.new(models: @models, output_dir: tmp_dir, safe_new_columns: true).generate!
-      SchemaGenerator.new(models: @models, output_dir: tmp_dir).tidy!
+      @regenerator.call(tmp_dir)
+    end
+
+    private def active_record_regenerator(models)
+      lambda do |tmp_dir|
+        # Explicit: safe mode is not optional here, whatever the library default is.
+        SchemaGenerator.new(models: models, output_dir: tmp_dir, safe_new_columns: true).generate!
+        SchemaGenerator.new(models: models, output_dir: tmp_dir).tidy!
+      end
     end
 
     # Every config file under `dir`, keyed by its path relative to `dir` so the

data/lib/exwiw/table_config.rb

@@ -170,9 +170,9 @@ module Exwiw
         merged_table.type = passed_table.type
         merged_table.comment = comment
         merged_table.filter = filter
-        merged_table.bulk_insert_chunk_size = passed_table.bulk_insert_chunk_size
         merged_table.ignore = ignore
         # User-owned, never regenerated: carry over from the existing config.
+        merged_table.bulk_insert_chunk_size = bulk_insert_chunk_size
         merged_table.scope_exempt = scope_exempt
         merged_table.scope_column = scope_column
         merged_table.reverse_scope = reverse_scope

data/lib/exwiw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Exwiw
-  VERSION = "0.9.21"
+  VERSION = "0.9.23"
 end

data/lib/exwiw.rb

@@ -40,6 +40,10 @@ require_relative "exwiw/after_insert_hook"
 require_relative "exwiw/runner"
 require_relative "exwiw/explain_runner"
 require_relative "exwiw/schema_generator"
+require_relative "exwiw/db_introspector"
+require_relative "exwiw/db_introspector/mysql_introspector"
+require_relative "exwiw/db_introspector/postgresql_introspector"
+require_relative "exwiw/db_schema_generator"
 require_relative "exwiw/schema_check"
 require_relative "exwiw/mongoid_schema_generator"
 

data/lib/tasks/exwiw.rake

@@ -100,7 +100,44 @@ namespace :exwiw do
       Exwiw::MongoidSchemaGenerator.from_rails_application(
         output_dir: resolve_schema_dir.call,
         skip_unsupported: ENV["EXWIW_SKIP_UNSUPPORTED"] == "1",
+        # Same convention as `generate`: safe unless EXWIW_NEW_COLUMNS=plain.
+        safe_new_columns: safe_new_columns.call,
       ).generate!
     end
+
+    desc "Remove collections from the schema config that no longer exist in the Mongoid application"
+    task tidy_mongoid: :environment do
+      require "exwiw"
+
+      result = Exwiw::MongoidSchemaGenerator.from_rails_application(
+        output_dir: resolve_schema_dir.call,
+      ).tidy!
+
+      if result.empty?
+        puts "exwiw: schema config is already tidy; nothing to remove."
+      else
+        result.removed_tables.each do |name|
+          puts "exwiw: removed config for collection '#{name}' (no longer exists in the application)."
+        end
+      end
+    end
+
+    desc "Report how the committed schema config differs from the Mongoid application, without changing it"
+    task check_mongoid: :environment do
+      require "exwiw"
+
+      report = Exwiw::SchemaCheck.from_mongoid_application(schema_dir: resolve_schema_dir.call).run
+      json = JSON.pretty_generate(report)
+      puts json
+      # A file too, so a caller need not assume stdout carries only the JSON.
+      File.write(ENV["EXWIW_SCHEMA_CHECK_OUTPUT"], json + "\n") if ENV["EXWIW_SCHEMA_CHECK_OUTPUT"]
+
+      unless Exwiw::SchemaCheck.clean?(report)
+        $stderr.puts "exwiw: the schema config is out of date or has undecided masking; " \
+                     "run `rake exwiw:schema:generate_mongoid exwiw:schema:tidy_mongoid` " \
+                     "and resolve every `needs_mask_decision` field."
+        exit 1
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exwiw
 version: !ruby/object:Gem::Version
-  version: 0.9.21
+  version: 0.9.23
 platform: ruby
 authors:
 - Shia
@@ -69,6 +69,10 @@ files:
 - lib/exwiw/belongs_to.rb
 - lib/exwiw/cli.rb
 - lib/exwiw/config_file.rb
+- lib/exwiw/db_introspector.rb
+- lib/exwiw/db_introspector/mysql_introspector.rb
+- lib/exwiw/db_introspector/postgresql_introspector.rb
+- lib/exwiw/db_schema_generator.rb
 - lib/exwiw/ddl_postprocessor.rb
 - lib/exwiw/default_mask.rb
 - lib/exwiw/determine_table_processing_order.rb