sleeping_king_studios-tasks 0.1.0.rc.0 → 0.3.0

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/process_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Service object to run Jest as an external process with the specified
+  # parameters.
+  class JestRunner < SleepingKingStudios::Tasks::ProcessRunner
+    def call env: {}, files: [], options: [], report: true
+      report  = 'tmp/ci/jest.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 jest'
+    end
+
+    def build_options files:, options:, report:, **_kwargs
+      options += ['--json', "--outputFile=#{report}"] if report
+
+      super :files => files, :options => options
+    end
+
+    def load_report report:
+      raw = File.read report
+
+      return {} if raw.empty?
+
+      JSON.parse raw
+    rescue
+      # :nocov:
+      {}
+      # :nocov:
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tasks/ci'
+require 'sleeping_king_studios/tasks/ci/jest_results'
+require 'sleeping_king_studios/tasks/ci/jest_runner'
+
+module SleepingKingStudios::Tasks::Ci
+  # Defines a Thor task for running the full Jest (JavaScript) test suite.
+  class JestTask < SleepingKingStudios::Tasks::Task
+    def self.description
+      'Runs the Jest test suite.'
+    end
+
+    def self.task_name
+      'jest'
+    end
+
+    option :verbose,
+      :type => :boolean,
+      :desc => 'Output individual test results.'
+
+    def call *files
+      results = jest_runner.call(:files => files)
+
+      JestResults.new(results)
+    end
+
+    private
+
+    def default_verbose
+      SleepingKingStudios::Tasks.configuration.ci.jest.
+        fetch(:verbose, false)
+    end
+
+    def jest_runner
+      env  = options.fetch('__env__', {})
+      opts = %w[--color]
+      opts << "--verbose=#{options.fetch('verbose', default_verbose)}"
+
+      JestRunner.new(:env => env, :options => opts)
+    end
+  end
+end

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

@@ -21,6 +21,9 @@ module SleepingKingStudios::Tasks::Ci
       'rspec_each'
     end # class method task_name
 
+    option :format,
+      :type    => :string,
+      :desc    => 'The RSpec formatter to use. Defaults to the configuration.'
     option :quiet,
       :aliases => '-q',
       :type    => :boolean,
@@ -73,8 +76,13 @@ module SleepingKingStudios::Tasks::Ci
       } # end results
     end # method build_totals
 
+    def default_format
+      SleepingKingStudios::Tasks.configuration.ci.rspec_each.
+        fetch(:format, :documentation)
+    end # method default_format
+
     def files_list groups
-      groups = %w(spec) if groups.empty?
+      groups = %w[spec] if groups.empty?
 
       groups.map do |group_or_file|
         if File.extname(group_or_file).empty?
@@ -132,7 +140,15 @@ module SleepingKingStudios::Tasks::Ci
     end # method rspec_runner
 
     def run_file file
-      results = rspec_runner.call(:files => [file])
+      opts   = []
+      format = options.fetch('format', default_format)
+
+      if format && !quiet?
+        opts = %w[--color --tty]
+        opts << "--format=#{format}"
+      end # if
+
+      results = rspec_runner.call(:files => [file], :options => opts)
       results = RSpecResults.new(results)
 
       say "#{set_color results_state(results), results_color(results)} #{file}"

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

@@ -18,6 +18,9 @@ module SleepingKingStudios::Tasks::Ci
     option :coverage,
       :type    => :boolean,
       :desc    => 'Enable or disable coverage with SimpleCov, if available.'
+    option :format,
+      :type    => :string,
+      :desc    => 'The RSpec formatter to use. Defaults to the configuration.'
     option :gemfile,
       :type    => :string,
       :desc    => 'The Gemfile used to run the specs.',
@@ -41,6 +44,11 @@ module SleepingKingStudios::Tasks::Ci
 
     private
 
+    def default_format
+      SleepingKingStudios::Tasks.configuration.ci.rspec.
+        fetch(:format, :documentation)
+    end # method default_format
+
     def default_gemfile
       File.join(Dir.pwd, 'Gemfile')
     end # method default_gemfile
@@ -62,8 +70,10 @@ module SleepingKingStudios::Tasks::Ci
       env[:bundle_gemfile] = gemfile if gemfile
       env[:coverage]       = false unless coverage
 
-      opts = %w(--color --tty)
-      opts << '--format=documentation' unless quiet?
+      format = options.fetch('format', default_format)
+
+      opts = %w[--color --tty]
+      opts << "--format=#{format}" unless quiet?
 
       RSpecRunner.new(:env => env, :options => opts)
     end # method rspec_runner

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

@@ -35,7 +35,7 @@ module SleepingKingStudios::Tasks::Ci
     private
 
     def rubocop_runner
-      opts = %w(--color)
+      opts = %w[--color]
       opts << '--format=progress' unless quiet?
 
       RuboCopRunner.new(:options => opts)

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

@@ -0,0 +1,24 @@
+# lib/sleeping_king_studios/tasks/ci/tasks.thor
+
+require 'sleeping_king_studios/tasks/ci/cucumber_task'
+require 'sleeping_king_studios/tasks/ci/eslint_task'
+require 'sleeping_king_studios/tasks/ci/jest_task'
+require 'sleeping_king_studios/tasks/ci/rspec_task'
+require 'sleeping_king_studios/tasks/ci/rspec_each_task'
+require 'sleeping_king_studios/tasks/ci/rubocop_task'
+require 'sleeping_king_studios/tasks/ci/steps_task'
+
+module SleepingKingStudios::Tasks::Ci
+  # Thor integration for continuous integration tasks.
+  class Tasks < SleepingKingStudios::Tasks::TaskGroup
+    namespace :ci
+
+    task SleepingKingStudios::Tasks::Ci::CucumberTask
+    task SleepingKingStudios::Tasks::Ci::EslintTask
+    task SleepingKingStudios::Tasks::Ci::JestTask
+    task SleepingKingStudios::Tasks::Ci::RSpecTask
+    task SleepingKingStudios::Tasks::Ci::RSpecEachTask
+    task SleepingKingStudios::Tasks::Ci::RuboCopTask
+    task SleepingKingStudios::Tasks::Ci::StepsTask
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/configuration.rb

@@ -5,6 +5,8 @@ require 'sleeping_king_studios/tools/toolbox/configuration'
 require 'sleeping_king_studios/tasks'
 
 module SleepingKingStudios::Tasks
+  # rubocop:disable Metrics/ClassLength
+
   # Task configuration options, grouped by namespace.
   class Configuration < SleepingKingStudios::Tools::Toolbox::Configuration
     # rubocop:disable Metrics/BlockLength
@@ -32,7 +34,7 @@ module SleepingKingStudios::Tasks
             :global  => true
           } # end rspec
 
-        option :steps, :default => %i(rspec rubocop simplecov)
+        option :steps, :default => %i[rspec rubocop simplecov]
 
         define_method :steps_with_options do
           steps.each.with_object({}) do |step, hsh|
@@ -55,18 +57,36 @@ module SleepingKingStudios::Tasks
           :default_files => ['step_definitions', 'step_definitions.rb']
         } # end cucumber
 
+      option :eslint, :default =>
+        {
+          :class         => 'SleepingKingStudios::Tasks::Ci::EslintTask',
+          :default_files => '"**/*.js"',
+          :require       => 'sleeping_king_studios/tasks/ci/eslint_task',
+          :title         => 'ESLint'
+        }
+
+      option :jest, :default =>
+        {
+          :class   => 'SleepingKingStudios::Tasks::Ci::JestTask',
+          :require => 'sleeping_king_studios/tasks/ci/jest_task',
+          :title   => 'Jest',
+          :verbose => false
+        }
+
       option :rspec, :default =>
         {
           :require => 'sleeping_king_studios/tasks/ci/rspec_task',
           :class   => 'SleepingKingStudios::Tasks::Ci::RSpecTask',
-          :title   => 'RSpec'
+          :title   => 'RSpec',
+          :format  => 'documentation'
         } # end rspec
 
       option :rspec_each, :default =>
         {
           :require => 'sleeping_king_studios/tasks/ci/rspec_each_task',
           :class   => 'SleepingKingStudios::Tasks::Ci::RSpecEachTask',
-          :title   => 'RSpec (Each)'
+          :title   => 'RSpec (Each)',
+          :format  => nil
         } # end rspec
 
       option :rubocop, :default =>
@@ -83,7 +103,7 @@ module SleepingKingStudios::Tasks
           :title   => 'SimpleCov'
         } # end rspec
 
-      option :steps, :default => %i(rspec rubocop simplecov)
+      option :steps, :default => %i[rspec rubocop simplecov]
 
       define_method :steps_with_options do
         steps.each.with_object({}) do |step, hsh|
@@ -111,4 +131,5 @@ module SleepingKingStudios::Tasks
       option :template_paths, :default => [default_template_path]
     end # namespace
   end # class
+  # rubocop:enable Metrics/ClassLength
 end # module

data/lib/sleeping_king_studios/tasks/file/new_task.rb

@@ -11,6 +11,8 @@ module SleepingKingStudios::Tasks::File
 
   # Thor task for generating a new Ruby source file.
   class NewTask < SleepingKingStudios::Tasks::Task
+    class MissingTemplateError < StandardError; end
+
     def self.description
       'Creates a Ruby source file and corresponding spec file.'
     end # class method description
@@ -56,8 +58,8 @@ module SleepingKingStudios::Tasks::File
 
       return unless prompt_confirmation
 
-      create_source_file
-      create_spec_file
+      create_source_file unless dry_run?
+      create_spec_file   unless dry_run?
 
       say 'Complete!', :green
     end # method file_name
@@ -78,10 +80,16 @@ module SleepingKingStudios::Tasks::File
       raise "file already exists at #{file_path}" unless force?
     end # method check_for_existing_file
 
+    def create_directories *directory_names
+      directory_path = directory_names.compact.join(File::SEPARATOR)
+
+      FileUtils.mkdir_p directory_path unless directory_path.empty?
+    end # method create_directories
+
     def create_source_file
       create_directories directory, *relative_path
 
-      File.write file_path, rendered_source unless dry_run?
+      File.write file_path, rendered_source
     end # method create_file
 
     def create_spec_file
@@ -91,15 +99,9 @@ module SleepingKingStudios::Tasks::File
 
       create_directories 'spec', *relative_path
 
-      File.write spec_path, rendered_spec unless dry_run?
+      File.write spec_path, rendered_spec
     end # method create_spec_file
 
-    def create_directories *directory_names
-      return if dry_run?
-
-      FileUtils.mkdir_p directory_names.compact.join(File::SEPARATOR)
-    end # method create_directories
-
     def find_template name
       template_paths.each do |template_dir|
         template_path = File.expand_path(File.join template_dir, name)
@@ -109,7 +111,7 @@ module SleepingKingStudios::Tasks::File
         return File.read(template_path)
       end # each
 
-      nil
+      raise MissingTemplateError, "No template found for \"#{name}\""
     end # method find_template
 
     def preview
@@ -218,7 +220,7 @@ module SleepingKingStudios::Tasks::File
     end # method split_file_path
 
     def split_relative_path fragments
-      if %w(app apps lib spec tmp vendor).include?(fragments.first)
+      if %w[app apps lib spec tmp vendor].include?(fragments.first)
         @directory = fragments.shift
       end # if
 

data/lib/sleeping_king_studios/tasks/file/tasks.thor

@@ -0,0 +1,13 @@
+# lib/sleeping_king_studios/tasks/file/tasks.thor
+
+require 'sleeping_king_studios/tasks/file'
+require 'sleeping_king_studios/tasks/file/new_task'
+
+module SleepingKingStudios::Tasks::File
+  # Thor integration for file tasks.
+  class Tasks < SleepingKingStudios::Tasks::TaskGroup
+    namespace :file
+
+    task SleepingKingStudios::Tasks::File::NewTask
+  end # class
+end # module

data/lib/sleeping_king_studios/tasks/file/templates/rspec.erb

@@ -0,0 +1,13 @@
+<%# lib/sleeping_king_studios/tasks/file/templates/ruby.rspec %>
+<% require 'sleeping_king_studios/tools' %>
+<% tools = SleepingKingStudios::Tools::Toolbelt.new %>
+<% full_path = [*relative_path, file_name.sub(/_spec\z/, '')] %>
+require '<%= full_path.join('/') %>'
+
+<%
+  qualified_module =
+    full_path.map { |rel| tools.string.camelize(rel) }.join('::')
+%>
+RSpec.describe <%= qualified_module %> do
+  pending
+end

data/lib/sleeping_king_studios/tasks/file/templates/ruby.erb

@@ -0,0 +1,28 @@
+<%# lib/sleeping_king_studios/tasks/file/templates/ruby.erb %>
+<% require 'sleeping_king_studios/tools' %>
+<% tools = SleepingKingStudios::Tools::Toolbelt.new %>
+<% if relative_path.empty? %>
+<% if defined?(superclass) %>
+class <%= tools.string.camelize file_name %> < <%= superclass %>
+
+end
+<% else %>
+module <%= tools.string.camelize file_name %>
+
+end
+<% end %>
+<% else %>
+require '<%= relative_path.join('/') %>'
+
+module <%= relative_path.map { |rel| tools.string.camelize(rel) }.join('::') %>
+  <% if defined?(superclass) %>
+  class <%= tools.string.camelize file_name %> < <%= superclass %>
+
+  end
+  <% else %>
+  module <%= tools.string.camelize file_name %>
+
+  end
+  <% end %>
+end
+<% end %>

data/lib/sleeping_king_studios/tasks/process_runner.rb

@@ -29,8 +29,8 @@ module SleepingKingStudios::Tasks
     end # method base_command
 
     def build_command **kwargs
-      env  = build_environment(kwargs)
-      opts = build_options(kwargs)
+      env  = build_environment(**kwargs)
+      opts = build_options(**kwargs)
 
       "#{env} #{base_command} #{opts}".strip
     end # method build_command
@@ -52,7 +52,7 @@ module SleepingKingStudios::Tasks
     end # method build_options
 
     def stream_process command
-      Bundler.with_clean_env do
+      unbundled_env do
         IO.popen(command) do |io|
           loop do
             char = io.getc
@@ -60,11 +60,21 @@ module SleepingKingStudios::Tasks
             char ? print(char) : break
           end # loop
         end # popen
-      end # with_clean_env
+      end # with_unbundled_env
     end # method stream_process
 
     def tools
       SleepingKingStudios::Tools::Toolbelt.new
     end # method tools
+
+    def unbundled_env
+      # :nocov:
+      if Bundler.respond_to?(:with_unbundled_env)
+        Bundler.with_unbundled_env { yield }
+      else
+        Bundler.with_clean_env { yield }
+      end
+      # :nocov:
+    end
   end # class
 end # module