commander 4.2.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41862606cf4f4960a8b46ae50cbf08aef24358d5
-  data.tar.gz: 7b1e4b14ddd3ce4df29348644219896f82f5b298
+  metadata.gz: a71b1e0b6cd4cc5c9155cd54879132e0e8d76446
+  data.tar.gz: 7cebb2917cfd393a23a1aac0fd4763142709ed01
 SHA512:
-  metadata.gz: 90629f894d285139dd00327a3feb641ac5e7dd3d2e9d07f3c85056389ccc25b1b67b936693ff437dee52cd9a877654285548e77251f7f2160beedd7839c635f1
-  data.tar.gz: 038edb894790574b9b4b3973c511c539c746ff5bfdfed25c52247242cd0fba232479c5e07211d31e7ef440b18cdbdbcc5e3513111392323f47408dbe8e1f6888
+  metadata.gz: 0de8b294364f785f0ce045d801fc2bf7c6f64ab3cd505cef40169533461377314098044ad8a88f3b297625cb92fc970f7a8f8c06b056ac75266f32fc40c9155b
+  data.tar.gz: 6d90f6f512e2856f9aa3779e6bcf54a8d4118c3f9083b544fbe1a4488248dbc548977ace3684cee16bcd2529a7e8e06053f66b3c2f290029f7cf874da9251652

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+# Offense count: 5
+Encoding:
+  Enabled: false
+
+# Offense count: 1
+LineLength:
+  Max: 242
+

data/.rubocop_todo.yml

@@ -0,0 +1,212 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-02-07 17:05:05 -0800 using RuboCop version 0.29.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+Lint/AmbiguousOperator:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# Offense count: 2
+Lint/Eval:
+  Enabled: false
+
+# Offense count: 2
+Lint/HandleExceptions:
+  Enabled: false
+
+# Offense count: 1
+Lint/RescueException:
+  Enabled: false
+
+# Offense count: 2
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 221
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 2
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 242
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 33
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 18
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/EachWithObject:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+# Offense count: 5
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/FormatString:
+  Enabled: false
+
+# Offense count: 12
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/Lambda:
+  Enabled: false
+
+# Offense count: 17
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Offense count: 1
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Not:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Enabled: false
+
+# Offense count: 5
+Style/RescueModifier:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingComma:
+  Enabled: false
+
+# Offense count: 74
+# Cop supports --auto-correct.
+Style/TrailingWhitespace:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false
+
+# Offense count: 1
+Style/UnlessElse:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/VariableName:
+  Enabled: false

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 before_install: gem update --system
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - jruby-18mode
   - jruby-19mode
   - rbx-2

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 4.3.0 / 2015-02-07
+
+* Drops support for Ruby 1.8. Please use 4.2.1 if you still need Ruby 1.8 compatibility.
+* Fixed a bug with `always_trace` (#91) (@KrauseFx)
+* Renamed `commands` to `defined_commands` for better compatibility with Pry
+
 === 4.2.1 / 2014-09-28
 
 * Improve `choose` compatibility with HighLine's version (#79)

data/README.md

@@ -1,5 +1,5 @@
 [<img src="https://secure.travis-ci.org/ggilder/commander.png?branch=master" alt="Build Status" />](http://travis-ci.org/ggilder/commander)
-[![Inline docs](http://inch-ci.org/github/visionmedia/commander.png)](http://inch-ci.org/github/visionmedia/commander)
+[![Inline docs](http://inch-ci.org/github/tj/commander.png)](http://inch-ci.org/github/tj/commander)
 
 # Commander
 
@@ -75,6 +75,7 @@ end
 ```
 
 Example output:
+
 ```
 $ foobar bar
 # => (bar)
@@ -84,6 +85,9 @@ $ foobar bar --suffix '}' --prefix '{'
 ```
 
 ### Modular style
+
+**NOTE:** Make sure to use `require 'commander'` rather than `require 'commander/import'`, otherwise Commander methods will still be imported into the global namespace.
+
 ```ruby
 require 'rubygems'
 require 'commander'
@@ -112,6 +116,7 @@ MyApplication.new.run if $0 == __FILE__
 ```
 
 ### Block style
+
 ```ruby
 require 'rubygems'
 require 'commander'
@@ -234,7 +239,7 @@ end
 ## Growl Notifications
 
 Commander provides methods for displaying Growl notifications. To use these
-methods you need to install http://github.com/visionmedia/growl which utilizes
+methods you need to install http://github.com/tj/growl which utilizes
 the [growlnotify](http://growl.info/extras.php#growlnotify) executable. Note that
 growl is auto-imported by Commander when available, no need to require.
 
@@ -425,7 +430,7 @@ global_option '--config FILE'
 
 ## ASCII Tables
 
-For feature rich ASCII tables for your terminal app check out visionmedia's terminal-table gem at http://github.com/visionmedia/terminal-table
+For feature rich ASCII tables for your terminal app check out the terminal-table gem at http://github.com/tj/terminal-table
 
     +----------+-------+----+--------+-----------------------+
     | Terminal | Table | Is | Wicked | Awesome               |
@@ -444,7 +449,7 @@ OR
 ## Contrib
 
 Feel free to fork and request a pull, or submit a ticket
-http://github.com/visionmedia/commander/issues
+http://github.com/tj/commander/issues
 
 ## License
 

data/Rakefile

@@ -1,10 +1,13 @@
-require "rspec/core/rake_task"
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
   t.verbose = false
   t.rspec_opts = '--color --order random'
 end
 
-task :default => :spec
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bin/commander

@@ -10,10 +10,10 @@ program :description, 'Commander utility program.'
 command :init do |c|
   c.syntax = 'commander init <file>'
   c.summary = 'Initialize a commander template'
-  c.description = 'Initialize an empty <file> with a commander template, 
+  c.description = 'Initialize an empty <file> with a commander template,
     allowing very quick creation of commander executables.'
   c.example 'Create a new file with a commander template.', 'commander init bin/my_executable'
-  c.action do |args, options|
+  c.action do |args, _options|
     file = args.shift || abort('file argument required.')
     name = ask 'Machine name of program: '
     description = ask 'Describe your program: '
@@ -22,13 +22,13 @@ command :init do |c|
       File.open(file, 'w') do |f|
         f.write <<-"...".gsub!(/^ {10}/, '')
           #!/usr/bin/env ruby
-          
+
           require 'rubygems'
           require 'commander/import'
-          
+
           program :version, '0.0.1'
           program :description, '#{description}'
-           
+
         ...
         commands.each do |command|
           f.write <<-"...".gsub!(/^ {12}/, '')
@@ -45,11 +45,11 @@ command :init do |c|
 
           ...
         end
-       end
-       File.chmod 0755, file
-       say "Initialized template in #{file}"
-     rescue Exception => e
-       abort e
-     end
+      end
+      File.chmod 0755, file
+      say "Initialized template in #{file}"
+    rescue Exception => e
+      abort e
+    end
   end
-end
+end

data/commander.gemspec

@@ -1,27 +1,26 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "commander/version"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'commander/version'
 
 Gem::Specification.new do |s|
-  s.name        = "commander"
+  s.name        = 'commander'
   s.version     = Commander::VERSION
-  s.authors     = ["TJ Holowaychuk", "Gabriel Gilder"]
-  s.email       = ["ggilder@tractionco.com"]
-  s.license     = "MIT"
-  s.homepage    = "http://visionmedia.github.com/commander"
-  s.summary     = "The complete solution for Ruby command-line executables"
-  s.description = "The complete solution for Ruby command-line executables. Commander bridges the gap between other terminal related libraries you know and love (OptionParser, HighLine), while providing many new features, and an elegant API."
-
-  s.rubyforge_project = "commander"
+  s.authors     = ['TJ Holowaychuk', 'Gabriel Gilder']
+  s.email       = ['gabriel@gabrielgilder.com']
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/tj/commander'
+  s.summary     = 'The complete solution for Ruby command-line executables'
+  s.description = 'The complete solution for Ruby command-line executables. Commander bridges the gap between other terminal related libraries you know and love (OptionParser, HighLine), while providing many new features, and an elegant API.'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('highline', '~> 1.6.11')
 
-  s.add_runtime_dependency("highline", "~> 1.6.11")
-  
-  s.add_development_dependency("rspec", "~> 2.14")
-  s.add_development_dependency("rake")
-  s.add_development_dependency("simplecov")
+  s.add_development_dependency('rspec', '~> 2.14')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('rubocop', '~> 0.29.0')
 end

data/lib/commander/blank.rb

@@ -1,8 +1,8 @@
 
 module Blank
-  def self.included base
+  def self.included(base)
     base.class_eval do
       instance_methods.each { |m| undef_method m unless m =~ /^__|object_id/ }
     end
   end
-end
+end