acclaim 0.2.0 → 0.2.1

data/lib/acclaim/command.rb

@@ -113,7 +113,7 @@ module Acclaim
       # subcommands; if one is found, it will be invoked, if not, this command
       # will be executed. A subcommand may be anywhere in the array as long as
       # it is before an argument separator, which is tipically a double dash
-      # (<tt>--<\tt>) and may be omitted.
+      # (<tt>--</tt>) and may be omitted.
       #
       # All argument separators will be deleted from the argument array before a
       # command is executed.
@@ -157,35 +157,41 @@ module Acclaim
       # until the root command.
       alias until_root root
 
-      # Return this command's parent commands.
-      def parents
+      # Returns the sequence of commands from #root that leads to this command.
+      def path
         Array.new.tap do |parents|
           until_root do |command|
             parents << command
           end
+          parents.reverse!
         end
       end
 
+      # Return this command's parent commands.
+      def parents
+        path.tap { |path| path.pop; path.reverse! }
+      end
+
       # Computes the full command line of this command, which takes parent
       # commands into account.
       #
       #   class Command < Acclaim::Command
-      #     class Subcommand < Command
-      #       class Subcommand2 < Subcommand
+      #     class Do < Command
+      #       class Something < Do
       #       end
       #     end
       #   end
       #
-      #   Command::Subcommand::Subcommand2.full_line
-      #    => "subcommand subcommand2"
+      #   Command::Do::Something.full_line
+      #    => "do something"
       #
-      #   Command::Subcommand::Subcommand2.full_line include_root: true
-      #    => "command subcommand subcommand2"
+      #   Command::Do::Something.full_line include_root: true
+      #    => "command do something"
       def full_line(*args)
         options = args.extract_ribbon!
-        parents.tap do |parents|
-          parents.pop unless options.include_root?
-        end.reverse.map(&:line).join ' '
+        path.tap do |path|
+          path.shift unless options.include_root?
+        end.map(&:line).join ' '
       end
 
       private

data/lib/acclaim/version.rb

@@ -16,7 +16,7 @@ module Acclaim
     # Patch version.
     #
     # Increments denote changes in implementation.
-    PATCH = 0
+    PATCH = 1
 
     # Build version.
     #

data/spec/acclaim/command_spec.rb

@@ -6,8 +6,11 @@ class Test::Command::Subcommand < Test::Command; end
 
 describe Acclaim::Command do
 
+  let(:root_command) { Test::Command }
+  let(:subcommand) { Test::Command::Subcommand }
+
   describe Test::Command do
-    subject { Test::Command }
+    subject { root_command }
 
     describe '::line' do
       context 'when not given a parameter' do
@@ -27,6 +30,52 @@ describe Acclaim::Command do
       end
     end
 
+    describe '::full_line' do
+      context 'when not given any options' do
+        it 'should return an empty string' do
+          subject.full_line.should be_empty
+        end
+      end
+
+      context 'when given an options hash' do
+        context 'which specified that the root command should be excluded' do
+          it 'should return an empty string' do
+            subject.full_line(include_root: false).should be_empty
+          end
+        end
+
+        context 'which specified that the root command should be included' do
+          it "should return the command's name" do
+            subject.full_line(include_root: true).should == 'command'
+          end
+        end
+      end
+    end
+
+    describe '::root' do
+      it 'should return this command' do
+        subject.root.should == subject
+      end
+    end
+
+    describe '::root?' do
+      it 'should return true' do
+        subject.root?.should be_true
+      end
+    end
+
+    describe '::path' do
+      it 'should return an array containing only the root command itself' do
+        subject.path.should == [ root_command ]
+      end
+    end
+
+    describe '::parents' do
+      it 'should return an empty array' do
+        subject.parents.should == []
+      end
+    end
+
     describe '::subcommands' do
       it 'should not be empty' do
         subject.subcommands.should_not be_empty
@@ -39,7 +88,7 @@ describe Acclaim::Command do
   end
 
   describe Test::Command::Subcommand do
-    subject { Test::Command::Subcommand }
+    subject { subcommand }
 
     describe '::line' do
       context 'when not given a parameter' do
@@ -59,6 +108,52 @@ describe Acclaim::Command do
       end
     end
 
+    describe '::full_line' do
+      context 'when not given any options' do
+        it "should return the command's name" do
+          subject.full_line.should == 'subcommand'
+        end
+      end
+
+      context 'when given an options hash' do
+        context 'which specified that the root command should be excluded' do
+          it "should return the command's name" do
+            subject.full_line(include_root: false).should == 'subcommand'
+          end
+        end
+
+        context 'which specified that the root command should be included' do
+          it "should return the command's name prepended by the root command's name" do
+            subject.full_line(include_root: true).should == 'command subcommand'
+          end
+        end
+      end
+    end
+
+    describe '::root' do
+      it 'should return the root command' do
+        subject.root.should == root_command
+      end
+    end
+
+    describe '::root?' do
+      it 'should return false' do
+        subject.root?.should be_false
+      end
+    end
+
+    describe '::path' do
+      it 'should return an array containing the root command and the subcommand, in order' do
+        subject.path.should == [ root_command, subcommand ]
+      end
+    end
+
+    describe '::parents' do
+      it 'should return the root command' do
+        subject.parents.should == [ root_command ]
+      end
+    end
+
     describe '::subcommands' do
       it 'should be empty' do
         subject.subcommands.should be_empty

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acclaim
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-19 00:00:00.000000000 Z
+date: 2012-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ribbon
-  requirement: &20746840 !ruby/object:Gem::Requirement
+  requirement: &17374400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20746840
+  version_requirements: *17374400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20745700 !ruby/object:Gem::Requirement
+  requirement: &17373960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20745700
+  version_requirements: *17373960
 - !ruby/object:Gem::Dependency
   name: rookie
-  requirement: &20744980 !ruby/object:Gem::Requirement
+  requirement: &17373240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20744980
+  version_requirements: *17373240
 description: Command-line option parser and command interface.
 email: matheus.a.m.moreira@gmail.com
 executables: []
@@ -95,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1211294602011748853
+      hash: 3127084049849445509
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1211294602011748853
+      hash: 3127084049849445509
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10