sleeping_king_studios-tasks 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 03f905500258c4aa80931f51df259ef2315a42e1
-  data.tar.gz: 37b0c7ebdf7af0066633302858264a6e019febbe
+SHA256:
+  metadata.gz: ddfbfc40ee6294af3eecd6e729ea837d4744f193e516320348de5410885db19e
+  data.tar.gz: ebd8165cbfeb62882af9d327d01632cd3eb56c8c8c89e9ade902281198858846
 SHA512:
-  metadata.gz: 9398af7d0a0ed84066289b79d2fa972dc89f016a2a57fd722a993d3e264beaed97e7227beeab2fa6d9ab42c8941b1f4fb016f3427c3330b1bf24901b5eb96776
-  data.tar.gz: a7cd72d7ab6fc247f878714d5660f54245c15da97e851c91ff5598b59626dcbebe93f01218bb9c1b6867c0c0f894fb804fba433431a2ee60e2f565c6ab4bdeb6
+  metadata.gz: 943e07b91a67a3dcef63beb1115c1c36ff4d0f302c700d10811bbd50770229104cf79918872fc26fa4d1959345f7b20dd84250bfb7faced58cbeff0a8b64a8f6
+  data.tar.gz: b820d7614f276d330d109422704e26dd0a6b694a86d949fd0607ab6c4730b439b58b2250e81cc9ca104d7abdcf53bd86dae9805460d0608cb656a509dfd93c8d

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.4.1
+
+- Add gem compatibility with SleepingKingStudios::Tools 1.0 release.
+
+## 0.4.0
+
+- Fix deprecations from SleepingKingStudios::Tools.
+- Add support for Ruby 3.0.
+
+## 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,5 +1,9 @@
 ## Tasks
 
+### Version 0.2.1
+
+- add --retry option to Cucumber task.
+
 ### Future Tasks
 
 - add documentation for "ci" option in applications.yml

data/README.md

@@ -1,5 +1,7 @@
 # SleepingKingStudios::Tasks [![Build Status](https://travis-ci.org/sleepingkingstudios/sleeping_king_studios-tasks.svg?branch=master)](https://travis-ci.org/sleepingkingstudios/sleeping_king_studios-tasks)
 
+**Note:** This project is deprecated, and will not receive further feature updates.
+
 A toolkit providing an encapsulation layer around the Thor CLI library, with predefined tasks for development and continuous integration.
 
 See also [https://github.com/erikhuda/thor](https://github.com/erikhuda/thor).
@@ -10,10 +12,6 @@ See also [https://github.com/erikhuda/thor](https://github.com/erikhuda/thor).
 
 The canonical repository for this gem is on [GitHub](https://github.com/sleepingkingstudios/sleeping_king_studios-tasks).
 
-### A Note From The Developer
-
-Hi, I'm Rob Smith, a Ruby Engineer and the developer of this library. I use these tools every day, but they're not just written for me. If you find this project helpful in your own work, or if you have any questions, suggestions or critiques, please feel free to get in touch! I can be reached on GitHub (see above, and feel encouraged to submit bug reports or merge requests there) or via email at `merlin@sleepingkingstudios.com`. I look forward to hearing from you!
-
 ## Task Classes
 
 SleepingKingStudios::Tasks defines a wrapper around the Thor CLI.
@@ -169,9 +167,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:
+
+- `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.
+`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.rb

@@ -23,7 +23,7 @@ module SleepingKingStudios::Tasks
 
           apps.each do |key, data|
             name = key.to_s
-            data = tools.hash.convert_keys_to_symbols(data)
+            data = tools.hsh.convert_keys_to_symbols(data)
 
             data[:name] ||= name
 

data/lib/sleeping_king_studios/tasks/apps/app_configuration.rb

@@ -49,7 +49,7 @@ module SleepingKingStudios::Tasks::Apps
 
     define_method :short_name do
       # rubocop:disable Style/RedundantSelf
-      tools.string.underscore(self.name.gsub(/\s+/, '_'))
+      tools.str.underscore(self.name.gsub(/\s+/, '_'))
       # rubocop:enable Style/RedundantSelf
     end # define_method
 

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

@@ -1,6 +1,6 @@
 # lib/sleeping_king_studios/tasks/apps/ci/results_reporter.rb
 
-require 'sleeping_king_studios/tools/toolbox/delegator'
+require 'forwardable'
 
 require 'sleeping_king_studios/tasks/apps/ci'
 require 'sleeping_king_studios/tasks/ci/results_helpers'
@@ -9,21 +9,23 @@ module SleepingKingStudios::Tasks::Apps::Ci
   # Reports on the results of a multi-application continuous integration
   # process, printing the step results grouped by application.
   class ResultsReporter
-    extend SleepingKingStudios::Tools::Toolbox::Delegator
+    extend Forwardable
 
     include SleepingKingStudios::Tasks::Ci::ResultsHelpers
 
-    delegate \
-      :applications,
+    def_delegators :@context,
       :print_table,
       :say,
-      :set_color,
-      :to => :@context
+      :set_color
 
     def initialize context
       @context = context
     end # method initialize
 
+    def applications
+      @context.send(:applications)
+    end
+
     def call results
       width = 1 + heading_width(results)
 

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/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,11 +175,11 @@ module SleepingKingStudios::Tasks::Ci
         scenario_count
         pending_scenarios
         failing_scenarios
-      ) # end keys
+      ] # end keys
     end # method keys
 
     def pluralize count, singular, plural = nil
-      "#{count} #{tools.integer.pluralize count, singular, plural}"
+      "#{count} #{tools.int.pluralize count, singular, plural}"
     end # method pluralize
 
     def tools

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.int.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.int.pluralize count, singular, plural}"
+    end
+
+    def start_time
+      @results['startTime'] || 0
+    end
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+  end
+end