tty-option 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48f8a476c72fb96d9f6bf49daea6533b2cc6940a536eb0e5a56fce19ff6c75b
-  data.tar.gz: cbadbde794e8469c8d0b1bc5ade00c47e2420d885f5a5fd6e410dce5950d3d8a
+  metadata.gz: fabf2ee6efdc82e500dee823a54a90675a52dc06e90496b922396fe412c7780f
+  data.tar.gz: c2e00f207d86ca4adfbe84b0e8a99298720d50e754cdb77e3ab815c11d9152eb
 SHA512:
-  metadata.gz: b6257d839aefe82f045f8708ebd5b5443a2df85090b1c3a722f8dbe3ba40704c79277a203e44d78e458405200ad465e3471dc4b3575fc101806d7b4b93717ee6
-  data.tar.gz: 461f0b5454e44e5bebf59dcd308ffa2fda57f457d0191c709b859dae216880b781ff62d40e96e2cc101f8637ee94b1029174c7d63c2d872c345614b692412e34
+  metadata.gz: c484049a77722baae844331533373d174f35999ab621040b2be38968fd64b0d6fa14372873741e4df40d75fa15d36f7f22557d02f48f5d25de40f14ad42da400
+  data.tar.gz: 173e26541c883f4111a69b5f1d8287cea032bd727275ac04f62ab4da3d4925680b5dcd8ef0cf81a7cc5d73a32e67aaf71042b7dbe5c72817429155a5abc55479

data/CHANGELOG.md

@@ -1,7 +1,22 @@
 # Change log
 
+## [v0.2.0] - 2021-08-04
+
+### Added
+* Add predicate methods for checking if a given parameter is supported
+
+### Changed
+* Change Conversions to stop raising error and return Undefined value instead
+* Change to skip conversion of parameters with nil value
+
+### Fixed
+* Fix conversion of nil into array or hash to stop raising an error
+* Fix #no_command to correctly mark command as not present
+* Fix warnings about shadowing local variables
+
 ## [v0.1.0] - 2020-05-18
 
 * Initial implementation and release
 
-[v0.1.0]: https://github.com/piotrmurach/tty-option/compare/v0.1.0
+[v0.2.0]: https://github.com/piotrmurach/tty-option/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-option/compare/95179f0...v0.1.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Piotr Murach
+Copyright (c) 2020 Piotr Murach (piotrmurach.com)
 
 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/README.md

@@ -1,22 +1,22 @@
 <div align="center">
-  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="tty logo" /></a>
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="TTY Toolkit logo"/></a>
 </div>
 
 # TTY::Option
 
 [![Gem Version](https://badge.fury.io/rb/tty-option.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-option.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/tty-option/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Build status](https://ci.appveyor.com/api/projects/status/gxml9ttyvgpeasy5?svg=true)][appveyor]
 [![Maintainability](https://api.codeclimate.com/v1/badges/1083a2fd114d6faf5d65/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-option/badge.svg)][coverage]
-[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-option.svg?branch=master)][inchpages]
+[![Inline docs](https://inch-ci.org/github/piotrmurach/tty-option.svg?branch=master)][inchpages]
 
-[gem]: http://badge.fury.io/rb/tty-option
-[travis]: http://travis-ci.org/piotrmurach/tty-option
+[gem]: https://badge.fury.io/rb/tty-option
+[gh_actions_ci]: https://github.com/piotrmurach/tty-option/actions?query=workflow%3ACI
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-option
 [codeclimate]: https://codeclimate.com/github/piotrmurach/tty-option/maintainability
 [coverage]: https://coveralls.io/github/piotrmurach/tty-option
-[inchpages]: http://inch-ci.org/github/piotrmurach/tty-option
+[inchpages]: https://inch-ci.org/github/piotrmurach/tty-option
 
 > Parser for command line arguments, keywords, options and environment variables
 
@@ -280,7 +280,7 @@ argument :foo do
   required                   # a default
   variable "foo(int)"        # name for the usage display
   arity one_or_more          # how many times to occur
-  convert :int               # values converted to intenger
+  convert :int               # values converted to integer
   validate -> { |v| v < 14 } # validation rule
   desc "Some foo desc"       # description for the usage display
 end
@@ -338,7 +338,7 @@ A more involved example to parse multiple keyword arguments requires use of help
 keyword :foo do
   required                   # by default keywrod is not required
   arity one_or_more          # how many times to occur
-  convert :int               # values converted to intenger
+  convert :int               # values converted to integer
   validate -> { |v| v < 14 } # validation rule
   desc "Some foo desc"       # description for the usage display
 end
@@ -362,7 +362,7 @@ You can also specify for the keyword argument to accept a list type:
 keyword :foo do
   required                   # by default keyword is not required
   arity one_or_more          # how many times to occur
-  convert :int_list          # input can be a list of intengers
+  convert :int_list          # input can be a list of integers
   validate -> { |v| v < 14 } # validation rule
   desc "Some foo desc"       # description for the usage display
 end
@@ -453,7 +453,7 @@ option :foo do
   arity one_or_more          # how many times option can occur
   short "-f"                 # declares a short flag name
   long  "--foo list"         # declares a long flag with a required argument
-  convert :int_list          # input can be a list of intengers
+  convert :int_list          # input can be a list of integers
   validate -> { |v| v < 14 } # validation rule
   desc "Some foo desc"       # description for the usage display
 end

data/lib/tty/option/aggregate_errors.rb

@@ -75,12 +75,12 @@ module TTY
         output = []
         space_indent = " " * indent
         if messages.count == 1
-          message = messages.first
+          msg = messages.first
           label = "Error: "
           output << "#{space_indent}#{label}" \
-                    "#{wrap(message, indent: indent + label.length, width: width)}"
+                    "#{wrap(msg, indent: indent + label.length, width: width)}"
         else
-          output << space_indent + "Errors:"
+          output << "#{space_indent}Errors:"
           messages.each_with_index do |message, num|
             entry = "  #{num + 1}) "
             output << "#{space_indent}#{entry}" \

data/lib/tty/option/const.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TTY
+  module Option
+    module Const
+      Undefined = Object.new.tap do |obj|
+        def obj.to_s
+          "undefined"
+        end
+
+        def obj.inspect
+          "undefined".inspect
+        end
+      end
+    end # Const
+  end # Option
+end # TTY

data/lib/tty/option/conversions.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "const"
 require_relative "converter"
 
 module TTY
@@ -10,13 +11,6 @@ module TTY
       TRUE_VALUES = /^(true|y(es)?|t|1)$/i.freeze
       FALSE_VALUES = /^(false|n(o)?|f|0)$/i.freeze
 
-      # @api public
-      def self.raise_invalid_argument(conv_name, val)
-        raise ConversionError,
-              format("invalid value of %<value>s for %<conv>s conversion",
-                     value: val.inspect, conv: conv_name.inspect)
-      end
-
       convert :bool, :boolean do |val|
         case val.to_s
         when TRUE_VALUES
@@ -24,7 +18,7 @@ module TTY
         when FALSE_VALUES
           false
         else
-          raise_invalid_argument(:bool, val)
+          Const::Undefined
         end
       end
 
@@ -33,7 +27,7 @@ module TTY
           require "date" unless defined?(::Date)
           ::Date.parse(val)
         rescue ArgumentError, TypeError
-          raise_invalid_argument(:date, val)
+          Const::Undefined
         end
       end
 
@@ -41,7 +35,7 @@ module TTY
         begin
           Float(val)
         rescue ArgumentError, TypeError
-          raise_invalid_argument(:float, val)
+          Const::Undefined
         end
       end
 
@@ -49,7 +43,7 @@ module TTY
         begin
           Float(val).to_i
         rescue ArgumentError, TypeError
-          raise_invalid_argument(:integer, val)
+          Const::Undefined
         end
       end
 
@@ -62,7 +56,7 @@ module TTY
         begin
           Regexp.new(val.to_s)
         rescue TypeError, RegexpError
-          raise_invalid_argument(:regexp, val)
+          Const::Undefined
         end
       end
 
@@ -70,7 +64,7 @@ module TTY
         begin
           String(val).to_sym
         rescue ArgumentError
-          raise_invalid_argument(:symbol, val)
+          Const::Undefined
         end
       end
 
@@ -79,18 +73,22 @@ module TTY
           require "uri"
           ::URI.parse(val)
         rescue ::URI::InvalidURIError
-          raise_invalid_argument(:uri, val)
+          Const::Undefined
         end
       end
 
       convert :list, :array do |val|
-        (val.respond_to?(:to_a) ? val : val.split(/(?<!\\),/))
+        next Const::Undefined if val.nil?
+
+        (val.respond_to?(:map) ? val : val.to_s.split(/(?<!\\),/))
           .map { |v| v.strip.gsub(/\\,/, ",") }
           .reject(&:empty?)
       end
 
       convert :map, :hash do |val|
-        values = val.respond_to?(:to_a) ? val : val.split(/[& ]/)
+        next Const::Undefined if val.nil?
+
+        values = val.respond_to?(:each) ? val : val.to_s.split(/[& ]/)
         values.each_with_object({}) do |pair, pairs|
           key, value = pair.split(/[=:]/, 2)
           if (current = pairs[key.to_sym])
@@ -107,16 +105,26 @@ module TTY
 
         [:"#{type}_list", :"#{type}_array", :"#{type}s"].each do |new_type|
           convert new_type do |val|
-            conversions[:list].(val).map do |obj|
-              conversions[type].(obj)
+            list_conversion = conversions[:list].(val)
+            next list_conversion if list_conversion == Const::Undefined
+
+            list_conversion.map do |obj|
+              converted = conversions[type].(obj)
+              break converted if converted == Const::Undefined
+              converted
             end
           end
         end
 
         [:"#{type}_map", :"#{type}_hash"].each do |new_type|
           convert new_type do |val|
+            map_conversion = conversions[:map].(val)
+            next map_conversion if map_conversion == Const::Undefined
+
             conversions[:map].(val).each_with_object({}) do |(k, v), h|
-              h[k] = conversions[type].(v)
+              converted = conversions[type].(v)
+              break converted if converted == Const::Undefined
+              h[k] = converted
             end
           end
         end

data/lib/tty/option/converter.rb

@@ -32,7 +32,7 @@ module TTY
         names.each do |name|
           if contain?(name)
             raise ConversionAlreadyDefined,
-                "conversion #{name.inspect} is already defined"
+                  "conversion #{name.inspect} is already defined"
           end
           conversions[name] = block
         end
@@ -56,7 +56,7 @@ module TTY
       # @api public
       def raise_unsupported_error(conv_name)
         raise UnsupportedConversion,
-             "unsupported conversion type #{conv_name.inspect}"
+              "unsupported conversion type #{conv_name.inspect}"
       end
     end # Converter
   end # Option

data/lib/tty/option/deep_dup.rb

@@ -14,7 +14,6 @@ module TTY
       # @api public
       def self.deep_dup(object)
         case object
-        when String then object.dup
         when *NONDUPLICATABLE then object
         when Hash   then deep_dup_hash(object)
         when Array  then deep_dup_array(object)

data/lib/tty/option/dsl.rb

@@ -28,10 +28,10 @@ module TTY
       # @api public
       def usage(**properties, &block)
         @usage ||= Usage.create(**properties, &block).tap do |usage|
-                    if usage.command.empty?
-                      usage.command(dasherize(demodulize(self.name)))
-                    end
-                  end
+                     unless usage.command? || usage.no_command?
+                       usage.command(dasherize(demodulize(self.name)))
+                     end
+                   end
       end
 
       # Specify an argument
@@ -69,7 +69,7 @@ module TTY
       #
       # @api public
       def flag(name, **settings, &block)
-        defaults = { default: false }
+        defaults = {default: false}
         option(name, **defaults.merge(settings), &block)
       end
 

data/lib/tty/option/formatter.rb

@@ -53,10 +53,12 @@ module TTY
 
       # A formatted help usage information
       #
+      # @yieldparam [TTY::Option::Sections] sections
+      #
       # @return [String]
       #
       # @api public
-      def help(&block)
+      def help
         sections = Sections.new
 
         sections.add(:header, help_header) if @usage.header?
@@ -82,9 +84,7 @@ module TTY
         sections.add(:examples, help_examples) if @usage.example?
         sections.add(:footer, help_footer) if @usage.footer?
 
-        if block_given?
-          yield(sections)
-        end
+        yield(sections) if block_given?
 
         formatted = sections.reject(&:empty?).join(NEWLINE)
         formatted.end_with?(NEWLINE) ? formatted : formatted + NEWLINE
@@ -182,7 +182,7 @@ module TTY
           args << "[" if param.optional?
           args << param_name
           (param.arity - 1).times { args << " #{param_name}" }
-          args. << "]" if param.optional?
+          args << "]" if param.optional?
           args.join
         else
           (param.arity.abs - 1).times { args << param_name }

data/lib/tty/option/param_conversion.rb

@@ -10,24 +10,26 @@ module TTY
       #
       # @example
       #   param = Parameter::Argument.create(:foo, convert: :int)
-      #   ParamConversion[param, "12"] # => 12
+      #   result = ParamConversion[param, "12"]
+      #   result.value # => 12
       #
       # @api public
       def call(param, value)
-        return Result.success(value) unless param.convert?
+        return Result.success(value) if !param.convert? || value.nil?
 
-        case cast = param.convert
-        when Proc
-          Result.success(cast.(value))
+        cast = param.convert
+        cast = cast.is_a?(Proc) ? cast : Conversions[cast]
+        converted = cast.(value)
+
+        if converted == Const::Undefined
+          Result.failure(InvalidConversionArgument.new(param, value))
         else
-          Result.success(Conversions[cast].(value))
+          Result.success(converted)
         end
-      rescue ConversionError
-        Result.failure(InvalidConversionArgument.new(param, value))
       end
       module_function :call
 
-      alias :[] :call
+      alias [] call
       module_function :[]
     end # ParamConversion
   end # Option

data/lib/tty/option/param_permitted.rb

@@ -23,7 +23,7 @@ module TTY
       end
       module_function :call
 
-      alias :[] :call
+      alias [] call
       module_function :[]
     end # ParamPermitted
   end # Option

data/lib/tty/option/param_validation.rb

@@ -41,7 +41,7 @@ module TTY
       end
       module_function :call
 
-      alias :[] :call
+      alias [] call
       module_function :[]
     end # ParamValidation
   end # Option

data/lib/tty/option/parameter.rb

@@ -11,6 +11,12 @@ module TTY
       include DSL::Arity
       include DSL::Conversion
 
+      # Zero or more parameter arity pattern
+      ZERO_OR_MORE_ARITY = /\*|any/.freeze
+
+      # One or more parameter arity pattern
+      ONE_OR_MORE_ARITY = /\+/.freeze
+
       # A parameter factory
       #
       # @api public
@@ -32,20 +38,20 @@ module TTY
       def initialize(key, **settings, &block)
         @key = key
         @settings = {}
-        settings.each do |key, val|
-          case key.to_sym
+        settings.each do |name, val|
+          case name.to_sym
           when :arity
             val = check_arity(val)
           when :default
             val = check_default(val)
           when :optional
-            key, val = :required, check_required(!val)
+            name, val = :required, check_required(!val)
           when :permit
             val = check_permitted(val)
           when :validate
             val = check_validation(val)
           end
-          @settings[key.to_sym] = val
+          @settings[name.to_sym] = val
         end
 
         instance_eval(&block) if block_given?
@@ -136,7 +142,7 @@ module TTY
       end
 
       def required?
-        @settings.fetch(:required) { false }
+        @settings.fetch(:required, false)
       end
 
       def hidden
@@ -144,7 +150,7 @@ module TTY
       end
 
       def hidden?
-        @settings.fetch(:hidden) { false }
+        @settings.fetch(:hidden, false)
       end
 
       def display?
@@ -203,6 +209,7 @@ module TTY
       # @api public
       def ==(other)
         return false unless instance_of?(other.class)
+
         name == other.name && to_h == other.to_h
       end
 
@@ -211,6 +218,7 @@ module TTY
       # @api public
       def eql?(other)
         return false unless instance_of?(other.class)
+
         name.eql?(other.name) && to_h.eql?(other.to_h)
       end
 
@@ -250,15 +258,14 @@ module TTY
         end
 
         case value.to_s
-        when %r{\*|any} then value = -1
-        when %r{\+}     then value = -2
-        else value = value.to_i
-        end
-
-        if value.zero?
-          raise ConfigurationError, "#{to_sym} '#{name}' arity cannot be zero"
+        when ZERO_OR_MORE_ARITY then -1
+        when ONE_OR_MORE_ARITY then -2
+        else value.to_i
+        end.tap do |val|
+          if val.zero?
+            raise ConfigurationError, "#{to_sym} '#{name}' arity cannot be zero"
+          end
         end
-        value
       end
 
       # @api private

data/lib/tty/option/parameters.rb

@@ -13,7 +13,16 @@ module TTY
       # @api private
       def self.define_query(name)
         define_method(:"#{name}?") do
-          !self.public_send(name).empty?
+          !public_send(name).empty?
+        end
+      end
+
+      # Define a predicate method to check if a parameter is supported
+      #
+      # @api private
+      def self.define_param_query(name)
+        define_method(:"#{name}?") do |param|
+          public_send(:"#{name}s").map(&:key).include?(param)
         end
       end
 
@@ -37,6 +46,11 @@ module TTY
       define_query :options
       define_query :environments
 
+      define_param_query :argument
+      define_param_query :keyword
+      define_param_query :option
+      define_param_query :environment
+
       # A parameters list
       #
       # @api private

data/lib/tty/option/parser.rb

@@ -15,7 +15,7 @@ module TTY
         keywords: TTY::Option::Parser::Keywords,
         arguments: TTY::Option::Parser::Arguments,
         environments: TTY::Option::Parser::Environments
-      }
+      }.freeze
 
       ARGUMENT_SEPARATOR = /^-{2,}$/.freeze
 

data/lib/tty/option/parser/arguments.rb

@@ -109,7 +109,7 @@ module TTY
           values = []
           arity = arg.arity.abs - 1
 
-          arity.times do |i|
+          arity.times do
             break if @argv.empty?
             value = @argv.shift
             if argument?(value)

data/lib/tty/option/parser/arity_check.rb

@@ -12,7 +12,7 @@ module TTY
         def add(param)
           @multiplies << param
         end
-        alias :<< :add
+        alias << add
 
         # Check if parameter matches arity
         #

data/lib/tty/option/parser/environments.rb

@@ -150,10 +150,10 @@ module TTY
             if allowed
               case value
               when Hash
-                (@parsed[env_arg.key] ||=  {}).merge!(value)
+                (@parsed[env_arg.key] ||= {}).merge!(value)
               else
                 Array(value).each do |v|
-                  (@parsed[env_arg.key] ||=  []) << v
+                  (@parsed[env_arg.key] ||= []) << v
                 end
               end
             else

data/lib/tty/option/parser/keywords.rb

@@ -142,7 +142,7 @@ module TTY
                 (@parsed[kwarg.key] ||= {}).merge!(value)
               else
                 Array(value).each do |v|
-                  (@parsed[kwarg.key] ||=  []) << v
+                  (@parsed[kwarg.key] ||= []) << v
                 end
               end
             else

data/lib/tty/option/parser/param_types.rb

@@ -4,6 +4,18 @@ module TTY
   module Option
     class Parser
       module ParamTypes
+        # Positional argument pattern
+        ARGUMENT_PARAMETER = /^[^-][^=]*\z/.freeze
+
+        # Environment variable pattern
+        ENV_VAR_PARAMETER = /^[\p{Lu}_\-\d]+=/.freeze
+
+        # Keyword pattern
+        KEYWORD_PARAMETER = /^([^-=][\p{Ll}_\-\d]*)=([^=]+)/.freeze
+
+        # Option and flag pattern
+        OPTION_PARAMETER = /^-./.freeze
+
         # Check if value looks like an argument
         #
         # @param [String] value
@@ -12,7 +24,7 @@ module TTY
         #
         # @api public
         def argument?(value)
-          !value.match(/^[^-][^=]*\z/).nil?
+          !value.match(ARGUMENT_PARAMETER).nil?
         end
 
         # Check if value is an environment variable
@@ -23,7 +35,7 @@ module TTY
         #
         # @api public
         def env_var?(value)
-          !value.match(/^[\p{Lu}_\-\d]+=/).nil?
+          !value.match(ENV_VAR_PARAMETER).nil?
         end
 
         # Check to see if value is a keyword
@@ -32,7 +44,7 @@ module TTY
         #
         # @api public
         def keyword?(value)
-          !value.to_s.match(/^([^-=][\p{Ll}_\-\d]*)=([^=]+)/).nil?
+          !value.to_s.match(KEYWORD_PARAMETER).nil?
         end
 
         # Check if value looks like an option
@@ -43,7 +55,7 @@ module TTY
         #
         # @api public
         def option?(value)
-          !value.match(/^-./).nil?
+          !value.match(OPTION_PARAMETER).nil?
         end
       end # ParamTypes
     end # Parser

data/lib/tty/option/parser/required_check.rb

@@ -12,7 +12,7 @@ module TTY
         def add(param)
           @required << param
         end
-        alias :<< :add
+        alias << add
 
         def delete(param)
           @required.delete(param)

data/lib/tty/option/pipeline.rb

@@ -11,7 +11,7 @@ module TTY
         ParamConversion,
         ParamPermitted,
         ParamValidation
-      ]
+      ].freeze
 
       # Create a param processing pipeline
       #

data/lib/tty/option/result.rb

@@ -18,29 +18,51 @@ module TTY
         Failure.new(value)
       end
 
+      # Wrapped value
+      #
+      # @api public
       attr_reader :value
 
+      # Reason for failure
+      #
+      # @api public
       attr_reader :error
 
+      # Check whether or not a result is a success monad
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def success?
         is_a?(Success)
       end
 
+      # Check whether or not a result is a failure class
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def failure?
         is_a?(Failure)
       end
 
+      # Success monad containing a value
+      #
+      # @api private
       class Success < Result
         def initialize(value)
           @value = value
         end
       end
 
+      # Failure monad containing an error
+      #
+      # @api private
       class Failure < Result
         def initialize(error)
           @error = error
         end
       end
-    end
-  end
-end
+    end # Result
+  end # Option
+end # TTY

data/lib/tty/option/usage.rb

@@ -17,8 +17,11 @@ module TTY
       # @api public
       def initialize(**properties, &block)
         @properties = {}
+        @no_command = false
         properties.each do |key, val|
           case key.to_sym
+          when :command
+            key, val = :command, Array(val)
           when :desc, :description
             key, val = :desc, [Array(val)]
           when :header, :footer
@@ -34,8 +37,10 @@ module TTY
 
       # Program name for display in help and error messages
       #
+      # @param [String] name
+      #
       # @api public
-      def program(name = (not_set = true), &block)
+      def program(name = (not_set = true))
         if not_set
           @properties.fetch(:program) { ::File.basename($0, ".*") }
         else
@@ -45,6 +50,8 @@ module TTY
 
       # Action name for display in help and error messages
       #
+      # @param [Array<String>] values
+      #
       # @api public
       def command(*values)
         if values.empty?
@@ -60,15 +67,32 @@ module TTY
       #
       # @api public
       def no_command
+        @no_command = true
         @properties[:command] = []
       end
 
+      # Whether or not to show command in usage
+      #
+      # @retrun [Boolean]
+      #
+      # @api public
+      def no_command?
+        @no_command
+      end
+
+      # Check for command definition
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def command?
         @properties.key?(:command) && !@properties[:command].empty?
       end
 
       # Display info before anything else in the usage help
       #
+      # @param [Array<String>] values
+      #
       # @api public
       def header(*values)
         if values.empty?
@@ -78,12 +102,19 @@ module TTY
         end
       end
 
+      # Whether or not to show header in usage
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def header?
         @properties.key?(:header) && !@properties[:header].empty?
       end
 
       # Main way to show how all parameters can be used
       #
+      # @param [String] value
+      #
       # @api public
       def banner(value = (not_set = true))
         if not_set
@@ -93,12 +124,19 @@ module TTY
         end
       end
 
+      # Whether or not to show banner in usage
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def banner?
         @properties.key?(:banner) && !@properties[:banner].nil?
       end
 
       # Description
       #
+      # @param [Array<String>] values
+      #
       # @api public
       def desc(*values)
         if values.empty?
@@ -109,6 +147,11 @@ module TTY
       end
       alias description desc
 
+      # Whether or not to show description in usage
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def desc?
         @properties.key?(:desc) && !@properties[:desc].empty?
       end
@@ -116,6 +159,8 @@ module TTY
 
       # Collects usage examples
       #
+      # @param [Array<String>] values
+      #
       # @api public
       def example(*values)
         if values.empty?
@@ -126,6 +171,11 @@ module TTY
       end
       alias examples example
 
+      # Whether or not to show example in usage
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def example?
         @properties.key?(:example) && !@properties[:example].empty?
       end
@@ -133,6 +183,8 @@ module TTY
 
       # Display info after everyting else in the usage help
       #
+      # @param [Array<String>] values
+      #
       # @api public
       def footer(*values)
         if values.empty?
@@ -142,6 +194,11 @@ module TTY
         end
       end
 
+      # Whether or not to show footer in usage
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def footer?
         @properties.key?(:footer) && !@properties[:footer].empty?
       end

data/lib/tty/option/usage_wrapper.rb

@@ -14,13 +14,14 @@ module TTY
       def wrap(text, width: 80, indent: 2, indent_first: false)
         wrap = width - indent
         lines = []
+        indentation = " " * indent
 
         line, rest = *next_line(text, wrap: wrap)
-        lines << (indent_first ? " " * indent : "") + line
+        lines << (indent_first ? indentation : "") + line
 
         while !rest.nil?
           line, rest = *next_line(rest, wrap: wrap)
-          lines << " " * indent + line.strip
+          lines << indentation + line.strip
         end
 
         lines.join("\n")

data/lib/tty/option/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Option
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # Option
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-option
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -55,6 +55,7 @@ files:
 - lib/tty-option.rb
 - lib/tty/option.rb
 - lib/tty/option/aggregate_errors.rb
+- lib/tty/option/const.rb
 - lib/tty/option/conversions.rb
 - lib/tty/option/converter.rb
 - lib/tty/option/deep_dup.rb
@@ -100,7 +101,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/tty-option
   homepage_uri: https://ttytoolkit.org
   source_code_uri: https://github.com/piotrmurach/tty-option
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: An intuitive and flexible command line parser
+summary: An intuitive and flexible command line parser.
 test_files: []