cri 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c7acd3557015c65b10c166ddd982ff09a9e9439
-  data.tar.gz: 1084f157713632392659284ae92b39b85f5c45dd
+  metadata.gz: 125652850f61d27f4d91ec9e3bbfa46f25c03d11
+  data.tar.gz: dd5156012cb91ad551377bd807cd9b544300a618
 SHA512:
-  metadata.gz: 672ba33c779d549ffb422125dc480fa81f33f04ece3753f1f2294de9389d1ff6b91607ad3340db86cdef47e80282cbbd6e61d06fadd5f1c4e6e0a42115a1470b
-  data.tar.gz: 250a1fc1938e2be8090e772dddd2b3f3ca83e7c9f899cf2ace594750b5368b2e2a9ed538fe618ae863fbb88829c8bd116a1f1185fc5e88593fea4ab1aa7d0c3d
+  metadata.gz: cd917c4f792476b45868a6c95c3a1a75ee88c3b49bdb05dd18e30bc637e69fe476d6a0f5d57cbdd86ddbc3e5d07ee24e63f8dd1a23bf207dbfc913e763237b81
+  data.tar.gz: b697f2c2897405954a4c66437515648b4e3e18631bf3cb9059ef0e221a8bf5412d0bd1b744099ece0e894fc278406765c0754766347011507374ae69fa0642cc

data/Gemfile

@@ -2,9 +2,9 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'asciidoctor'
 gem 'coveralls'
-gem 'rake'
 gem 'minitest'
-gem 'yard'
-gem 'asciidoctor'
+gem 'rake'
 gem 'rubocop'
+gem 'yard'

data/Gemfile.lock

@@ -1,16 +1,14 @@
 PATH
   remote: .
   specs:
-    cri (2.7.0)
+    cri (2.7.1)
       colored (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     asciidoctor (1.5.2)
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
+    ast (2.3.0)
     colored (1.2)
     coveralls (0.8.1)
       json (~> 1.8)
@@ -27,22 +25,22 @@ GEM
     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)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.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)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.5)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     simplecov (0.10.0)
       docile (~> 1.1.0)
       json (~> 1.8)
@@ -55,6 +53,7 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
+    unicode-display_width (1.1.1)
     yard (0.8.7.6)
 
 PLATFORMS
@@ -69,3 +68,6 @@ DEPENDENCIES
   rake
   rubocop
   yard
+
+BUNDLED WITH
+   1.13.6

data/NEWS.md

@@ -1,6 +1,13 @@
 Cri News
 ========
 
+2.7.1
+-----
+
+Fixes:
+
+* Fixed some grammatical mistakes
+
 2.7.0
 -----
 

data/README.adoc

@@ -6,13 +6,13 @@ link:https://coveralls.io/r/ddfreyne/cri[image:http://img.shields.io/coveralls/d
 link:https://codeclimate.com/github/ddfreyne/cri[image:http://img.shields.io/codeclimate/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
+Cri is a library for building easy-to-use command-line tools with support for
 nested commands.
 
 == Usage ==
 
 The central concept in Cri is the _command_, which has option definitions as
-well as code for actually executing itself. In Cri, the commandline tool
+well as code for actually executing itself. In Cri, the command-line tool
 itself is a command as well.
 
 Here’s a sample command definition:
@@ -45,7 +45,7 @@ end
 --------------------------------------------------------------------------------
 
 To run this command, invoke the `#run` method with the raw arguments. For
-example, for a root command (the commandline tool itself), the command could
+example, for a root command (the command-line tool itself), the command could
 be called like this:
 
 [source,ruby]
@@ -84,7 +84,7 @@ description 'This command does a lot of stuff. I really mean a lot.'
 --------------------------------------------------------------------------------
 
 These lines of the command definition specify the name of the command (or the
-commandline tool, if the command is the root command), the usage, a list of
+command-line tool, if the command is the root command), the usage, a list of
 aliases that can be used to call this command, a one-line summary and a (long)
 description. The usage should not include a “usage:” prefix nor the name of
 the supercommand, because the latter will be automatically prepended.
@@ -174,7 +174,7 @@ into manageable pieces.
 
 === Subcommands ===
 
-Commands can have subcommands. For example, the `git` commandline tool would be
+Commands can have subcommands. For example, the `git` command-line tool would be
 represented by a command that has subcommands named `commit`, `add`, and so on.
 Commands with subcommands do not use a run block; execution will always be
 dispatched to a subcommand (or none, if no subcommand is found).

data/Rakefile

@@ -22,8 +22,10 @@ task :test_unit do
   end
 end
 
-RuboCop::RakeTask.new(:test_style)
+RuboCop::RakeTask.new(:test_style) do |task|
+  task.options = %w(--display-cop-names --format simple)
+end
 
-task :test => [:test_unit, :test_style]
+task test: [:test_unit, :test_style]
 
-task :default => :test
+task default: :test

data/cri.gemspec

@@ -7,8 +7,8 @@ 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.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.summary     = 'a library for building easy-to-use command-line tools'
+  s.description = 'Cri allows building easy-to-use command-line interfaces with support for subcommands.'
   s.license     = 'MIT'
 
   s.author = 'Denis Defreyne'

data/lib/cri.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 require 'cri/version'
 
-# The namespace for Cri, a library for building easy-to-use commandline tools
+# The namespace for Cri, a library for building easy-to-use command-line tools
 # with support for nested commands.
 module Cri
   # A generic error class for all Cri-specific errors.

data/lib/cri/argument_array.rb

@@ -1,5 +1,3 @@
-# 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

data/lib/cri/command.rb

@@ -1,8 +1,6 @@
-# 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.
+  # Cri::Command represents a command that can be executed on the command line.
+  # It is also used for the command-line 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
@@ -25,8 +23,7 @@ module Cri
       # @param [Cri::OptionParser] option_parser The option parser
       #
       # @return [void]
-      def option_added(_key, _value, _option_parser)
-      end
+      def option_added(_key, _value, _option_parser); end
 
       # Called when an argument is parsed.
       #
@@ -47,7 +44,7 @@ module Cri
 
     # @return [Set<Cri::Command>] This command’s subcommands
     attr_accessor :commands
-    alias_method :subcommands, :commands
+    alias subcommands commands
 
     # @return [String] The name
     attr_accessor :name
@@ -69,7 +66,7 @@ module Cri
     # @return [Boolean] true if the command is hidden (e.g. because it is
     #   deprecated), false otherwise
     attr_accessor :hidden
-    alias_method :hidden?, :hidden
+    alias hidden? hidden
 
     # @return [Array<Hash>] The list of option definitions
     attr_accessor :option_definitions
@@ -140,7 +137,7 @@ module Cri
       if [-1, 0].include? block.arity
         dsl.instance_eval(&block)
       else
-        block.call(dsl)
+        yield(dsl)
       end
       self
     end
@@ -177,7 +174,7 @@ module Cri
       if [-1, 0].include? block.arity
         dsl.instance_eval(&block)
       else
-        block.call(dsl)
+        yield(dsl)
       end
 
       # Create command
@@ -217,19 +214,19 @@ module Cri
     def command_named(name)
       commands = commands_named(name)
 
-      if commands.size < 1
+      if commands.empty?
         $stderr.puts "#{self.name}: unknown command '#{name}'\n"
         exit 1
       elsif commands.size > 1
         $stderr.puts "#{self.name}: '#{name}' is ambiguous:"
-        $stderr.puts "  #{commands.map { |c| c.name }.sort.join(' ') }"
+        $stderr.puts "  #{commands.map(&:name).sort.join(' ')}"
         exit 1
       else
         commands[0]
       end
     end
 
-    # Runs the command with the given commandline arguments, possibly invoking
+    # Runs the command with the given command-line arguments, possibly invoking
     # subcommands and passing on the options and arguments.
     #
     # @param [Array<String>] opts_and_args A list of unparsed arguments
@@ -261,7 +258,7 @@ module Cri
       end
     end
 
-    # Runs the actual command with the given commandline arguments, not
+    # Runs the actual command with the given command-line arguments, not
     # invoking any subcommands. If the command does not have an execution
     # block, an error ir raised.
     #
@@ -277,7 +274,8 @@ module Cri
     def run_this(opts_and_args, parent_opts = {})
       # Parse
       parser = Cri::OptionParser.new(
-        opts_and_args, 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)
@@ -288,8 +286,8 @@ module Cri
 
       # Execute
       if block.nil?
-        fail NotImplementedError,
-             "No implementation available for '#{name}'"
+        raise NotImplementedError,
+              "No implementation available for '#{name}'"
       end
       block.call(global_opts, args, self)
     end
@@ -341,8 +339,8 @@ module Cri
       ]
     end
 
-    def handle_parser_errors_while(&block)
-      block.call
+    def handle_parser_errors_while
+      yield
     rescue Cri::OptionParser::IllegalOptionError => e
       $stderr.puts "#{name}: illegal option -- #{e}"
       exit 1

data/lib/cri/command_dsl.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   # The command DSL is a class that is used for building and modifying
   # commands.
@@ -48,7 +46,7 @@ module Cri
     #
     # @return [void]
     def aliases(*args)
-      @command.aliases = args.flatten.map { |a| a.to_s }
+      @command.aliases = args.flatten.map(&:to_s)
     end
 
     # Sets the command summary.
@@ -114,20 +112,20 @@ module Cri
       hidden = params.fetch(:hidden, false)
 
       if short.nil? && long.nil?
-        fail ArgumentError, 'short and long options cannot both be nil'
+        raise ArgumentError, 'short and long options cannot both be nil'
       end
 
       @command.option_definitions << {
-        :short    => short.nil? ? nil : short.to_s,
-        :long     => long.nil? ? nil : long.to_s,
-        :desc     => desc,
-        :argument => requiredness,
-        :multiple => multiple,
-        :block    => block,
-        :hidden   => hidden,
+        short: short.nil? ? nil : short.to_s,
+        long: long.nil? ? nil : long.to_s,
+        desc: desc,
+        argument: requiredness,
+        multiple: multiple,
+        block: block,
+        hidden: hidden,
       }
     end
-    alias_method :opt, :option
+    alias opt option
 
     # Adds a new option with a required argument to the command. If a block is
     # given, it will be executed when the option is successfully parsed.
@@ -148,7 +146,7 @@ module Cri
     #
     # @see {#option}
     def required(short, long, desc, params = {}, &block)
-      params = params.merge(:argument => :required)
+      params = params.merge(argument: :required)
       option(short, long, desc, params, &block)
     end
 
@@ -171,10 +169,10 @@ module Cri
     #
     # @see {#option}
     def flag(short, long, desc, params = {}, &block)
-      params = params.merge(:argument => :forbidden)
+      params = params.merge(argument: :forbidden)
       option(short, long, desc, params, &block)
     end
-    alias_method :forbidden, :flag
+    alias forbidden flag
 
     # Adds a new option with an optional argument to the command. If a block
     # is given, it will be executed when the option is successfully parsed.
@@ -195,7 +193,7 @@ module Cri
     #
     # @see {#option}
     def optional(short, long, desc, params = {}, &block)
-      params = params.merge(:argument => :optional)
+      params = params.merge(argument: :optional)
       option(short, long, desc, params, &block)
     end
 
@@ -213,8 +211,8 @@ module Cri
     # @return [void]
     def run(&block)
       unless [2, 3].include?(block.arity)
-        fail ArgumentError,
-             'The block given to Cri::Command#run expects two or three args'
+        raise ArgumentError,
+              'The block given to Cri::Command#run expects two or three args'
       end
 
       @command.block = block

data/lib/cri/command_runner.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Cri
   # A command runner is responsible for the execution of a command. Using it
   # is optional, but it is useful for commands whose execution block is large.
@@ -40,7 +38,7 @@ module Cri
     #
     # @abstract
     def run
-      fail NotImplementedError, 'Cri::CommandRunner subclasses must implement #run'
+      raise NotImplementedError, 'Cri::CommandRunner subclasses must implement #run'
     end
   end
 end

data/lib/cri/commands/basic_help.rb

@@ -1,21 +1,19 @@
-# encoding: utf-8
-
 name        'help'
 usage       'help [command_name]'
 summary     'show help'
 description <<-EOS
 Show help for the given command, or show general help. When no command is
 given, a list of available commands is displayed, as well as a list of global
-commandline options. When a command is given, a command description as well as
-command-specific commandline options are shown.
+command-line options. When a command is given, a command description, as well
+as command-specific command-line options, are shown.
 EOS
 
 flag :v, :verbose, 'show more detailed help'
 
 run do |opts, args, cmd|
   if cmd.supercommand.nil?
-    fail NoHelpAvailableError,
-         'No help available because the help command has no supercommand'
+    raise NoHelpAvailableError,
+          'No help available because the help command has no supercommand'
   end
 
   is_verbose = opts.fetch(:verbose, false)
@@ -23,5 +21,5 @@ run do |opts, args, cmd|
   resolved_cmd = args.inject(cmd.supercommand) do |acc, name|
     acc.command_named(name)
   end
-  puts resolved_cmd.help(:verbose => is_verbose, :io => $stdout)
+  puts resolved_cmd.help(verbose: is_verbose, io: $stdout)
 end

data/lib/cri/commands/basic_root.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 flag :h, :help, 'show help for this command' do |_value, cmd|
   puts cmd.help
   exit 0