sleeping_king_studios-tasks 0.1.0.rc.0

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

@@ -0,0 +1,62 @@
+# lib/sleeping_king_studios/tasks/ci/rspec_runner.rb
+
+require 'json'
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/process_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Service object to run RSpec as an external process with the specified
+  # parameters.
+  class RSpecRunner < SleepingKingStudios::Tasks::ProcessRunner
+    def call env: {}, files: [], options: [], report: true
+      report  = 'tmp/ci/rspec.json' if report && !report.is_a?(String)
+      command =
+        build_command(
+          :env     => env,
+          :files   => files,
+          :options => options,
+          :report  => report
+        ) # end build_command
+
+      stream_process(command)
+
+      report ? load_report(:report => report) : {}
+    end # method call
+
+    private
+
+    def base_command
+      'bundle exec rspec'
+    end # method base_command
+
+    def build_options files:, options:, report:, **_kwargs
+      options += ['--format=json', "--out=#{report}"] if report
+
+      super :files => files, :options => options
+    end # method build_options
+
+    def load_report report:
+      raw = File.read report
+
+      return {} if raw.empty?
+
+      json = JSON.parse raw
+      hsh  = json['summary']
+
+      hsh['error_count'] = parse_errors(json['summary_line'])
+
+      hsh
+    rescue
+      {}
+    end # method load_report
+
+    def parse_errors summary
+      return 0 unless summary && !summary.empty?
+
+      match = summary.match(/(?<digits>\d+) error/)
+
+      match ? match[:digits].to_i : 0
+    end # method parse_errors
+  end # class
+end # module

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

@@ -0,0 +1,71 @@
+# lib/sleeping_king_studios/tasks/ci/rspec_task.rb
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/rspec_results'
+require 'sleeping_king_studios/tasks/ci/rspec_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Defines a Thor task for running the full RSpec test suite.
+  class RSpecTask < SleepingKingStudios::Tasks::Task
+    def self.description
+      'Runs the RSpec test suite.'
+    end # class method description
+
+    def self.task_name
+      'rspec'
+    end # class method task_name
+
+    option :coverage,
+      :type    => :boolean,
+      :desc    => 'Enable or disable coverage with SimpleCov, if available.'
+    option :gemfile,
+      :type    => :string,
+      :desc    => 'The Gemfile used to run the specs.',
+      :default => ENV['BUNDLE_GEMFILE']
+    option :quiet,
+      :aliases => '-q',
+      :type    => :boolean,
+      :default => false,
+      :desc    => 'Do not write spec results to STDOUT.'
+    option :raw,
+      :aliases => '-r',
+      :type    => :boolean,
+      :default => false,
+      :desc    => 'Return a Hash instead of a results object.'
+
+    def call *files
+      results = rspec_runner(files.empty?).call(:files => files)
+
+      raw? ? results : RSpecResults.new(results)
+    end # method call
+
+    private
+
+    def default_gemfile
+      File.join(Dir.pwd, 'Gemfile')
+    end # method default_gemfile
+
+    def gemfile
+      return options['gemfile'] if options.key?('gemfile')
+
+      gemfile = ENV['BUNDLE_GEMFILE']
+
+      return gemfile if gemfile && gemfile != default_gemfile
+
+      nil
+    end # method gemfile
+
+    def rspec_runner default_coverage = true
+      coverage = options.fetch('coverage', default_coverage)
+
+      env = options.fetch('__env__', {})
+      env[:bundle_gemfile] = gemfile if gemfile
+      env[:coverage]       = false unless coverage
+
+      opts = %w(--color --tty)
+      opts << '--format=documentation' unless quiet?
+
+      RSpecRunner.new(:env => env, :options => opts)
+    end # method rspec_runner
+  end # class
+end # module

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

@@ -0,0 +1,80 @@
+# lib/sleeping_king_studios/tasks/ci/rubocop_results.rb
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Encapsulates the results of a RuboCop call.
+  class RuboCopResults
+    # @param results [Hash] The raw results of the RuboCop call.
+    def initialize results
+      @results = results
+    end # constructor
+
+    # @param other [RSpecResults] 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? : to_h == other
+      elsif other.is_a?(RuboCopResults)
+        to_h == other.to_h
+      else
+        false
+      end # if-elsif-else
+    end # method ==
+
+    # @return [Boolean] True if there are no inspected files, otherwise false.
+    def empty?
+      inspected_file_count.zero?
+    end # method empty?
+
+    # @return [Boolean] True if there are any offenses, otherwise false.
+    def failing?
+      !offense_count.zero?
+    end # method failing?
+
+    # @return [Integer] The number of inspected files.
+    def inspected_file_count
+      @results.fetch('inspected_file_count', 0)
+    end # method inspected_file_count
+
+    # Adds the given result values and returns a new results object with the
+    # sums.
+    #
+    # @param other [RuboCopResults] The results to add.
+    #
+    # @return [RuboCopResults] The total results.
+    def merge other
+      self.class.new(
+        'inspected_file_count' =>
+          inspected_file_count + other.inspected_file_count,
+        'offense_count'        => offense_count + other.offense_count
+      ) # end new
+    end # method merge
+
+    # @return [Integer] The number of detected offenses.
+    def offense_count
+      @results.fetch('offense_count', 0)
+    end # method offense_count
+
+    # @return [Boolean] False.
+    def pending?
+      false
+    end # method pending?
+
+    # @return [Hash] The hash representation of the results.
+    def to_h
+      {
+        'inspected_file_count' => inspected_file_count,
+        'offense_count'        => offense_count
+      } # end hash
+    end # method to_h
+
+    # @return [String] The string representation of the results.
+    def to_s
+      str = "#{inspected_file_count} files inspected"
+
+      str << ", #{offense_count} offenses"
+    end # method to_s
+  end # class
+end # module

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

@@ -0,0 +1,46 @@
+# lib/sleeping_king_studios/tasks/ci/rubocop_runner.rb
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/process_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Service object to run RuboCop as an external process with the specified
+  # parameters.
+  class RuboCopRunner < SleepingKingStudios::Tasks::ProcessRunner
+    def call env: {}, files: [], options: [], report: true
+      report  = 'tmp/ci/rubocop.json' if report && !report.is_a?(String)
+      command =
+        build_command(
+          :env     => env,
+          :files   => files,
+          :options => options,
+          :report  => report
+        ) # end build_command
+
+      stream_process(command)
+
+      report ? load_report(:report => report) : {}
+    end # method call
+
+    private
+
+    def base_command
+      'bundle exec rubocop'
+    end # method base_command
+
+    def build_options files:, options:, report:, **_kwargs
+      options += ['--format=json', "--out=#{report}"] if report
+
+      super :files => files, :options => options
+    end # method build_options
+
+    def load_report report:
+      raw  = File.read report
+      json = JSON.parse raw
+
+      json['summary']
+    rescue
+      {}
+    end # method load_report
+  end # class
+end # module

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

@@ -0,0 +1,44 @@
+# lib/sleeping_king_studios/tasks/ci/rubocop_task.rb
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/rubocop_results'
+require 'sleeping_king_studios/tasks/ci/rubocop_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Defines a Thor task for running the RuboCop linter.
+  class RuboCopTask < SleepingKingStudios::Tasks::Task
+    def self.description
+      'Runs the RuboCop linter.'
+    end # class method description
+
+    def self.task_name
+      'rubocop'
+    end # class method task_name
+
+    option :quiet,
+      :aliases => '-q',
+      :type    => :boolean,
+      :default => false,
+      :desc    => 'Do not write lint results to STDOUT.'
+    option :raw,
+      :aliases => '-r',
+      :type    => :boolean,
+      :default => false,
+      :desc    => 'Return a Hash instead of a results object.'
+
+    def call *files
+      results = rubocop_runner.call(:files => files)
+
+      raw? ? results : RuboCopResults.new(results)
+    end # method call
+
+    private
+
+    def rubocop_runner
+      opts = %w(--color)
+      opts << '--format=progress' unless quiet?
+
+      RuboCopRunner.new(:options => opts)
+    end # method rubocop_runner
+  end # class
+end # module

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

@@ -0,0 +1,62 @@
+# lib/sleeping_king_studios/tasks/ci/simplecov_results.rb
+
+require 'sleeping_king_studios/tools/toolbox/delegator'
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Encapsulates the results of aggregated SimpleCov data.
+  class SimpleCovResults
+    extend SleepingKingStudios::Tools::Toolbox::Delegator
+
+    # @param results [SimpleCov::Result] The raw results of the SimpleCov call.
+    def initialize results
+      @results = results
+    end # constructor
+
+    delegate \
+      :covered_lines,
+      :covered_percent,
+      :missed_lines,
+      :total_lines,
+      :to => :@results
+
+    # @return [Boolean] True if there are no covered lines, otherwise false.
+    def empty?
+      covered_lines.zero?
+    end # method empty?
+
+    # @return [Boolean] True if the covered percentage is less than or equal to
+    #   the configured value, otherwise false.
+    def failing?
+      covered_percent.round(1) <= failing_percent.round(1)
+    end # method failing?
+
+    # @return [Float] If the covered percentage is less than or equal to this
+    #   value, the result is failing.
+    def failing_percent
+      90.0
+    end # method failing_percent
+
+    # @return [Boolean] True if the covered percentage is less than or equal to
+    #   the configured value, otherwise false.
+    def pending?
+      !failing? && covered_percent.round(1) <= pending_percent.round(1)
+    end # method pending?
+
+    # @return [Float] If the covered percentage is less than or equal to this
+    #   value, the result is pending.
+    def pending_percent
+      95.0
+    end # method failing_percent
+
+    # @return [String] The string representation of the results.
+    def to_s
+      str = "#{covered_percent.round(2)}% coverage"
+
+      str << ", #{missed_lines} missed lines"
+
+      str << ", #{total_lines} total lines"
+    end # method to_s
+  end # class
+end # module

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

@@ -0,0 +1,25 @@
+# lib/sleeping_king_studios/tasks/ci/simplecov_task.rb
+
+require 'simplecov'
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/simplecov_results'
+
+module SleepingKingStudios::Tasks::Ci
+  # Defines a Thor task for aggregating SimpleCov results.
+  class SimpleCovTask < SleepingKingStudios::Tasks::Task
+    def self.description
+      'Aggregates the SimpleCov results.'
+    end # class method description
+
+    def self.task_name
+      'simplecov'
+    end # class method task_name
+
+    def call *_args
+      results = ::SimpleCov.result
+
+      SimpleCovResults.new(results)
+    end # method call
+  end # class
+end # module

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

@@ -0,0 +1,69 @@
+# lib/sleeping_king_studios/tasks/ci/steps_runner.rb
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Abstract base class for running a sequence of tasks from a configured list.
+  class StepsRunner < SleepingKingStudios::Tasks::Task
+    def call *args
+      results = {}
+
+      filtered_steps.each do |name, config|
+        next if skip_step?(name, config)
+
+        title = config.fetch(:title, name)
+
+        results[title] = call_step(config, args)
+      end # reduce
+
+      results
+    end # method call
+
+    private
+
+    def ci_steps
+      []
+    end # method ci_steps
+
+    def call_step config, args
+      class_name   = config[:class]
+      require_path = config.fetch(:require, require_path(class_name))
+
+      require require_path if require_path
+
+      step_class = Object.const_get(class_name)
+      instance   = step_class.new(options)
+
+      instance.call(*args)
+    end # method call_step
+
+    # rubocop:disable Metrics/AbcSize
+    def filtered_steps
+      filtered = ci_steps
+
+      if options.key?('except') && !options['except'].empty?
+        filtered =
+          filtered.reject { |key, _| options['except'].include?(key.to_s) }
+      end # if
+
+      if options.key?('only') && !options['only'].empty?
+        filtered =
+          filtered.select { |key, _| options['only'].include?(key.to_s) }
+      end # if
+
+      filtered
+    end # method filtered_steps
+    # rubocop:enable Metrics/AbcSize
+
+    def require_path class_name
+      class_name.
+        split('::').
+        map { |str| tools.string.underscore(str) }.
+        join '/'
+    end # method require_path
+
+    def skip_step? _name, _config
+      false
+    end # method skip_step?
+  end # class
+end # module