sleeping_king_studios-tasks 0.1.0.rc.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 23b7118b16d2e49bdf0cce8ae9fc851a9dc15e65
-  data.tar.gz: 871a76c2aca5508af7274c523b490b280e5bf88e
+SHA256:
+  metadata.gz: c9380cfb581917cac00ae5102325dd895fcbd1364b4d8a53844f9ead55a41173
+  data.tar.gz: 69647411117043bf53bf24c4f47231de7d970de6c3adff412cc4a5228af7939e
 SHA512:
-  metadata.gz: cd3215b9178f05d13cbc1242de1a29fadbe73b4d09c69c7fcb867135286e945df6ad16073945174afd352d93fe8393a6ad49c647c538a90a92cc8fdf6a1e96fb
-  data.tar.gz: 9d07f269ef18d991864ae874b6355c531d1c111857b4f4891adf8f782b1a490062e49c314790d762c581dce0d7bad25b363cc6f42ee062f29280ce6ef1c32289
+  metadata.gz: 563983af6ab016118a21b810e8c5b2f61ef915ddee3bdce425f8945c5bf2bfb5dfc21a14acf8a07a7c08776443fd0cf7e46e5f96ff2c708a88f0834e4d856e51
+  data.tar.gz: 0b2d75151cc7513903514ed8f60041c5b7e73b2723373ceedb7f904a65059e8815f100f9cb54f745c6619274650f3ca7b2da063b50082b5548159fcf0d3918d9

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.3.0
+
+- Fix deprecation warnings in Ruby 2.7.
+- Add support for Thor 1.0.
+
+## 0.2.0
+
+### Ci
+
+- Implement tasks for Jest.js, ESLint.
+- Add --format option, configuration value for RSpec, RSpec (Each) tasks.
+
 ## 0.1.0
 
 Initial commit.

data/DEVELOPMENT.md

@@ -1,13 +1,12 @@
 ## Tasks
 
-### 0.1.0
+### Version 0.2.1
 
-- task names should be strings, not symbols
-- formalize (public) task names as _Task, _task.rb ?
-- documentation pass
+- add --retry option to Cucumber task.
 
 ### Future Tasks
 
+- add documentation for "ci" option in applications.yml
 - integration testing for RSpec, RSpecEach tasks
   - sample spec files with known output(s)
 - extract common Results object superclass
@@ -22,6 +21,12 @@
 
 #### CI
 
+- configurable --format options for CI steps
+
+- task ci:rspec_each: |
+
+  Default to displaying --format=progress.
+
 - task ci:steps: |
 
   Add --diff option

data/README.md

@@ -169,9 +169,11 @@ In addition, the cucumber step has the additional option:
 
 - `default_files [Array]`: Files that are always loaded when running Cucumber, such as step definitions or support files. By default, this includes 'step_definitions.rb' and the 'step_definitions' directory inside 'features'.
 
-`config.ci.rspec [Hash]`: Step configuration for the RSpec step. Has the same options as `config.ci.cucumber`, above, except for the aforementioned `default_files` option.
+`config.ci.rspec [Hash]`: Step configuration for the RSpec step. Has the same options as `config.ci.cucumber`, above, except for the aforementioned `default_files` option. In addition, the RSpec task has the following option:
 
-`config.ci.rspec_each [Hash]`: Step configuration for the RSpec Each step.
+- `format [String]`: The RSpec formatter used to format the spec results. Defaults to 'documentation'.
+
+`config.ci.rspec_each [Hash]`: Step configuration for the RSpec Each step. Has the same configuration options as the RSpec step.
 
 `config.ci.rubocop [Hash]`: Step configuration for the RuboCop step.
 

data/lib/sleeping_king_studios/tasks/apps/bundle/tasks.thor

@@ -0,0 +1,15 @@
+# lib/sleeping_king_studios/tasks/apps/bundle/tasks.thor
+
+require 'sleeping_king_studios/tasks/apps/bundle'
+require 'sleeping_king_studios/tasks/apps/bundle/install_task'
+require 'sleeping_king_studios/tasks/apps/bundle/update_task'
+
+module SleepingKingStudios::Tasks::Apps::Bundle
+  # Thor integration for application gem dependency tasks.
+  class Tasks < SleepingKingStudios::Tasks::TaskGroup
+    namespace :"apps:bundle"
+
+    task SleepingKingStudios::Tasks::Apps::Bundle::InstallTask
+    task SleepingKingStudios::Tasks::Apps::Bundle::UpdateTask
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/apps/ci/rspec_task.rb

@@ -22,7 +22,7 @@ module SleepingKingStudios::Tasks::Apps::Ci
 
     def call *applications
       SleepingKingStudios::Tasks::Apps::Ci::StepsTask.
-        new(options.merge('only' => %w(rspec))).
+        new(options.merge('only' => %w[rspec])).
         call(*applications)
     end # method call
   end # class

data/lib/sleeping_king_studios/tasks/apps/ci/rubocop_task.rb

@@ -22,7 +22,7 @@ module SleepingKingStudios::Tasks::Apps::Ci
 
     def call *applications
       SleepingKingStudios::Tasks::Apps::Ci::StepsTask.
-        new(options.merge('only' => %w(rubocop))).
+        new(options.merge('only' => %w[rubocop])).
         call(*applications)
     end # method call
   end # class

data/lib/sleeping_king_studios/tasks/apps/ci/tasks.thor

@@ -0,0 +1,20 @@
+# lib/sleeping_king_studios/tasks/apps/ci/tasks.thor
+
+require 'sleeping_king_studios/tasks/apps/ci'
+require 'sleeping_king_studios/tasks/apps/ci/rspec_task'
+require 'sleeping_king_studios/tasks/apps/ci/rubocop_task'
+require 'sleeping_king_studios/tasks/apps/ci/simplecov_task'
+require 'sleeping_king_studios/tasks/apps/ci/steps_task'
+
+module SleepingKingStudios::Tasks::Apps::Ci
+  # Thor integration for continuous integration tasks in semi-distributed
+  # applications.
+  class Tasks < SleepingKingStudios::Tasks::TaskGroup
+    namespace :"apps:ci"
+
+    task SleepingKingStudios::Tasks::Apps::Ci::RSpecTask
+    task SleepingKingStudios::Tasks::Apps::Ci::RuboCopTask
+    task SleepingKingStudios::Tasks::Apps::Ci::SimpleCovTask
+    task SleepingKingStudios::Tasks::Apps::Ci::StepsTask
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/ci/cucumber_parser.rb

@@ -65,11 +65,12 @@ module SleepingKingStudios::Tasks::Ci
 
         status = step_status(step) || 'failed'
 
-        if status == 'failed'
+        case status
+        when 'failed'
           report['failing_step_count'] += 1
-        elsif status == 'pending' || status == 'skipped'
+        when 'pending', 'skipped'
           report['pending_step_count'] += 1
-        end # if
+        end
 
         status
       end # method parse_step

data/lib/sleeping_king_studios/tasks/ci/cucumber_results.rb

@@ -167,7 +167,7 @@ module SleepingKingStudios::Tasks::Ci
     end # method build_summary_details
 
     def keys
-      %w(
+      %w[
         duration
         step_count
         pending_step_count
@@ -175,7 +175,7 @@ module SleepingKingStudios::Tasks::Ci
         scenario_count
         pending_scenarios
         failing_scenarios
-      ) # end keys
+      ] # end keys
     end # method keys
 
     def pluralize count, singular, plural = nil

data/lib/sleeping_king_studios/tasks/ci/cucumber_task.rb

@@ -33,7 +33,7 @@ module SleepingKingStudios::Tasks::Ci
     private
 
     def cucumber_runner
-      opts = %w(--color)
+      opts = %w[--color]
       opts << '--format=pretty' unless quiet?
 
       CucumberRunner.new(:options => opts)

data/lib/sleeping_king_studios/tasks/ci/eslint_results.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Encapsulates the results of an Eslint call.
+  class EslintResults
+    # @param results [Hash] The raw results of the Eslint call.
+    def initialize results
+      @results = results
+    end
+
+    # @param other [EslintResults] The other results object to compare.
+    #
+    # @return [Boolean] True if the results are equal, otherwise false.
+    def == other
+      if other.is_a?(Array)
+        empty? ? other.empty? : @results == other
+      elsif other.is_a?(EslintResults)
+        to_h == other.to_h
+      else
+        false
+      end
+    end
+
+    # @return [Boolean] True if there are no inspected files, otherwise false.
+    def empty?
+      inspected_file_count.zero?
+    end
+
+    # @return [Integer] The total number of error results across all files.
+    def error_count
+      @error_count ||= @results.map { |hsh| hsh['errorCount'] }.sum
+    end
+
+    # @return [Boolean] True if there are no errors or warnings, otherwise
+    #   false.
+    def failing?
+      !(error_count.zero? && warning_count.zero?)
+    end
+
+    # @return [Integer] The number of inspected files.
+    def inspected_file_count
+      @results.size
+    end
+
+    # @return [Boolean] Always false. Both warnings and errors trigger a failure
+    #   state.
+    def pending?
+      false
+    end
+
+    # @return [Hash] The hash representation of the results.
+    def to_h
+      {
+        'inspected_file_count' => inspected_file_count,
+        'error_count'          => error_count,
+        'warning_count'        => warning_count
+      }
+    end
+
+    # @return [String] The string representation of the results.
+    def to_s # rubocop:disable Metrics/AbcSize
+      str = +"#{pluralize inspected_file_count, 'file'} inspected"
+
+      str << ", #{pluralize error_count, 'error'}"
+
+      str << ", #{pluralize warning_count, 'warning'}"
+
+      str << "\n" unless non_empty_results.empty?
+
+      non_empty_results.each do |hsh|
+        str << "\n    #{format_result_item(hsh)}"
+      end
+
+      str
+    end
+
+    # @return [Integer] The total number of warning results across all files.
+    def warning_count
+      @warning_count ||= @results.map { |hsh| hsh['warningCount'] }.sum
+    end
+
+    private
+
+    def format_result_item hsh
+      str = +relative_path(hsh['filePath'])
+
+      str << ": #{pluralize hsh['errorCount'], 'error'}"
+
+      str << ", #{pluralize hsh['warningCount'], 'warning'}"
+    end
+
+    def non_empty_results
+      @results.reject do |hsh|
+        hsh['errorCount'].zero? && hsh['warningCount'].zero?
+      end
+    end
+
+    def pluralize count, singular, plural = nil
+      "#{count} #{tools.integer.pluralize count, singular, plural}"
+    end
+
+    def relative_path path
+      path.sub(/\A#{Dir.getwd}#{File::SEPARATOR}?/, '')
+    end
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+  end
+end

data/lib/sleeping_king_studios/tasks/ci/eslint_runner.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/process_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Service object to run Eslint as an external process with the specified
+  # parameters.
+  class EslintRunner < SleepingKingStudios::Tasks::ProcessRunner
+    def call env: {}, files: [], options: [], report: true
+      report  = 'tmp/ci/eslint.json' if report && !report.is_a?(String)
+      command =
+        build_command(
+          :env     => env,
+          :files   => files,
+          :options => options,
+          :report  => report
+        )
+
+      stream_process(command)
+
+      report ? load_report(:report => report) : []
+    end
+
+    private
+
+    def base_command
+      'yarn eslint'
+    end
+
+    def build_options files:, options:, report:, **_kwargs
+      files = default_files if files.empty?
+      options += ['--format=json', "--output-file=#{report}"] if report
+
+      super :files => files, :options => options
+    end
+
+    def default_files
+      SleepingKingStudios::Tasks.configuration.ci.eslint.
+        fetch(:default_files, '"**/*.js"')
+    end
+
+    def load_report report:
+      raw = File.read report
+
+      JSON.parse raw
+    rescue
+      []
+    end
+  end
+end

data/lib/sleeping_king_studios/tasks/ci/eslint_task.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/eslint_results'
+require 'sleeping_king_studios/tasks/ci/eslint_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Defines a Thor task for running the Eslint linter.
+  class EslintTask < SleepingKingStudios::Tasks::Task
+    def self.description
+      'Runs the ESLint linter.'
+    end
+
+    def self.task_name
+      'eslint'
+    end
+
+    def call *files
+      results = eslint_runner.call(:files => files)
+
+      EslintResults.new(results)
+    end
+
+    private
+
+    def eslint_runner
+      opts = %w[--color]
+
+      EslintRunner.new(:options => opts)
+    end
+  end
+end

data/lib/sleeping_king_studios/tasks/ci/jest_results.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Encapsulates the results of a Jest call.
+  class JestResults
+    # @param results [Hash] The raw results of the Jest call.
+    def initialize results
+      @results = results
+    end
+
+    # @param other [JestResults] The other results object to compare.
+    #
+    # @return [Boolean] True if the results are equal, otherwise false.
+    def == other
+      if other.is_a?(Hash)
+        empty? ? other.empty? : @results == other
+      elsif other.is_a?(JestResults)
+        to_h == other.to_h
+      else
+        false
+      end
+    end
+
+    # @return [Float] The duration value, in seconds.
+    def duration
+      (end_time - start_time).to_f / 1000
+    end
+
+    # @return [Boolean] True if there are no tests, otherwise false.
+    def empty?
+      test_count.zero?
+    end
+
+    # @return [Boolean] True if there are any failing tests, otherwise false.
+    def failing?
+      !failure_count.zero?
+    end
+
+    # @return [Integer] The number of failing tests.
+    def failure_count
+      @results.fetch('numFailedTests', 0)
+    end
+
+    # @return [Boolean] True if there are any pending tests, otherwise false.
+    def pending?
+      !pending_count.zero?
+    end
+
+    # @return [Intger] The number of pending tests.
+    def pending_count
+      @results.fetch('numPendingTests', 0)
+    end
+
+    # @return [Integer] The total number of tests.
+    def test_count
+      @results.fetch('numTotalTests', 0)
+    end
+
+    # @return [Hash] The hash representation of the results.
+    def to_h
+      {
+        'duration'      => duration,
+        'failure_count' => failure_count,
+        'pending_count' => pending_count,
+        'test_count'    => test_count
+      }
+    end
+
+    # @return [String] The string representation of the results.
+    def to_s # rubocop:disable Metrics/AbcSize
+      str = +pluralize(test_count, 'test')
+
+      str << ', ' << pluralize(failure_count, 'failure')
+
+      str << ', ' << pending_count.to_s << ' pending' if pending?
+
+      str << " in #{duration.round(2)} seconds"
+    end
+
+    private
+
+    def end_time
+      return 0 unless @results['testResults']
+
+      @results['testResults'].
+        map { |test_result| test_result['endTime'] }.
+        reduce do |memo, time|
+          [memo, time].max
+        end
+    end
+
+    def pluralize count, singular, plural = nil
+      "#{count} #{tools.integer.pluralize count, singular, plural}"
+    end
+
+    def start_time
+      @results['startTime'] || 0
+    end
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+  end
+end