command_line_helper 0.0.1

data/lib/command_line_helper/program_name.rb

@@ -0,0 +1,9 @@
+module CommandLineHelper
+  module ProgramName
+
+    def program_name
+      @program_name ||= File.basename($0)
+    end
+
+  end
+end

data/lib/command_line_helper/program_name.rb~

@@ -0,0 +1,12 @@
+# TODO Check for definition of options_possible
+require 'active_support/concern'
+
+module CommandLineHelper
+  module ProgramName
+
+    def program_name
+      @program_name ||= File.basename($0)
+    end
+
+  end
+end

data/lib/command_line_helper/version.rb

@@ -0,0 +1,3 @@
+module CommandLineHelper
+  VERSION = "0.0.1"
+end

data/spec/lib/command_line_helper/base_spec.rb~

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe CommandLineHelper::HelpText do
+  it { expect{ subject.help_info }.to raise_error }
+
+  context do
+    before do
+      subject.stub(:options_possible).and_return(
+        [ ['--foo', '-f', 1, 'Fooism'], ['--bar', '-b', 2, 'Bark'] ]
+      )
+    end
+
+    describe "#program_name" do
+      it { subject.program_name.should == "rspec" }
+
+      it {
+        described_class.should_receive(:program_name)
+        subject.program_name
+      }
+
+      it {
+        subject.program_name
+        described_class.instance_variable_get(:"@program_name").should == "rspec"
+      }
+    end
+
+    describe "#help_info" do
+      it "should return the nice string" do
+        subject.should_receive(:program_name)
+        subject.should_receive(:short_hand_options)
+        subject.should_receive(:option_details)
+        subject.should_receive(:version_info)
+
+        subject.send(:help_info)
+      end
+
+      it "should return helpful information based on options" do
+        File.stub(:basename).and_return("program_name")
+        subject.stub(:version_number).and_return("version")
+        subject.send(:help_info).should == <<-EOH
+Usage: program_name [options]
+  [--foo|-f argument], [--bar|-b]
+
+  Options:
+    --foo, -f   Fooism
+    --bar, -b   Bark
+
+0.0.1
+        EOH
+      end
+    end
+
+    describe "#option_details" do
+      it "should return nice things" do
+        subject.send(:option_details).should ==
+          "    --foo, -f   Fooism\n    --bar, -b   Bark\n"
+      end
+    end
+
+    describe "#short_hand_option" do
+      it "should return '--foo|-f argument'" do
+        option = ["--foo", "-f", GetoptLong::REQUIRED_ARGUMENT]
+        subject.send(:short_hand_option, option).should == "--foo|-f argument"
+      end
+
+      it "should return '--bar|-b'" do
+        option = ["--bar", "-b", nil]
+        subject.send(:short_hand_option, option).should == "--bar|-b"
+      end
+    end
+
+  end
+end

data/spec/lib/command_line_helper/help_text_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+class HelpTextClass
+  include CommandLineHelper::HelpText
+end
+
+describe CommandLineHelper::HelpText do
+  subject { HelpTextClass.new }
+
+  it { expect{ subject.help_info }.to raise_error }
+
+  context do
+    before do
+      subject.stub(:options_possible).and_return(
+        [ ['--foo', '-f', 1, 'Fooism'], ['--bar', '-b', 2, 'Bark'] ]
+      )
+    end
+
+    describe "#help_info" do
+      it "should return the nice string" do
+        subject.should_receive(:program_name)
+        subject.should_receive(:short_hand_options)
+        subject.should_receive(:option_details)
+        subject.should_receive(:version_info)
+
+        subject.send(:help_info)
+      end
+
+      it "should return helpful information based on options" do
+        File.stub(:basename).and_return("program_name")
+        subject.stub(:version_number).and_return("version")
+        subject.send(:help_info).should == <<-EOH
+Usage: program_name [options]
+  [--foo|-f argument], [--bar|-b]
+
+  Options:
+    --foo, -f   Fooism
+    --bar, -b   Bark
+
+0.0.1
+        EOH
+      end
+    end
+
+    describe "#option_details" do
+      it "should return nice things" do
+        subject.send(:option_details).should ==
+          "    --foo, -f   Fooism\n    --bar, -b   Bark\n"
+      end
+    end
+
+    describe "#short_hand_option" do
+      it "should return '--foo|-f argument'" do
+        option = ["--foo", "-f", GetoptLong::REQUIRED_ARGUMENT]
+        subject.send(:short_hand_option, option).should == "--foo|-f argument"
+      end
+
+      it "should return '--bar|-b'" do
+        option = ["--bar", "-b", nil]
+        subject.send(:short_hand_option, option).should == "--bar|-b"
+      end
+    end
+
+  end
+end

data/spec/lib/command_line_helper/help_text_spec.rb~

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+class HelpTextClass
+  include CommandLineHelper::HelpText
+end
+
+describe CommandLineHelper::HelpText do
+  subject { HelpTextClass.new }
+
+  it { expect{ subject.help_info }.to raise_error }
+
+  context do
+    before do
+      subject.stub(:options_possible).and_return(
+        [ ['--foo', '-f', 1, 'Fooism'], ['--bar', '-b', 2, 'Bark'] ]
+      )
+    end
+
+    describe "#program_name" do
+      it { subject.program_name.should == "rspec" }
+
+      it {
+        described_class.should_receive(:program_name)
+        subject.program_name
+      }
+
+      it {
+        subject.program_name
+        described_class.instance_variable_get(:"@program_name").should == "rspec"
+      }
+    end
+
+    describe "#help_info" do
+      it "should return the nice string" do
+        subject.should_receive(:program_name)
+        subject.should_receive(:short_hand_options)
+        subject.should_receive(:option_details)
+        subject.should_receive(:version_info)
+
+        subject.send(:help_info)
+      end
+
+      it "should return helpful information based on options" do
+        File.stub(:basename).and_return("program_name")
+        subject.stub(:version_number).and_return("version")
+        subject.send(:help_info).should == <<-EOH
+Usage: program_name [options]
+  [--foo|-f argument], [--bar|-b]
+
+  Options:
+    --foo, -f   Fooism
+    --bar, -b   Bark
+
+0.0.1
+        EOH
+      end
+    end
+
+    describe "#option_details" do
+      it "should return nice things" do
+        subject.send(:option_details).should ==
+          "    --foo, -f   Fooism\n    --bar, -b   Bark\n"
+      end
+    end
+
+    describe "#short_hand_option" do
+      it "should return '--foo|-f argument'" do
+        option = ["--foo", "-f", GetoptLong::REQUIRED_ARGUMENT]
+        subject.send(:short_hand_option, option).should == "--foo|-f argument"
+      end
+
+      it "should return '--bar|-b'" do
+        option = ["--bar", "-b", nil]
+        subject.send(:short_hand_option, option).should == "--bar|-b"
+      end
+    end
+
+  end
+end

data/spec/lib/command_line_helper/helper.rb~

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class CommandLineHelperHelperSpec
+  include CommandLineHelper::Helper
+
+  def options_possible
+    [ ['--blah', '-b', GetoptLong::NO_ARGUMENT, 'Helpful!' ] ]
+  end
+end
+
+describe CommandLineHelper::Helper do
+  subject { CommandLineHelperHelperSpec.new }
+  describe "#help_info" do
+    it "should return the nice string" do
+      subject.should_receive(:program_name)
+      subject.should_receive(:short_hand_options)
+      subject.should_receive(:option_details)
+      subject.should_receive(:version_info)
+
+      subject.send(:help_info)
+    end
+  end
+end

data/spec/lib/command_line_helper/helper_spec.rb~

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+class CommandLineHelperHelperSpec < CommandLineHelper::Base
+  def options_possible
+    [ ['--blah', '-b', GetoptLong::NO_ARGUMENT, 'Helpful!' ] ]
+  end
+end
+
+describe CommandLineHelper::Helper do
+  subject { CommandLineHelperHelperSpec.new }
+
+  describe "#help_info" do
+    it "should return the nice string" do
+      subject.should_receive(:program_name)
+      subject.should_receive(:short_hand_options)
+      subject.should_receive(:option_details)
+      subject.should_receive(:version_info)
+
+      subject.send(:help_info)
+    end
+  end
+end

data/spec/lib/command_line_helper/program_name_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class ProgramNameClass
+  include CommandLineHelper::ProgramName
+end
+
+describe CommandLineHelper::ProgramName do
+
+  subject { ProgramNameClass.new }
+
+  describe "#program_name" do
+    it { subject.program_name.should == "rspec" }
+
+    it {
+      subject.program_name
+      subject.instance_variable_get(:"@program_name").should == "rspec"
+    }
+  end
+
+end

data/spec/lib/command_line_helper/program_name_spec.rb~

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class ProgramNameClass
+  include CommandLineHelper::ProgramName
+end
+
+describe CommandLineHelper::ProgramName do
+
+  subject { ProgramNameClass.new }
+
+  describe "#program_name" do
+    it { subject.program_name.should == "rspec" }
+
+    it {
+      subject.program_name
+      subject.instance_variable_get(:"@program_name").should == "rspec"
+    }
+  end
+
+end

data/spec/reports/SPEC-CommandLineHelper-Base-help-info.0.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#help_info" tests="2" time="0.002074" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#help_info should return the nice string" time="0.000783">
+  </testcase>
+  <testcase name="CommandLineHelper::Base#help_info should return helpful information based on options" time="0.000998">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-help-info.1.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#help_info" tests="2" time="0.001641" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#help_info should return the nice string" time="0.000775">
+  </testcase>
+  <testcase name="CommandLineHelper::Base#help_info should return helpful information based on options" time="0.000666">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-help-info.2.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#help_info" tests="2" time="0.001807" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#help_info should return the nice string" time="0.000935">
+  </testcase>
+  <testcase name="CommandLineHelper::Base#help_info should return helpful information based on options" time="0.000665">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-help-info.3.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#help_info" tests="2" time="0.001662" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#help_info should return the nice string" time="0.000815">
+  </testcase>
+  <testcase name="CommandLineHelper::Base#help_info should return helpful information based on options" time="0.000634">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-help-info.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#help_info" tests="2" time="0.003942" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#help_info should return helpful information based on options" time="0.000742">
+  </testcase>
+  <testcase name="CommandLineHelper::Base#help_info should return the nice string" time="0.00076">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-option-details.0.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#option_details" tests="1" time="0.000784" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#option_details should return nice things" time="0.000576">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-option-details.1.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#option_details" tests="1" time="0.002857" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#option_details should return nice things" time="0.000512">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-option-details.2.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#option_details" tests="1" time="0.000826" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#option_details should return nice things" time="0.000581">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>

data/spec/reports/SPEC-CommandLineHelper-Base-option-details.3.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="CommandLineHelper::Base#option_details" tests="1" time="0.000557" failures="0" errors="0" skipped="0">
+  <testcase name="CommandLineHelper::Base#option_details should return nice things" time="0.000398">
+  </testcase>
+  <system-out>
+  </system-out>
+  <system-err>
+  </system-err>
+</testsuite>