pronto-rails_migrations_annotated 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f2b2a7302b5a18526b94a83ecd5b43783c31ea3dd1bc4d65987d7e8e9f5c637
+  data.tar.gz: 954ec3c7b49dad59c247f76d74c787ce1db6761230710fe4fa7d8169b193bb03
+SHA512:
+  metadata.gz: 194af503a81830b608c5068d9f26b18b3692833dd55e065bb913acbe4262f633027831133873f5f8b3263f18a748515edeedbf1cea9a7551bf8507b912ba6f45
+  data.tar.gz: 8f5ebbd09ebb84f7b0dc9b7940f0aed70cc56efa027393b64b2c4806f195c86fb4778286f98371443b63db8f9dfa8d49a8b035f37c6bbe32ad29ca177a2876bd

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pronto-rails_migrations_annotated.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    pronto-rails_migrations_annotated (0.0.1)
+      pronto (~> 0.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    gitlab (4.17.0)
+      httparty (~> 0.18)
+      terminal-table (~> 1.5, >= 1.5.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.1115)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    octokit (4.21.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pronto (0.11.0)
+      gitlab (~> 4.4, >= 4.4.0)
+      httparty (>= 0.13.7)
+      octokit (~> 4.7, >= 4.7.0)
+      rainbow (>= 2.2, < 4.0)
+      rexml (~> 3.2)
+      rugged (>= 0.23.0, < 1.1.0)
+      thor (>= 0.20.3, < 2.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    rugged (1.0.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.1.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  pronto-rails_migrations_annotated!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.2.31

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Vasily Fedoseyev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Pronto::RailsMigrationsAnnotated
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pronto-rails_migrations_annotated'
+```
+
+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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Vasfed/pronto-rails_migrations_annotated.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/pronto/rails_migrations_annotated/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pronto
+  module RailsMigrationsAnnotatedVersion
+    VERSION = "0.0.1"
+  end
+end

data/lib/pronto/rails_migrations_annotated.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require_relative "rails_migrations_annotated/version"
+
+module Pronto
+  class RailsMigrationsAnnotated < Runner
+    VERSION = Pronto::RailsMigrationsAnnotatedVersion::VERSION
+
+    def run
+      @messages = []
+
+      check_migrations_mixed_with_code
+      check_migration_version_numbers
+
+      @messages
+    end
+
+    # todo: override def self.title ?
+
+    private
+
+    def add_message_at_patch(patches, message, level = :warning, line: :first)
+      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
+        )
+      end
+    end
+
+    def check_migrations_mixed_with_code
+      return unless migration_patches.any? && non_migration_related_patches.any?
+
+      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?
+
+      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 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)
+        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
+
+        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 }
+
+
+        version_numbers.select { |version| versions_from_schema.none? { |strct_ver| strct_ver.include?(version) } }
+          .each do |wrong_version|
+          add_message_at_patch(
+            migration_patches.first { |patch| patch.delta.new_file[:path].include?(wrong_version) },
+            "Migration #{wrong_version} is missing from structure.sql"
+          )
+        end
+
+        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) }
+
+            add_message_at_patch(patch, "Migration #{version} is not present in this changeset", :error, line: line)
+          end
+        end
+
+        bad_semicolon = !versions_from_schema.last.end_with?("');\n")
+        unsorted_migrations = versions_from_schema != versions_from_schema.sort
+
+        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
+
+        unless 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
+      end
+
+    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
+      # rails uses Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+      @migration_patches ||= @patches.select do |patch|
+        patch.delta.added? && patch.delta.new_file[:path] =~ %r{db/migrate/.*[0-9]+_\w+.rb}
+      end
+    end
+
+    def non_migration_related_patches
+      @patches.reject 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
+      end
+    end
+
+    def schema_patches
+      @schema_patches = @patches.select { |patch| patch.delta.new_file[:path] =~ %r{db/schema.rb} }
+    end
+
+    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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/pronto/rails_migrations_annotated/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pronto-rails_migrations_annotated"
+  spec.version = Pronto::RailsMigrationsAnnotatedVersion::VERSION
+  spec.authors = ["Vasily Fedoseyev"]
+  spec.email = ["vasilyfedoseyev@gmail.com"]
+
+  spec.summary = "Pronto runner to check rails migrations to be separate from other code, but allow annotations"
+  spec.description = <<~TEXT
+    For project stability it's a common practive to release db migrations separated from other code changes.
+    This pronto runner helps to enforce this. Also checks other migration PR basic sanity things.
+  TEXT
+  spec.homepage = "https://github.com/Vasfed/pronto-rails_migrations_annotated"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Vasfed/pronto-rails_migrations_annotated"
+  # spec.metadata["changelog_uri"] = "TODO: Put CHANGELOG.md URL here once there's a changelog"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pronto", '~>0.11'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: pronto-rails_migrations_annotated
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vasily Fedoseyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: |
+  For project stability it's a common practive to release db migrations separated from other code changes.
+  This pronto runner helps to enforce this. Also checks other migration PR basic sanity things.
+email:
+- vasilyfedoseyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pronto/rails_migrations_annotated.rb
+- lib/pronto/rails_migrations_annotated/version.rb
+- pronto-rails_migrations_annotated.gemspec
+homepage: https://github.com/Vasfed/pronto-rails_migrations_annotated
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Vasfed/pronto-rails_migrations_annotated
+  source_code_uri: https://github.com/Vasfed/pronto-rails_migrations_annotated
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Pronto runner to check rails migrations to be separate from other code, but
+  allow annotations
+test_files: []