command_kit 0.1.0.pre2 → 0.2.1

data/spec/options_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/options'
 
-describe Options do
+describe CommandKit::Options do
   module TestOptions
     class ImplicitCmd
       include CommandKit::Options
@@ -133,5 +133,287 @@ describe Options do
     it "must initialize #options" do
       expect(subject.options).to eq({})
     end
+
+    context "when options have default values" do
+      module TestOptions
+        class TestCommandWithDefaultValues
+
+          include CommandKit::Options
+
+          option :option1, value: {
+                             required: true,
+                             type: String
+                           },
+                           desc: 'Option 1'
+
+          option :option2, value: {
+                             required: false,
+                             type: String,
+                             default: "foo"
+                           },
+                           desc: 'Option 2'
+        end
+      end
+
+      let(:command_class) { TestOptions::TestCommandWithDefaultValues }
+
+      it "must pre-populate #options with the default values" do
+        expect(subject.options).to_not have_key(:option1)
+        expect(subject.options).to have_key(:option2)
+        expect(subject.options[:option2]).to eq("foo")
+      end
+    end
+  end
+
+  module TestOptions
+    class TestCommandWithOptionsAndArguments
+
+      include CommandKit::Options
+
+      usage '[OPTIONS] ARG1 [ARG2]'
+
+      option :option1, short: '-a',
+                       value: {
+                         type: Integer,
+                         default: 1
+                       },
+                       desc: "Option 1"
+
+      option :option2, short: '-b',
+                       value: {
+                         type: String,
+                         usage: 'FILE'
+                       },
+                       desc: "Option 2"
+
+      argument :argument1, required: true,
+                           usage:    'ARG1',
+                           desc:     "Argument 1"
+
+      argument :argument2, required: false,
+                           usage:    'ARG2',
+                           desc:     "Argument 2"
+
+    end
+  end
+
+  describe "#option_parser" do
+    context "when an option does not accept a value" do
+      module TestOptions
+        class TestCommandWithOptionWithoutValue
+
+          include CommandKit::Options
+
+          option :opt, desc: "Option without a value"
+
+        end
+      end
+
+      let(:command_class) { TestOptions::TestCommandWithOptionWithoutValue }
+
+      context "but the option flag was not given" do
+        let(:argv) { [] }
+
+        before { subject.option_parser.parse(argv) }
+
+        it "must not populate #options with a value" do
+          expect(subject.options).to be_empty
+        end
+      end
+
+      context "and the option flag was given" do
+        let(:argv) { %w[--opt] }
+
+        before { subject.option_parser.parse(argv) }
+
+        it "must set a key in #options to true" do
+          expect(subject.options[:opt]).to be(true)
+        end
+      end
+    end
+
+    context "when an option requires a value" do
+      module TestOptions
+        class TestCommandWithOptionWithRequiredValue
+
+          include CommandKit::Options
+
+          option :opt, value: {
+                         required: true,
+                         type: String
+                       },
+                       desc: "Option without a value"
+
+        end
+      end
+
+      let(:command_class) do
+        TestOptions::TestCommandWithOptionWithRequiredValue
+      end
+
+      context "but the option flag was not given" do
+        let(:argv) { [] }
+
+        before { subject.option_parser.parse(argv) }
+
+        it "must not populate #options with a value" do
+          expect(subject.options).to be_empty
+        end
+      end
+
+      context "and the option flag and value were given" do
+        let(:value) { 'foo'            }
+        let(:argv)  { ['--opt', value] }
+
+        before { subject.option_parser.parse(argv) }
+
+        it "must set a key in #options to the value" do
+          expect(subject.options[:opt]).to eq(value)
+        end
+      end
+    end
+
+    context "when an option does not require a value" do
+      module TestOptions
+        class TestCommandWithOptionWithOptionalValue
+
+          include CommandKit::Options
+
+          option :opt, value: {
+                         required: false,
+                         type: String
+                       },
+                       desc: "Option without a value"
+
+        end
+      end
+
+      let(:command_class) do
+        TestOptions::TestCommandWithOptionWithOptionalValue
+      end
+
+      context "but the option flag was not given" do
+        let(:argv) { [] }
+
+        before { subject.option_parser.parse(argv) }
+
+        it "must not populate #options with a value" do
+          expect(subject.options).to be_empty
+        end
+      end
+
+      context "and the option flag and value were given" do
+        let(:value) { 'foo'            }
+        let(:argv)  { ['--opt', value] }
+
+        before { subject.option_parser.parse(argv) }
+
+        it "must set a key in #options to the value" do
+          expect(subject.options[:opt]).to eq(value)
+        end
+      end
+
+      context "and the option has a default value" do
+        module TestOptions
+          class TestCommandWithOptionWithOptionalValueAndDefaultValue
+
+            include CommandKit::Options
+
+            option :opt, value: {
+                           required: false,
+                           type: String,
+                           default: "bar"
+                         },
+                         desc: "Option without a value"
+
+          end
+        end
+
+        let(:command_class) do
+          TestOptions::TestCommandWithOptionWithOptionalValueAndDefaultValue
+        end
+
+        context "but the option flag was not given" do
+          let(:argv) { [] }
+
+          before { subject.option_parser.parse(argv) }
+
+          it "must set a key in #options to the default value" do
+            expect(subject.options[:opt]).to eq("bar")
+          end
+        end
+
+        context "and the option flag and value were given" do
+          let(:value) { 'foo'            }
+          let(:argv)  { ['--opt', value] }
+
+          before { subject.option_parser.parse(argv) }
+
+          it "must set a key in #options to the value" do
+            expect(subject.options[:opt]).to eq(value)
+          end
+        end
+
+        context "and the option flag but not the value are given" do
+          let(:argv)  { ['--opt'] }
+
+          before { subject.option_parser.parse(argv) }
+
+          it "must set a key in #options to nil" do
+            expect(subject.options).to have_key(:opt)
+            expect(subject.options[:opt]).to be(nil)
+          end
+        end
+      end
+    end
+  end
+
+  describe "#main" do
+    let(:command_class) { TestOptions::TestCommandWithOptionsAndArguments }
+
+    let(:argv) { %w[-a 42 -b foo.txt arg1 arg2] }
+
+    it "must parse options before validating the number of arguments" do
+      expect {
+        expect(subject.main(argv)).to eq(0)
+      }.to_not output.to_stderr
+    end
+
+    context "but the wrong number of arguments are given" do
+      let(:argv) { %w[-a 42 -b foo.txt] }
+
+      it "must still validate the number of arguments" do
+        expect {
+          expect(subject.main(argv)).to eq(1)
+        }.to output("#{subject.command_name}: insufficient number of arguments.#{$/}").to_stderr
+      end
+    end
+  end
+
+  describe "#help" do
+    let(:command_class) { TestOptions::TestCommandWithOptionsAndArguments }
+
+    let(:option1)   { command_class.options[:option1]     }
+    let(:option2)   { command_class.options[:option2]     }
+    let(:argument1) { command_class.arguments[:argument1] }
+    let(:argument2) { command_class.arguments[:argument2] }
+
+    it "must print the usage, options and arguments" do
+      expect { subject.help }.to output(
+        [
+          "Usage: #{subject.usage}",
+          '',
+          'Options:',
+          "    #{option1.usage.join(', ').ljust(33 - 1)} #{option1.desc}",
+          "    #{option2.usage.join(', ').ljust(33 - 1)} #{option2.desc}",
+          '    -h, --help                       Print help information',
+          '',
+          "Arguments:",
+          "    #{argument1.usage.ljust(33)}#{argument1.desc}",
+          "    #{argument2.usage.ljust(33)}#{argument2.desc}",
+          ''
+        ].join($/)
+      ).to_stdout
+    end
   end
 end

data/spec/os/linux_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+require 'command_kit/os/linux'
+
+describe CommandKit::OS::Linux do
+  module TestOSLinux
+    class TestCommand
+      include CommandKit::OS::Linux
+    end
+  end
+
+  let(:command_class) { TestOSLinux::TestCommand }
+
+  describe ".linux_distro" do
+    subject { command_class }
+
+    context "and the /etc/fedora-release file exists" do
+      before do
+        expect(File).to receive(:file?).with("/etc/fedora-release").and_return(true)
+      end
+
+      it { expect(subject.linux_distro).to be(:fedora) }
+    end
+
+    context "and the /etc/redhat-release file exists" do
+      before do
+        allow(File).to receive(:file?).with("/etc/fedora-release").and_return(false)
+        expect(File).to receive(:file?).with("/etc/redhat-release").and_return(true)
+      end
+
+      it { expect(subject.linux_distro).to be(:redhat) }
+    end
+
+    context "and the /etc/debian_version file exists" do
+      before do
+        allow(File).to receive(:file?).with("/etc/fedora-release").and_return(false)
+        allow(File).to receive(:file?).with("/etc/redhat-release").and_return(false)
+        expect(File).to receive(:file?).with("/etc/debian_version").and_return(true)
+      end
+
+      it { expect(subject.linux_distro).to be(:debian) }
+    end
+
+    context "and the /etc/SuSE-release file exists" do
+      before do
+        allow(File).to receive(:file?).with("/etc/fedora-release").and_return(false)
+        allow(File).to receive(:file?).with("/etc/redhat-release").and_return(false)
+        allow(File).to receive(:file?).with("/etc/debian_version").and_return(false)
+        expect(File).to receive(:file?).with("/etc/SuSE-release").and_return(true)
+      end
+
+      it { expect(subject.linux_distro).to be(:suse) }
+    end
+
+    context "and the /etc/arch-release file exists" do
+      before do
+        allow(File).to receive(:file?).with("/etc/fedora-release").and_return(false)
+        allow(File).to receive(:file?).with("/etc/redhat-release").and_return(false)
+        allow(File).to receive(:file?).with("/etc/debian_version").and_return(false)
+        allow(File).to receive(:file?).with("/etc/SuSE-release").and_return(false)
+        expect(File).to receive(:file?).with("/etc/arch-release").and_return(true)
+      end
+
+      it { expect(subject.linux_distro).to be(:arch) }
+    end
+  end
+
+  subject { command_class.new }
+
+  describe "#initialize" do
+    it "must default #linux_distro to self.class.linux_distro" do
+      expect(subject.linux_distro).to eq(command_class.linux_distro)
+    end
+
+    context "when the linux_distro: keyword is given" do
+      let(:linux_distro) { :suse }
+
+      subject { command_class.new(linux_distro: linux_distro) }
+
+      it "must set #linux_distro" do
+        expect(subject.linux_distro).to eq(linux_distro)
+      end
+    end
+  end
+
+  describe "#redhat_linux?" do
+    subject { command_class.new(linux_distro: linux_distro) }
+
+    context "when #linux_distro is :redhat" do
+      let(:linux_distro) { :redhat }
+
+      it { expect(subject.redhat_linux?).to be(true) }
+    end
+
+    context "when #linux_distro is not :redhat" do
+      let(:linux_distro) { :debian }
+
+      it { expect(subject.redhat_linux?).to be(false) }
+    end
+  end
+
+  describe "#fedora_linux?" do
+    subject { command_class.new(linux_distro: linux_distro) }
+
+    context "when #linux_distro is :fedora" do
+      let(:linux_distro) { :fedora }
+
+      it { expect(subject.fedora_linux?).to be(true) }
+    end
+
+    context "when #linux_distro is not :fedora" do
+      let(:linux_distro) { :debian }
+
+      it { expect(subject.fedora_linux?).to be(false) }
+    end
+  end
+
+  describe "#debian_linux?" do
+    subject { command_class.new(linux_distro: linux_distro) }
+
+    context "when #linux_distro is :debian" do
+      let(:linux_distro) { :debian }
+
+      it { expect(subject.debian_linux?).to be(true) }
+    end
+
+    context "when #linux_distro is not :fedora" do
+      let(:linux_distro) { :redhat }
+
+      it { expect(subject.debian_linux?).to be(false) }
+    end
+  end
+
+  describe "#suse_linux?" do
+    subject { command_class.new(linux_distro: linux_distro) }
+
+    context "when #linux_distro is :suse" do
+      let(:linux_distro) { :suse }
+
+      it { expect(subject.suse_linux?).to be(true) }
+    end
+
+    context "when #linux_distro is not :suse" do
+      let(:linux_distro) { :debian }
+
+      it { expect(subject.suse_linux?).to be(false) }
+    end
+  end
+
+  describe "#arch_linux?" do
+    subject { command_class.new(linux_distro: linux_distro) }
+
+    context "when #linux_distro is :arch" do
+      let(:linux_distro) { :arch }
+
+      it { expect(subject.arch_linux?).to be(true) }
+    end
+
+    context "when #linux_distro is not :arch" do
+      let(:linux_distro) { :debian }
+
+      it { expect(subject.arch_linux?).to be(false) }
+    end
+  end
+end

data/spec/os_spec.rb

@@ -1,46 +1,233 @@
 require 'spec_helper'
 require 'command_kit/os'
 
-describe OS do
-  class TestOS
-    include CommandKit::OS
+describe CommandKit::OS do
+  module TestOS
+    class TestCommand
+      include CommandKit::OS
+    end
   end
 
-  subject { TestOS.new }
+  let(:command_class) { TestOS::TestCommand }
+  subject { command_class.new }
+
+  describe ".os" do
+    subject { command_class }
 
-  describe "#linux?" do
     context "when RUBY_PLATFORM contains 'linux'" do
       before { stub_const('RUBY_PLATFORM','x86_64-linux') }
 
-      it { expect(subject.linux?).to be(true) }
+      it { expect(subject.os).to be(:linux) }
     end
 
-    context "when RUBY_PLATFORM does not contain 'linux'" do
+    context "when RUBY_PLATFORM contains 'darwin'" do
       before { stub_const('RUBY_PLATFORM','aarch64-darwin') }
 
+      it { expect(subject.os).to be(:macos) }
+    end
+
+    context "when RUBY_PLATFORM contains 'freebsd'" do
+      before { stub_const('RUBY_PLATFORM','x86_64-freebsd') }
+
+      it { expect(subject.os).to be(:freebsd) }
+    end
+
+    context "when RUBY_PLATFORM contains 'openbsd'" do
+      before { stub_const('RUBY_PLATFORM','x86_64-openbsd') }
+
+      it { expect(subject.os).to be(:openbsd) }
+    end
+
+    context "when RUBY_PLATFORM contains 'netbsd'" do
+      before { stub_const('RUBY_PLATFORM','x86_64-netbsd') }
+
+      it { expect(subject.os).to be(:netbsd) }
+    end
+
+    context "when Gem.win_platform? returns true" do
+      before do
+        stub_const('RUBY_PLATFORM','x86_64-mswin')
+
+        expect(Gem).to receive(:win_platform?).and_return(true)
+      end
+
+      it { expect(subject.os).to be(:windows) }
+    end
+  end
+
+  describe "#initialize" do
+    it "must default #os to self.class.os" do
+      expect(subject.os).to eq(command_class.os)
+    end
+
+    context "when initialized with the os: keyword" do
+      let(:os) { :netbsd }
+
+      subject { command_class.new(os: os) }
+
+      it "must set #os" do
+        expect(subject.os).to eq(os)
+      end
+    end
+  end
+
+  describe "#linux?" do
+    context "when #os is :linux" do
+      subject { command_class.new(os: :linux) }
+
+      it { expect(subject.linux?).to be(true) }
+    end
+
+    context "when #os is not :linux" do
+      subject { command_class.new(os: :windows) }
+
       it { expect(subject.linux?).to be(false) }
     end
   end
 
   describe "#macos?" do
-    context "when RUBY_PLATFORM contains 'darwin'" do
-      before { stub_const('RUBY_PLATFORM','aarch64-darwin') }
+    context "when #os is :macos" do
+      subject { command_class.new(os: :macos) }
 
       it { expect(subject.macos?).to be(true) }
     end
 
-    context "when RUBY_PLATFORM does not contain 'darwin'" do
-      before { stub_const('RUBY_PLATFORM','mswin') }
+    context "when #os is not :macos" do
+      subject { command_class.new(os: :windows) }
 
       it { expect(subject.macos?).to be(false) }
     end
   end
 
+  describe "#freebsd?" do
+    context "when #os is :freebsd" do
+      subject { command_class.new(os: :freebsd) }
+
+      it { expect(subject.freebsd?).to be(true) }
+    end
+
+    context "when #os is not :freebsd" do
+      subject { command_class.new(os: :windows) }
+
+      it { expect(subject.freebsd?).to be(false) }
+    end
+  end
+
+  describe "#openbsd?" do
+    context "when #os is :openbsd" do
+      subject { command_class.new(os: :openbsd) }
+
+      it { expect(subject.openbsd?).to be(true) }
+    end
+
+    context "when #os is not :openbsd" do
+      subject { command_class.new(os: :windows) }
+
+      it { expect(subject.openbsd?).to be(false) }
+    end
+  end
+
+  describe "#netbsd?" do
+    context "when #os is :netbsd" do
+      subject { command_class.new(os: :netbsd) }
+
+      it { expect(subject.netbsd?).to be(true) }
+    end
+
+    context "when #os is not :netbsd" do
+      subject { command_class.new(os: :windows) }
+
+      it { expect(subject.netbsd?).to be(false) }
+    end
+  end
+
+  describe "#bsd?" do
+    context "when #os is :freebsd" do
+      subject { command_class.new(os: :freebsd) }
+
+      it { expect(subject.bsd?).to be(true) }
+    end
+
+    context "when #os is :openbsd" do
+      subject { command_class.new(os: :openbsd) }
+
+      it { expect(subject.bsd?).to be(true) }
+    end
+
+    context "when #os is :netbsd" do
+      subject { command_class.new(os: :netbsd) }
+
+      it { expect(subject.bsd?).to be(true) }
+    end
+
+    context "when #os is :macos" do
+      subject { command_class.new(os: :macos) }
+
+      it { expect(subject.bsd?).to be(false) }
+    end
+
+    context "when #os is :linux" do
+      subject { command_class.new(os: :linux) }
+
+      it { expect(subject.bsd?).to be(false) }
+    end
+
+    context "when #os is :windows" do
+      subject { command_class.new(os: :windows) }
+
+      it { expect(subject.bsd?).to be(false) }
+    end
+  end
+
+  describe "#unix?" do
+    context "when #os is :freebsd" do
+      subject { command_class.new(os: :freebsd) }
+
+      it { expect(subject.unix?).to be(true) }
+    end
+
+    context "when #os is :openbsd" do
+      subject { command_class.new(os: :openbsd) }
+
+      it { expect(subject.unix?).to be(true) }
+    end
+
+    context "when #os is :netbsd" do
+      subject { command_class.new(os: :netbsd) }
+
+      it { expect(subject.unix?).to be(true) }
+    end
+
+    context "when #os is :macos" do
+      subject { command_class.new(os: :macos) }
+
+      it { expect(subject.unix?).to be(true) }
+    end
+
+    context "when #os is :linux" do
+      subject { command_class.new(os: :linux) }
+
+      it { expect(subject.unix?).to be(true) }
+    end
+
+    context "when #os is :windows" do
+      subject { command_class.new(os: :windows) }
+
+      it { expect(subject.unix?).to be(false) }
+    end
+  end
+
   describe "#windows?" do
-    it "must call Gem.win_platform?" do
-      expect(Gem).to receive(:win_platform?)
+    context "when #os is :windows" do
+      subject { command_class.new(os: :windows) }
+
+      it { expect(subject.windows?).to be(true) }
+    end
+
+    context "when #os is not :windows" do
+      subject { command_class.new(os: :linux) }
 
-      subject.windows?
+      it { expect(subject.windows?).to be(false) }
     end
   end
 end