pronto-rails_migrations_annotated 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2b2a7302b5a18526b94a83ecd5b43783c31ea3dd1bc4d65987d7e8e9f5c637
-  data.tar.gz: 954ec3c7b49dad59c247f76d74c787ce1db6761230710fe4fa7d8169b193bb03
+  metadata.gz: d2b901020822988af989df4a5c7380a1d0888436b99a1b2ccd835e9b08a88875
+  data.tar.gz: 51392445670ec4052e0ad6790a6499cf71d62b4d5354a48e27df8ed036ab5f34
 SHA512:
-  metadata.gz: 194af503a81830b608c5068d9f26b18b3692833dd55e065bb913acbe4262f633027831133873f5f8b3263f18a748515edeedbf1cea9a7551bf8507b912ba6f45
-  data.tar.gz: 8f5ebbd09ebb84f7b0dc9b7940f0aed70cc56efa027393b64b2c4806f195c86fb4778286f98371443b63db8f9dfa8d49a8b035f37c6bbe32ad29ca177a2876bd
+  metadata.gz: 9b50a79d424571f695fe1faeb208ab10d0b474ab161d26c9128cfe355cbaf4de58000cb373daa64b234ac0bd0e2a7b8744ee2dec000f80785c673bdd067db353
+  data.tar.gz: 4b2b7867aced9e74a06c855337437b802407479d67bb805da19ec502079bdebe748e8f185f383c99338c74d9e9d8194461100c55374b0f1c93bd35a840610143

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pronto-rails_migrations_annotated (0.0.1)
+    pronto-rails_migrations_annotated (0.0.2)
       pronto (~> 0.11)
 
 GEM

data/lib/pronto/rails_migrations_annotated/version.rb

@@ -2,6 +2,6 @@
 
 module Pronto
   module RailsMigrationsAnnotatedVersion
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/pronto/rails_migrations_annotated.rb

@@ -12,6 +12,7 @@ module Pronto
 
       check_migrations_mixed_with_code
       check_migration_version_numbers
+      check_large_schema_diff
 
       @messages
     end
@@ -40,6 +41,23 @@ module Pronto
       end
     end
 
+    def diff_threshold
+      # TODO: some config for this?
+      200
+    end
+
+    def check_large_schema_diff
+      return unless diff_threshold
+
+      if schema_patches.sum(&:additions) >= diff_threshold || schema_patches.sum(&:deletions) >= diff_threshold
+        add_message_at_patch(schema_patches.first, "Large schema diff, pay attention")
+      end
+
+      if structure_patches.sum(&:additions) >= diff_threshold || structure_patches.sum(&:deletions) >= diff_threshold
+        add_message_at_patch(structure_patches.first, "Large structure diff, pay attention")
+      end
+    end
+
     def check_migrations_mixed_with_code
       return unless migration_patches.any? && non_migration_related_patches.any?
 
@@ -52,45 +70,46 @@ module Pronto
       version_numbers = migration_patches.map { |patch| patch.delta.new_file[:path].sub(/^[^0-9]*([0-9]+).+/, '\1') }
 
       schema_file_name = 'db/schema.rb'
-      if File.exist?(schema_file_name)
+      if File.exist?(schema_file_name) && !gitignored?(schema_file_name)
         if schema_patches.none?
           add_message_at_patch(migration_patches, "Migration file detected, but no changes in schema.rb", :error)
-        end
-
-        match = File.read(schema_file_name).match(%r{ActiveRecord::Schema.define\(version:\s*(?<version>[0-9_]+)\s*\)})
-        if match
-          schema_migration_version = match[:version]
-          schema_migration_version_clean = schema_migration_version.gsub(/[^0-9]/, '')
-          version_numbers.select { |version| version > schema_migration_version_clean }.each do |wrong_version|
-            add_message_at_patch(
-              migration_patches.first { |patch| patch.delta.new_file[:path].include?(wrong_version) },
-              "Migration version #{wrong_version} is above schema.rb version #{schema_migration_version}"
-            )
-          end
         else
-          add_message_at_patch(migration_patches.first, "Cannot detect schema migration version", :warning)
+          match = File.read(schema_file_name).match(%r{ActiveRecord::Schema.define\(version:\s*(?<version>[0-9_]+)\s*\)})
+          if match
+            schema_migration_version = match[:version]
+            schema_migration_version_clean = schema_migration_version.gsub(/[^0-9]/, '')
+            version_numbers.select { |version| version > schema_migration_version_clean }.each do |wrong_version|
+              add_message_at_patch(
+                migration_patches.first { |patch| patch.delta.new_file[:path].include?(wrong_version) },
+                "Migration version #{wrong_version} is above schema.rb version #{schema_migration_version}"
+              )
+            end
+          else
+            add_message_at_patch(migration_patches.first, "Cannot detect schema migration version", :warning)
+          end
         end
       end
 
       structure_file_name = 'db/structure.sql'
-      if File.exist?(structure_file_name)
-        if structure_patches.none?
-          add_message_at_patch(migration_patches, "Migration file detected, but no changes in structure.sql", :error)
-        end
-
+      if File.exist?(structure_file_name) && !gitignored?(structure_file_name)
         migration_line_regex = /\A\s*\('(?<version>[0-9]{14})'\)/
         structure_file_lines = File.readlines(structure_file_name)
         versions_from_schema = structure_file_lines.select{|line| line =~ migration_line_regex }
 
-
+        missing_from_structure = false
         version_numbers.select { |version| versions_from_schema.none? { |strct_ver| strct_ver.include?(version) } }
           .each do |wrong_version|
+          missing_from_structure = true
           add_message_at_patch(
             migration_patches.first { |patch| patch.delta.new_file[:path].include?(wrong_version) },
-            "Migration #{wrong_version} is missing from structure.sql"
+            "Migration #{wrong_version} is missing from structure.sql", :error
           )
         end
 
+        if structure_patches.none? && !missing_from_structure
+          add_message_at_patch(migration_patches, "Migration file detected, but no changes in structure.sql")
+        end
+
         structure_patches.each do |patch|
           patch.added_lines.each do |line|
             next unless line.content.match?(migration_line_regex)
@@ -113,8 +132,9 @@ module Pronto
             )
         end
 
-        unless structure_file_lines.last(2) == ["\n", "\n"] && structure_file_lines[-3] != "\n" ||
-          structure_file_lines.last.match?(/\A\s*[^\s]\s*\n/)
+        if structure_patches.any? &&
+          !(structure_file_lines.last(2) == ["\n", "\n"] && structure_file_lines[-3] != "\n") &&
+          !structure_file_lines.last.match?(/\A\s*[^\s]+\s*\n/)
           add_message_at_patch(structure_patches.last,
             "structure.sql must end with a newline or 2 empty lines", line: :last)
         end
@@ -122,6 +142,13 @@ module Pronto
 
     end
 
+    def gitignored?(path)
+      # TODO: get this from rugged (but it's not exposed to plugins) or make more compatible
+      `git check-ignore #{path}` != ""
+    rescue Errno::ENOENT # when git not present
+      nil
+    end
+
     def migration_patches
       # nb: there may be engines added to migrations_paths in config or database.yml
       # but cannot check for this without more knowledge into the particular app

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-rails_migrations_annotated
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vasily Fedoseyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto