command_kit 0.2.2 → 0.3.0

data/spec/file_utils_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'command_kit/file_utils'
+require 'tempfile'
+
+describe CommandKit::FileUtils do
+  module TestFileUtils
+    class Command
+      include CommandKit::FileUtils
+
+      attr_reader :var
+
+      def initialize(var: nil)
+        super()
+
+        @var = var
+      end
+
+      def test_method
+        'some method'
+      end
+    end
+  end
+
+  let(:var) { 42 }
+
+  let(:command_class) { TestFileUtils::Command }
+  subject { command_class.new(var: var) }
+
+  let(:fixtures_dir)  { File.expand_path(File.join(__dir__,'fixtures')) }
+  let(:template_path) { File.join(fixtures_dir,'template.erb') }
+
+  describe "#erb" do
+    let(:expected_result) do
+      [
+        "Raw text",
+        '',
+        "variable = #{var}",
+        '',
+        "method = #{subject.test_method}"
+      ].join($/)
+    end
+
+    context "when only given a source file argument" do
+      it "must render the erb template and return the result" do
+        expect(subject.erb(template_path)).to eq(expected_result)
+      end
+    end
+
+    context "when given an additional destination file argument" do
+      let(:dest_path) { Tempfile.new.path }
+
+      before { subject.erb(template_path,dest_path) }
+
+      it "must render the erb template and write the result to the destination" do
+        expect(File.read(dest_path)).to eq(expected_result)
+      end
+    end
+  end
+end

data/spec/fixtures/template.erb

@@ -0,0 +1,5 @@
+Raw text
+
+variable = <%= @var %>
+
+method = <%= test_method -%>

data/spec/options/option_spec.rb

@@ -145,6 +145,20 @@ describe CommandKit::Options::Option do
       end
     end
 
+    it "must default #category to nil" do
+      expect(subject.category).to be(nil)
+    end
+
+    context "when the category: keyword is given" do
+      let(:category) { 'Other Options' }
+
+      subject { described_class.new(name, desc: desc, category: category) }
+
+      it "must set #category" do
+        expect(subject.category).to eq(category)
+      end
+    end
+
     context "when a block is given" do
       subject { described_class.new(name, desc: desc, &block) }
 
@@ -293,5 +307,27 @@ describe CommandKit::Options::Option do
         expect(subject.desc).to eq("#{desc} (Default: #{default})")
       end
     end
+
+    context "when #desc was initialized with an Array" do
+      let(:desc) do
+        [
+          'Line 1',
+          'Line 2'
+        ]
+      end
+
+      it "must return the desc: value" do
+        expect(subject.desc).to eq(desc)
+      end
+
+      context "when #value has been initialized with a default value" do
+        let(:default)  { "foo" }
+        let(:value) { {default: default} }
+
+        it "should append '(Default: ...)' to the desc Array" do
+          expect(subject.desc).to eq([*desc, "(Default: #{default})"])
+        end
+      end
+    end
   end
 end

data/spec/options/parser_spec.rb

@@ -34,16 +34,6 @@ describe CommandKit::Options::Parser do
       expect(subject.option_parser.banner).to eq("Usage: #{subject.usage}")
     end
 
-    it "must include a 'Options:' separator" do
-      expect(subject.option_parser.to_s).to include(
-        [
-          '',
-          'Options:',
-          ''
-        ].join($/)
-      )
-    end
-
     it "must define a default --help option" do
       expect(subject.option_parser.to_s).to include(
         [

data/spec/options_spec.rb

@@ -415,5 +415,51 @@ describe CommandKit::Options do
         ].join($/)
       ).to_stdout
     end
+
+    context "but when the options are have categories" do
+      module TestOptions
+        class TestCommandWithOptionsAndCategories
+
+          include CommandKit::Options
+
+          option :opt1, short: '-a',
+                        desc: "Option 1"
+          option :opt2, short: '-b',
+                        desc: "Option 2"
+
+          option :opt3, short:    '-c',
+                        desc:     "Option 3",
+                        category: 'Other Options'
+          option :opt4, short:    '-d',
+                        desc:     "Option 4",
+                        category: 'Other Options'
+        end
+      end
+
+      let(:command_class) { TestOptions::TestCommandWithOptionsAndCategories }
+
+      let(:option1)   { command_class.options[:opt1] }
+      let(:option2)   { command_class.options[:opt2] }
+      let(:option3)   { command_class.options[:opt3] }
+      let(:option4)   { command_class.options[:opt4] }
+
+      it "must group the options by category" do
+        expect { subject.help }.to output(
+          [
+            "Usage: #{subject.usage}",
+            '',
+            'Other Options:',
+            "    #{option3.usage.join(', ').ljust(33 - 1)} #{option3.desc}",
+            "    #{option4.usage.join(', ').ljust(33 - 1)} #{option4.desc}",
+            '',
+            'Options:',
+            "    #{option1.usage.join(', ').ljust(33 - 1)} #{option1.desc}",
+            "    #{option2.usage.join(', ').ljust(33 - 1)} #{option2.desc}",
+            '    -h, --help                       Print help information',
+            ''
+          ].join($/)
+        ).to_stdout
+      end
+    end
   end
 end

data/spec/program_name_spec.rb

@@ -56,6 +56,14 @@ describe CommandKit::ProgramName do
     end
   end
 
+  describe "#command_name" do
+    subject { command_class.new }
+
+    it "should be the same as #program_name" do
+      expect(subject.command_name).to eq(subject.program_name)
+    end
+  end
+
   after do
     $PROGRAM_NAME = @original_program_name
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_kit
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Postmodern
@@ -71,6 +71,7 @@ files:
 - lib/command_kit/env/path.rb
 - lib/command_kit/examples.rb
 - lib/command_kit/exception_handler.rb
+- lib/command_kit/file_utils.rb
 - lib/command_kit/help.rb
 - lib/command_kit/help/man.rb
 - lib/command_kit/inflector.rb
@@ -121,6 +122,8 @@ files:
 - spec/env_spec.rb
 - spec/examples_spec.rb
 - spec/exception_handler_spec.rb
+- spec/file_utils_spec.rb
+- spec/fixtures/template.erb
 - spec/help/man_spec.rb
 - spec/help_spec.rb
 - spec/inflector_spec.rb