tty-option 0.1.0 → 0.3.0

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.3.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.3.0
 platform: ruby
 authors:
 - Piotr Murach
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2023-05-29 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
@@ -99,8 +100,9 @@ metadata:
   changelog_uri: https://github.com/piotrmurach/tty-option/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/tty-option
   homepage_uri: https://ttytoolkit.org
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/piotrmurach/tty-option
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,7 +118,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: []