picky 1.3.1 → 1.3.2

data/lib/picky/cli.rb

@@ -21,8 +21,10 @@ module Picky
       def usage name, params
         puts "Usage\n  picky #{name} #{params_to_s(params)}"
       end
+      # String params are optional, Symbol params aren't.
+      #
       def params_to_s params
-        params.map { |param| "<#{param}>" }.join(' ') if params
+        params.map { |param| param.respond_to?(:to_str) ? "[#{param}]" : param }.join(' ') if params
       end
     end
     class Statistics < Base
@@ -88,10 +90,10 @@ module Picky
     # Maps commands to the other gem's command.
     #
     @@mapping = {
-      :generate => [Generate, 'sinatra_client | unicorn_server | empty_unicorn_server', 'app_directory_name (optional)'],
+      :generate => [Generate, :'(sinatra_client | unicorn_server | empty_unicorn_server)', :'app_directory_name'],
       :help     => [Help],
-      :stats    => [Statistics, 'logfile, e.g. log/search.log', 'port (optional)'],
-      :live     => [Live, 'host:port/path (optional, default: localhost:8080/admin)', 'port (optional)']
+      :stats    => [Statistics, :'logfile (e.g. log/search.log)', 'port (default: 4567)'],
+      :live     => [Live, 'host:port/path (default: localhost:8080/admin)', 'port (default: 4568)']
     }
     def self.mapping
       @@mapping

data/spec/lib/cli_spec.rb

@@ -19,16 +19,16 @@ describe Picky::CLI do
         @cli.executor_class_for.should == [Picky::CLI::Help]
       end
       it 'returns Generator for generate' do
-        @cli.executor_class_for(:generate).should == [Picky::CLI::Generate, "sinatra_client | unicorn_server | empty_unicorn_server", "app_directory_name (optional)"]
+        @cli.executor_class_for(:generate).should == [Picky::CLI::Generate, :"(sinatra_client | unicorn_server | empty_unicorn_server)", :"app_directory_name"]
       end
       it 'returns Help for help' do
         @cli.executor_class_for(:help).should == [Picky::CLI::Help]
       end
       it 'returns Statistics for stats' do
-        @cli.executor_class_for(:stats).should == [Picky::CLI::Statistics, "logfile, e.g. log/search.log", "port (optional)"]
+        @cli.executor_class_for(:stats).should == [Picky::CLI::Statistics, :"logfile (e.g. log/search.log)", "port (default: 4567)"]
       end
       it 'returns Live for live' do
-        @cli.executor_class_for(:live).should == [Picky::CLI::Live, "host:port/path (optional, default: localhost:8080/admin)", "port (optional)"]
+        @cli.executor_class_for(:live).should == [Picky::CLI::Live, "host:port/path (default: localhost:8080/admin)", "port (default: 4568)"]
       end
     end
   end
@@ -45,14 +45,14 @@ describe Picky::CLI do
     end
     describe 'usage' do
       it 'calls puts with an usage' do
-        @executor.should_receive(:puts).once.with "Usage\n  picky some_name <param1> <param 2 (optional)>"
+        @executor.should_receive(:puts).once.with "Usage\n  picky some_name param1 [param2]"
         
-        @executor.usage :some_name, [:param1, 'param 2 (optional)']
+        @executor.usage :some_name, [:param1, 'param2']
       end
     end
     describe 'params_to_s' do
       it 'returns the right string' do
-        @executor.params_to_s([:param1, 'param 2 (optional)']).should == '<param1> <param 2 (optional)>'
+        @executor.params_to_s([:param1, 'param2']).should == 'param1 [param2]'
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 3
-  - 1
-  version: 1.3.1
+  - 2
+  version: 1.3.2
 platform: ruby
 authors: 
 - Florian Hanke