migration_signature 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21b9a40066ce68440305cfca161d1f774d80be846ea19ea2938df5612e7c32cc
+  data.tar.gz: 03713b084e7381e46b17bcbfd67a7f3ca8647a1b8ef363d7a9862d40e999c3f7
+SHA512:
+  metadata.gz: ac6c41cbc16270c4823ff650bfc6b71310bfbf35fc87755fd8acfff2dac71433bec24cd57978f38b4d4a9100ceeff8785c0107f3617c0e0edd1430e9857dd015
+  data.tar.gz: 7db7de487a64a60bb53a815d6b00b05690a2673178d9d02c7487a0157a00d695c5b1cba2d574f83dae0d37b08392d7e3ed87beb39f96f8b629e5f3463819ed10

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in migration_signature.gemspec
+gemspec
+
+gem 'rubocop'

data/exe/migration_signature

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'migration_signature'
+require 'optparse'
+
+OptionParser.new do |parser|
+  parser.banner = <<~BANNER
+    Usage: migration_signature {check|buildall|build <file>}
+
+        check        - Check all your migration files for present and correct migration signatures
+        buildall     - Rebuild all migration signatures for all files (should only be used in setup)
+        build <file> - Rebuild a migration signature for a single migration
+
+  BANNER
+
+  parser.on('-h', '--help', 'Prints this help') do
+    puts parser
+    exit
+  end
+end.parse!
+
+action = ARGV[0]
+unless action
+  warn 'You must supply one of {check|buildall|build <file>}'
+  exit 1
+end
+
+if action == 'check'
+  begin
+    MigrationSignature.check_all
+  rescue MigrationSignature::InvalidSignatureError => e
+    warn e.message
+    exit 1
+  end
+elsif action == 'buildall'
+  MigrationSignature.build_all
+elsif action == 'build'
+  file = ARGV[1]
+
+  unless file
+    warn 'You must supply a file to build a signature for'
+    exit 1
+  end
+
+  MigrationSignature.build_file(file)
+else
+  warn 'You must supply one of {check|buildall|build <file>}'
+  exit 1
+end

data/lib/migration_signature/config.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MigrationSignature
+  class Config
+    DEFAULTS = {
+      'ignore' => [],
+      'rails_dir' => Dir.pwd,
+      'migration_dir' => 'db/migrate'
+    }.freeze
+
+    CONFIG_FILE_PATH = "#{Dir.pwd}/.migration_signature.yml"
+
+    def self.load
+      return new(DEFAULTS) unless File.exist?(CONFIG_FILE_PATH)
+
+      require 'yaml'
+      hash = YAML.safe_load(File.read(CONFIG_FILE_PATH), [Regexp]) || {}
+
+      new(DEFAULTS.merge(hash))
+    end
+
+    def initialize(opts = DEFAULTS)
+      @opts = opts
+    end
+
+    def all_runnable_files
+      @all_runnable_files ||= begin
+        require 'pathname'
+
+        Dir["#{migration_dir}/*"].sort.reject do |f|
+          ignore?(f)
+        end
+      end
+    end
+
+    def migration_dir
+      "#{@opts['rails_dir']}/#{@opts['migration_dir']}"
+    end
+
+    def ignore?(file)
+      rails_root_file =
+        Pathname.new(file).relative_path_from(@opts['rails_dir']).to_s
+
+      return true if string_ignores.include?(file)
+      return true if string_ignores.include?(rails_root_file)
+      return true if regexp_ignores.any? { |ignore| ignore =~ file }
+      return true if regexp_ignores.any? { |ignore| ignore =~ rails_root_file }
+
+      false
+    end
+
+    private
+
+    def regexp_ignores
+      @regexp_ignores ||= @opts['ignore'].find_all { |i| i.is_a?(Regexp) }
+    end
+
+    def string_ignores
+      @string_ignores ||= @opts['ignore'].reject { |i| i.is_a?(Regexp) }
+    end
+  end
+end

data/lib/migration_signature/migration_file.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module MigrationSignature
+  class MigrationFile
+    MIGRATION_SIG_PREFIX = '# migration_signature: '
+
+    def self.resolve_full_name(path_or_version)
+      path =
+        if path_or_version =~ /^\d+$/
+          Dir["#{MigrationSignature.config.migration_dir}/#{path_or_version}*"]
+            .first
+        else
+          File.expand_path(path_or_version)
+        end
+
+      return path if path && File.exist?(path)
+
+      bad_basename = path ? path.split('/').last : path_or_version
+      raise("Could not find migration #{bad_basename}")
+    end
+
+    def initialize(path_or_version)
+      @path = self.class.resolve_full_name(path_or_version)
+    end
+
+    def ignore?
+      MigrationSignature.config.ignore?(@path)
+    end
+
+    def update_signature!
+      new_lines = lines.dup
+      unless signature?
+        new_lines.unshift("\n")
+        # add blank line between magic comments and content
+        if !new_lines[1].empty? && !new_lines[2].start_with?('#')
+          new_lines.unshift("\n")
+        end
+      end
+
+      new_lines[signature_line_number || 0] = new_source_signature_line
+      write_to_file(new_lines)
+    end
+
+    def validate_signature!
+      return true if valid_signature?
+
+      raise MigrationSignature::InvalidSignatureError,
+            'Missing or invalid migration signature in migration: ' \
+            "#{basename}. Please re-run your migration to receive an " \
+            'updated signature.'
+    end
+
+    def basename
+      File.basename(path)
+    end
+
+    private
+
+    attr_reader :path
+
+    def valid_signature?
+      return false unless signature?
+
+      comment_signature = lines[signature_line_number]
+                          .sub(MIGRATION_SIG_PREFIX, '')
+                          .strip
+      comment_signature == source_signature
+    end
+
+    def new_source_signature_line
+      "#{MIGRATION_SIG_PREFIX}#{source_signature}\n"
+    end
+
+    def source_signature
+      Digest::MD5.hexdigest(Parser::CurrentRuby.parse(lines.join).inspect)
+    end
+
+    def signature?
+      signature_line_number && signature_line_number > -1
+    end
+
+    def signature_line_number
+      lines.index { |l| l.start_with?(MIGRATION_SIG_PREFIX) }
+    end
+
+    def lines
+      @lines ||= File.read(path).lines
+    end
+
+    def write_to_file(new_lines)
+      File.write(path, new_lines.join)
+      remove_instance_variable(:@lines) if defined?(@lines)
+      true
+    end
+  end
+end

data/lib/migration_signature/railtie.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MigrationSignature
+  class Railtie < Rails::Railtie
+    initializer 'migration_signatures.prepend migrator' do
+      ActiveRecord::Migrator.prepend(MigrationSignature::MigratorEnhancement)
+    end
+  end
+
+  module MigratorEnhancement
+    def run
+      res = super
+      return res unless @direction == :up
+
+      MigrationSignature.build_file(@target_version.to_s)
+
+      puts('Migration signature successfully built')
+      res
+    end
+
+    def migrate
+      runnable = super
+
+      return runnable if @direction && @direction != :up
+
+      runnable.each do |migration|
+        MigrationSignature.build_file(migration.filename)
+      end
+
+      puts('Migration signatures successfully built')
+      runnable
+    end
+  end
+end

data/lib/migration_signature/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MigrationSignature
+  VERSION = '0.1.0'
+end

data/lib/migration_signature.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'parser/current'
+require 'digest/md5'
+require_relative './migration_signature/config'
+require_relative './migration_signature/migration_file'
+require_relative './migration_signature/railtie' if defined?(Rails)
+
+module MigrationSignature
+  class InvalidSignatureError < StandardError; end
+
+  def self.config
+    @config ||= MigrationSignature::Config.load
+  end
+
+  def self.check_all
+    config.all_runnable_files.each do |path|
+      MigrationSignature::MigrationFile.new(path).validate_signature!
+    end
+
+    true
+  end
+
+  def self.build_all
+    config.all_runnable_files.each do |path|
+      MigrationSignature::MigrationFile.new(path).update_signature!
+    end
+  end
+
+  def self.build_file(file)
+    mf = MigrationSignature::MigrationFile.new(file)
+
+    if mf.ignore?
+      warn "Tried to build signature for #{mf.basename}, but it is ignored."
+      return
+    end
+
+    mf.update_signature!
+  end
+end

data/migration_signature.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'migration_signature/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'migration_signature'
+  spec.version       = MigrationSignature::VERSION
+  spec.authors       = ['Dave Allie']
+  spec.email         = ['dave@tanda.co']
+
+  spec.summary       = 'Generate signatures for migration files when they ' \
+                       'are run and check them in CI.'
+  spec.description   = 'A small Rails utility to ensure all migration files ' \
+                       'have been tested before they are committed and run ' \
+                       'in production.'
+  spec.homepage      = 'https://github.com/TandaHQ/migration_signature'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['exe/*'] + Dir['lib/**/*'] +
+                       %w[Gemfile migration_signature.gemspec]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'parser', '>= 2'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: migration_signature
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Allie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A small Rails utility to ensure all migration files have been tested
+  before they are committed and run in production.
+email:
+- dave@tanda.co
+executables:
+- migration_signature
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- exe/migration_signature
+- lib/migration_signature.rb
+- lib/migration_signature/config.rb
+- lib/migration_signature/migration_file.rb
+- lib/migration_signature/railtie.rb
+- lib/migration_signature/version.rb
+- migration_signature.gemspec
+homepage: https://github.com/TandaHQ/migration_signature
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Generate signatures for migration files when they are run and check them
+  in CI.
+test_files: []