cuprum-cli 0.1.0 → 0.2.0

data/lib/cuprum/cli/rspec/deferred/templates_examples.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'rspec/sleeping_king_studios/deferred/provider'
+
+require 'cuprum/cli/rspec/deferred'
+
+module Cuprum::Cli::RSpec::Deferred
+  # Deferred examples for testing file generator templates.
+  module TemplatesExamples
+    include RSpec::SleepingKingStudios::Deferred::Provider
+
+    deferred_examples 'should apply the configured engine' do
+      context 'when initialized with engine: ERB' do
+        let(:engine)     { Cuprum::Cli::Files::Engines::ERB }
+        let(:options)    { super().merge(engine:) }
+        let(:parameters) { defined?(super()) ? super() : {} }
+
+        it 'should return a passing result with the rendered template' do
+          expect(template.call(**parameters))
+            .to be_a_passing_result
+            .with_value(raw_value)
+        end
+
+        describe 'with extra parameters' do
+          let(:parameters) { super().merge(extra_parameter: 'extra value') }
+
+          it 'should return a passing result with the rendered template' do
+            expect(template.call(**parameters))
+              .to be_a_passing_result
+              .with_value(raw_value)
+          end
+        end
+
+        describe 'with a parameterized template' do
+          let(:raw_value) { '<h1><%= greeting %></h1>' }
+
+          describe 'with a missing parameter' do
+            let(:expected_template_name) do
+              next unless defined?(template_name)
+
+              value = template_name
+
+              value = instance_exec(&value) if value.is_a?(Proc)
+
+              value
+            end
+            let(:expected_error) do
+              Cuprum::Cli::Files::Errors::MissingParameter.new(
+                message:        'unable to render ERB template',
+                parameter_name: :greeting,
+                template_name:  expected_template_name
+              )
+            end
+
+            it 'should return a failing result' do
+              expect(template.call(**parameters))
+                .to be_a_failing_result
+                .with_error(expected_error)
+            end
+          end
+
+          describe 'with a parameter of invalid type' do
+            let(:raw_value) { "<h1><%= greetings.join(', ') %></h1>" }
+            let(:parameters) do
+              super().merge(greetings: 'Greetings, starfighter!')
+            end
+            let(:expected_template_name) do
+              next unless defined?(template_name)
+
+              value = template_name
+
+              value = instance_exec(&value) if value.is_a?(Proc)
+
+              value
+            end
+            let(:expected_error) do
+              message =
+                begin
+                  'Greetings, starfighter!'.join
+                rescue NameError => exception
+                  exception.message
+                end
+
+              Cuprum::Cli::Files::Errors::TemplateError.new(
+                message:       "unable to render ERB template - #{message}",
+                template_name: expected_template_name
+              )
+            end
+
+            it 'should return a failing result' do
+              expect(template.call(**parameters))
+                .to be_a_failing_result
+                .with_error(expected_error)
+            end
+          end
+
+          describe 'with valid parameters' do
+            let(:parameters) do
+              super().merge(greeting: 'Greetings, starfighter!')
+            end
+            let(:expected_value) do
+              "<h1>#{parameters[:greeting]}</h1>"
+            end
+
+            it 'should return a passing result' do
+              expect(template.call(**parameters))
+                .to be_a_passing_result
+                .with_value(expected_value)
+            end
+          end
+
+          describe 'with extra parameters' do
+            let(:parameters) do
+              super().merge(
+                extra_parameter: 'extra value',
+                greeting:        'Greetings, starfighter!'
+              )
+            end
+            let(:expected_value) do
+              "<h1>#{parameters[:greeting]}</h1>"
+            end
+
+            it 'should return a passing result' do
+              expect(template.call(**parameters))
+                .to be_a_passing_result
+                .with_value(expected_value)
+            end
+          end
+        end
+      end
+
+      context 'when initialized with engine: an unknown engine' do
+        let(:engine)     { 'spec.undefined.engine' }
+        let(:options)    { super().merge(engine:) }
+        let(:parameters) { defined?(super()) ? super() : {} }
+        let(:expected_error) do
+          details = "unknown template engine #{engine.inspect}"
+
+          Cuprum::Cli::Files::Errors::TemplateError.new(
+            details:,
+            message: "unable to render template - #{details}"
+          )
+        end
+
+        it 'should return a failing result with a template error' do
+          expect(template.call(**parameters))
+            .to be_a_failing_result
+            .with_error(expected_error)
+        end
+      end
+    end
+
+    deferred_examples 'should implement the Template interface' do
+      describe '#call' do
+        let(:parameters) do
+          defined?(super()) ? super() : { parameter: 'value' }
+        end
+
+        it 'should define the method' do
+          expect(subject)
+            .to be_callable
+            .with(0).arguments
+            .and_any_keywords
+        end
+      end
+
+      describe '#engine' do
+        include_examples 'should define reader', :engine, nil
+
+        context 'when initialized with engine: value' do
+          let(:engine)  { Cuprum::Cli::Files::Engines::ERB }
+          let(:options) { super().merge(engine:) }
+
+          it { expect(subject.engine).to be engine }
+        end
+      end
+
+      describe '#raw_value' do
+        include_examples 'should define private reader', :raw_value
+      end
+    end
+  end
+end

data/lib/cuprum/cli/version.rb

@@ -11,7 +11,7 @@ module Cuprum
       # Major version.
       MAJOR = 0
       # Minor version.
-      MINOR = 1
+      MINOR = 2
       # Patch version.
       PATCH = 0
       # Prerelease version.

data/lib/cuprum/cli.rb

@@ -16,6 +16,7 @@ module Cuprum
     autoload :Commands,     'cuprum/cli/commands'
     autoload :Dependencies, 'cuprum/cli/dependencies'
     autoload :Errors,       'cuprum/cli/errors'
+    autoload :Files,        'cuprum/cli/files'
     autoload :Metadata,     'cuprum/cli/metadata'
     autoload :Option,       'cuprum/cli/option'
     autoload :Options,      'cuprum/cli/options'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuprum-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
@@ -95,14 +95,10 @@ files:
 - lib/cuprum/cli/commands/ci/rspec_each_command.rb
 - lib/cuprum/cli/commands/echo_command.rb
 - lib/cuprum/cli/commands/file.rb
-- lib/cuprum/cli/commands/file/generate_file.rb
 - lib/cuprum/cli/commands/file/new_command.rb
-- lib/cuprum/cli/commands/file/render_erb.rb
-- lib/cuprum/cli/commands/file/resolve_template.rb
-- lib/cuprum/cli/commands/file/templates.rb
-- lib/cuprum/cli/commands/file/templates/rspec.rb.erb
-- lib/cuprum/cli/commands/file/templates/ruby.rb.erb
 - lib/cuprum/cli/dependencies.rb
+- lib/cuprum/cli/dependencies/clock.rb
+- lib/cuprum/cli/dependencies/clock/mock.rb
 - lib/cuprum/cli/dependencies/file_system.rb
 - lib/cuprum/cli/dependencies/file_system/mock.rb
 - lib/cuprum/cli/dependencies/standard_io.rb
@@ -111,14 +107,33 @@ files:
 - lib/cuprum/cli/dependencies/system_command.rb
 - lib/cuprum/cli/dependencies/system_command/mock.rb
 - lib/cuprum/cli/errors.rb
-- lib/cuprum/cli/errors/files.rb
-- lib/cuprum/cli/errors/files/file_not_writeable.rb
-- lib/cuprum/cli/errors/files/missing_parameter.rb
-- lib/cuprum/cli/errors/files/missing_template.rb
-- lib/cuprum/cli/errors/files/template_error.rb
-- lib/cuprum/cli/errors/files/template_not_resolved.rb
 - lib/cuprum/cli/errors/system_command_failure.rb
+- lib/cuprum/cli/files.rb
+- lib/cuprum/cli/files/create_file.rb
+- lib/cuprum/cli/files/engines.rb
+- lib/cuprum/cli/files/engines/render_erb.rb
+- lib/cuprum/cli/files/errors.rb
+- lib/cuprum/cli/files/errors/file_not_writeable.rb
+- lib/cuprum/cli/files/errors/generator_error.rb
+- lib/cuprum/cli/files/errors/missing_parameter.rb
+- lib/cuprum/cli/files/errors/missing_template.rb
+- lib/cuprum/cli/files/errors/template_error.rb
+- lib/cuprum/cli/files/generator.rb
+- lib/cuprum/cli/files/generators.rb
+- lib/cuprum/cli/files/generators/basic_generator.rb
+- lib/cuprum/cli/files/generators/rspec_generator.rb
+- lib/cuprum/cli/files/generators/ruby_generator.rb
+- lib/cuprum/cli/files/template.rb
+- lib/cuprum/cli/files/templates.rb
+- lib/cuprum/cli/files/templates/basic_template.rb
+- lib/cuprum/cli/files/templates/file_template.rb
+- lib/cuprum/cli/files/templates/rspec.rb.erb
+- lib/cuprum/cli/files/templates/ruby.rb.erb
+- lib/cuprum/cli/files/templates/string_template.rb
 - lib/cuprum/cli/integrations.rb
+- lib/cuprum/cli/integrations/async.rb
+- lib/cuprum/cli/integrations/async/commands.rb
+- lib/cuprum/cli/integrations/async/commands/rspec_each_command.rb
 - lib/cuprum/cli/integrations/thor.rb
 - lib/cuprum/cli/integrations/thor/arguments_parser.rb
 - lib/cuprum/cli/integrations/thor/registry.rb
@@ -137,9 +152,11 @@ files:
 - lib/cuprum/cli/rspec/deferred/ci/report_examples.rb
 - lib/cuprum/cli/rspec/deferred/dependencies.rb
 - lib/cuprum/cli/rspec/deferred/dependencies/file_system_examples.rb
+- lib/cuprum/cli/rspec/deferred/generators_examples.rb
 - lib/cuprum/cli/rspec/deferred/metadata_examples.rb
 - lib/cuprum/cli/rspec/deferred/options_examples.rb
 - lib/cuprum/cli/rspec/deferred/registry_examples.rb
+- lib/cuprum/cli/rspec/deferred/templates_examples.rb
 - lib/cuprum/cli/version.rb
 homepage: http://sleepingkingstudios.com
 licenses:
@@ -167,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.15
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A command-line utility powered by Cuprum.
 test_files: []

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

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-require 'cuprum/command'
-
-require 'cuprum/cli/commands/file'
-require 'cuprum/cli/errors/files/template_not_resolved'
-
-module Cuprum::Cli::Commands::File
-  # Utility command for resolving a template and parameterized values.
-  class ResolveTemplate < Cuprum::Command
-    # @param templates [Array<Hash>] the defined templates.
-    def initialize(templates:)
-      super()
-
-      @templates = templates
-    end
-
-    # @return [Array<Hash>] the defined templates.
-    attr_reader :templates
-
-    private
-
-    def default_params(file_path:, **params) # rubocop:disable Metrics/MethodLength
-      dir_name   = File.dirname(file_path)
-      ext_name   = File.extname(file_path)
-      base_name  = File.basename(file_path)
-      short_name = base_name.split('.').first
-
-      {
-        base_name:,
-        dir_name:,
-        ext_name:,
-        file_path:,
-        short_name:,
-        **params
-      }
-    end
-
-    def filter_templates(except:, file_templates:, only:)
-      file_templates = [file_templates] unless file_templates.is_a?(Array)
-      except         = Array(except).map(&:to_s)
-      only           = Array(only).map(&:to_s)
-
-      unless except.empty?
-        file_templates = reject_templates(file_templates, *except)
-      end
-
-      unless only.empty?
-        file_templates = select_templates(file_templates, *only)
-      end
-
-      file_templates
-    end
-
-    def match_pattern(pattern, file_path)
-      case pattern
-      when Proc
-        pattern.call(file_path)
-      when Regexp
-        match_regexp(pattern, file_path)
-      when String
-        { file_path: } if file_path.end_with?(pattern)
-      else
-        # :nocov:
-        false
-        # :nocov:
-      end
-    end
-
-    def match_regexp(pattern, file_path)
-      pattern
-        .match(file_path)
-        &.named_captures
-        &.then { |captures| tools.hash_tools.convert_keys_to_symbols(captures) }
-    end
-
-    def process(file_path, except: [], only: []) # rubocop:disable Metrics/MethodLength
-      templates.each do |hsh|
-        params = match_pattern(hsh.fetch(:pattern), file_path)
-
-        next unless params
-
-        file_templates = hsh.fetch(:templates)
-        file_templates = step do
-          filter_templates(file_templates:, except:, only:)
-        end
-
-        step { require_templates(file_path:, file_templates:, except:, only:) }
-
-        return success([file_templates, default_params(file_path:, **params)])
-      end
-
-      message = 'no template matching file path'
-
-      failure(template_not_resolved_error(file_path:, message:))
-    end
-
-    def reject_templates(file_templates, *filters)
-      file_templates.reject do |template|
-        types = template.fetch(:types, Array(template[:type])).map(&:to_s)
-
-        types.any? { |type| filters.include?(type) }
-      end
-    end
-
-    def require_templates(file_path:, file_templates:, except:, only:)
-      return unless file_templates.empty?
-
-      options = {}
-      options[:except] = except unless except.empty?
-      options[:only]   = only   unless only.empty?
-
-      error = template_not_resolved_error(
-        file_path:,
-        message:   'all templates filtered out',
-        options:
-      )
-
-      failure(error)
-    end
-
-    def select_templates(file_templates, *filters)
-      file_templates.select do |template|
-        types = template.fetch(:types, Array(template[:type])).map(&:to_s)
-
-        types.any? { |type| filters.include?(type) }
-      end
-    end
-
-    def template_not_resolved_error(**)
-      Cuprum::Cli::Errors::Files::TemplateNotResolved.new(**)
-    end
-
-    def tools = @tools ||= SleepingKingStudios::Tools::Toolbelt.instance
-  end
-end

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

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'cuprum/cli/commands/file'
-
-module Cuprum::Cli::Commands::File
-  # Namespace for defining templates for generated files.
-  module Templates
-    RSPEC_PATTERN = <<~PATTERN.strip.then { |pattern| /#{pattern}/xo }
-      \\A
-      (?<root_path>\\w+#{File::SEPARATOR})?
-      (?<relative_path>(\\w+#{File::SEPARATOR})*)
-      (?<base_name>\\w+)_spec\\.rb
-      \\z
-    PATTERN
-    private_constant :RSPEC_PATTERN
-
-    RUBY_PATTERN = <<~PATTERN.strip.then { |pattern| /#{pattern}/xo }
-      \\A
-      (?<root_path>\\w+#{File::SEPARATOR})?
-      (?<relative_path>(\\w+#{File::SEPARATOR})*)
-      (?<base_name>\\w+)\\.rb
-      \\z
-    PATTERN
-    private_constant :RUBY_PATTERN
-
-    TEMPLATES_PATH =
-      File
-      .join(
-        Cuprum::Cli.gem_path,
-        'lib',
-        'cuprum',
-        'cli',
-        'commands',
-        'file',
-        'templates'
-      )
-      .freeze
-    private_constant :TEMPLATES_PATH
-
-    # Default templates used to generate Ruby and RSpec files.
-    DEFAULT_TEMPLATES = [
-      {
-        name:      'RSpec File',
-        pattern:   RSPEC_PATTERN,
-        templates: {
-          file_path: '%<root_path>s%<relative_path>s%<base_name>s_spec.rb',
-          template:  File.join(TEMPLATES_PATH, 'rspec.rb.erb'),
-          types:     %i[ruby rspec spec test]
-        }
-      },
-      {
-        name:      'Ruby File (With Spec)',
-        pattern:   RUBY_PATTERN,
-        templates: [
-          {
-            file_path: '%<root_path>s%<relative_path>s%<base_name>s.rb',
-            template:  File.join(TEMPLATES_PATH, 'ruby.rb.erb'),
-            type:      :ruby
-          },
-          {
-            file_path: 'spec/%<relative_path>s%<base_name>s_spec.rb',
-            template:  File.join(TEMPLATES_PATH, 'rspec.rb.erb'),
-            types:     %i[ruby rspec spec test]
-          }
-        ]
-      }
-    ].then do |ary|
-      SleepingKingStudios::Tools::Toolbelt.instance.array_tools.deep_freeze(ary)
-    end
-  end
-end

data/lib/cuprum/cli/errors/files/template_not_resolved.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'cuprum/cli/errors/files'
-require 'cuprum/cli/errors/files/template_error'
-
-module Cuprum::Cli::Errors::Files
-  # Error returned when unable to resolve a template for a templated file.
-  class TemplateNotResolved < Cuprum::Cli::Errors::Files::TemplateError
-    # Short string used to identify the type of error.
-    TYPE = 'cuprum.cli.errors.files.template_not_resolved'
-
-    # @param file_path [String] the file path for the templated file.
-    # @param details [String] additional information about the error.
-    # @param message [String] an optional message to display.
-    # @param options [Hash] options used when attempting to resolve the
-    #   template.
-    def initialize(file_path:, details: nil, message: nil, options: {})
-      @file_path = file_path
-      @options   = options
-
-      super(details:, file_path:, message: default_message(message), options:)
-    end
-
-    # @return [String] the file path for the templated file.
-    attr_reader :file_path
-
-    # @return [Hash] options used when attempting to resolve the template.
-    attr_reader :options
-
-    private
-
-    def as_json_data
-      hsh = super
-
-      hsh['file_path'] = file_path
-      hsh['options']   = options.transform_keys(&:to_s) unless options.empty?
-
-      hsh
-    end
-
-    def default_message(message)
-      str = "unable to resolve template for file #{file_path}"
-      str = "#{str} with options" unless options.empty?
-
-      options.each.with_index do |(key, value), index|
-        str += "#{',' unless index.zero?} #{key}: #{value.inspect}"
-      end
-
-      return str unless message && !message.empty?
-
-      "#{str} - #{message}"
-    end
-  end
-end

data/lib/cuprum/cli/errors/files.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'cuprum/cli/errors'
-
-module Cuprum::Cli::Errors
-  # Namespace for errors returned when creating or managing files.
-  module Files
-    autoload :FileNotWriteable,
-      'cuprum/cli/errors/files/file_not_writeable'
-    autoload :MissingParameter,
-      'cuprum/cli/errors/files/missing_parameter'
-    autoload :MissingTemplate,
-      'cuprum/cli/errors/files/missing_template'
-    autoload :TemplateError,
-      'cuprum/cli/errors/files/template_error'
-    autoload :TemplateNotResolved,
-      'cuprum/cli/errors/files/template_not_resolved'
-  end
-end