toys-core 0.3.3 → 0.3.4

data/lib/toys/utils/line_output.rb

@@ -0,0 +1,105 @@
+# Copyright 2018 Daniel Azuma
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+;
+
+require "highline"
+
+module Toys
+  module Utils
+    ##
+    # Something that outputs lines to the console or log.
+    #
+    class LineOutput
+      ##
+      # Create a line output.
+      #
+      # @param [IO,Logger,nil] sink Where to write lines.
+      #
+      def initialize(sink, log_level: ::Logger::INFO, styled: nil)
+        @sink = sink
+        @log_level = sink.is_a?(::Logger) ? log_level : nil
+        @styled =
+          if styled.nil?
+            sink.respond_to?(:tty?) && sink.tty?
+          else
+            styled ? true : false
+          end
+      end
+
+      ##
+      # Where to write lines
+      # @return [IO,Logger,nil]
+      #
+      attr_reader :sink
+
+      ##
+      # Whether output is styled
+      # @return [Boolean]
+      #
+      attr_reader :styled
+
+      ##
+      # If the sink is a Logger, the level to log, otherwise `nil`.
+      # @return [Integer,nil]
+      #
+      attr_reader :log_level
+
+      ##
+      # Write a line.
+      #
+      # @param [String] str The line to write
+      # @param [Symbol...] styles Styles to apply to the entire line.
+      #
+      def puts(str = "", *styles)
+        if styled
+          str = color(str, *styles) unless styles.empty?
+        else
+          str = ::HighLine.uncolor(str)
+        end
+        case sink
+        when ::Logger
+          sink.log(log_level, str)
+        when ::IO
+          sink.puts(str)
+        end
+        self
+      end
+
+      ##
+      # Apply the given styles to a string
+      #
+      # @param [String] str The string
+      # @param [Symbol...] styles Styles to apply to the string.
+      # @return [String] The string with styles applied.
+      #
+      def color(str, *styles)
+        ::HighLine.color(str, *styles)
+      end
+    end
+  end
+end

data/lib/toys/utils/wrappable_string.rb

@@ -35,58 +35,106 @@ module Toys
     class WrappableString
       ##
       # Create a wrapped string.
-      # @param [String] string The string.
+      # @param [String,Array<String>] string The string or array of string
+      #     fragments
       #
       def initialize(string = "")
-        @string = string
+        @fragments = string.is_a?(::Array) ? string.map(&:to_s) : string.to_s.split
       end
 
       ##
-      # Returns the string.
+      # Returns the fragments.
+      # @return [Array<String>]
+      #
+      attr_reader :fragments
+
+      ##
+      # Concatenates this WrappableString with another WrappableString
+      # @param [WrappableString] other
+      #
+      def +(other)
+        other = WrappableString.new(other) unless other.is_a?(WrappableString)
+        WrappableString.new(fragments + other.fragments)
+      end
+
+      ##
+      # Returns true if the string is empty (i.e. has no fragments)
       # @return [String]
       #
-      attr_reader :string
+      def empty?
+        @fragments.empty?
+      end
 
       ##
-      # Returns the string.
+      # Returns the string without any wrapping
       # @return [String]
       #
       def to_s
-        string
+        @fragments.join(" ")
       end
+      alias string to_s
 
       ## @private
       def ==(other)
-        other.is_a?(WrappableString) ? other.string == string : false
+        return false unless other.is_a?(WrappableString)
+        other.fragments == fragments
       end
       alias eql? ==
 
       ## @private
       def hash
-        string.hash
+        fragments.hash
       end
 
       ##
       # Wraps the string to the given width.
       #
-      # @param [Integer] width Width in characters.
+      # @param [Integer,nil] width Width in characters, or `nil` for infinite.
+      # @param [Integer,nil] width2 Width in characters for the second and
+      #     subsequent lines, or `nil` to use the same as width.
       # @return [Array<String>] Wrapped lines
       #
-      def wrap(width)
+      def wrap(width, width2 = nil)
         lines = []
-        str = string.gsub(/\s/, " ").sub(/^\s+/, "")
-        until str.empty?
-          i = str.index(/\S(\s|$)/) + 1
-          loop do
-            next_i = str.index(/\S(\s|$)/, i)
-            break if next_i.nil? || next_i >= width
-            i = next_i + 1
+        line = ""
+        line_len = 0
+        fragments.each do |frag|
+          frag_len = ::HighLine.uncolor(frag).size
+          if line_len.zero?
+            line = frag
+            line_len = frag_len
+          elsif width && line_len + 1 + frag_len > width
+            lines << line
+            line = frag
+            line_len = frag_len
+            width = width2 if width2
+          else
+            line_len += frag_len + 1
+            line = "#{line} #{frag}"
           end
-          lines << str[0, i]
-          str = str[i..-1].sub(/^\s+/, "")
         end
+        lines << line if line_len > 0
         lines
       end
+
+      ##
+      # Wraps an array of lines to the given width.
+      #
+      # @param [Array<WrappableString>] strs Array of strings to wrap.
+      # @param [Integer,nil] width Width in characters, or `nil` for infinite.
+      # @param [Integer,nil] width2 Width in characters for the second and
+      #     subsequent lines, or `nil` to use the same as width.
+      # @return [Array<String>] Wrapped lines
+      #
+      def self.wrap_lines(strs, width, width2 = nil)
+        result = Array(strs).map do |s|
+          lines = s.empty? ? [""] : s.wrap(width, width2)
+          width = width2 if width2
+          lines
+        end.flatten
+        result = [] if result.all?(&:empty?)
+        result
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -119,11 +119,11 @@ files:
 - lib/toys/helpers/spinner.rb
 - lib/toys/loader.rb
 - lib/toys/middleware.rb
-- lib/toys/middleware/add_verbosity_switches.rb
+- lib/toys/middleware/add_verbosity_flags.rb
 - lib/toys/middleware/base.rb
 - lib/toys/middleware/handle_usage_errors.rb
 - lib/toys/middleware/set_default_descriptions.rb
-- lib/toys/middleware/show_usage.rb
+- lib/toys/middleware/show_help.rb
 - lib/toys/middleware/show_version.rb
 - lib/toys/template.rb
 - lib/toys/templates.rb
@@ -133,8 +133,9 @@ files:
 - lib/toys/templates/rubocop.rb
 - lib/toys/templates/yardoc.rb
 - lib/toys/tool.rb
+- lib/toys/utils/help_text.rb
+- lib/toys/utils/line_output.rb
 - lib/toys/utils/module_lookup.rb
-- lib/toys/utils/usage.rb
 - lib/toys/utils/wrappable_string.rb
 homepage: https://github.com/dazuma/toys
 licenses:

data/lib/toys/middleware/add_verbosity_switches.rb

@@ -1,99 +0,0 @@
-# Copyright 2018 Daniel Azuma
-#
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# * Redistributions of source code must retain the above copyright notice,
-#   this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
-# * Neither the name of the copyright holder, nor the names of any other
-#   contributors to this software, may be used to endorse or promote products
-#   derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-;
-
-require "toys/middleware/base"
-
-module Toys
-  module Middleware
-    ##
-    # A middleware that provides switches for editing the verbosity.
-    #
-    # This middleware adds `-v`, `--verbose`, `-q`, and `--quiet` switches, if
-    # not already defined by the tool. These switches affect the setting of
-    # {Toys::Context::VERBOSITY}, and, thus, the logger level.
-    #
-    class AddVerbositySwitches < Base
-      ##
-      # Default verbose switches
-      # @return [Array<String>]
-      #
-      DEFAULT_VERBOSE_SWITCHES = ["-v", "--verbose"].freeze
-
-      ##
-      # Default quiet switches
-      # @return [Array<String>]
-      #
-      DEFAULT_QUIET_SWITCHES = ["-q", "--quiet"].freeze
-
-      ##
-      # Create a AddVerbositySwitches middleware.
-      #
-      # @param [Boolean,Array<String>,Proc] verbose_switches Specify switches
-      #     to increase verbosity. The value may be any of the following:
-      #     *  An array of switches that increase verbosity.
-      #     *  The `true` value to use {DEFAULT_VERBOSE_SWITCHES}. (Default)
-      #     *  The `false` value to disable verbose switches.
-      #     *  A proc that takes a tool and returns any of the above.
-      # @param [Boolean,Array<String>,Proc] quiet_switches Specify switches
-      #     to decrease verbosity. The value may be any of the following:
-      #     *  An array of switches that decrease verbosity.
-      #     *  The `true` value to use {DEFAULT_QUIET_SWITCHES}. (Default)
-      #     *  The `false` value to disable quiet switches.
-      #     *  A proc that takes a tool and returns any of the above.
-      #
-      def initialize(verbose_switches: true, quiet_switches: true)
-        @verbose_switches = verbose_switches
-        @quiet_switches = quiet_switches
-      end
-
-      ##
-      # Configure the tool switches.
-      #
-      def config(tool)
-        verbose_switches = Middleware.resolve_switches_spec(@verbose_switches, tool,
-                                                            DEFAULT_VERBOSE_SWITCHES)
-        unless verbose_switches.empty?
-          tool.add_switch(Context::VERBOSITY, *verbose_switches,
-                          docs: "Increase verbosity",
-                          handler: ->(_val, cur) { cur + 1 },
-                          only_unique: true)
-        end
-        quiet_switches = Middleware.resolve_switches_spec(@quiet_switches, tool,
-                                                          DEFAULT_QUIET_SWITCHES)
-        unless quiet_switches.empty?
-          tool.add_switch(Context::VERBOSITY, *quiet_switches,
-                          docs: "Decrease verbosity",
-                          handler: ->(_val, cur) { cur - 1 },
-                          only_unique: true)
-        end
-        yield
-      end
-    end
-  end
-end

data/lib/toys/middleware/show_usage.rb

@@ -1,174 +0,0 @@
-# Copyright 2018 Daniel Azuma
-#
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# * Redistributions of source code must retain the above copyright notice,
-#   this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
-# * Neither the name of the copyright holder, nor the names of any other
-#   contributors to this software, may be used to endorse or promote products
-#   derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-;
-
-require "highline"
-
-require "toys/middleware/base"
-require "toys/utils/usage"
-
-module Toys
-  module Middleware
-    ##
-    # A middleware that shows usage documentation.
-    #
-    # This can be configured to display usage text when a switch (typically
-    # `--help`) is provided. It can also be configured to display usage text
-    # automatically for tools that do not have an executor.
-    #
-    # If a tool has no executor, this middleware can also add a
-    # `--[no-]recursive` flag, which, when set to `true` (the default), shows
-    # all subcommands recursively rather than only immediate subcommands.
-    #
-    class ShowUsage < Base
-      ##
-      # Default help switches
-      # @return [Array<String>]
-      #
-      DEFAULT_HELP_SWITCHES = ["-?", "--help"].freeze
-
-      ##
-      # Default recursive switches
-      # @return [Array<String>]
-      #
-      DEFAULT_RECURSIVE_SWITCHES = ["-r", "--[no-]recursive"].freeze
-
-      ##
-      # Default search switches
-      # @return [Array<String>]
-      #
-      DEFAULT_SEARCH_SWITCHES = ["-s WORD", "--search=WORD"].freeze
-
-      ##
-      # Create a ShowUsage middleware.
-      #
-      # @param [Boolean,Array<String>,Proc] help_switches Specify switches to
-      #     activate help. The value may be any of the following:
-      #     *  An array of switches.
-      #     *  The `true` value to use {DEFAULT_HELP_SWITCHES}. (Default)
-      #     *  The `false` value for no switches.
-      #     *  A proc that takes a tool and returns any of the above.
-      # @param [Boolean,Array<String>,Proc] recursive_switches Specify switches
-      #     to control recursive subcommand search. The value may be any of the
-      #     following:
-      #     *  An array of switches.
-      #     *  The `true` value to use {DEFAULT_RECURSIVE_SWITCHES}. (Default)
-      #     *  The `false` value for no switches.
-      #     *  A proc that takes a tool and returns any of the above.
-      # @param [Boolean,Array<String>,Proc] search_switches Specify switches
-      #     to search subcommands for a search term. The value may be any of
-      #     the following:
-      #     *  An array of switches.
-      #     *  The `true` value to use {DEFAULT_SEARCH_SWITCHES}. (Default)
-      #     *  The `false` value for no switches.
-      #     *  A proc that takes a tool and returns any of the above.
-      # @param [Boolean] default_recursive Whether to search recursively for
-      #     subcommands by default. Default is `true`.
-      # @param [Boolean] fallback_execution Cause the tool to display its own
-      #     usage text if it does not otherwise have an executor. This is
-      #     mostly useful for groups, which have children but no executor.
-      #     Default is `true`.
-      #
-      def initialize(help_switches: true,
-                     recursive_switches: true,
-                     search_switches: true,
-                     default_recursive: true,
-                     fallback_execution: true)
-        @help_switches = help_switches
-        @recursive_switches = recursive_switches
-        @search_switches = search_switches
-        @default_recursive = default_recursive ? true : false
-        @fallback_execution = fallback_execution
-      end
-
-      ##
-      # Configure switches and default data.
-      #
-      def config(tool)
-        help_switches = Middleware.resolve_switches_spec(@help_switches, tool,
-                                                         DEFAULT_HELP_SWITCHES)
-        is_default = !tool.includes_executor? && @fallback_execution
-        if !help_switches.empty?
-          docs = "Show help message"
-          docs << " (default for groups)" if is_default
-          tool.add_switch(:_help, *help_switches,
-                          docs: docs,
-                          default: is_default,
-                          only_unique: true)
-        elsif is_default
-          tool.default_data[:_help] = true
-        end
-        if !tool.includes_executor? && (!help_switches.empty? || @fallback_execution)
-          add_recursive_switches(tool)
-          add_search_switches(tool)
-        end
-        yield
-      end
-
-      ##
-      # Display usage text if requested.
-      #
-      def execute(context)
-        if context[:_help]
-          usage = Utils::Usage.from_context(context)
-          width = ::HighLine.new.output_cols
-          puts(usage.string(recursive: context[:_recursive_subcommands],
-                            search: context[:_search_subcommands],
-                            show_path: context.verbosity > 0,
-                            wrap_width: width))
-        else
-          yield
-        end
-      end
-
-      private
-
-      def add_recursive_switches(tool)
-        recursive_switches = Middleware.resolve_switches_spec(@recursive_switches, tool,
-                                                              DEFAULT_RECURSIVE_SWITCHES)
-        unless recursive_switches.empty?
-          tool.add_switch(:_recursive_subcommands, *recursive_switches,
-                          default: @default_recursive,
-                          docs: "Show all subcommands recursively" \
-                                " (default is #{@default_recursive})",
-                          only_unique: true)
-        end
-      end
-
-      def add_search_switches(tool)
-        search_switches = Middleware.resolve_switches_spec(@search_switches, tool,
-                                                           DEFAULT_SEARCH_SWITCHES)
-        unless search_switches.empty?
-          tool.add_switch(:_search_subcommands, *search_switches,
-                          docs: "Search subcommands for the given term",
-                          only_unique: true)
-        end
-      end
-    end
-  end
-end