cuprum-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0569f2b0f6fd69ffae0141d299421c0a42d91182e8d795151ab0d8994838cf5
-  data.tar.gz: d585735c4712bd25a0729c09fb8547e46b0e4a2222d3cf1476c178ea17d54bc1
+  metadata.gz: '053079e009641ced526992e4638869d248642d3bb52d03ce3eec21ce936684fd'
+  data.tar.gz: 0e2fe126bc581aec7b90b778b1f21d618883bcd0cfad321d92af0190af7f1c93
 SHA512:
-  metadata.gz: b65e0e51ef3d04c4adb58998dc62e3a153e9e8cb2c44f21fd540798993bf13633e7079c07df56a03e30d0d0d5300f31b3eeacf3b2575ae4c88f513ecd60f5e1f
-  data.tar.gz: d0b99e59cc83645160bad0fec52432cee1d10b1f7efaf4f5771dff0c7a1df747dd2e9364ac27994ba73b17aaa6c74070711ff048e4185512a085a2d85346d6ee
+  metadata.gz: f73d5753de14f610d59c47bfc193ec6202e8bd5ba1f252a4f7ce38d6682d72688807508f9ae2c1c16b659c2ba7163e2b7b8f42e3d191ef3b382ea99e3c9172ad
+  data.tar.gz: 507e66d118165c0ae0dfbad7bfe6a2465cd61de01719eb0c4a8d716546754b028faad08cd2cb13fa2cb68e997629dade961d6e257dbd3cefd279a9648de0e79d

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 0.2.0
+
+## Commands
+
+- Implemented support for resolving aliased options.
+- Normalized option keys for variadic options.
+
+### Built-In Commands
+
+- Fixed directory expansion for `Ci::RSpecEachCommand`.
+- Fixed `Ci::RSpecEachCommand` reporting failing specs as errored.
+- Updated `Ci::RSpecEachCommand` output to report total elapsed time.
+- Updated `File::NewCommand` to use generators instead of raw templates.
+
+### Dependencies
+
+- Implemented `Clock` dependency.
+- Implemented `FileSystem#copy_file` helper.
+- Implemented `FileSystem#delete_directory` helper.
+- Improved handling of file parameters for `FileSystem::Mock`.
+- Updated `FileSystem#each_file` enumerated values to match the given pattern - values will only be converted to absolute paths if the input pattern is an absolute path.
+- Fixed a `FileSystem#each_file` bug when matching a template that included the root path.
+- Fixed a `FileSystem::Mock` bug that would wipe existing mock directories.
+- Fixed a `FileSystem::Mock` bug that did not include directories in `each_file`.
+- Fixed a `FileSystem::Mock` bug in handling globbed file patterns ending in `**`.
+
+### Files
+
+- Implemented file generators, a more robust solution for generating files or groups of files.
+  - Implemented file templates for defining the outputs of generators.
+- Refactored `Errors::Files` to `Files::Errors`.
+
+## Integrations
+
+- Added `Async` integration.
+- Added `Async::Commands::RSpecEachCommand`, which allows running spec files in parallel.
+- Fixed error handling for `Thor` integration.
+- Enabled passing variadic options through `Thor` tasks.
+
+## Registries
+
+- Added support for registering groups of commands.
+
 ## 0.1.0
 
 Initial version.

data/README.md

@@ -89,11 +89,17 @@ Cuprum::Cli.initializer.call
 
 registry = Cuprum::Cli::Integrations::Thor::Registry.new
 
+# Register an individual command.
 registry.register Cuprum::Cli::Commands::Ci::RSpecCommand
+
+# Register a command with configuration options.
 registry.register Cuprum::Cli::Commands::Ci::RSpecCommand,
   full_name:   'ci:rspec:sinatra4',
   description: 'Runs the RSpec tests against Sinatra 4.X',
   options:     { gemfile: 'gemfiles/sinatra_4.gemfile' }
+
+# Register a group of commands.
+registry.register Cuprum::Cli::Commands::File.commands
 ```
 
 Finally, you can call the commands from your CLI tool:
@@ -104,6 +110,10 @@ ci
 --
 thor ci:rspec ...FILE_PATTERNS       # Runs an RSpec command.
 thor ci:rspec:sinatra4 ...FILE_PATTERNS  # Runs the RSpec tests against Sinatra 4.X
+
+file
+----
+thor file:new FILE_PATH  # Generates a new templated file or files.
 ```
 
 ### Defining Commands

data/lib/cuprum/cli/argument.rb

@@ -35,9 +35,9 @@ module Cuprum::Cli # rubocop:disable Metrics/ModuleLength
       default:        nil,
       description:    nil,
       parameter_name: nil,
-      required:       false,
+      required:       false, # rubocop:disable Layout/ExtraSpacing
       type:           :string,
-      variadic:       false
+      variadic:       false # rubocop:disable Layout/ExtraSpacing
     )
       name     = name.to_sym
       required = required ? true : false

data/lib/cuprum/cli/command.rb

@@ -81,10 +81,8 @@ module Cuprum::Cli
     #
     #   @return [Cuprum::Result] the command result.
     def call(*, resolved_arguments: nil, resolved_options: nil, **)
-      @arguments =
-        resolved_arguments || self.class.resolve_arguments(*)
-      @options   =
-        resolved_options   || self.class.resolve_options(**)
+      @arguments = resolved_arguments || self.class.resolve_arguments(*)
+      @options   = resolved_options   || self.class.resolve_options(**)
 
       super()
     end

data/lib/cuprum/cli/commands/ci/rspec_each_command.rb

@@ -6,12 +6,16 @@ require 'cuprum/cli/commands/ci/rspec_command'
 module Cuprum::Cli::Commands::Ci
   # Command for running each RSpec file in its own process.
   class RSpecEachCommand < Cuprum::Cli::Command # rubocop:disable Metrics/ClassLength
+    dependency :clock
     dependency :file_system
     dependency :standard_io
 
     include Cuprum::Cli::Dependencies::StandardIo::Helpers
     include Cuprum::Cli::Options::Quiet
 
+    FILE_PATTERN = /\.\w+\z/
+    private_constant :FILE_PATTERN
+
     arguments :file_patterns
 
     option :color, type: :boolean, default: true
@@ -32,12 +36,14 @@ module Cuprum::Cli::Commands::Ci
 
     attr_reader :report
 
-    def aggregate_file_results(filename:, result:) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    attr_reader :total_time
+
+    def aggregate_file_results(filename:, result:)
       if result.value.is_a?(Cuprum::Cli::Commands::Ci::Report)
         merge_report(result)
       end
 
-      if result.value&.errored? || result.failure?
+      if errored?(result)
         errored_files << filename
       elsif result.value&.failure?
         failing_files << filename
@@ -55,13 +61,25 @@ module Cuprum::Cli::Commands::Ci
     def configured_file_patterns
       patterns = arguments.fetch(:file_patterns, [])
 
-      return patterns unless patterns.empty?
+      return ['spec/**{,/*/**}/*_spec.rb'] if patterns.empty?
+
+      patterns.map do |pattern|
+        next pattern if wildcard_pattern?(pattern) || file_pattern?(pattern)
+
+        File.join(pattern, '**', '*')
+      end
+    end
+
+    def errored?(result)
+      return true unless result.value.is_a?(Cuprum::Cli::Commands::Ci::Report)
 
-      ['spec/**{,/*/**}/*_spec.rb']
+      result.value.errored?
     end
 
+    def file_pattern?(pattern) = pattern.match?(FILE_PATTERN)
+
     def format_status(result)
-      if result.failure? || result.value.errored?
+      if errored?(result)
         color('Errored', 'red')
       elsif result.value.failure?
         color('Failing', 'red')
@@ -78,7 +96,9 @@ module Cuprum::Cli::Commands::Ci
       all_files = Set.new
 
       configured_file_patterns.each do |pattern|
-        file_system.each_file(pattern) { |filename| all_files << filename }
+        file_system.each_file(pattern) do |filename|
+          all_files << filename if file_system.file?(filename)
+        end
       end
 
       @matching_files = all_files.sort
@@ -92,7 +112,7 @@ module Cuprum::Cli::Commands::Ci
       say "Running #{matching_files.count} spec files...\n"
       say "\n" unless matching_files.none?
 
-      matching_files.each { |filename| run_file(filename) }
+      @total_time = clock.measure { run_matching_files }
 
       summarize_report
 
@@ -126,6 +146,10 @@ module Cuprum::Cli::Commands::Ci
       result
     end
 
+    def run_matching_files
+      matching_files.each { |filename| run_file(filename) }
+    end
+
     def say_errored
       return if errored_files.empty?
 
@@ -157,7 +181,7 @@ module Cuprum::Cli::Commands::Ci
     end
 
     def say_summary # rubocop:disable Metrics/AbcSize
-      say "\nFinished in #{report.duration.round(2)} seconds"
+      say "\nFinished in #{total_time.round(2)} seconds"
 
       summary_color =
         if report.errored? || report.failure? || errored_files.any?
@@ -181,5 +205,7 @@ module Cuprum::Cli::Commands::Ci
     def trim_filename(filename)
       filename.sub(%r{\A#{file_system.root_path}/?}, '')
     end
+
+    def wildcard_pattern?(pattern) = pattern.include?('*')
   end
 end

data/lib/cuprum/cli/commands/ci.rb

@@ -8,5 +8,13 @@ module Cuprum::Cli::Commands
     autoload :Report,           'cuprum/cli/commands/ci/report'
     autoload :RSpecCommand,     'cuprum/cli/commands/ci/rspec_command'
     autoload :RSpecEachCommand, 'cuprum/cli/commands/ci/rspec_each_command'
+
+    # @return [Array<Class>] the default commands defined for running CI steps.
+    def self.commands
+      [
+        RSpecCommand,
+        RSpecEachCommand
+      ]
+    end
   end
 end

data/lib/cuprum/cli/commands/file/new_command.rb

@@ -2,8 +2,6 @@
 
 require 'cuprum/cli/command'
 require 'cuprum/cli/commands/file'
-require 'cuprum/cli/commands/file/render_erb'
-require 'cuprum/cli/commands/file/resolve_template'
 
 module Cuprum::Cli::Commands::File
   # Command for generating a templated file or files.
@@ -14,73 +12,68 @@ module Cuprum::Cli::Commands::File
     include Cuprum::Cli::Options::Quiet
     include Cuprum::Cli::Options::Verbose
 
+    class << self
+      # @return [Array<Class>] the default generators configured for the
+      #   command.
+      def default_generators
+        [
+          Cuprum::Cli::Files::Generators::RubyGenerator,
+          Cuprum::Cli::Files::Generators::RSpecGenerator
+        ]
+      end
+    end
+
     argument :file_path, type: String, required: true
 
-    option :directories,  type: :boolean, default: true
-    option :dry_run,      type: :boolean, default: false
-    option :parent_class, type: String
-    option :templates,
-      type:    Array,
-      default: Cuprum::Cli::Commands::File::Templates::DEFAULT_TEMPLATES
-    option :extra_flags,
-      type:     :boolean,
-      variadic: true
+    option :directories, type: :boolean, default: true
+    option :dry_run,     type: :boolean, default: false
+    option :generators,  type: :array,   default: default_generators
+    option :params,      type: :object,  variadic: true
 
     description 'Generates a new templated file or files.'
 
     private
 
-    def excluded_tags
-      excluded = []
+    def build_generator
+      generator = generators.reverse_each.find do |generator_class|
+        generator_class.match?(file_path, **params)
+      end
 
-      extra_flags.each do |flag, value|
-        excluded << flag if value == false
+      if generator
+        return generator.new(file_path, **params, **generator_options)
       end
 
-      excluded
+      details = 'no generator matches the file path and options'
+      failure(generator_error(details:))
     end
 
-    def generate_file(file_path:, parameters:, template_path:) # rubocop:disable Metrics/MethodLength
-      file_path = resolve_file_path(file_path, **parameters)
-      command   = GenerateFile.new(
-        file_system:,
-        standard_io:,
+    def generator_error(details: nil)
+      message = "unable to generate file #{file_path}"
+      message = "#{message} - #{details}" if details
+
+      Cuprum::Cli::Files::Errors::GeneratorError.new(
+        details:,
+        file_path:,
+        message:,
+        options:
+      )
+    end
+
+    def generator_options
+      {
         directories: directories?,
         dry_run:     dry_run?,
+        file_system:,
         quiet:       quiet?,
+        standard_io:,
         verbose:     verbose?
-      )
-
-      parameters = parameters.merge(parent_class:)
-
-      step { command.call(file_path:, parameters:, template_path:) }
-
-      file_path
+      }
     end
 
     def process
-      templates, parameters = step { resolve_template }
-
-      templates.map do |template|
-        file_path     = template.fetch(:file_path, self.file_path)
-        template_path = template.fetch(:template)
-
-        step { generate_file(file_path:, parameters:, template_path:) }
-      end
-    end
-
-    def resolve_file_path(file_path, **params)
-      params = tools.hash_tools.convert_keys_to_symbols(params)
-
-      format(file_path, params)
-    end
-
-    def resolve_template
-      command = Cuprum::Cli::Commands::File::ResolveTemplate.new(templates:)
+      generator = step { build_generator }
 
-      command.call(file_path, except: excluded_tags)
+      generator.call
     end
-
-    def tools = @tools ||= SleepingKingStudios::Tools::Toolbelt.instance
   end
 end

data/lib/cuprum/cli/commands/file.rb

@@ -5,10 +5,13 @@ require 'cuprum/cli/commands'
 module Cuprum::Cli::Commands
   # Namespace for commands that create or manage files.
   module File
-    autoload :GenerateFile,    'cuprum/cli/commands/file/generate_file'
-    autoload :NewCommand,      'cuprum/cli/commands/file/new_command'
-    autoload :RenderErb,       'cuprum/cli/commands/file/render_erb'
-    autoload :ResolveTemplate, 'cuprum/cli/commands/file/resolve_template'
-    autoload :Templates,       'cuprum/cli/commands/file/templates'
+    autoload :NewCommand, 'cuprum/cli/commands/file/new_command'
+
+    # @return [Array<Class>] the default commands defined for file management.
+    def self.commands
+      [
+        NewCommand
+      ]
+    end
   end
 end

data/lib/cuprum/cli/dependencies/clock/mock.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'cuprum/cli/dependencies/clock'
+
+module Cuprum::Cli::Dependencies
+  # Mock implementation of Clock for testing purposes.
+  class Clock::Mock < Cuprum::Cli::Dependencies::Clock
+    # @param current_time [Time] the current time in UTC time zone.
+    # @param monotonic_time [Numeric] the monotonic server time.
+    def initialize(current_time: nil, monotonic_time: nil)
+      super()
+
+      @current_time   = current_time || Time.now(in: 'Z')
+      @monotonic_time =
+        monotonic_time || Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    # @return [Numeric] the mocked monotonic time.
+    def get_monotonic_time # rubocop:disable Naming/AccessorMethodName
+      @monotonic_time
+    end
+
+    # @return [Time] the mocked current time.
+    def get_time = @current_time # rubocop:disable Naming/AccessorMethodName
+    alias current_time get_time
+    alias now get_time
+  end
+end

data/lib/cuprum/cli/dependencies/clock.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'cuprum/cli/dependencies'
+
+module Cuprum::Cli::Dependencies
+  # Utility wrapping the current time and time calculations.
+  class Clock
+    autoload :Mock, 'cuprum/cli/dependencies/clock/mock'
+
+    # @return [Numeric] a monotonically increasing system clock time.
+    def get_monotonic_time # rubocop:disable Naming/AccessorMethodName
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    # @return [Time] the current time in the UTC time zone.
+    def get_time = Time.now(in: 'Z') # rubocop:disable Naming/AccessorMethodName
+    alias current_time get_time
+    alias now get_time
+
+    # Measures the time elapsed while the block is run.
+    def measure
+      start_time = get_monotonic_time
+
+      yield
+
+      get_monotonic_time - start_time
+    end
+  end
+end