sleeping_king_studios-tasks 0.1.0.rc.0

data/lib/sleeping_king_studios/tasks.rb

@@ -0,0 +1,27 @@
+# lib/sleeping_king_studios/tasks.rb
+
+require 'sleeping_king_studios/tools'
+
+# Hic iacet Arthurus, rex quondam, rexque futurus.
+module SleepingKingStudios
+  # Toolkit providing an encapsulation layer around the Thor CLI library, with
+  # predefined tasks for development and continuous integration.
+  module Tasks
+    autoload :Configuration, 'sleeping_king_studios/tasks/configuration'
+    autoload :Task,          'sleeping_king_studios/tasks/task'
+    autoload :TaskGroup,     'sleeping_king_studios/tasks/task_group'
+
+    def self.configuration
+      @configuration ||= SleepingKingStudios::Tasks::Configuration.new
+    end # class method configuration
+
+    def self.configure
+      yield configuration
+    end # class method configure
+
+    # The file path to the root of the gem directory.
+    def self.gem_path
+      @gem_path ||= __dir__.sub %r{/lib/sleeping_king_studios\z}, ''
+    end # class method gem_path
+  end # module
+end # module

data/lib/sleeping_king_studios/tasks/apps.rb

@@ -0,0 +1,49 @@
+# lib/sleeping_king_studios/tasks/apps.rb
+
+require 'yaml'
+
+require 'sleeping_king_studios/tasks'
+
+module SleepingKingStudios::Tasks
+  # Thor tasks for semi-distributed applications.
+  module Apps
+    autoload :AppConfiguration,
+      'sleeping_king_studios/tasks/apps/app_configuration'
+
+    # rubocop:disable Metrics/MethodLength
+    def self.configuration
+      @configuration ||=
+        begin
+          tools = SleepingKingStudios::Tools::Toolbelt.instance
+          apps  = load_configuration
+          hsh   = Hash.new do |_, key|
+            SleepingKingStudios::Tasks::Apps::AppConfiguration.
+              new(:name => key.to_s)
+          end # hash
+
+          apps.each do |key, data|
+            name = key.to_s
+            data = tools.hash.convert_keys_to_symbols(data)
+
+            data[:name] ||= name
+
+            hsh[key] =
+              SleepingKingStudios::Tasks::Apps::AppConfiguration.new(data)
+          end # each
+
+          hsh
+        end # begin-end
+    end # class method configuration
+    # rubocop:enable Metrics/MethodLength
+
+    def self.load_configuration
+      config_file = SleepingKingStudios::Tasks.configuration.apps.config_file
+      raw         = ::File.read(config_file)
+
+      YAML.safe_load raw
+    rescue
+      {}
+    end # class method load_configuration
+    class << self; private :load_configuration; end
+  end # module
+end # module

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

@@ -0,0 +1,68 @@
+# lib/sleeping_king_studios/tasks/apps/app_configuration.rb
+
+require 'sleeping_king_studios/tools/toolbox/configuration'
+
+require 'sleeping_king_studios/tasks/apps'
+
+module SleepingKingStudios::Tasks::Apps
+  # Application configuration options.
+  class AppConfiguration < SleepingKingStudios::Tools::Toolbox::Configuration
+    namespace :ci do
+      option :rspec, :default => {}
+
+      option :rubocop, :default => {}
+
+      option :simplecov, :default => {}
+
+      option :steps, :default =>
+        ->() { SleepingKingStudios::Tasks.configuration.apps.ci.steps }
+
+      define_method :steps_with_options do
+        steps.each.with_object({}) do |step, hsh|
+          value = send(step)
+
+          next hsh[step] = false if value == false
+
+          default   =
+            SleepingKingStudios::Tasks.configuration.apps.ci.send(step)
+          hsh[step] = default.merge(value)
+        end # each
+      end # method steps_with_options
+    end # namespace
+
+    define_method :default_source_files do
+      files = [
+        "apps/#{short_name}",
+        "apps/#{short_name}.rb",
+        "lib/#{short_name}",
+        "lib/#{short_name}.rb"
+      ] # end files
+
+      files.select { |path| File.exist?(path) }
+    end # method default_source_files
+
+    define_method :default_spec_files do
+      files = ["apps/#{short_name}/spec", "spec/#{short_name}"]
+
+      files.select { |path| File.exist?(path) }
+    end # method default_spec_files
+
+    define_method :short_name do
+      # rubocop:disable Style/RedundantSelf
+      tools.string.underscore(self.name.gsub(/\s+/, '_'))
+      # rubocop:enable Style/RedundantSelf
+    end # define_method
+
+    define_method :tools do
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end # method tools
+
+    option :gemfile, :default => 'Gemfile'
+
+    option :name
+
+    option :source_files, :default => ->() { default_source_files }
+
+    option :spec_files, :default => ->() { default_spec_files }
+  end # module
+end # module

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

@@ -0,0 +1,28 @@
+# lib/sleeping_king_studios/tasks/apps/applications_task.rb
+
+require 'yaml'
+
+require 'sleeping_king_studios/tasks/apps'
+
+module SleepingKingStudios::Tasks::Apps
+  # Extension module with additional configuration for performing actions on a
+  # per-application basis.
+  module ApplicationsTask
+    private
+
+    def applications
+      SleepingKingStudios::Tasks::Apps.configuration
+    end # method applications
+
+    def filter_applications only: []
+      filtered = applications
+
+      if only && !only.empty?
+        normalized = only.map(&:to_s)
+        filtered   = filtered.select { |key, _| normalized.include?(key) }
+      end # if
+
+      filtered
+    end # method filter_applications
+  end # class
+end # module

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

@@ -0,0 +1,8 @@
+# lib/sleeping_king_studios/tasks/apps/bundle.rb
+
+require 'sleeping_king_studios/tasks/apps'
+
+module SleepingKingStudios::Tasks::Apps
+  # Thor tasks for maintaing gem dependencies in semi-distributed applications.
+  module Bundle; end
+end # module

data/lib/sleeping_king_studios/tasks/apps/bundle/install_runner.rb

@@ -0,0 +1,21 @@
+# lib/sleeping_king_studios/tasks/apps/bundle/install_runner.rb
+
+require 'sleeping_king_studios/tasks/apps/bundle'
+require 'sleeping_king_studios/tasks/process_runner'
+
+module SleepingKingStudios::Tasks::Apps::Bundle
+  # Service object to run bundle install as an external process.
+  class InstallRunner < SleepingKingStudios::Tasks::ProcessRunner
+    def call gemfile
+      command = build_command :env => { :bundle_gemfile => gemfile }
+
+      stream_process(command)
+    end # method call
+
+    private
+
+    def base_command
+      'bundle install'
+    end # method base_command
+  end # module
+end # module

data/lib/sleeping_king_studios/tasks/apps/bundle/install_task.rb

@@ -0,0 +1,39 @@
+# lib/sleeping_king_studios/tasks/apps/bundle/install_task.rb
+
+require 'sleeping_king_studios/tasks/apps/applications_task'
+require 'sleeping_king_studios/tasks/apps/bundle'
+require 'sleeping_king_studios/tasks/apps/bundle/install_runner'
+
+module SleepingKingStudios::Tasks::Apps::Bundle
+  # Defines a Thor task for installing gem dependencies for each application.
+  class InstallTask < SleepingKingStudios::Tasks::Task
+    include SleepingKingStudios::Tasks::Apps::ApplicationsTask
+
+    def self.description
+      'Installs the Ruby gem dependencies for each application.'
+    end # class method description
+
+    def call *applications
+      filtered = filter_applications(:only => applications)
+
+      gemfiles(filtered).each do |gemfile|
+        say %(\nInstalling gems for gemfile "#{gemfile}")
+        say '-' * 80
+        say "\n"
+
+        install_runner.call(gemfile)
+      end # each
+    end # method call
+
+    private
+
+    def gemfiles applications
+      applications.map { |_, config| config.gemfile }.uniq
+    end # method gemfiles
+
+    def install_runner
+      @install_runner =
+        SleepingKingStudios::Tasks::Apps::Bundle::InstallRunner.new
+    end # method install_runner
+  end # module
+end # module

data/lib/sleeping_king_studios/tasks/apps/bundle/update_runner.rb

@@ -0,0 +1,21 @@
+# lib/sleeping_king_studios/tasks/apps/bundle/update_runner.rb
+
+require 'sleeping_king_studios/tasks/apps/bundle'
+require 'sleeping_king_studios/tasks/process_runner'
+
+module SleepingKingStudios::Tasks::Apps::Bundle
+  # Service object to run bundle update as an external process.
+  class UpdateRunner < SleepingKingStudios::Tasks::ProcessRunner
+    def call gemfile
+      command = build_command :env => { :bundle_gemfile => gemfile }
+
+      stream_process(command)
+    end # method call
+
+    private
+
+    def base_command
+      'bundle update'
+    end # method base_command
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/apps/bundle/update_task.rb

@@ -0,0 +1,39 @@
+# lib/sleeping_king_studios/tasks/apps/bundle/update_task.rb
+
+require 'sleeping_king_studios/tasks/apps/applications_task'
+require 'sleeping_king_studios/tasks/apps/bundle'
+require 'sleeping_king_studios/tasks/apps/bundle/update_runner'
+
+module SleepingKingStudios::Tasks::Apps::Bundle
+  # Defines a Thor task for updating gem dependencies for each application.
+  class UpdateTask < SleepingKingStudios::Tasks::Task
+    include SleepingKingStudios::Tasks::Apps::ApplicationsTask
+
+    def self.description
+      'Updates the Ruby gem dependencies for each application.'
+    end # class method description
+
+    def call *applications
+      filtered = filter_applications(:only => applications)
+
+      gemfiles(filtered).each do |gemfile|
+        say %(\nUpdating gems for gemfile "#{gemfile}")
+        say '-' * 80
+        say "\n"
+
+        update_runner.call(gemfile)
+      end # each
+    end # method call
+
+    private
+
+    def gemfiles applications
+      applications.map { |_, config| config.gemfile }.uniq
+    end # method gemfiles
+
+    def update_runner
+      @update_runner =
+        SleepingKingStudios::Tasks::Apps::Bundle::UpdateRunner.new
+    end # method update_runner
+  end # class
+end # module

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

@@ -0,0 +1,8 @@
+# lib/sleeping_king_studios/tasks/apps/ci.rb
+
+require 'sleeping_king_studios/tasks/apps'
+
+module SleepingKingStudios::Tasks::Apps
+  # Thor tasks for continuous integration in semi-distributed applications.
+  module Ci; end
+end # module

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

@@ -0,0 +1,69 @@
+# lib/sleeping_king_studios/tasks/apps/ci/results_reporter.rb
+
+require 'sleeping_king_studios/tools/toolbox/delegator'
+
+require 'sleeping_king_studios/tasks/apps/ci'
+require 'sleeping_king_studios/tasks/ci/results_helpers'
+
+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
+
+    include SleepingKingStudios::Tasks::Ci::ResultsHelpers
+
+    delegate \
+      :applications,
+      :print_table,
+      :say,
+      :set_color,
+      :to => :@context
+
+    def initialize context
+      @context = context
+    end # method initialize
+
+    def call results
+      width = 1 + heading_width(results)
+
+      results.each do |application, app_results|
+        report_application application, app_results, :width => width
+      end # each
+    end # method call
+
+    private
+
+    def heading_width results
+      results.reduce(0) do |memo, (_, hsh)|
+        [memo, *hsh.keys.map(&:size)].max
+      end # reduce
+    end # method heading_width
+
+    def generate_rows results, width:
+      results.map do |key, obj|
+        next nil if obj.nil?
+
+        badge = format("  %-#{width}.#{width}s", "#{key}:")
+
+        [set_color(badge, results_color(obj)), obj.to_s]
+      end. # rows
+        compact
+    end # method generate_rows
+
+    def report_application app_name, results, width:
+      config   = applications.fetch(app_name, {})
+      app_name = config.fetch('name', app_name)
+      rows     = generate_rows(results, :width => width)
+
+      return if rows.empty?
+
+      say "#{app_name}:"
+      say "\n"
+
+      print_table rows
+
+      say "\n"
+    end # method report_application
+  end # class
+end # module

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

@@ -0,0 +1,29 @@
+# lib/sleeping_king_studios/tasks/apps/ci/rspec_task.rb
+
+require 'sleeping_king_studios/tasks/apps/ci'
+require 'sleeping_king_studios/tasks/apps/ci/steps_task'
+
+module SleepingKingStudios::Tasks::Apps::Ci
+  # Defines a Thor task for running the RSpec test suite for each application.
+  class RSpecTask < SleepingKingStudios::Tasks::Task
+    def self.description
+      'Runs the RSpec test suite for each application.'
+    end # class method description
+
+    def self.task_name
+      'rspec'
+    end # class method task_name
+
+    option :quiet,
+      :aliases => '-q',
+      :type    => :boolean,
+      :default => false,
+      :desc    => 'Do not write spec results to STDOUT.'
+
+    def call *applications
+      SleepingKingStudios::Tasks::Apps::Ci::StepsTask.
+        new(options.merge('only' => %w(rspec))).
+        call(*applications)
+    end # method call
+  end # class
+end # module

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

@@ -0,0 +1,42 @@
+# lib/sleeping_king_studios/tasks/apps/ci/rspec_wrapper.rb
+
+require 'sleeping_king_studios/tasks/apps/ci'
+require 'sleeping_king_studios/tasks/apps/ci/step_wrapper'
+require 'sleeping_king_studios/tasks/ci/rspec_results'
+
+module SleepingKingStudios::Tasks::Apps::Ci
+  # Wrapper class for calling an RSpec Ci task for a specific application.
+  class RSpecWrapper < SleepingKingStudios::Tasks::Apps::Ci::StepWrapper
+    def call application
+      super
+
+      if spec_files.empty?
+        return SleepingKingStudios::Tasks::Ci::RSpecResults.new({})
+      end # if
+
+      run_step(*spec_files)
+    end # method call
+
+    private
+
+    def spec_files
+      SleepingKingStudios::Tasks::Apps.
+        configuration[current_application].
+        spec_files
+    end # method spec_files
+
+    def step_key
+      :rspec
+    end # method step_key
+
+    def step_options
+      gemfile = applications[current_application].fetch('gemfile', 'Gemfile')
+
+      super.merge(
+        'coverage' => true,
+        'gemfile'  => gemfile,
+        '__env__'  => { :app_name => current_application }
+      ) # end merge
+    end # method step_options
+  end # class
+end # module