commander 4.3.3 → 4.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 539292421c6c437b5a79388d3736875b95a2d953
-  data.tar.gz: dfd174077251e2415e83a49ce5a9d518457986d4
+  metadata.gz: 72ee1a4d6498d366df2896b19afd77d57a2fe2e5
+  data.tar.gz: 0c3c85152bcd33462c1f2e399c05badd4bb62b63
 SHA512:
-  metadata.gz: 45fdd002a404d22e1c69e7c448c1e0559cbb572b051179ca9a2dbbc1b851d2e96983cb44ec92d53a32dc7dfed3cbfa782ebc4dd2c9cdee82df00f52dc4b65c81
-  data.tar.gz: ded7f701bdadcdd2ddd2e26068121bbdc9a50c29a54908ae18d70a89f189142e286235c74be22458542e7435a7279a12489c2097668495ff15bde139b7e8338d
+  metadata.gz: 4c3d14e701cfe6e057f0f002aad28ffbf1d1b91ad2fa4f7a320326e161c079d5001c670b938a55090fc76a510a94e1f48b1a7474e760588d5ed8fee5223a9a41
+  data.tar.gz: 1ee04c92a9502fc7c0f970a52705746fc657fd9833b694b67246ce036356ac3cd9698a938b535c392c11e2939a5e177a3a99196b18d194ed6f0a0d715a599ee7

data/History.rdoc

@@ -1,6 +1,11 @@
+=== 4.3.4 / 2015-05-03
+
+* Fixed a regression with the compact help formatter.
+
 === 4.3.3 / 2015-04-21
 
 * Updated to highline 1.7.2 to fix a regression with terminal size (https://github.com/JEG2/highline/pull/139).
+* Help formatting updated to look better for commands with long names. (@jszwedko)
 
 === 4.3.2 / 2015-03-31
 

data/lib/commander/help_formatters.rb

@@ -4,6 +4,42 @@ module Commander
     autoload :Terminal, 'commander/help_formatters/terminal'
     autoload :TerminalCompact, 'commander/help_formatters/terminal_compact'
 
+    class Context
+      def initialize(target)
+        @target = target
+      end
+
+      def get_binding
+        @target.instance_eval { binding }.tap do |bind|
+          decorate_binding(bind)
+        end
+      end
+
+      # No-op, override in subclasses.
+      def decorate_binding(_bind)
+      end
+    end
+
+    class ProgramContext < Context
+      def decorate_binding(bind)
+        bind.eval("max_command_length = #{max_command_length(bind)}")
+        bind.eval("max_aliases_length = #{max_aliases_length(bind)}")
+      end
+
+      def max_command_length(bind)
+        max_key_length(bind.eval('@commands'))
+      end
+
+      def max_aliases_length(bind)
+        max_key_length(bind.eval('@aliases'))
+      end
+
+      def max_key_length(hash, default = 20)
+        longest = hash.keys.max_by(&:size)
+        longest ? longest.size : default
+      end
+    end
+
     module_function
 
     def indent(amount, text)

data/lib/commander/help_formatters/terminal.rb

@@ -4,11 +4,11 @@ module Commander
   module HelpFormatter
     class Terminal < Base
       def render
-        template(:help).result @runner.get_binding
+        template(:help).result(ProgramContext.new(@runner).get_binding)
       end
 
       def render_command(command)
-        template(:command_help).result command.get_binding
+        template(:command_help).result(Context.new(command).get_binding)
       end
 
       def template(name)

data/lib/commander/help_formatters/terminal/help.erb

@@ -1,10 +1,3 @@
-<%
-  # TODO: move into formatter?
-  longest_command = @commands.keys.max_by(&:size)
-  max_command_length = longest_command ? longest_command.size : 20
-  longest_alias = @aliases.keys.max_by(&:size)
-  max_aliases_length = longest_alias ? longest_alias.size : 20
-%>
   <%= $terminal.color "NAME", :bold %>:
 
     <%= program :name %>

data/lib/commander/help_formatters/terminal_compact/help.erb

@@ -1,5 +1,3 @@
-<% max_command_length = @commands.keys.max_by(&:size).size %>
-<% max_aliases_length = @aliases.keys.max_by(&:size).size %>
   <%= program :name %>
 
   <%= program :description %>

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '4.3.3'
+  VERSION = '4.3.4'
 end

data/spec/help_formatters/terminal_compact_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Commander::HelpFormatter::TerminalCompact do
+  include Commander::Methods
+
+  before :each do
+    mock_terminal
+  end
+
+  describe 'global help' do
+    before :each do
+      new_command_runner 'help' do
+        program :help_formatter, :compact
+        command :'install gem' do |c|
+          c.syntax = 'foo install gem [options]'
+          c.summary = 'Install some gem'
+        end
+      end.run!
+      @global_help = @output.string
+    end
+
+    describe 'should display' do
+      it 'the command name' do
+        expect(@global_help).to include('install gem')
+      end
+
+      it 'the summary' do
+        expect(@global_help).to include('Install some gem')
+      end
+    end
+  end
+
+  describe 'command help' do
+    before :each do
+      new_command_runner 'help', 'install', 'gem' do
+        program :help_formatter, :compact
+        command :'install gem' do |c|
+          c.syntax = 'foo install gem [options]'
+          c.summary = 'Install some gem'
+          c.description = 'Install some gem, blah blah blah'
+          c.example 'one', 'two'
+          c.example 'three', 'four'
+        end
+      end.run!
+      @command_help = @output.string
+    end
+
+    describe 'should display' do
+      it 'the command name' do
+        expect(@command_help).to include('install gem')
+      end
+
+      it 'the description' do
+        expect(@command_help).to include('Install some gem, blah blah blah')
+      end
+
+      it 'all examples' do
+        expect(@command_help).to include('# one')
+        expect(@command_help).to include('two')
+        expect(@command_help).to include('# three')
+        expect(@command_help).to include('four')
+      end
+
+      it 'the syntax' do
+        expect(@command_help).to include('foo install gem [options]')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander
 version: !ruby/object:Gem::Version
-  version: 4.3.3
+  version: 4.3.4
 platform: ruby
 authors:
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -131,6 +131,7 @@ files:
 - spec/configure_spec.rb
 - spec/core_ext/array_spec.rb
 - spec/core_ext/object_spec.rb
+- spec/help_formatters/terminal_compact_spec.rb
 - spec/help_formatters/terminal_spec.rb
 - spec/methods_spec.rb
 - spec/runner_spec.rb
@@ -165,6 +166,7 @@ test_files:
 - spec/configure_spec.rb
 - spec/core_ext/array_spec.rb
 - spec/core_ext/object_spec.rb
+- spec/help_formatters/terminal_compact_spec.rb
 - spec/help_formatters/terminal_spec.rb
 - spec/methods_spec.rb
 - spec/runner_spec.rb