cri 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42a611aea2f4ef126558c77832d3f87e4c7769ee
-  data.tar.gz: 4629089940c31510094b05bafef780756d72f2db
+  metadata.gz: 7c7acd3557015c65b10c166ddd982ff09a9e9439
+  data.tar.gz: 1084f157713632392659284ae92b39b85f5c45dd
 SHA512:
-  metadata.gz: 5722bead0775cc5d35b658d60318c7b530590681f751dcfb51b9bf6cfd9c0d065387237d7906b8c4163a324d4e1df288f76bcac6fa4fb37775336b8c2908feff
-  data.tar.gz: 67a2d794fa2206fd4487068cb4ffe6e3876c8c9c1b49951b180d7bc62ae4bc375db1a063fbebab89a5aac6bc3e314bdb6e41ced98bbca7e6838424514aa2a17d
+  metadata.gz: 672ba33c779d549ffb422125dc480fa81f33f04ece3753f1f2294de9389d1ff6b91607ad3340db86cdef47e80282cbbd6e61d06fadd5f1c4e6e0a42115a1470b
+  data.tar.gz: 250a1fc1938e2be8090e772dddd2b3f3ca83e7c9f899cf2ace594750b5368b2e2a9ed538fe618ae863fbb88829c8bd116a1f1185fc5e88593fea4ab1aa7d0c3d

data/Gemfile

@@ -7,3 +7,4 @@ gem 'rake'
 gem 'minitest'
 gem 'yard'
 gem 'asciidoctor'
+gem 'rubocop'

data/Gemfile.lock

@@ -1,37 +1,61 @@
 PATH
   remote: .
   specs:
-    cri (2.6.1)
+    cri (2.7.0)
       colored (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    asciidoctor (0.1.4)
+    asciidoctor (1.5.2)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
     colored (1.2)
-    coveralls (0.7.0)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    docile (1.1.3)
-    mime-types (2.3)
-    minitest (5.3.4)
-    multi_json (1.10.1)
-    rake (10.3.2)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    simplecov (0.8.2)
+    coveralls (0.8.1)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.2)
+    mime-types (2.5)
+    minitest (5.6.1)
+    netrc (0.10.3)
+    parser (2.2.2.2)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.0)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rubocop (0.30.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    simplecov (0.10.0)
       docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
-    tins (1.3.0)
-    yard (0.8.7.4)
+    tins (1.5.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
@@ -43,4 +67,5 @@ DEPENDENCIES
   cri!
   minitest
   rake
+  rubocop
   yard

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Denis Defreyne and contributors
+Copyright (c) 2015 Denis Defreyne and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS.md

@@ -1,6 +1,18 @@
 Cri News
 ========
 
+2.7.0
+-----
+
+Features:
+
+* Added support for hidden options (#43, #44) [Bart Mesuere]
+
+Enhancements:
+
+* Added option values to help output (#37, #40, #41)
+* Made option descriptions wrap (#36, #45) [Bart Mesuere]
+
 2.6.1
 -----
 

data/README.adoc

@@ -4,7 +4,7 @@ link:http://rubygems.org/gems/cri[image:http://img.shields.io/gem/v/cri.svg[]]
 link:https://travis-ci.org/ddfreyne/cri[image:http://img.shields.io/travis/ddfreyne/cri.svg[]]
 link:https://coveralls.io/r/ddfreyne/cri[image:http://img.shields.io/coveralls/ddfreyne/cri.svg[]]
 link:https://codeclimate.com/github/ddfreyne/cri[image:http://img.shields.io/codeclimate/github/ddfreyne/cri.svg[]]
-link:http://inch-pages.github.io/github/ddfreyne/cri/[image:http://inch-pages.github.io/github/ddfreyne/cri.svg[]]
+link:http://inch-ci.org/github/ddfreyne/cri/[image:http://inch-ci.org/github/ddfreyne/cri.svg[]]
 
 Cri is a library for building easy-to-use commandline tools with support for
 nested commands.

data/Rakefile

@@ -1,6 +1,7 @@
 # encoing: utf-8
 
 require 'rake/testtask'
+require 'rubocop/rake_task'
 require 'yard'
 
 YARD::Rake::YardocTask.new(:doc) do |yard|
@@ -9,11 +10,11 @@ YARD::Rake::YardocTask.new(:doc) do |yard|
     '--markup',        'markdown',
     '--readme',        'README.adoc',
     '--files',         'NEWS.md,LICENSE',
-    '--output-dir',    'doc/yardoc',
+    '--output-dir',    'doc/yardoc'
   ]
 end
 
-task :test do
+task :test_unit do
   require './test/helper.rb'
 
   FileList['./test/**/test_*.rb', './test/**/*_spec.rb'].each do |fn|
@@ -21,4 +22,8 @@ task :test do
   end
 end
 
+RuboCop::RakeTask.new(:test_style)
+
+task :test => [:test_unit, :test_style]
+
 task :default => :test

data/cri.gemspec

@@ -6,7 +6,7 @@ require 'cri/version'
 Gem::Specification.new do |s|
   s.name        = 'cri'
   s.version     = Cri::VERSION
-  s.homepage    = 'http://stoneship.org/software/cri/' # TODO CREATE A WEB SITE YOU SILLY PERSON
+  s.homepage    = 'http://stoneship.org/software/cri/' # TODO: CREATE A WEB SITE YOU SILLY PERSON
   s.summary     = 'a library for building easy-to-use commandline tools'
   s.description = 'Cri allows building easy-to-use commandline interfaces with support for subcommands.'
   s.license     = 'MIT'
@@ -14,15 +14,13 @@ Gem::Specification.new do |s|
   s.author = 'Denis Defreyne'
   s.email  = 'denis.defreyne@stoneship.org'
 
-  s.files              = Dir['[A-Z]*'] +
-                         Dir['{lib,test}/**/*'] +
-                         [ 'cri.gemspec' ]
-  s.require_paths      = [ 'lib' ]
+  s.files = Dir['[A-Z]*'] + Dir['{lib,test}/**/*'] + ['cri.gemspec']
+  s.require_paths = ['lib']
 
   s.add_dependency('colored', '~> 1.2')
 
   s.add_development_dependency('bundler', '~> 1.6')
 
-  s.rdoc_options     = [ '--main', 'README.adoc' ]
-  s.extra_rdoc_files = [ 'LICENSE', 'README.adoc', 'NEWS.md' ]
+  s.rdoc_options     = ['--main', 'README.adoc']
+  s.extra_rdoc_files = ['LICENSE', 'README.adoc', 'NEWS.md']
 end

data/lib/cri.rb

@@ -5,7 +5,6 @@ require 'cri/version'
 # The namespace for Cri, a library for building easy-to-use commandline tools
 # with support for nested commands.
 module Cri
-
   # A generic error class for all Cri-specific errors.
   class Error < ::StandardError
   end
@@ -27,7 +26,6 @@ module Cri
   autoload 'HelpRenderer',      'cri/help_renderer'
   autoload 'OptionParser',      'cri/option_parser'
   autoload 'Platform',          'cri/platform'
-
 end
 
 require 'set'

data/lib/cri/argument_array.rb

@@ -1,12 +1,10 @@
 # encoding: utf-8
 
 module Cri
-
   # Represents an array of arguments. It is an array that strips separator
   # arguments (`--`) but provides a `#raw` method to get the raw arguments
   # array, i.e. an array that includes the separator `--` arguments.
   class ArgumentArray < Array
-
     # Initializes the array using the given raw arguments.
     #
     # @param [Array<String>] raw_arguments A list of raw arguments, i.e.
@@ -21,7 +19,5 @@ module Cri
     def raw
       @raw_arguments
     end
-
   end
-
 end

data/lib/cri/command.rb

@@ -1,18 +1,15 @@
 # encoding: utf-8
 
 module Cri
-
   # Cri::Command represents a command that can be executed on the commandline.
   # It is also used for the commandline tool itself.
   class Command
-
     # Delegate used for partitioning the list of arguments and options. This
     # delegate will stop the parser as soon as the first argument, i.e. the
     # command, is found.
     #
     # @api private
     class OptionParserPartitioningDelegate
-
       # Returns the last parsed argument, which, in this case, will be the
       # first argument, which will be either nil or the command name.
       #
@@ -28,7 +25,7 @@ module Cri
       # @param [Cri::OptionParser] option_parser The option parser
       #
       # @return [void]
-      def option_added(key, value, option_parser)
+      def option_added(_key, _value, _option_parser)
       end
 
       # Called when an argument is parsed.
@@ -42,7 +39,6 @@ module Cri
         @last_argument = argument
         option_parser.stop
       end
-
     end
 
     # @return [Cri::Command, nil] This command’s supercommand, or nil if the
@@ -95,12 +91,12 @@ module Cri
     # @param [String, nil] filename The filename corresponding to the string parameter (only useful if a string is given)
     #
     # @return [Cri::Command] The newly defined command
-    def self.define(string=nil, filename=nil, &block)
+    def self.define(string = nil, filename = nil, &block)
       dsl = Cri::CommandDSL.new
       if string
-        args = filename ? [ string, filename ] : [ string ]
+        args = filename ? [string, filename] : [string]
         dsl.instance_eval(*args)
-      elsif [ -1, 0 ].include? block.arity
+      elsif [-1, 0].include? block.arity
         dsl.instance_eval(&block)
       else
         block.call(dsl)
@@ -115,7 +111,7 @@ module Cri
     # @return [Cri::Command] A basic root command
     def self.new_basic_root
       filename = File.dirname(__FILE__) + '/commands/basic_root.rb'
-      self.define(File.read(filename))
+      define(File.read(filename))
     end
 
     # Returns a new command that implements showing help.
@@ -123,7 +119,7 @@ module Cri
     # @return [Cri::Command] A basic help command
     def self.new_basic_help
       filename = File.dirname(__FILE__) + '/commands/basic_help.rb'
-      self.define(File.read(filename))
+      define(File.read(filename))
     end
 
     def initialize
@@ -141,7 +137,7 @@ module Cri
     # @return [Cri::Command] The command itself
     def modify(&block)
       dsl = Cri::CommandDSL.new(self)
-      if [ -1, 0 ].include? block.arity
+      if [-1, 0].include? block.arity
         dsl.instance_eval(&block)
       else
         block.call(dsl)
@@ -174,11 +170,11 @@ module Cri
     #   should be set (yet)
     #
     # @return [Cri::Command] The subcommand
-    def define_command(name=nil, &block)
+    def define_command(name = nil, &block)
       # Execute DSL
       dsl = Cri::CommandDSL.new
       dsl.name name unless name.nil?
-      if [ -1, 0 ].include? block.arity
+      if [-1, 0].include? block.arity
         dsl.instance_eval(&block)
       else
         block.call(dsl)
@@ -186,7 +182,7 @@ module Cri
 
       # Create command
       cmd = dsl.command
-      self.add_command(cmd)
+      add_command(cmd)
       cmd
     end
 
@@ -200,7 +196,7 @@ module Cri
       # Find by exact name or alias
       @commands.each do |cmd|
         found = cmd.name == name || cmd.aliases.include?(name)
-        return [ cmd ] if found
+        return [cmd] if found
       end
 
       # Find by approximation
@@ -242,12 +238,12 @@ module Cri
     #   supercommand
     #
     # @return [void]
-    def run(opts_and_args, parent_opts={})
+    def run(opts_and_args, parent_opts = {})
       # Parse up to command name
       stuff = partition(opts_and_args)
       opts_before_subcmd, subcmd_name, opts_and_args_after_subcmd = *stuff
 
-      if subcommands.empty? || (subcmd_name.nil? && !self.block.nil?)
+      if subcommands.empty? || (subcmd_name.nil? && !block.nil?)
         run_this(opts_and_args, parent_opts)
       else
         # Handle options
@@ -258,7 +254,7 @@ module Cri
           $stderr.puts "#{name}: no command given"
           exit 1
         end
-        subcommand = self.command_named(subcmd_name)
+        subcommand = command_named(subcmd_name)
 
         # Run
         subcommand.run(opts_and_args_after_subcmd, opts_before_subcmd)
@@ -278,10 +274,10 @@ module Cri
     #   block
     #
     # @return [void]
-    def run_this(opts_and_args, parent_opts={})
+    def run_this(opts_and_args, parent_opts = {})
       # Parse
       parser = Cri::OptionParser.new(
-        opts_and_args, self.global_option_definitions)
+        opts_and_args, global_option_definitions)
       handle_parser_errors_while { parser.run }
       local_opts  = parser.options
       global_opts = parent_opts.merge(parser.options)
@@ -291,11 +287,11 @@ module Cri
       handle_options(local_opts)
 
       # Execute
-      if self.block.nil?
-        raise NotImplementedError,
-          "No implementation available for '#{self.name}'"
+      if block.nil?
+        fail NotImplementedError,
+             "No implementation available for '#{name}'"
       end
-      self.block.call(global_opts, args, self)
+      block.call(global_opts, args, self)
     end
 
     # @return [String] The help text for this command
@@ -305,7 +301,7 @@ module Cri
     #
     # @option params [IO] :io ($stdout) the IO the help text is intended for.
     #   This influences the decision to enable/disable colored output.
-    def help(params={})
+    def help(params = {})
       HelpRenderer.new(self, params).render
     end
 
@@ -317,10 +313,10 @@ module Cri
     #
     # @see Object<=>
     def <=>(other)
-      self.name <=> other.name
+      name <=> other.name
     end
 
-  private
+    private
 
     def handle_options(opts)
       opts.each_pair do |key, value|
@@ -336,28 +332,23 @@ module Cri
       parser = Cri::OptionParser.new(opts_and_args, global_option_definitions)
       parser.delegate = delegate
       handle_parser_errors_while { parser.run }
-      parser
 
       # Extract
       [
         parser.options,
         delegate.last_argument,
-        parser.unprocessed_arguments_and_options
+        parser.unprocessed_arguments_and_options,
       ]
     end
 
     def handle_parser_errors_while(&block)
-      begin
-        block.call
-      rescue Cri::OptionParser::IllegalOptionError => e
-        $stderr.puts "#{name}: illegal option -- #{e}"
-        exit 1
-      rescue Cri::OptionParser::OptionRequiresAnArgumentError => e
-        $stderr.puts "#{name}: option requires an argument -- #{e}"
-        exit 1
-      end
+      block.call
+    rescue Cri::OptionParser::IllegalOptionError => e
+      $stderr.puts "#{name}: illegal option -- #{e}"
+      exit 1
+    rescue Cri::OptionParser::OptionRequiresAnArgumentError => e
+      $stderr.puts "#{name}: option requires an argument -- #{e}"
+      exit 1
     end
-
   end
-
 end