rcoli 0.5.0 → 0.5.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rcoli (0.5.0)
+    rcoli (0.5.1)
       highline (~> 1.6.11)
 
 GEM

data/lib/rcoli/help.rb

@@ -4,11 +4,20 @@ module RCoLi
   
   module Help
     
-    def help
-      puts template 'help'
+    def help(*args)
+      if args[0].empty?
+        puts template('help', nil)
+      else
+        command = self
+        args[0].each do |arg| 
+          command = command.find_command(arg)
+          raise InvalidCommand, "'#{arg}' is not a valid #{@name} command" unless command
+        end
+        puts template('help_command', command)
+      end
     end
 
-    def template(name)
+    def template(name, command)
       ERB.new(File.read(File.join(File.dirname(__FILE__), 'templates', "#{name}.erb")), nil, '-').result binding
     end
 

data/lib/rcoli/model.rb

@@ -71,16 +71,16 @@ module RCoLi
       parse_args(args, result)
     end
     
+    def find_command(name)
+      commands.find{|command| command.value_of_name.eql? name}
+    end
+    
     private
     
     def find_option(name)
       options.find{|opt| opt.correspond?(name)}
     end
-    
-    def find_command(name)
-      commands.find{|command| command.value_of_name.eql? name}
-    end
-        
+
     def is_option?(value)
       value.start_with?('-')
     end
@@ -141,6 +141,16 @@ module RCoLi
     
     include CommandContainer
     
+    def full_command
+      command = self
+      result = []
+      while(command.parent) do
+        result << command.value_of_name
+        command = command.parent
+      end
+      return result.reverse.join(' ')
+    end
+    
   end
   
   class Program

data/lib/rcoli/templates/help.erb

@@ -1,16 +1,20 @@
   <%= $terminal.color "NAME", :bold %>:
-    <%= @name %>
+  
+    <%= @name %> - <%= @description %>
 
+  <%= $terminal.color "SYNOPSIS", :bold %>:
+  
+    <%=@name%> [global options] command [command options] [arguments...]
+    
   <%= $terminal.color "VERSION", :bold %>:
+  
     <%= @version %>
 
-  <%= $terminal.color "DESCRIPTION", :bold %>:
-    <%= @description %>
-
   <%= $terminal.color "COMMANDS", :bold %>:
-    <% @commands.sort{|a,b| a.value_of_name <=> b.value_of_name}.each do |c| -%>
+  
+<% @commands.sort{|a,b| a.value_of_name <=> b.value_of_name}.each do |c| -%>
     <%= "%-20s %s" % [c.value_of_name, c.value_of_description] %>
-    <% end %>
+<% end -%>
 
 <% unless @options.empty? -%>
   <%= $terminal.color "GLOBAL OPTIONS", :bold %>:

data/lib/rcoli/templates/help_command.erb

@@ -0,0 +1,23 @@
+  <%= $terminal.color "NAME", :bold %>:
+  
+    <%= command.full_command %> - <%= command.value_of_description %>
+
+  <%= $terminal.color "SYNOPSIS", :bold %>:
+  
+    <%= @name %> [global options] <%= command.full_command%> [command options] [arguments...]
+
+<% unless command.commands.empty? -%>
+  <%= $terminal.color "SUBCOMMANDS", :bold %>:
+  
+<% command.commands.sort{|a,b| a.value_of_name <=> b.value_of_name}.each do |c| -%>
+    <%= "%-20s %s" % [c.value_of_name, c.value_of_description] %>
+<% end %>
+<% end -%>
+
+<% unless command.options.empty? -%>
+  <%= $terminal.color "COMMAND OPTIONS", :bold %>:
+	<% for option in command.options -%>    
+    <%= option.help_keys.join ', ' %> 
+        <%= option.value_of_description %>
+	<% end -%>
+<% end -%>

data/lib/rcoli/version.rb

@@ -1,5 +1,5 @@
 module RCoLi
   
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
   
 end

data/lib/rcoli.rb

@@ -11,7 +11,7 @@ def application(id, &block)
   @program.command(:help) do |c|
     c.description "Display help documentation"
     c.action do |global_opts, opts, args|
-      @program.help
+      @program.help args
     end
   end
   @program.instance_eval &block

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcoli
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -60,6 +60,7 @@ files:
 - lib/rcoli/help.rb
 - lib/rcoli/model.rb
 - lib/rcoli/templates/help.erb
+- lib/rcoli/templates/help_command.erb
 - lib/rcoli/version.rb
 - rcoli.gemspec
 homepage: http://jiripisa.com
@@ -76,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1633884952265524071
+      hash: -2525730890181152634
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1633884952265524071
+      hash: -2525730890181152634
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24