tty-option 0.0.0 → 0.1.0

data/lib/tty/option/section.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TTY
+  module Option
+    class Section
+      attr_accessor :name, :content
+
+      def initialize(name, content = [])
+        @name = name
+        @content = content
+      end
+
+      def to_a
+        [name, content]
+      end
+
+      def empty?
+        content.empty?
+      end
+
+      def to_s
+        content
+      end
+    end # Section
+  end # Option
+end # TTY

data/lib/tty/option/sections.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "section"
+
+module TTY
+  module Option
+    class Sections
+      include Enumerable
+      extend Forwardable
+
+      def_delegators :@sections, :size, :to_a
+
+      def initialize
+        @sections = []
+      end
+
+      def [](name)
+        @sections.find { |s| s.name == name }
+      end
+
+      def add(name, content)
+        @sections << Section.new(name, content)
+      end
+
+      def add_before(name, sect_name, sect_content)
+        @sections.insert(find_index(name), Section.new(sect_name, sect_content))
+      end
+
+      def add_after(name, sect_name, sect_content)
+        @sections.insert(find_index(name) + 1, Section.new(sect_name, sect_content))
+      end
+
+      def replace(name, content)
+        self[name].content = content
+      end
+
+      def delete(*names)
+        @sections.delete_if { |s| names.include?(s.name) }
+      end
+
+      def each(&block)
+        @sections.each(&block)
+      end
+
+      private
+
+      def find_index(name)
+        index = @sections.index { |sect| sect.name == name }
+        return index if index
+        raise ArgumentError, "There is no section named: #{name.inspect}"
+      end
+    end # Section
+  end # Option
+end # TTY

data/lib/tty/option/usage.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require_relative "deep_dup"
+
+module TTY
+  module Option
+    class Usage
+      # Create an usage
+      #
+      # @api public
+      def self.create(**properties, &block)
+        new(**properties, &block)
+      end
+
+      # Create an usage
+      #
+      # @api public
+      def initialize(**properties, &block)
+        @properties = {}
+        properties.each do |key, val|
+          case key.to_sym
+          when :desc, :description
+            key, val = :desc, [Array(val)]
+          when :header, :footer
+            val = [Array(val)]
+          when :example, :examples
+            key, val = :example, [Array(val)]
+          end
+          @properties[key.to_sym] = val
+        end
+
+        instance_eval(&block) if block_given?
+      end
+
+      # Program name for display in help and error messages
+      #
+      # @api public
+      def program(name = (not_set = true), &block)
+        if not_set
+          @properties.fetch(:program) { ::File.basename($0, ".*") }
+        else
+          @properties[:program] = name
+        end
+      end
+
+      # Action name for display in help and error messages
+      #
+      # @api public
+      def command(*values)
+        if values.empty?
+          @properties.fetch(:command) { [] }
+        else
+          @properties[:command] = []
+          values.each { |val| @properties[:command] << val }
+        end
+      end
+      alias commands command
+
+      # Remove default commands
+      #
+      # @api public
+      def no_command
+        @properties[:command] = []
+      end
+
+      def command?
+        @properties.key?(:command) && !@properties[:command].empty?
+      end
+
+      # Display info before anything else in the usage help
+      #
+      # @api public
+      def header(*values)
+        if values.empty?
+          @properties.fetch(:header) { [] }
+        else
+          (@properties[:header] ||= []) << values
+        end
+      end
+
+      def header?
+        @properties.key?(:header) && !@properties[:header].empty?
+      end
+
+      # Main way to show how all parameters can be used
+      #
+      # @api public
+      def banner(value = (not_set = true))
+        if not_set
+          @properties[:banner]
+        else
+          @properties[:banner] = value
+        end
+      end
+
+      def banner?
+        @properties.key?(:banner) && !@properties[:banner].nil?
+      end
+
+      # Description
+      #
+      # @api public
+      def desc(*values)
+        if values.empty?
+          @properties.fetch(:desc) { [] }
+        else
+          (@properties[:desc] ||= []) << values
+        end
+      end
+      alias description desc
+
+      def desc?
+        @properties.key?(:desc) && !@properties[:desc].empty?
+      end
+      alias description? desc?
+
+      # Collects usage examples
+      #
+      # @api public
+      def example(*values)
+        if values.empty?
+          @properties.fetch(:example) { [] }
+        else
+          (@properties[:example] ||= []) << values
+        end
+      end
+      alias examples example
+
+      def example?
+        @properties.key?(:example) && !@properties[:example].empty?
+      end
+      alias examples? example?
+
+      # Display info after everyting else in the usage help
+      #
+      # @api public
+      def footer(*values)
+        if values.empty?
+          @properties.fetch(:footer) { [] }
+        else
+          (@properties[:footer] ||= []) << values
+        end
+      end
+
+      def footer?
+        @properties.key?(:footer) && !@properties[:footer].empty?
+      end
+
+      # Return a hash of this usage properties
+      #
+      # @return [Hash] the names and values of this usage
+      #
+      # @api public
+      def to_h(&block)
+        if block_given?
+          @properties.each_with_object({}) do |(key, val), acc|
+            k, v = *block.(key, val)
+            acc[k] = v
+          end
+        else
+          DeepDup.deep_dup(@properties)
+        end
+      end
+    end # Usage
+  end # Option
+end # TTY

data/lib/tty/option/usage_wrapper.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module TTY
+  module Option
+    module UsageWrapper
+      # Wrap a string to a maximum width with indentation
+      #
+      # @param [String] text
+      # @param [Integer] width
+      # @param [Integer] indent
+      # @param [Boolean] indent_first
+      #
+      # @api public
+      def wrap(text, width: 80, indent: 2, indent_first: false)
+        wrap = width - indent
+        lines = []
+
+        line, rest = *next_line(text, wrap: wrap)
+        lines << (indent_first ? " " * indent : "") + line
+
+        while !rest.nil?
+          line, rest = *next_line(rest, wrap: wrap)
+          lines << " " * indent + line.strip
+        end
+
+        lines.join("\n")
+      end
+      module_function :wrap
+
+      # Extract a line from a string and return remainder
+      #
+      # @param [String] str
+      # @param [Integer] wrap
+      #
+      # @return [Array<String, String>]
+      #
+      # @api private
+      def next_line(text, wrap: nil)
+        line = text[0, wrap + 1] # account for word boundary
+        index = line.index("\n", 1)
+
+        # line without newlines and can be broken
+        if (index.nil? || index.zero?) && wrap < line.length
+          index = line.rindex(/\s/)
+        end
+
+        # line without any whitespace
+        if index.nil? || index.zero?
+          index = wrap
+        end
+
+        [text[0...index], text[index..-1]]
+      end
+      module_function :next_line
+      private_class_method :next_line
+    end # StringsHelper
+  end # Option
+end # TTY

data/lib/tty/option/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-option
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Parser for command line arguments, keywords, options and environment
+description: Parser for command line arguments, keywords, flags, options and environment
   variables.
 email:
 - piotr@piotrmurach.com
@@ -54,7 +54,41 @@ files:
 - README.md
 - lib/tty-option.rb
 - lib/tty/option.rb
+- lib/tty/option/aggregate_errors.rb
+- lib/tty/option/conversions.rb
+- lib/tty/option/converter.rb
+- lib/tty/option/deep_dup.rb
+- lib/tty/option/dsl.rb
+- lib/tty/option/dsl/arity.rb
+- lib/tty/option/dsl/conversion.rb
+- lib/tty/option/error_aggregator.rb
+- lib/tty/option/errors.rb
+- lib/tty/option/formatter.rb
+- lib/tty/option/inflection.rb
+- lib/tty/option/param_conversion.rb
+- lib/tty/option/param_permitted.rb
+- lib/tty/option/param_validation.rb
+- lib/tty/option/parameter.rb
+- lib/tty/option/parameter/argument.rb
+- lib/tty/option/parameter/environment.rb
+- lib/tty/option/parameter/keyword.rb
+- lib/tty/option/parameter/option.rb
+- lib/tty/option/parameters.rb
+- lib/tty/option/params.rb
 - lib/tty/option/parser.rb
+- lib/tty/option/parser/arguments.rb
+- lib/tty/option/parser/arity_check.rb
+- lib/tty/option/parser/environments.rb
+- lib/tty/option/parser/keywords.rb
+- lib/tty/option/parser/options.rb
+- lib/tty/option/parser/param_types.rb
+- lib/tty/option/parser/required_check.rb
+- lib/tty/option/pipeline.rb
+- lib/tty/option/result.rb
+- lib/tty/option/section.rb
+- lib/tty/option/sections.rb
+- lib/tty/option/usage.rb
+- lib/tty/option/usage_wrapper.rb
 - lib/tty/option/version.rb
 homepage: https://ttytoolkit.org
 licenses: