cuprum-cli 0.1.0 → 0.2.0

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'cuprum/cli/rspec/deferred'
+
+module Cuprum::Cli::RSpec::Deferred
+  # Deferred examples for testing generators options.
+  module GeneratorsExamples
+    include RSpec::SleepingKingStudios::Deferred::Provider
+
+    deferred_examples 'should output file' do |output_path, **examples_options|
+      description =
+        if examples_options.fetch(:as, :default) == :default
+          'should output file'
+        else
+          "should output #{examples_options[:as].inspect} file"
+        end
+
+      describe(description) do
+        let(:expected_key) do
+          next super() if defined?(super())
+
+          examples_options.fetch(:as, :default)
+        end
+        let(:expected_parameters) do
+          next super() if defined?(super())
+
+          subject.parameters
+        end
+        let(:expected_file_path) do
+          next super() if defined?(super())
+
+          format(output_path, **expected_parameters)
+        end
+        let(:expected_template_path) do
+          next super() if defined?(super())
+
+          path = examples_options.fetch(:template)
+
+          path.is_a?(Proc) ? instance_exec(&path) : path
+        end
+        let(:expected_contents) do
+          next super() if defined?(super())
+
+          template = file_system.read(expected_template_path)
+          result   =
+            Cuprum::Cli::Files::Engines::RenderErb
+            .new
+            .call(template, **expected_parameters)
+
+          raise result.error.message if result.failure?
+
+          result.value
+        end
+
+        if examples_options.fetch(:require_template, false)
+          # :nocov:
+          it 'should not generate the file', :aggregate_failures do
+            expect(subject.call).to be_a_failing_result
+
+            expect(file_system.file?(expected_file_path)).to be false
+          end
+          # :nocov:
+        else
+          it 'should generate the file', :aggregate_failures do
+            expect(subject.call).to be_a_passing_result
+
+            expect(file_system.read_file(expected_file_path))
+              .to eq(expected_contents)
+          end
+        end
+
+        if examples_options.fetch(:allow_skip, false)
+          context 'when initialized with key: false' do
+            let(:constructor_options) do
+              super().merge(expected_key => false)
+            end
+
+            it 'should not generate the file', :aggregate_failures do
+              expect(subject.call).to be_a_passing_result
+
+              expect(file_system.file?(expected_file_path)).to be false
+            end
+          end
+        end
+
+        if examples_options.fetch(:allow_custom_template, false) ||
+           examples_options.fetch(:require_template, false)
+          context 'when initialized with a custom template' do
+            let(:custom_template) { 'custom_template.erb' }
+            let(:constructor_options) do
+              super().merge("#{expected_key}_template": custom_template)
+            end
+
+            before(:example) do
+              file_system.write_file(
+                custom_template,
+                File.read(expected_template_path)
+              )
+            end
+
+            it 'should generate the file', :aggregate_failures do
+              expect(subject.call).to be_a_passing_result
+
+              expect(file_system.read_file(expected_file_path))
+                .to eq(expected_contents)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -63,6 +63,13 @@ module Cuprum::Cli::RSpec::Deferred
         end
       end
 
+      describe '.full_name?' do
+        it 'should define the class predicate' do
+          expect(described_class)
+            .to define_predicate(:full_name?)
+        end
+      end
+
       describe '.namespace' do
         include_examples 'should define class reader', :namespace
       end
@@ -77,6 +84,30 @@ module Cuprum::Cli::RSpec::Deferred
       describe '.short_name' do
         include_examples 'should define class reader', :short_name
       end
+
+      describe '.with_description' do
+        it 'should define the class method' do
+          expect(described_class)
+            .to respond_to(:with_description)
+            .with(1).argument
+        end
+      end
+
+      describe '.with_full_description' do
+        it 'should define the class method' do
+          expect(described_class)
+            .to respond_to(:with_full_description)
+            .with(1).argument
+        end
+      end
+
+      describe '.with_full_name' do
+        it 'should define the class method' do
+          expect(described_class)
+            .to respond_to(:with_full_name)
+            .with(1).argument
+        end
+      end
     end
 
     deferred_examples 'should define metadata for the command' do
@@ -774,6 +805,58 @@ module Cuprum::Cli::RSpec::Deferred
         end
       end
 
+      describe '.full_name?' do
+        it { expect(described_class.full_name?).to be false }
+
+        context 'when the command has a configured full name' do
+          before(:example) do
+            described_class.full_name('category:sub_category:do_something')
+          end
+
+          it { expect(described_class.full_name?).to be true }
+        end
+
+        wrap_deferred 'when the command is an anonymous class' do
+          it { expect(described_class.full_name?).to be false }
+
+          context 'when the command has a configured full name' do
+            before(:example) do
+              described_class.full_name('category:sub_category:do_something')
+            end
+
+            it { expect(described_class.full_name?).to be true }
+          end
+        end
+
+        wrap_deferred 'when the command has a parent command' do
+          it { expect(described_class.full_name?).to be false }
+
+          context 'when the command has a configured full name' do
+            before(:example) do
+              described_class.full_name('category:sub_category:do_something')
+            end
+
+            it { expect(described_class.full_name?).to be true }
+          end
+
+          context 'when the parent command has a configured full name' do
+            before(:example) do
+              parent_class.full_name('category:sub_category:parent_command')
+            end
+
+            it { expect(described_class.full_name?).to be false }
+
+            context 'when the command has a configured full name' do
+              before(:example) do
+                described_class.full_name('category:sub_category:do_something')
+              end
+
+              it { expect(described_class.full_name?).to be true }
+            end
+          end
+        end
+      end
+
       describe '.namespace' do
         it { expect(described_class.namespace).to be == 'spec' }
 
@@ -851,6 +934,223 @@ module Cuprum::Cli::RSpec::Deferred
           it { expect(described_class.short_name).to be == expected }
         end
       end
+
+      describe '.with_description' do
+        describe 'with nil' do
+          let(:error_message) do
+            tools.assertions.error_message_for('presence', as: 'description')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_description(nil) }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an Object' do
+          let(:error_message) do
+            tools.assertions.error_message_for('name', as: 'description')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_description(Object.new.freeze) }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an empty String' do
+          let(:error_message) do
+            tools.assertions.error_message_for('presence', as: 'description')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_description('') }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with a non-empty String' do
+          let(:value) do
+            'No one is quite sure what this does.'
+          end
+
+          it 'should return the command class' do
+            expect(described_class.with_description(value))
+              .to be described_class
+          end
+
+          it 'should set the description' do
+            expect { described_class.with_description(value) }
+              .to change(described_class, :description)
+              .to be == value
+          end
+        end
+      end
+
+      describe '.with_full_description' do
+        describe 'with nil' do
+          let(:error_message) do
+            tools
+              .assertions
+              .error_message_for('presence', as: 'full_description')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_full_description(nil) }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an Object' do
+          let(:error_message) do
+            tools.assertions.error_message_for('name', as: 'full_description')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_full_description(Object.new.freeze) }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an empty String' do
+          let(:error_message) do
+            tools
+              .assertions
+              .error_message_for('presence', as: 'full_description')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_full_description('') }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with a non-empty String' do
+          let(:value) do
+            <<~DESC
+              No one is quite sure what this does.
+
+              ...but it sure looks cool!
+            DESC
+          end
+
+          it 'should return the command class' do
+            expect(described_class.with_full_description(value))
+              .to be described_class
+          end
+
+          it 'should set the full description' do
+            expect { described_class.with_full_description(value) }
+              .to change(described_class, :full_description)
+              .to be == value
+          end
+        end
+
+        context 'when the command has a description' do
+          let(:description) do
+            'No one is quite sure what this does.'
+          end
+
+          before(:example) do
+            described_class.description(description)
+          end
+
+          describe 'with a non-empty String' do
+            let(:value) do
+              <<~DESC
+                No one is quite sure what this does.
+
+                ...but it sure looks cool!
+              DESC
+            end
+
+            it 'should return the command class' do
+              expect(described_class.with_full_description(value))
+                .to be described_class
+            end
+
+            it 'should set the full description' do
+              expect { described_class.with_full_description(value) }
+                .to change(described_class, :full_description)
+                .to be == value
+            end
+          end
+        end
+      end
+
+      describe '.with_full_name' do
+        describe 'with nil' do
+          let(:error_message) do
+            tools.assertions.error_message_for('presence', as: 'full_name')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_full_name(nil) }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an Object' do
+          let(:error_message) do
+            tools.assertions.error_message_for('name', as: 'full_name')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_full_name(Object.new.freeze) }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an empty String' do
+          let(:error_message) do
+            tools.assertions.error_message_for('presence', as: 'full_name')
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_full_name('') }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an invalid String' do
+          let(:error_message) do
+            'full_name does not match format category:sub_category:do_something'
+          end
+
+          it 'should raise an exception' do
+            expect { described_class.with_full_name(described_class.name) }
+              .to raise_error ArgumentError, error_message
+          end
+        end
+
+        describe 'with an valid String' do
+          let(:value) { 'do_something' }
+
+          it 'should return the command class' do
+            expect(described_class.with_full_name(value)).to be described_class
+          end
+
+          it 'should set the full name' do
+            expect { described_class.with_full_name(value) }
+              .to change(described_class, :full_name)
+              .to be == value
+          end
+        end
+
+        describe 'with an valid scoped String' do
+          let(:value) { 'category:sub_category:do_something' }
+
+          it 'should return the command class' do
+            expect(described_class.with_full_name(value)).to be described_class
+          end
+
+          it 'should set the full name' do
+            expect { described_class.full_name(value) }
+              .to change(described_class, :full_name)
+              .to be == value
+          end
+        end
+      end
     end
   end
 end

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

@@ -13,7 +13,7 @@ module Cuprum::Cli::RSpec::Deferred
       describe "should define option #{option_name.inspect}" do
         boolean_option =
           option_options[:type] == :boolean && !option_options[:variadic]
-        expect_method  =
+        expect_method =
           option_options
           .fetch(:define_method, !boolean_option)
         expect_predicate =
@@ -183,7 +183,13 @@ module Cuprum::Cli::RSpec::Deferred
         end
 
         describe '#default' do
-          it { expect(defined_option.default).to be == configured_default }
+          let(:option_default) do
+            default = defined_option.default
+
+            default.is_a?(Proc) ? default.call : default
+          end
+
+          it { expect(option_default).to be == configured_default }
         end
 
         describe '#description' do