sleeping_king_studios-tasks 0.1.0.rc.0

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

@@ -0,0 +1,53 @@
+# lib/sleeping_king_studios/tasks/ci/cucumber_runner.rb
+
+require 'json'
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/cucumber_parser'
+require 'sleeping_king_studios/tasks/process_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Service object to run Cucumber as an external process with the specified
+  # parameters.
+  class CucumberRunner < SleepingKingStudios::Tasks::ProcessRunner
+    def call env: {}, files: [], options: [], report: true
+      report  = 'tmp/ci/cucumber.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 cucumber'
+    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
+      parser = SleepingKingStudios::Tasks::Ci::CucumberParser
+
+      parser.parse(json)
+    rescue
+      {}
+    end # method load_report
+  end # class
+end # module

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

@@ -0,0 +1,47 @@
+# lib/sleeping_king_studios/tasks/ci/cucumber_task.rb
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/cucumber_results'
+require 'sleeping_king_studios/tasks/ci/cucumber_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Defines a Thor task for running the full RSpec test suite.
+  class CucumberTask < SleepingKingStudios::Tasks::Task
+    def self.description
+      'Runs the Cucumber feature suite.'
+    end # class method description
+
+    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
+      files += default_files unless files.empty?
+
+      results = cucumber_runner.call(:files => files)
+
+      raw? ? results : CucumberResults.new(results)
+    end # method call
+
+    private
+
+    def cucumber_runner
+      opts = %w(--color)
+      opts << '--format=pretty' unless quiet?
+
+      CucumberRunner.new(:options => opts)
+    end # method cucumber_runner
+
+    def default_files
+      SleepingKingStudios::Tasks.configuration.ci.cucumber.
+        fetch('default_files', [])
+    end # method default_files
+  end # class
+end # module

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

@@ -0,0 +1,44 @@
+# lib/sleeping_king_studios/tasks/ci/results_helpers.rb
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Helper methods for reporting CI results.
+  module ResultsHelpers
+    private
+
+    # Returns a terminal color corresponding to the state of the results object.
+    #
+    # @param results [Object] The results object.
+    #
+    # @return [Symbol] The terminal color.
+    def results_color results
+      if results.failing?
+        :red
+      elsif results.respond_to?(:errored?) && results.errored?
+        :red
+      elsif results.pending? || results.empty?
+        :yellow
+      else
+        :green
+      end # if-elsif-else
+    end # method set_results_color
+
+    # Returns a state string for the results object.
+    #
+    # @param results [Object] The results object.
+    #
+    # @return [String] The results state.
+    def results_state results
+      if results.respond_to?(:errored?) && results.errored?
+        'Errored'
+      elsif results.failing?
+        'Failing'
+      elsif results.pending? || results.empty?
+        'Pending'
+      else
+        'Passing'
+      end # if-elsif-else
+    end # method results_state
+  end # module
+end # module

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

@@ -0,0 +1,118 @@
+# lib/sleeping_king_studios/tasks/ci/rspec_each_results.rb
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Encapsulates the results of an RSpecEach call.
+  class RSpecEachResults
+    # @param results [Hash] The raw results of the RSpecEach call.
+    def initialize results
+      @results = results
+    end # constructor
+
+    # @param other [RSpecEachResults] 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?(RSpecEachResults)
+        to_h == other.to_h
+      else
+        false
+      end # if-elsif-else
+    end # method ==
+
+    # @return [Float] The duration value.
+    def duration
+      @results.fetch('duration', 0.0)
+    end # method duration
+
+    # @return [Boolean] True if there are no files, otherwise false.
+    def empty?
+      file_count.zero?
+    end # method empty?
+
+    # @return [Boolean] True if there are any errored files, otherwise false.
+    def errored?
+      !errored_count.zero?
+    end # method errored?
+
+    # @return [Integer] The number of errored files.
+    def errored_count
+      errored_files.count
+    end # method errored_count
+
+    # @return [Array] The list of errored file names.
+    def errored_files
+      @results.fetch('errored_files', [])
+    end # method errored_files
+
+    # @return [Boolean] True if there are any failing files, otherwise false.
+    def failing?
+      !failure_count.zero?
+    end # method failing?
+
+    # @return [Array] The list of failing file names.
+    def failing_files
+      @results.fetch('failing_files', [])
+    end # method failing_files
+
+    # @return [Integer] The number of failing files.
+    def failure_count
+      failing_files.count
+    end # method failing_files
+
+    # @return [Integer] The total file count.
+    def file_count
+      @results.fetch('file_count', 0)
+    end # method file_count
+
+    # @return [Boolean] True if there are any pending files, otherwise false.
+    def pending?
+      !pending_count.zero?
+    end # method pending?
+
+    # @return [Integer] The number of pending files.
+    def pending_count
+      pending_files.count
+    end # method pending_count
+
+    # @return [Array] The list of pending file names.
+    def pending_files
+      @results.fetch('pending_files', [])
+    end # method pending_files
+
+    def pluralize count, singular, plural = nil
+      "#{count} #{tools.integer.pluralize count, singular, plural}"
+    end # method pluralize
+
+    # @return [Hash] The hash representation of the results.
+    def to_h
+      {
+        'failing_files' => failing_files,
+        'pending_files' => pending_files,
+        'errored_files' => errored_files,
+        'file_count'    => file_count,
+        'duration'      => duration
+      } # end hash
+    end # method to_h
+
+    # @return [String] The string representation of the results.
+    def to_s
+      str = "#{file_count} files"
+
+      str << ', ' << pluralize(failure_count, 'failure')
+
+      str << ", #{pending_count} pending" if pending?
+
+      str << ", #{errored_count} errored" if errored?
+
+      str << " in #{duration.round(2)} seconds"
+    end # method to_s
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end # method tools
+  end # class
+end # module

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

@@ -0,0 +1,156 @@
+# lib/sleeping_king_studios/tasks/ci/rspec_each_task.rb
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/results_helpers'
+require 'sleeping_king_studios/tasks/ci/rspec_each_results'
+require 'sleeping_king_studios/tasks/ci/rspec_results'
+require 'sleeping_king_studios/tasks/ci/rspec_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # rubocop:disable Metrics/ClassLength
+
+  # Defines a Thor task for running the full RSpec test suite.
+  class RSpecEachTask < SleepingKingStudios::Tasks::Task
+    include SleepingKingStudios::Tasks::Ci::ResultsHelpers
+
+    def self.description
+      'Runs each spec file as an individual RSpec process.'
+    end # class method description
+
+    def self.task_name
+      'rspec_each'
+    end # class method task_name
+
+    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 *groups
+      mute! if quiet?
+
+      files = files_list(groups)
+
+      say "Running #{files.count} spec files..."
+      say "\n"
+
+      results = run_files(files)
+
+      report_pending results
+      report_failing results
+      report_errored results
+      report_totals  results
+
+      raw? ? results.to_h : results
+    end # method call
+
+    private
+
+    def aggregate_results file, results, totals
+      if results.errored?
+        totals['errored_files'] << file
+      elsif results.failing?
+        totals['failing_files'] << file
+      elsif results.pending?
+        totals['pending_files'] << file
+      end # if-else
+
+      totals['file_count'] += 1
+    end # method aggregate_results
+
+    def build_totals
+      {
+        'pending_files' => [],
+        'failing_files' => [],
+        'errored_files' => [],
+        'file_count'    => 0
+      } # end results
+    end # method build_totals
+
+    def files_list groups
+      groups = %w(spec) if groups.empty?
+
+      groups.map do |group_or_file|
+        if File.extname(group_or_file).empty?
+          Dir[File.join group_or_file, pattern]
+        else
+          [group_or_file]
+        end # if-else
+      end. # map
+        flatten.
+        uniq
+    end # method files_list
+
+    def pattern
+      '**{,/*/**}/*_spec.rb'
+    end # method pattern
+
+    def report_errored results
+      return unless results.errored?
+
+      say "\nErrored:\n\n"
+
+      results.errored_files.each { |file| say "  #{file}", :red }
+    end # report_pending
+
+    def report_failing results
+      return unless results.failing?
+
+      say "\nFailures:\n\n"
+
+      results.failing_files.each { |file| say "  #{file}", :red }
+    end # report_pending
+
+    def report_pending results
+      return unless results.pending?
+
+      say "\nPending:\n\n"
+
+      results.pending_files.each { |file| say "  #{file}", :yellow }
+    end # report_pending
+
+    def report_totals results
+      say "\nFinished in #{results.duration.round(2)} seconds"
+
+      if results.failing? || results.errored?
+        say results.to_s, :red
+      elsif results.pending? || results.empty?
+        say results.to_s, :yellow
+      else
+        say results.to_s, :green
+      end # if-elsif-else
+    end # method report_totals
+
+    def rspec_runner
+      RSpecRunner.new(:env => { :coverage => false })
+    end # method rspec_runner
+
+    def run_file file
+      results = rspec_runner.call(:files => [file])
+      results = RSpecResults.new(results)
+
+      say "#{set_color results_state(results), results_color(results)} #{file}"
+
+      results
+    end # method run_file
+
+    def run_files files
+      start  = Time.now
+      totals = build_totals
+
+      files.each { |file| aggregate_results(file, run_file(file), totals) }
+
+      totals['duration'] = Time.now - start
+
+      RSpecEachResults.new(totals)
+    end # method run_files
+  end # class
+
+  # rubocop:enable Metrics/ClassLength
+end # module

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

@@ -0,0 +1,126 @@
+# lib/sleeping_king_studios/tasks/ci/rspec_results.rb
+
+require 'sleeping_king_studios/tasks/ci'
+
+module SleepingKingStudios::Tasks::Ci
+  # Encapsulates the results of an RSpec call.
+  class RSpecResults
+    # @param results [Hash] The raw results of the RSpec 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?(RSpecResults)
+        to_h == other.to_h
+      else
+        false
+      end # if-elsif-else
+    end # method ==
+
+    # @return [Float] The duration value.
+    def duration
+      @results.fetch('duration', 0.0)
+    end # method duration
+
+    # @return [Boolean] True if there are no examples, otherwise false.
+    def empty?
+      example_count.zero?
+    end # method empty?
+
+    # @return [Boolean] True if there are no results or if errors occurred
+    #   outside of examples, otherwise false.
+    def errored?
+      @results.empty? || !error_count.zero?
+    end # method errored?
+
+    # @return [Integer] The number of errors that occurred outside of examples.
+    def error_count
+      @results.fetch('error_count', 0)
+    end # method error_count
+
+    # @return [Integer] The total number of examples.
+    def example_count
+      @results.fetch('example_count', 0)
+    end # method example_count
+
+    # @return [Boolean] True if there are any failing examples, otherwise false.
+    def failing?
+      !failure_count.zero?
+    end # method failing?
+
+    # @return [Integer] The number of failing examples.
+    def failure_count
+      @results.fetch('failure_count', 0)
+    end # method failure_count
+
+    # Adds the given result values and returns a new results object with the
+    # sums.
+    #
+    # @param other [RSpecResults] The results to add.
+    #
+    # @return [RSpecResults] The total results.
+    def merge other
+      self.class.new(
+        'duration'      => duration      + other.duration,
+        'example_count' => example_count + other.example_count,
+        'failure_count' => failure_count + other.failure_count,
+        'pending_count' => pending_count + other.pending_count
+      ) # end new
+    end # method merge
+
+    # @return [Boolean] True if there are any pending examples, otherwise false.
+    def pending?
+      !pending_count.zero?
+    end # method pending?
+
+    # @return [Intger] The number of pending examples.
+    def pending_count
+      @results.fetch('pending_count', 0)
+    end # method pending_count
+
+    def pluralize count, singular, plural = nil
+      "#{count} #{tools.integer.pluralize count, singular, plural}"
+    end # method pluralize
+
+    # @return [Hash] The hash representation of the results.
+    def to_h
+      {
+        'duration'      => duration,
+        'example_count' => example_count,
+        'failure_count' => failure_count,
+        'pending_count' => pending_count,
+        'error_count'   => error_count
+      } # end hash
+    end # method to_h
+
+    # rubocop:disable Metrics/AbcSize
+
+    # @return [String] The string representation of the results.
+    def to_s
+      str = pluralize(example_count, 'example')
+
+      str << ', ' << pluralize(failure_count, 'failure')
+
+      str << ', ' << pending_count.to_s << ' pending' if pending?
+
+      if error_count.zero?
+        str << " in #{duration.round(2)} seconds"
+      else
+        str << ', ' << pluralize(error_count, 'error') <<
+          ' occurred outside of examples'
+      end # if-else
+    end # method to_s
+
+    # rubocop:enable Metrics/AbcSize
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end # method tools
+  end # class
+end # module