schema_dev 3.13.0 → 4.1.0

data/lib/schema_dev/gemfiles.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'tmpdir'
 
 require_relative 'templates'
 
 module SchemaDev
-
   module Gemfiles
     extend self
 
@@ -12,9 +13,9 @@ module SchemaDev
       Dir.mktmpdir do |tmpdir|
         @tmpdir = Pathname.new(tmpdir).realpath
 
-        gemfiles = Pathname("gemfiles")
+        gemfiles = Pathname('gemfiles')
         tmp_root = @tmpdir + gemfiles
-        target_root = Pathname.new(".").realpath + gemfiles
+        target_root = Pathname.new('.').realpath + gemfiles
 
         _install gemfiles + 'Gemfile.base'
 
@@ -22,11 +23,11 @@ module SchemaDev
           activerecord_path = gemfiles + "activerecord-#{activerecord}"
           _install activerecord_path + 'Gemfile.base'
           config.db.each do |db|
-            _install  activerecord_path + "Gemfile.#{db}"
+            _install activerecord_path + "Gemfile.#{db}"
           end
         end
 
-        if `diff -rq #{tmp_root} #{target_root} 2>&1 | grep -v lock`.length == 0
+        if `diff -rq #{tmp_root} #{target_root} 2>&1 | grep -v lock`.empty?
           return false
         end
 

data/lib/schema_dev/github_actions.rb

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'yaml'
+
+require_relative 'gemfile_selector'
+
+module SchemaDev
+  module GithubActions
+    extend self
+
+    WORKFLOW_FILE = '.github/workflows/prs.yml'
+
+    HEADER = <<~YAML
+      # This file was auto-generated by the schema_dev tool, based on the data in
+      #                 ./schema_dev.yml
+      # Please do not edit this file; any changes will be overwritten next time
+      # schema_dev gets run.
+    YAML
+
+    BASIC_WORKFLOW = {
+      name:        'CI PR Builds',
+      on:          {
+        push:         {
+          branches: %w[master],
+        },
+        pull_request: nil,
+      },
+      concurrency: {
+        group:                '${{ github.head_ref }}',
+        'cancel-in-progress': true,
+      }
+    }.freeze
+
+    BASIC_JOB = { 'runs-on': 'ubuntu-latest' }.freeze
+
+    BASIC_ENV = {
+      BUNDLE_GEMFILE: '${{ github.workspace }}/gemfiles/activerecord-${{ matrix.activerecord }}/Gemfile.${{ matrix.db }}'
+    }.freeze
+
+    FINISH_STEPS = [
+      {
+        name: 'Coveralls Finished',
+        if:   '${{ !env.ACT }}',
+        uses: 'coverallsapp/github-action@master',
+        with: {
+          'github-token':      '${{ secrets.GITHUB_TOKEN }}',
+          'parallel-finished': true,
+        }
+      }
+    ].freeze
+
+    STEPS = {
+      start:  [
+                {
+                  uses: 'actions/checkout@v2',
+                },
+                {
+                  name: 'Set up Ruby',
+                  uses: 'ruby/setup-ruby@v1',
+                  with: {
+                    'ruby-version':  '${{ matrix.ruby }}',
+                    'bundler-cache': true,
+                  },
+                },
+                {
+                  name: 'Run bundle update',
+                  run:  'bundle update',
+                },
+              ],
+      test:   [
+                {
+                  name: 'Run tests',
+                  run:  'bundle exec rake spec',
+                }
+              ],
+      finish: [
+                {
+                  name: 'Coveralls Parallel',
+                  if:   '${{ !env.ACT }}',
+                  uses: 'coverallsapp/github-action@master',
+                  with: {
+                    'github-token': '${{ secrets.GITHUB_TOKEN }}',
+                    'flag-name':    'run-${{ matrix.ruby }}-${{ matrix.activerecord }}-${{ matrix.db }}-${{ matrix.dbversion }}',
+                    parallel:       true,
+                  }
+                }
+              ],
+    }.freeze
+
+    DB_ENV = {
+      postgresql: {
+        POSTGRESQL_DB_HOST: '127.0.0.1',
+        POSTGRESQL_DB_USER: 'schema_plus_test',
+        POSTGRESQL_DB_PASS: 'database',
+      },
+      mysql2:     {
+        MYSQL_DB_HOST: '127.0.0.1',
+        MYSQL_DB_USER: 'root',
+        MYSQL_DB_PASS: 'database',
+      },
+    }.freeze
+
+    DB_STARTUP = {
+      postgresql: [
+                    {
+                      name: 'Start Postgresql',
+                      if:   "matrix.db == 'postgresql'",
+                      run:  <<~BASH
+                        docker run --rm --detach \\
+                          -e POSTGRES_USER=$POSTGRESQL_DB_USER \\
+                          -e POSTGRES_PASSWORD=$POSTGRESQL_DB_PASS \\
+                          -p 5432:5432 \\
+                          --health-cmd "pg_isready -q" \\
+                          --health-interval 5s \\
+                          --health-timeout 5s \\
+                          --health-retries 5 \\
+                          --name database postgres:${{ matrix.dbversion }}
+                      BASH
+                    },
+                  ],
+      mysql2:     [
+                    {
+                      name: 'Start Mysql',
+                      if:   "matrix.db == 'mysql2'",
+                      run:  <<~BASH
+                        docker run --rm --detach \\
+                          -e MYSQL_ROOT_PASSWORD=$MYSQL_DB_PASS \\
+                          -p 3306:3306 \\
+                          --health-cmd "mysqladmin ping --host=127.0.0.1 --password=$MYSQL_DB_PASS --silent" \\
+                          --health-interval 5s \\
+                          --health-timeout 5s \\
+                          --health-retries 5 \\
+                          --name database mysql:5.6
+                      BASH
+                    }
+                  ],
+    }.freeze
+
+    DB_SETUP_NEEDED    = %w[postgresql mysql2].freeze
+    DB_SETUP           = [
+      {
+        name: 'Wait for database to start',
+        if:   "(matrix.db == 'postgresql' || matrix.db == 'mysql2')",
+        run:  <<~BASH
+          COUNT=0
+          ATTEMPTS=20
+          until [[ $COUNT -eq $ATTEMPTS ]]; do
+            [ "$(docker inspect -f {{.State.Health.Status}} database)" == "healthy" ] && break
+            echo $(( COUNT++ )) > /dev/null
+            sleep 2
+          done
+        BASH
+      },
+      {
+        name: 'Create testing database',
+        if:   "(matrix.db == 'postgresql' || matrix.db == 'mysql2')",
+        run:  'bundle exec rake create_ci_database',
+      },
+    ].freeze
+    DB_TEARDOWN_NEEDED = %w[postgresql mysql2].freeze
+    DB_TEARDOWN        = [
+      {
+        name: 'Shutdown database',
+        if:   "always() && (matrix.db == 'postgresql' || matrix.db == 'mysql2')",
+        run:  'docker stop database',
+      }
+    ].freeze
+
+    def build(config)
+      matrix, env = build_matrices(config)
+      db_setup    = []
+      db_teardown = []
+      config.db.each do |db|
+        db_setup.concat DB_STARTUP.fetch(db.to_sym, [])
+      end
+      db_setup.concat(DB_SETUP) if config.db.any? { |e| DB_SETUP_NEEDED.include?(e) }
+      db_teardown.concat(DB_TEARDOWN) if config.db.any? { |e| DB_TEARDOWN_NEEDED.include?(e) }
+
+      strategy = {
+        'fail-fast': false,
+        matrix:      matrix,
+      }
+
+      steps = [
+        *STEPS[:start],
+        *db_setup,
+        *STEPS[:test],
+        *db_teardown,
+        *STEPS[:finish],
+      ]
+
+      {}.tap do |workflow|
+        workflow.merge!(BASIC_WORKFLOW)
+        workflow[:jobs] = {
+          test:   {}.merge(BASIC_JOB)
+                    .merge({
+                             strategy: strategy,
+                             env:      env,
+                             steps:    steps
+                           }.compact),
+          finish: {
+                    needs: 'test'
+                  }.merge(BASIC_JOB)
+                   .merge(steps: FINISH_STEPS)
+        }
+      end.deep_stringify_keys
+    end
+
+    def build_matrices(config)
+      include_skip = false
+
+      matrix = {
+        ruby:         config.ruby,
+        activerecord: config.activerecord,
+        db:           [*config.db],
+        dbversion:    [],
+        exclude:      [],
+        include:      [],
+      }
+
+      if config.exclude.any?
+        matrix[:exclude] = config.exclude.map(&:to_hash).reject { |e| e.key?(:dbversion) }
+      end
+
+      env = {}.merge(BASIC_ENV)
+      config.db.each do |db|
+        env.merge!(DB_ENV.fetch(db.to_sym, {}))
+      end
+
+      if config.db.include?('postgresql')
+        include_skip = true
+        matrix[:db].delete('postgresql')
+        config.matrix(db: 'postgresql', with_dbversion: true).map do |entry|
+          matrix[:include] << entry
+        end
+      end
+
+      if include_skip
+        matrix[:db] << 'skip'
+        matrix[:dbversion] << 'skip'
+        matrix[:exclude] << { db: 'skip', dbversion: 'skip' }
+      end
+
+      [
+        matrix.reject { |_, val| val.empty? },
+        env
+      ]
+    end
+
+    def update(config)
+      filepath = Pathname.new(WORKFLOW_FILE)
+      filepath.dirname.mkpath
+      newworkflow = build(config)
+      oldworkflow = YAML.safe_load(filepath.read) rescue nil
+      if oldworkflow != newworkflow
+        yaml_output = newworkflow.to_yaml(line_width: -1)
+        # fix for some broken libyaml implementations (< 0.2.5)
+        yaml_output.gsub!('pull_request: ', 'pull_request:')
+        filepath.write HEADER + yaml_output
+        return true
+      end
+      false
+    end
+  end
+end

data/lib/schema_dev/matrix_executor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'executor'
 
 module SchemaDev
@@ -16,14 +18,14 @@ module SchemaDev
         db = tuple[:db]
 
         label = "ruby #{ruby} - activerecord #{activerecord} - db #{db}"
-        msg = "#{label} [#{i+1} of #{@matrix.size}]"
+        msg = "#{label} [#{i + 1} of #{@matrix.size}]"
         puts "\n\n*** #{msg}\n\n"
 
         if not Executor.new(ruby: ruby, activerecord: activerecord, db: db).run(cmd, dry_run: dry_run)
           @errors << label
         end
       end
-      return @errors.empty?
+      @errors.empty?
     end
   end
 end

data/lib/schema_dev/readme.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module SchemaDev
   class Readme
     def self.update(config)
-      new(config.matrix).update
+      new(config.matrix(with_dbversion: true)).update
     end
 
     attr_accessor :matrix, :readme
@@ -15,13 +17,14 @@ module SchemaDev
 
     def update
       return false unless readme.exist?
+
       lines = readme.readlines
       newlines = sub_matrix(lines.dup)
       newlines = sub_templates(newlines)
       newreadme = Gem.new(Pathname.pwd.basename.to_s).erb(newlines.join)
       if newreadme != lines.join
         readme.write newreadme
-        return true
+        true
       end
     end
 
@@ -29,8 +32,13 @@ module SchemaDev
       replace_block(lines, %r{^\s*<!-- SCHEMA_DEV: MATRIX}) do |contents|
         contents << "<!-- SCHEMA_DEV: MATRIX - begin -->\n"
         contents << "<!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->\n"
-        self.matrix.group_by(&it.slice(:ruby, :activerecord)).each do |pair, items|
-          contents << "* ruby **#{pair[:ruby]}** with activerecord **#{pair[:activerecord]}**, using #{items.map{|item| "**#{item[:db]}**"}.to_sentence(last_word_connector: ' or ')}\n"
+        matrix.group_by { |e| e.slice(:ruby, :activerecord) }.each do |pair, items|
+          dbs = items.map do |item|
+            db = item[:db]
+            db = "#{db}:#{item[:dbversion]}" if item.key?(:dbversion)
+            "**#{db}**"
+          end.to_sentence(last_word_connector: ' or ')
+          contents << "* ruby **#{pair[:ruby]}** with activerecord **#{pair[:activerecord]}**, using #{dbs}\n"
         end
         contents << "\n"
         contents << "<!-- SCHEMA_DEV: MATRIX - end -->\n"
@@ -38,14 +46,14 @@ module SchemaDev
     end
 
     def sub_templates(lines)
-      Pathname.glob(SchemaDev::Templates.root + "README" + "*.md.erb").each do |template|
+      Pathname.glob(SchemaDev::Templates.root + 'README' + '*.md.erb').each do |template|
         lines = sub_template(template, lines)
       end
       lines
     end
 
     def sub_template(template, lines)
-      key = template.basename(".md.erb").to_s.upcase.tr('.', ' ')
+      key = template.basename('.md.erb').to_s.upcase.tr('.', ' ')
 
       replace_block(lines, %r{^\s*<!-- SCHEMA_DEV: TEMPLATE #{key}}) do |contents|
         contents << "<!-- SCHEMA_DEV: TEMPLATE #{key} - begin -->\n"
@@ -57,14 +65,13 @@ module SchemaDev
     end
 
     def replace_block(lines, pattern)
-      before = lines.take_while(&it !~ pattern)
+      before = lines.take_while { |e| e !~ pattern }
       return lines if before == lines
-      after = lines.reverse.take_while(&it !~ pattern).reverse
+
+      after = lines.reverse.take_while { |e| e !~ pattern }.reverse
       contents = []
       yield contents
       before + contents + after
     end
-
-
   end
 end

data/lib/schema_dev/rspec/db.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'pathname'
 require_relative '../gemfile_selector'
@@ -8,81 +10,90 @@ module SchemaDev
       extend self
 
       def setup
-        @db = GemfileSelector.infer_db
         set_logger
         connect
         RSpec.configure do |config|
           config.include Helpers
-          config.filter_run_excluding :postgresql => :only unless Helpers.postgresql?
-          config.filter_run_excluding :postgresql => :skip if     Helpers.postgresql?
-          config.filter_run_excluding :mysql      => :only unless Helpers.mysql?
-          config.filter_run_excluding :mysql      => :skip if     Helpers.mysql?
-          config.filter_run_excluding :sqlite3    => :only unless Helpers.sqlite3?
-          config.filter_run_excluding :sqlite3    => :skip if     Helpers.sqlite3?
+          config.filter_run_excluding postgresql: :only unless Helpers.postgresql?
+          config.filter_run_excluding postgresql: :skip if Helpers.postgresql?
+          config.filter_run_excluding mysql: :only unless Helpers.mysql?
+          config.filter_run_excluding mysql: :skip if Helpers.mysql?
+          config.filter_run_excluding sqlite3: :only unless Helpers.sqlite3?
+          config.filter_run_excluding sqlite3: :skip if Helpers.sqlite3?
         end
       end
 
       def tmproot
-        @tmproot ||= Pathname.new('tmp').tap { |path| path.mkpath }
+        @tmproot ||= Pathname.new('tmp').tap(&:mkpath)
       end
 
       def logroot
-        @logroot ||= Pathname.new('log').tap { |path| path.mkpath }
+        @logroot ||= Pathname.new('log').tap(&:mkpath)
       end
 
       def database
-        @database ||= "schema_plus_test"
+        @database ||= 'schema_plus_test'
         # @database ||= (Dir["*.gemspec"].first || "schema_dev_test").sub(/\.gemspec$/, '') + "_test"
       end
 
-      def configuration
-        case @db
+      def configuration(db: nil)
+        case db || infer_db
         when 'mysql'
           {
-            "adapter"      => 'mysql',
-            "database"     => database,
-            "username"     => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
-            "encoding"     => 'utf8',
-            "min_messages" => 'warning'
+            'adapter'      => 'mysql',
+            'database'     => database,
+            'host'         => ENV['MYSQL_DB_HOST'],
+            'username'     => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
+            'password'     => ENV['MYSQL_DB_PASS'],
+            'encoding'     => 'utf8',
+            'min_messages' => 'warning'
           }
         when 'mysql2'
           {
-            "adapter"      => 'mysql2',
-            "database"     => database,
-            "username"     => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
-            "encoding"     => 'utf8',
-            "min_messages" => 'warning'
+            'adapter'      => 'mysql2',
+            'database'     => database,
+            'host'         => ENV['MYSQL_DB_HOST'],
+            'username'     => ENV.fetch('MYSQL_DB_USER', 'schema_plus'),
+            'password'     => ENV['MYSQL_DB_PASS'],
+            'encoding'     => 'utf8',
+            'min_messages' => 'warning'
           }
         when 'postgresql'
           {
-            "adapter"      => 'postgresql',
-            "username"     => ENV['POSTGRESQL_DB_USER'],
-            "database"     => database,
-            "min_messages" => 'warning'
+            'adapter'      => 'postgresql',
+            'database'     => database,
+            'host'         => ENV['POSTGRESQL_DB_HOST'],
+            'username'     => ENV['POSTGRESQL_DB_USER'],
+            'password'     => ENV['POSTGRESQL_DB_PASS'],
+            'min_messages' => 'warning'
           }
         when 'sqlite3'
           {
-            "adapter"  => 'sqlite3',
-            "database" => tmproot.join("#{database}.sqlite3").to_s
+            'adapter'  => 'sqlite3',
+            'database' => tmproot.join("#{database}.sqlite3").to_s
           }
         else
-          raise "Unknown db adapter #{@db.inspect}"
-        end
+          raise "Unknown db adapter #{db.inspect}"
+        end.compact
+      end
+
+      def infer_db
+        @infer_db ||= GemfileSelector.infer_db
       end
 
       def connect
         ActiveRecord::Base.configurations = { 'schema_dev' => configuration }
         ActiveRecord::Base.establish_connection :schema_dev
-        case @db
+        case infer_db
         when 'sqlite3'
-          ActiveRecord::Base.connection.execute "PRAGMA synchronous = OFF"
+          ActiveRecord::Base.connection.execute 'PRAGMA synchronous = OFF'
         end
       end
 
       def set_logger
         ruby = "#{RUBY_ENGINE}#{RUBY_VERSION}"
         activerecord = "activerecord#{ActiveRecord.version}"
-        ActiveRecord::Base.logger = Logger.new(logroot.join("#{ruby}-#{activerecord}-#{@db}.log").open("w"))
+        ActiveRecord::Base.logger = Logger.new(logroot.join("#{ruby}-#{activerecord}-#{infer_db}.log").open('w'))
       end
 
       module Helpers

data/lib/schema_dev/rspec.rb

@@ -1,24 +1,19 @@
+# frozen_string_literal: true
+
 require_relative 'rspec/db'
 
 module SchemaDev
   module Rspec
-
     def self.setup
       Db.setup
     end
 
-    def self.setup_db
-      ActiveSupport::Deprecation.warn "SchemaDev::Rspec.setup_db is deprecated.  Use SchemaDev::Rspec.setup"
-      self.setup
-    end
-
-    def self.db_configuration
-      Db.configuration
+    def self.db_configuration(db: nil)
+      Db.configuration(db: db)
     end
 
     module Helpers
       extend Rspec::Db::Helpers
     end
   end
-
 end

data/lib/schema_dev/ruby_selector.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'which_works'
 
 module SchemaDev
   module RubySelector
     def self.command(ruby)
-      @@selector ||= [Chruby, Rvm, Rbenv].find(&:installed?).andand.new || abort("No ruby version manager found")
-      @@selector.command ruby
+      selector.command ruby
+    end
+
+    # for rspec, to avoid stickiness
+    def self._reset
+      @selector = nil
     end
-    def self._reset # for rspec, to avoid stickiness
-      @@selector = nil
+
+    def self.selector
+      @selector ||= [Chruby, Rvm, Rbenv].find(&:installed?)&.new || abort('No ruby version manager found')
     end
 
     class ManagerBase
@@ -18,20 +25,27 @@ module SchemaDev
     end
 
     class Chruby < ManagerBase
-      CORE_COMMAND = "chruby-exec"
+      CORE_COMMAND = 'chruby-exec'
 
       def initialize
-        @rubies = Pathname.new(ENV['HOME']).join(".rubies").entries().map(&its.basename.to_s)
+        super
+
+        @rubies = Pathname.new(ENV['HOME'])
+                          .join('.rubies')
+                          .entries
+                          .map { |e| e.basename.to_s }
       end
+
       def command(ruby)
-        bash = Which.which 'bash' || abort("no bash shell found")
-        ruby = @rubies.select(&it =~ /^(ruby-)?#{ruby}(-p.*)?$/).last || ruby
+        bash = Which.which 'bash' || abort('no bash shell found')
+        ruby = @rubies.select { |e| e =~ /^(ruby-)?#{ruby}(-p.*)?$/ }
+                      .last || ruby
         "SHELL=#{bash} #{CORE_COMMAND} #{ruby} --"
       end
     end
 
     class Rvm < ManagerBase
-      CORE_COMMAND = "rvm"
+      CORE_COMMAND = 'rvm'
 
       def command(ruby)
         "#{CORE_COMMAND} #{ruby} do"
@@ -39,25 +53,26 @@ module SchemaDev
     end
 
     class Rbenv < ManagerBase
-      CORE_COMMAND = "rbenv"
+      CORE_COMMAND = 'rbenv'
 
       def initialize
+        super
+
         # because we're running within a ruby program that was launched by
         # rbenv, we already have various environment variables set up.  need
         # strip those out so that the forked shell can run a diifferent ruby
         # version than the one we're in now.
-        ENV['PATH'] = ENV['PATH'].split(':').reject{|dir| dir =~ %r{/\.?rbenv/(?!shims)}}.join(':')
-        ENV['GEM_PATH'] = ENV['GEM_PATH'].split(':').reject{|dir| dir =~ %r{/\.?rbenv}}.join(':') unless ENV['GEM_PATH'].nil?
+        ENV['PATH'] = ENV['PATH'].split(':').reject { |dir| dir =~ %r{/\.?rbenv/(?!shims)} }.join(':')
+        ENV['GEM_PATH'] = ENV['GEM_PATH'].split(':').reject { |dir| dir =~ %r{/\.?rbenv} }.join(':') unless ENV['GEM_PATH'].nil?
         ENV['RBENV_DIR'] = nil
         ENV['RBENV_HOOK_PATH'] = nil
         @versions ||= `rbenv versions --bare`.split
       end
 
       def command(ruby)
-        version = @versions.select{|v| v.start_with? ruby}.last || abort("no ruby version '#{ruby}' installed in rbenv")
+        version = @versions.select { |v| v.start_with? ruby }.last || abort("no ruby version '#{ruby}' installed in rbenv")
         "RBENV_VERSION=#{version}"
       end
     end
-
   end
 end