ci-helper 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be5f0daccd23cb1ced8508dd4dd4048925d62fa6074e0fece72838f081c5e255
-  data.tar.gz: eb5c8470d8b1123d41d7a4125c78dd1635fdb1dd8044afa0abc7b0da1c1fa8d6
+  metadata.gz: 16a693137d6056e1974c2a2d23200ef231fa4f47daf5089e7d864b4d5a000c8f
+  data.tar.gz: bb295befcb67ffadbc7bee5aa27fd741aae1ceb086074eeefa31e954fc3a4b2a
 SHA512:
-  metadata.gz: '0209abc7579fb06c9e86e70bf4a76312a0cc78130c416660395aec20b7ceaecd1ae2b78aa47518c57dd38f1344146b65baaeaeb29427259195a514e4e1365a4b'
-  data.tar.gz: 48522ba56eb1ce4d907a2d52b21fb71d340c84f2b64ffb9b3923810a758d18b5c01fb5d782f09cefde340e8d0e9e67038704dcff0e5a55eca7ce39d8d5fa3853
+  metadata.gz: 3b45bbdc2a858c9ed54f5f239cf901907fec77daf441c5df537cf2b733e9ce5ba4292c9b527ff67cb761e54163fc9dd0481413f112ea1742d285f9f2de5a3dad
+  data.tar.gz: 4bc6630a050a3c37143cedcf22ca7c6328fc3603cca3d6f9a4d04b59d5c402c0648ccc72de7fa2a4d414d7aa0c93de612233c99a0b4424f516fc7a091388fd7c

data/.github/workflows/ruby.yml

@@ -33,6 +33,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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ci-helper (0.1.1)
+    ci-helper (0.2.0)
       colorize (~> 0.8)
       dry-inflector (~> 0.2)
 
@@ -15,9 +15,9 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.1)
-    bundler-audit (0.6.1)
+    bundler-audit (0.7.0.1)
       bundler (>= 1.2.0, < 3)
-      thor (~> 0.18)
+      thor (>= 0.18, < 2)
     coderay (1.1.3)
     colorize (0.8.1)
     concurrent-ruby (1.1.6)
@@ -29,13 +29,13 @@ GEM
     jaro_winkler (1.5.4)
     method_source (1.0.0)
     minitest (5.14.1)
-    parallel (1.19.1)
+    parallel (1.19.2)
     parser (2.7.1.3)
       ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
     rexml (3.2.4)
@@ -79,7 +79,7 @@ GEM
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
     simplecov-lcov (0.8.0)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)

data/README.md

@@ -1,26 +1,114 @@
-# 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.
+* **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.
+
+### 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
+```
 
-TODO: Write usage instructions here
+## 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 +118,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/lib/ci_helper/commands.rb

@@ -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_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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci-helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - JustAnotherDude
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -178,6 +178,7 @@ files:
 - 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/tools/colorize.rb