pronto-rails_migrations_annotated 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2b901020822988af989df4a5c7380a1d0888436b99a1b2ccd835e9b08a88875
-  data.tar.gz: 51392445670ec4052e0ad6790a6499cf71d62b4d5354a48e27df8ed036ab5f34
+  metadata.gz: 88430fc4dc1457f81ee58ddbb791363370cb6e85fcd6ffe17b504717a637d5de
+  data.tar.gz: e7f1c20a1f124f27506cb1494d756d1ab314cd9217ce075e68e7a42842380030
 SHA512:
-  metadata.gz: 9b50a79d424571f695fe1faeb208ab10d0b474ab161d26c9128cfe355cbaf4de58000cb373daa64b234ac0bd0e2a7b8744ee2dec000f80785c673bdd067db353
-  data.tar.gz: 4b2b7867aced9e74a06c855337437b802407479d67bb805da19ec502079bdebe748e8f185f383c99338c74d9e9d8194461100c55374b0f1c93bd35a840610143
+  metadata.gz: 0f56e324b56c92ef3e2957bd39a6dba969e6fa4748bf8acadc1e077288cf0abb882b6e30b9c7c1f9a6d4d0a73b2be713a344e66c8c2d5aee667e7e6dd379f21d
+  data.tar.gz: a9f3ebffd0dd50bc1549d669069cc27a0f3cd67dc0064d428c03f1adffcd0d58df885485e4b9458dbb0c95a8a244e4dc479fbffbb7b2ea169742a73e7b7db5ad

data/.rubocop.yml

@@ -1,5 +1,13 @@
+require:
+ - rubocop-rake
+ - rubocop-rspec
+ - rubocop-performance
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  Exclude:
+    - spec/fixtures/somerepo/**/*.rb
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +19,13 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+Metrics/ClassLength:
+  Max: 180
+Metrics/AbcSize:
+  Max: 25
+Metrics/CyclomaticComplexity:
+  Max: 8

data/Gemfile

@@ -10,3 +10,6 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pronto-rails_migrations_annotated (0.0.2)
+    pronto-rails_migrations_annotated (0.0.3)
       pronto (~> 0.11)
 
 GEM
@@ -84,6 +84,13 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     rugged (1.0.1)
@@ -103,6 +110,9 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
    2.2.31

data/README.md

@@ -1,4 +1,5 @@
 # Pronto::RailsMigrationsAnnotated
+[![Gem Version](https://badge.fury.io/rb/pronto-rails_migrations_annotated.svg)](https://badge.fury.io/rb/pronto-rails_migrations_annotated)
 
 Pronto runner to enforce migrations to be in separate PRs, but allow schema annotations.
 Also check for obvious things like adding migration number that is not present in PR to structure.sql.
@@ -8,17 +9,13 @@ Also check for obvious things like adding migration number that is not present i
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'pronto-rails_migrations_annotated'
+gem 'pronto-rails_migrations_annotated', require: false
 ```
 
 And then execute:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install pronto-rails_migrations_annotated
-
 ## Usage
 
 When in gemfile - pronto should pick up this runner automatically.

data/lib/pronto/rails_migrations_annotated/version.rb

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

data/lib/pronto/rails_migrations_annotated.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'pronto'
+require "pronto"
 require_relative "rails_migrations_annotated/version"
 
 module Pronto
+  # Runner that detects migration smells
   class RailsMigrationsAnnotated < Runner
     VERSION = Pronto::RailsMigrationsAnnotatedVersion::VERSION
 
@@ -11,13 +12,15 @@ module Pronto
       @messages = []
 
       check_migrations_mixed_with_code
-      check_migration_version_numbers
+      check_migration_schema_version
+      check_structure_migration_version_numbers
       check_large_schema_diff
+      check_large_structure_diff
 
       @messages
     end
 
-    # todo: override def self.title ?
+    # TODO: override def self.title ?
 
     private
 
@@ -25,19 +28,11 @@ module Pronto
       patches = [patches] unless patches.is_a?(Array)
       patches.each do |patch|
         target_line = case line
-        when :first then patch.added_lines.first || patch.lines.first
-        when :last then patch.added_lines.last || patch.lines.last
-        else line
-        end
-
-        @messages << Message.new(
-          patch.delta.new_file[:path],
-          target_line,
-          level,
-          message,
-          nil,
-          self.class
-        )
+                      when :first then patch.added_lines.first || patch.lines.first
+                      when :last then patch.added_lines.last || patch.lines.last
+                      else line
+                      end
+        @messages << Message.new(patch.delta.new_file[:path], target_line, level, message, nil, self.class)
       end
     end
 
@@ -48,14 +43,18 @@ module Pronto
 
     def check_large_schema_diff
       return unless diff_threshold
+      return unless schema_patches.sum(&:additions) >= diff_threshold ||
+                    schema_patches.sum(&:deletions) >= 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
+      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
+    def check_large_structure_diff
+      return unless diff_threshold
+      return unless 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
 
     def check_migrations_mixed_with_code
@@ -64,82 +63,109 @@ module Pronto
       add_message_at_patch(migration_patches, "Do not mix migrations with other stuff", :fatal)
     end
 
-    def check_migration_version_numbers
-      return unless migration_patches.any?
+    def check_migration_schema_version
+      return if migration_patches.none? || !File.exist?(schema_file_name) || gitignored?(schema_file_name)
 
-      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) && !gitignored?(schema_file_name)
-        if schema_patches.none?
-          add_message_at_patch(migration_patches, "Migration file detected, but no changes in schema.rb", :error)
-        else
-          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
+      if schema_patches.none?
+        return add_message_at_patch(migration_patches, "Migration file detected, but no changes in schema.rb", :error)
       end
 
-      structure_file_name = 'db/structure.sql'
-      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", :error
-          )
-        end
+      migration_version_numbers.select { |version| schema_migration_version&.<(version) }.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
+    end
 
-        if structure_patches.none? && !missing_from_structure
-          add_message_at_patch(migration_patches, "Migration file detected, but no changes in structure.sql")
-        end
+    def schema_migration_version
+      return @schema_migration_version if defined? @schema_migration_version
 
-        structure_patches.each do |patch|
-          patch.added_lines.each do |line|
-            next unless line.content.match?(migration_line_regex)
-            match = line.content.match(migration_line_regex)
-            version = match[:version]
-            next if version_numbers.include?(version) ||
-              line.content.end_with?(',') && patch.deleted_lines.any? { |deleted| deleted.content.include?(version) }
+      @schema_migration_version ||= File.read(schema_file_name)
+                                        .match(/ActiveRecord::Schema.define\(version:\s*(?<version>[0-9_]+)\s*\)/)
+                                        &.[](:version)&.gsub(/[^0-9]/, "") ||
+                                    (add_message_at_patch(migration_patches.first,
+                                                          "Cannot detect migration version in schema.rb. "\
+                                                          "Migration versions are not checked.",
+                                                          :warning) && nil)
+    end
 
-            add_message_at_patch(patch, "Migration #{version} is not present in this changeset", :error, line: line)
-          end
-        end
+    def migration_version_numbers
+      @migration_version_numbers ||= migration_patches.map do |patch|
+        patch.delta.new_file[:path].sub(/^[^0-9]*([0-9]+).+/, '\1')
+      end
+    end
 
-        bad_semicolon = !versions_from_schema.last.end_with?("');\n")
-        unsorted_migrations = versions_from_schema != versions_from_schema.sort
+    def check_structure_migration_version_numbers
+      return unless migration_patches.any?
 
-        if bad_semicolon || unsorted_migrations
-          add_message_at_patch(
-            structure_patches.first{ |patch| patch.lines.any?{ |line| line.content.match?(migration_line_regex) } },
-            "Migration versions must be sorted and have correct syntax"
-            )
-        end
+      structure_file_name = "db/structure.sql"
+      return if !File.exist?(structure_file_name) || gitignored?(structure_file_name)
+
+      structure_file_lines = File.readlines(structure_file_name)
+      versions_from_schema = structure_file_lines.grep(migration_line_regex)
+
+      check_structure_versions_present(versions_from_schema)
+      check_structure_migration_missing
+
+      check_structure_versions_syntax(versions_from_schema)
+      check_structure_versions_sorted(versions_from_schema)
+      check_structure_ending(structure_file_lines)
+    end
+
+    def check_structure_versions_present(versions_from_schema)
+      found_missing_migration = false
+      migration_version_numbers.select { |version| versions_from_schema.none? { |ver| ver.include?(version) } }
+                               .each do |wrong_version|
+        found_missing_migration = 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", :error)
+      end
+
+      return if structure_patches.any? || found_missing_migration
+
+      add_message_at_patch(migration_patches, "Migration file detected, but no changes in structure.sql")
+    end
 
-        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)
+    def check_structure_migration_missing
+      structure_patches.each do |patch|
+        patch.added_lines.select { |line| line.content.match?(migration_line_regex) }.each do |line|
+          version = line.content.match(migration_line_regex)[:version]
+          next if migration_version_numbers.include?(version)
+          next if line.content.end_with?(",") &&
+                  patch.deleted_lines.any? { |del| del.content.include?("#{version}');") }
+
+          add_message_at_patch(patch, "Migration #{version} is not present in this changeset", :error, line: line)
         end
       end
+    end
+
+    def check_structure_versions_sorted(versions_from_schema)
+      return if versions_from_schema == versions_from_schema.sort
+
+      add_message_at_patch(
+        structure_patches.first { |patch| patch.lines.any? { |line| line.content.match?(migration_line_regex) } },
+        "Migration versions must be sorted and have correct syntax"
+      )
+    end
+
+    def check_structure_versions_syntax(versions_from_schema)
+      return if versions_from_schema.last.end_with?("');\n") &&
+                versions_from_schema.all? { |line| line.end_with?("'),\n", "');\n") }
 
+      add_message_at_patch(
+        structure_patches.first { |patch| patch.lines.any? { |line| line.content.match?(migration_line_regex) } },
+        "Migration version lines must be separated by comma and end with semicolon"
+      )
+    end
+
+    def check_structure_ending(structure_file_lines)
+      return if structure_patches.none?
+      return if structure_file_lines.last(2) == %W[\n \n] && structure_file_lines[-3] != "\n"
+      return if 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
 
     def gitignored?(path)
@@ -149,6 +175,22 @@ module Pronto
       nil
     end
 
+    def schema_file_name
+      "db/schema.rb"
+    end
+
+    def migration_line_regex
+      /\A\s*\('(?<version>[0-9]{14})'\)/
+    end
+
+    def migration_related_files
+      Regexp.union(
+        %r{db/migrate/.*[0-9]+_\w+.rb},
+        %r{db/schema.rb},
+        %r{db/structure.sql}
+      )
+    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
@@ -159,14 +201,14 @@ module Pronto
     end
 
     def non_migration_related_patches
-      @patches.reject do |patch|
+      @patches.select do |patch|
         path = patch.delta.new_file[:path]
-        # lines = added_lines + deleted_lines, allow edits in comments
-        path =~ %r{db/migrate/.*[0-9]+_\w+.rb} || path =~ %r{db/schema.rb} || path =~ %r{db/structure.sql} ||
-          path.end_with?('.rb') && patch.lines.all? do |line|
-            !(line.addition? || line.deletion?) ||
-            (line.content =~ /\A\s*#/ || line.content =~ /\A\s*\z/)
-          end
+        next false if path.match?(migration_related_files)
+
+        # allow edits in comments and blank lines (model annotations usually come there)
+        !path.end_with?(".rb") || patch.lines.any? do |line|
+          (line.addition? || line.deletion?) && !line.content.match?(/\A\s*(#|\z)/)
+        end
       end
     end
 
@@ -177,6 +219,5 @@ module Pronto
     def structure_patches
       @structure_patches = @patches.select { |patch| patch.delta.new_file[:path] =~ %r{db/structure.sql} }
     end
-
   end
 end

data/pronto-rails_migrations_annotated.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   TEXT
   spec.homepage = "https://github.com/Vasfed/pronto-rails_migrations_annotated"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Vasfed/pronto-rails_migrations_annotated"
@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "pronto", '~>0.11'
+  spec.add_dependency "pronto", "~>0.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-rails_migrations_annotated
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Vasily Fedoseyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -57,7 +57,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="