ci-helper 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af54c4df4f96a962deb3ab2acbbbf2b189d1a14f945f1ad17501a196237babdc
-  data.tar.gz: 73211997e92fca4b8873e9e0e1c8dafc4f208cba7c41618500d136ec639c7e62
+  metadata.gz: 2b4de79227e8355d1648143f4d35abcd08c1ddf9be79f4ad32521c734a4fb74e
+  data.tar.gz: 9d0d15a617492173e9e331fd973fe71894ed4d2f81ac512e2ba2ca754507c23f
 SHA512:
-  metadata.gz: 3efa5ce49a800e019fa1a5b86f3d6d46132b91fb5eeb343d52f72a2052b5beec94ce8001e3c54edf180a2c7a45588217a464085aa4b191064106204f29ccf317
-  data.tar.gz: 6a91623e8a061aab27caa74e6f74a7dbf24a095ff821b5984fbd62672976f69dbf8615cf7772334e212e6052ee699cb538198efac70b2f31a6f00984fb59d46f
+  metadata.gz: c3025f9be4194acd855eabe134d7b1f28f2209e84e11f4e5d974b32ef086f85b6a37bb226303b674dd2b4151b17250a9b3f613df66369a1c346b99f83dc28426
+  data.tar.gz: 48a8fddce07d4587935d4901e912a0e6e58d41c281251e87668d283892c9b722878c0429214c96c7b474347461dca56fec4d5b0bad8b72cbc97e095469a160df

data/.github/workflows/test.yml

@@ -0,0 +1,61 @@
+name: Test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+
+env:
+  FULL_COVERAGE_CHECK: true
+
+jobs:
+  full-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3
+          bundler-cache: true
+      - name: Build and install gem to systems gems
+        run: bundle exec rake install
+      - name: Run Linter
+        run: bundle exec ci-helper RubocopLint
+      - name: Check missed spec suffixes
+        run: bundle exec ci-helper CheckSpecSuffixes --extra-paths spec/*.rb --ignored-paths spec/*_helper.rb
+      - name: Run specs
+        run: bundle exec ci-helper RunSpecs
+      - name: Audit
+        run: bundle exec ci-helper BundlerAudit
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+  specs:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+
+    env:
+      FULL_TEST_COVERAGE_CHECK: false
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+        experimental: [false]
+        include:
+          - ruby: head
+            experimental: true
+
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run specs
+        run: bundle exec rspec

data/.rubocop.yml

@@ -14,3 +14,7 @@ RSpec/EmptyLineAfterHook:
 Naming/FileName:
   Exclude:
     - lib/ci-helper.rb
+
+Style/HashConversion:
+  Exclude:
+    - spec/**/*_spec.rb

data/README.md

@@ -31,8 +31,10 @@ A command can accept list of options (parameters). Option values are passed thro
 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.
+If command accepts array as option's value, you can separate values with either commas or spaces.
 ```bash
-$ ci-helper BundlerAudit --ignored-advisories first,second
+$ ci-helper BundlerAudit --ignored-advisories first,second # Valid
+$ ci-helper BundlerAudit --ignored-advisories first second # Valid too!
 ```
 
 List of available commands:
@@ -63,12 +65,19 @@ List of available commands:
     * `--ignored-paths [values]` - accepts path patterns that should be ignored,
         delimited by coma.
 * **CheckCoverage** — checks coverage by executing `SimpleCov::collate`.
-    You should set `SimpleCov::minimum_coverage` in your `spec_helper.rb` file.
-    Accepted flags: `--split-resultset`.
+    Accepted flags: `--split-resultset`, `--setup-file-path`.
     * `--split-resultset` — if you execute command `RunSpecs` with `--split-resultset true`,
         you also should set this flag to `true`. If this flag set to `true`, final coverage will be
         calculated by merging results in all files, matching the mask `coverage/resultset.*.json`.
         By default final coverage is calculated using result from `coverage/.resultset.json`.
+    * `--setup-file-path` — relative path to your `.rb` file, which setups `SimpleCov`.
+      Usually it is `spec_helper.rb`.
+* **CheckSidekiqSchedulerConfig** — checks `sidekiq_scheduler` config by trying to resolve jobs constants via `rails runner`.
+    Accepted flags: `--config-path`
+    * `--config-path` — relative path to your config yaml file with schedule.
+      Usually it is `config/sidekiq_scheduler.yml`.
+    * `--with-database` — if you want to prepare database before executing specs,
+      you should set this flag to `true`.
 
 ### Rake Tasks
 

data/lib/ci_helper/cli.rb

@@ -26,13 +26,14 @@ module CIHelper
     end
 
     def parse_options_from(args)
-      args.each_slice(2).with_object({}) do |args, options|
-        key = Tools::Inflector.instance.underscore(args.first.split("--").last)
-        value = args[1] || ""
-        raise Error, "Not valid options" if key.empty?
-
-        options[key.to_sym] = value
-      end
+      args
+        .slice_when { |_el_before, el_after| el_after.start_with?("--") }
+        .each_with_object({}) do |commands, options|
+          key = Tools::Inflector.instance.underscore(commands.shift.split("--").last)
+          raise "Invalid options" if key.empty?
+          value = commands.size <= 1 ? commands.first : commands
+          options[key.to_sym] = value || ""
+        end
     end
 
     def perform_command!

data/lib/ci_helper/commands.rb

@@ -54,8 +54,15 @@ module CIHelper
         raise Error, message
       end
 
+      def boolean_option(key)
+        options[key] == "true"
+      end
+
       def plural_option(key)
         return [] unless options.key?(key)
+        value = options[key]
+        return value if value.is_a?(Array)
+
         options[key].split(",")
       end
 

data/lib/ci_helper/commands/check_coverage.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require "simplecov"
+
 module CIHelper
   module Commands
     class CheckCoverage < BaseCommand
       def call
-        SimpleCov.collate(files)
+        require(path.join(setup_file_path)) unless setup_file_path.nil?
+
+        ::SimpleCov.collate(files)
         0
       end
 
@@ -17,7 +21,11 @@ module CIHelper
       end
 
       def split_resultset?
-        options[:split_resultset] == "true"
+        boolean_option(:split_resultset)
+      end
+
+      def setup_file_path
+        options[:setup_file_path]
       end
     end
   end

data/lib/ci_helper/commands/check_sidekiq_scheduler_config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module CIHelper
+  module Commands
+    class CheckSidekiqSchedulerConfig < BaseCommand
+      def call
+        return 0 if job_constants.empty?
+
+        create_and_migrate_database! if with_database?
+        cmd = craft_jobs_const_get_cmd
+        execute_with_rails_runner(cmd)
+        0
+      end
+
+      private
+
+      def env
+        :development
+      end
+
+      def execute_with_rails_runner(cmd)
+        execute("bundle exec rails runner '#{cmd}'")
+      end
+
+      def craft_jobs_const_get_cmd
+        "#{job_constants}.each { |x| Object.const_get(x) }"
+      end
+
+      def job_constants
+        @job_constants ||= config.values.reject(&:nil?).flat_map(&:keys).uniq
+      end
+
+      def with_database?
+        boolean_option(:with_database)
+      end
+
+      def config
+        @config ||= YAML.load_file(options[:config_path])
+      end
+    end
+  end
+end

data/lib/ci_helper/commands/run_specs.rb

@@ -37,11 +37,11 @@ module CIHelper
       end
 
       def with_database?
-        options[:with_database] == "true"
+        boolean_option(:with_database)
       end
 
       def split_resultset?
-        options[:split_resultset] == "true"
+        boolean_option(:split_resultset)
       end
     end
   end

data/lib/ci_helper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ci-helper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - JustAnotherDude
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -173,7 +173,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -193,6 +193,7 @@ files:
 - lib/ci_helper/commands/check_coverage.rb
 - lib/ci_helper/commands/check_db_development.rb
 - lib/ci_helper/commands/check_db_rollback.rb
+- lib/ci_helper/commands/check_sidekiq_scheduler_config.rb
 - lib/ci_helper/commands/check_spec_suffixes.rb
 - lib/ci_helper/commands/rubocop_lint.rb
 - lib/ci_helper/commands/run_specs.rb
@@ -207,7 +208,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/umbrellio/ci_helper
   source_code_uri: https://github.com/umbrellio/ci_helper
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Continuous Integration helpers for Ruby
 test_files: []

data/.github/workflows/ruby.yml

@@ -1,84 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-env:
-  FULL_COVERAGE_CHECK: true
-
-jobs:
-  test-latest:
-
-    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.7
-    - 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 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
-      run: ci-helper BundlerAudit
-    - name: Coveralls
-      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