ci-helper 0.1.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1aa6bfe29d050175db60010ea49b38125a9f46f0e903348c67145e881b8dc7e
-  data.tar.gz: 614acf1d6cd9b22bb7697e54b51437d4cc67e13d65676e82c1ba934dc43e8f50
+  metadata.gz: fe12d4e12b312f65bd43218e3443d40c4ab27ce41aeb386bccebf4b9779d292e
+  data.tar.gz: ec3b1f6d22c637c72dd1600672cd1bb8b960e33727ebf3f16c97e6e10ce25e27
 SHA512:
-  metadata.gz: a99b5df7187a385ef8895a76a3d4631a540d5a72deab1c704cda1c7bb710a6818ac29a69a702f6e6bb658ef5110af228e972a88a9ac985c0fd30231bcd318a66
-  data.tar.gz: 3268627ed3a52c57f0b8328498c84a97c416ccb703c860d4599baee885195e7143734ec0096521375bb6f0d40cf5fbd12863b5b25ba5ba32bfd59c52ca97eddc
+  metadata.gz: d0fd1d742b556b1c6c3eac720d0709fb484780c2ac5dfa80f749bd4c4d8a338e6def6082550298c5c768df3fe6a25e65d0bc0333e9a7c2840b8273a30b544328
+  data.tar.gz: c50a69c1bf32a6ebec2299464063d656bd34af81eaf516935d20b9b55953851f293d5ac7bdaa82372fc79ad91f140ef4a65bda3191506d8a62cee5b7a6851f78

data/.github/workflows/ruby.yml

@@ -13,8 +13,11 @@ on:
   pull_request:
     branches: [ master ]
 
+env:
+  FULL_COVERAGE_CHECK: true
+
 jobs:
-  test:
+  test-latest:
 
     runs-on: ubuntu-latest
 
@@ -24,7 +27,7 @@ jobs:
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.7
     - name: Install dependencies
@@ -33,6 +36,8 @@ jobs:
       run: bundle exec rake install
     - name: Run Linter
       run: ci-helper RubocopLint
+    - name: Check missed spec suffixes
+      run: ci-helper CheckSpecSuffixes --extra-paths spec/*.rb --ignored-paths spec/*_helper.rb
     - name: Run specs
       run: ci-helper RunSpecs
     - name: Audit
@@ -41,3 +46,39 @@ jobs:
       uses: coverallsapp/github-action@v1.1.1
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
+  specs-for-26:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install && gem install bundler-audit
+    - name: Build and install gem to systems gems
+      run: bundle exec rake install
+    - name: Run specs
+      run: ci-helper RunSpecs
+  specs-for-25:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+    - name: Install dependencies
+      run: bundle install && gem install bundler-audit
+    - name: Build and install gem to systems gems
+      run: bundle exec rake install
+    - name: Run specs
+      run: ci-helper RunSpecs

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock

data/.rubocop.yml

@@ -10,3 +10,7 @@ Naming/MethodParameterName:
 
 RSpec/EmptyLineAfterHook:
   Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/ci-helper.rb

data/README.md

@@ -1,26 +1,122 @@
-# CIHelper   [![Actions Status](https://github.com/umbrellio/ci_helper/workflows/Ruby/badge.svg)](https://github.com/umbrellio/ci_helper/actions) [![Coverage Status](https://coveralls.io/repos/github/umbrellio/ci_helper/badge.svg?branch=master)](https://coveralls.io/github/umbrellio/ci_helper?branch=master)
-
-Documentation about gem here.
+# CIHelper   [![Actions Status](https://github.com/umbrellio/ci_helper/workflows/Ruby/badge.svg)](https://github.com/umbrellio/ci_helper/actions) [![Coverage Status](https://coveralls.io/repos/github/umbrellio/ci_helper/badge.svg?branch=master)](https://coveralls.io/github/umbrellio/ci_helper?branch=master) [![Gem Version](https://badge.fury.io/rb/ci-helper.svg)](https://badge.fury.io/rb/ci-helper)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ci_helper'
+gem "ci-helper", require: false
 ```
 
 And then execute:
+```bash
+$ bundle install
+```
+Or install it yourself as:
+```bash
+$ gem install ci_helper
+```
 
-    $ bundle install
+## Usage
 
-Or install it yourself as:
+### Command Line
 
-    $ gem install ci_helper
+You can use this gem as command line utility. For example, to lint project by rubocop,
+execute the following command in the project root:
+```bash
+$ ci-helper RubocopLint # Here's RubocopLint is a command
+```
 
-## Usage
+A command can accept list of options (parameters). Option values are passed through flags.
+For example, the BundlerAudit command accepts the ignored_advisories option
+You can set a value of this option by setting the flag `--ignored-advisories ignored-advisory`.
+It should be noted that all hyphens in flag names are automatically replaced with underscores.
+```bash
+$ ci-helper BundlerAudit --ignored-advisories first,second
+```
+
+List of available commands:
+
+* **BundlerAudit** — executes `bundler-audit`. Accepted flags: `--ignored-advisories`.
+    * `--ignored-advisories [values]` — accepts advisory codes, delimited by comma.
+* **CheckDBDevelopment** — executes rails db commands (`db:drop`, `db:create`, `db:migrate`)
+    and seeds database. Does not accept flags.
+* **CheckDBRollback** — executes rails db commands with additional command
+    `db:rollback_new_migrations`, which rollbacks migrations, added in tested branch.
+    Does not accept flags. Gem provides this rake task, but only for `Sequel`.
+    If you want to use `ActiveRecord::Migrator`, you'll have to write rake task by your own.
+* **RubocopLint** — executes rubocop linter. Does not accept flags.
+* **RunSpecs** — executes `rspec` in project root.
+Accepted flags: `--node-index`, `node-total`, `with-database`, `split-resultset`.
+    * `--node-index` — if you run specs in parallel in CI, then you might use this flag.
+    * `--node-total` — if you run specs in parallel in CI, then you might use this flag.
+    * `--with-database` — if you want to prepare database before executing specs,
+        you should set this flag to `true`.
+    * `--split-resultset` — if you run specs in parallel in CI,
+        then you might use this flag to `true`. If this flag set to true,
+        final `.resultset.json` will be renamed to `.resultset.#{node_index}.json`
+* **CheckSpecSuffixes** — checks specs in the spec subdirectories for `_spec` suffix,
+    by default ignores directories `support`, `factories` and files with `context` suffix.
+    Accepted flags: `--extra_paths`, `--ignored_paths`.
+    * `--extra-paths [values]` - accepts additional path patterns that should be scanned,
+        delimited by coma.
+    * `--ignored-paths [values]` - accepts path patterns that should be ignored,
+        delimited by coma.
+
+### Rake Tasks
 
-TODO: Write usage instructions here
+As you can see, some commands use generic rake tasks. To make tasks available in your application,
+you need to require the file `ci_helper/railtie`. Also, you can require it directly in `Gemfile`:
+`gem "ci-helper", require: "ci_helper/railtie, group: :test`.
+Or if you haven't set `require` option to `false`, rake tasks loads automatically.
+
+### Script
+
+Also, you can write your own script, which can executes this commands by calling classes:
+`CIHelper::Commands::#{command_name}`. For example,
+if you want to execute `RunSpecs` command in your script, you can write following lines:
+```ruby
+begin
+  CIHelper::Commands::RunSpecs.call!(with_database: "true") # returned value is exit code.
+rescue CIHelper::Commands::Error => e # Command raise error with this class if something went wrong.
+  abort e.message
+end
+```
+
+## Adding your own commands
+
+You can write plugins (gems) that add new commands.
+You just need create gem with following structure:
+```
+- lib
+  - ci_helper
+    - commands
+      - cool_command.rb
+```
+
+Where your `CoolCoomand` class may look something like this:
+```ruby
+module CIHelper
+  module Commands
+    class CoolCommand < BaseCommand
+      def call
+        execute("ls #{options[:cool_options]}")
+      end
+    end
+  end
+end
+```
+
+Then you add your gem to a Gemfile:
+```ruby
+gem "ci-helper", require: false
+gem "ci-helper-plugin-gem", require: false
+```
+
+And now, you can use your custom command with command line tool:
+```bash
+$ ci-helper CoolCommand --cool-options option_value
+```
 
 ## Contributing
 
@@ -30,3 +126,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/umbrel
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Authors
+
+Created by Ivan Chernov.
+
+<a href="https://github.com/umbrellio/">
+<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg" alt="Supported by Umbrellio" width="439" height="72">
+</a>

data/ci_helper.gemspec

@@ -10,9 +10,9 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Continuous Integration helpers for Ruby"
   spec.description   = "CIHelper is a gem with Continuous Integration helpers for Ruby"
-  spec.homepage      = "https://github.com/umbrellio"
+  spec.homepage      = "https://github.com/umbrellio/ci_helper"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/umbrellio/ci_helper"

data/lib/ci-helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "./ci_helper"

data/lib/ci_helper.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+module CIHelper
+end
+
 require "colorized_string"
 require "delegate"
 require "dry/inflector"
@@ -10,8 +13,8 @@ require "singleton"
 
 require "ci_helper/cli"
 require "ci_helper/commands"
+require "ci_helper/tools/colorize"
 require "ci_helper/tools/inflector"
 require "ci_helper/version"
 
-module CIHelper
-end
+require "ci_helper/railtie" if defined?(Rails)

data/lib/ci_helper/commands.rb

@@ -29,7 +29,7 @@ module CIHelper
       def execute(*commands)
         command = commands.join(" && ")
 
-        process_stdout.puts(ColorizedString["> "].green.bold + ColorizedString[command].blue.bold)
+        process_stdout.puts(Tools::Colorize.command(command))
 
         Open3.popen2e(command) do |_stdin, stdout, thread|
           stdout.each_char { |char| process_stdout.print(char) }
@@ -54,6 +54,11 @@ module CIHelper
         raise Error, message
       end
 
+      def plural_option(key)
+        return [] unless options.key?(key)
+        options[key].split(",")
+      end
+
       def path
         @path ||= Pathname.pwd
       end

data/lib/ci_helper/commands/bundler_audit.rb

@@ -11,14 +11,14 @@ module CIHelper
 
       def audit_cmd
         (+"bundle exec bundler-audit check --update").tap do |audit_cmd|
-          if ignored_advisories&.any?
+          if ignored_advisories.any?
             audit_cmd << " --ignore #{ignored_advisories.join(" ")}"
           end
         end
       end
 
       def ignored_advisories
-        @ignored_advisories ||= options[:ignored_advisories]&.split(",")
+        @ignored_advisories ||= plural_option(:ignored_advisories)
       end
     end
   end

data/lib/ci_helper/commands/check_db_development.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CIHelper
+  module Commands
+    class CheckDBDevelopment < BaseCommand
+      def call
+        create_and_migrate_database!
+        execute("bundle exec rake db:seed")
+      end
+
+      private
+
+      def env
+        :development
+      end
+    end
+  end
+end

data/lib/ci_helper/commands/check_spec_suffixes.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module CIHelper
+  module Commands
+    class CheckSpecSuffixes < BaseCommand
+      def call
+        paths = target_paths.reject { |path| path.end_with?("_spec.rb") }
+        fail!("Detected specs without _spec suffix: #{paths.join(" ")}") if paths.any?
+        0
+      end
+
+      private
+
+      def target_paths
+        spec_paths + extra_paths - ignored_paths
+      end
+
+      def spec_paths
+        base_paths.select do |path|
+          next if path.start_with?("spec/support")
+          next if path.start_with?("spec/factories")
+          next if path.end_with?("context.rb")
+          true
+        end
+      end
+
+      def base_paths
+        Dir["spec/*/**/*.rb"]
+      end
+
+      def extra_paths
+        @extra_paths ||= plural_option(:extra_paths).flat_map { |path| Dir[path] }
+      end
+
+      def ignored_paths
+        @ignored_paths ||= plural_option(:ignored_paths).flat_map { |path| Dir[path] }
+      end
+    end
+  end
+end

data/lib/ci_helper/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CIHelper
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/sequel_management.rake"
+    end
+  end
+end

data/lib/ci_helper/tools/colorize.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CIHelper
+  module Tools
+    module Colorize
+      extend self
+
+      def command(str)
+        ColorizedString[ColorizedString["> "].green.bold + ColorizedString[str].blue.bold]
+      end
+
+      def info(str)
+        ColorizedString[str].yellow
+      end
+    end
+  end
+end

data/lib/ci_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CIHelper
-  VERSION = "0.1.0"
+  VERSION = "0.2.5"
 end

data/lib/tasks/sequel_management.rake

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "logger"
+
+class SequelManagement
+  include Rake::DSL
+
+  MIGRATIONS_PATH = "db/migrate"
+
+  def initialize
+    self.logger = Logger.new(STDOUT)
+
+    define_db_task!
+  end
+
+  private
+
+  attr_accessor :logger
+
+  def migrations_path
+    self.class::MIGRATIONS_PATH
+  end
+
+  def define_db_task!
+    namespace :db do
+      desc "Rollback all migrations, which doesn't exist in master branch"
+      task rollback_new_migrations: :environment do
+        abort "Shouldn't run in production mode!" if Rails.env.production?
+
+        logger.info "Begin rolling back new migrations"
+
+        original_migrations = `#{git_command}`.split.map { |path| File.basename(path) }
+        migrations_to_rollback = (migrator.applied_migrations - original_migrations).sort.reverse
+
+        next if migrations_to_rollback.empty?
+
+        logger.info "Rolling back migrations:"
+        logger.info migrations_to_rollback.join("\n")
+
+        rollback!(migrations_to_rollback)
+      end
+    end
+  end
+
+  def git_command
+    "git ls-tree --name-only origin/master #{migrations_path}/"
+  end
+
+  def migrator
+    @migrator ||= begin
+      full_path = Rails.root.join(migrations_path)
+      Sequel::TimestampMigrator.new(DB, full_path, allow_missing_migration_files: true)
+    end
+  end
+
+  def rollback!(migrations)
+    migrations.each do |migration|
+      migrator.undo(migration.to_i)
+    rescue Sequel::Migrator::Error => error
+      if error.message.include?("does not exist in the filesystem")
+        logger.info error.message
+      else
+        raise error
+      end
+    end
+  end
+end
+
+SequelManagement.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci-helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.5
 platform: ruby
 authors:
 - JustAnotherDude
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -164,7 +164,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -172,20 +171,26 @@ files:
 - bin/setup
 - ci_helper.gemspec
 - exe/ci-helper
+- lib/ci-helper.rb
 - lib/ci_helper.rb
 - lib/ci_helper/cli.rb
 - lib/ci_helper/commands.rb
 - lib/ci_helper/commands/bundler_audit.rb
+- lib/ci_helper/commands/check_db_development.rb
 - lib/ci_helper/commands/check_db_rollback.rb
+- lib/ci_helper/commands/check_spec_suffixes.rb
 - lib/ci_helper/commands/rubocop_lint.rb
 - lib/ci_helper/commands/run_specs.rb
+- lib/ci_helper/railtie.rb
+- lib/ci_helper/tools/colorize.rb
 - lib/ci_helper/tools/inflector.rb
 - lib/ci_helper/version.rb
-homepage: https://github.com/umbrellio
+- lib/tasks/sequel_management.rake
+homepage: https://github.com/umbrellio/ci_helper
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/umbrellio
+  homepage_uri: https://github.com/umbrellio/ci_helper
   source_code_uri: https://github.com/umbrellio/ci_helper
 post_install_message: 
 rdoc_options: []
@@ -195,14 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Continuous Integration helpers for Ruby

data/Gemfile.lock

@@ -1,104 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ci-helper (0.1.0)
-      colorize (~> 0.8)
-      dry-inflector (~> 0.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
-    bundler-audit (0.6.1)
-      bundler (>= 1.2.0, < 3)
-      thor (~> 0.18)
-    coderay (1.1.3)
-    colorize (0.8.1)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    dry-inflector (0.2.0)
-    i18n (1.8.3)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    method_source (1.0.0)
-    minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rack (2.2.2)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-config-umbrellio (0.81.0.78)
-      rubocop (= 0.81.0)
-      rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.5.0)
-      rubocop-rspec (= 1.38.1)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.5.0)
-      activesupport
-      rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    simplecov-lcov (0.8.0)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  bundler-audit
-  ci-helper!
-  pry
-  rake
-  rspec
-  rubocop-config-umbrellio
-  simplecov
-  simplecov-lcov
-
-BUNDLED WITH
-   2.1.4