toys-core 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1552f14b276734b92f59f9c1d4464679ec1facdc6480e8ecb01b7818d7541712
-  data.tar.gz: d8da75bf066fa32de202edc57151a37c20b08a29537e7fbb25e9683d705fe625
+  metadata.gz: 3f7ff775c645d4bbd1906fab469307dcf06852e83d9fa02aba978fd0db53af21
+  data.tar.gz: 408ffcc9b47eff78b05228d811e2a32932a56eebe8e64381a5a96ce1c0e22caf
 SHA512:
-  metadata.gz: b3816d90527525a282e55b534a2c250fd7667b7c4a9c4922dbd9a67c9bea72223eb6e16f2d1a0d035213ce86be013bdce2a073c56b8f35c4e223262a494faaaa
-  data.tar.gz: d73196fce65e1c0cc5904dd93e529bd798cfd10a19a1ac4ac9c138b30c62d516f5e76380502e38306ad91105526fd699dbf41fa20643c2b8bd852dfa1914ce06
+  metadata.gz: 4969720705d06c492e7083dbd5d139b71ef3f3e260980acca8ec33771b4ee06b90e8138c341984681ff53a747fcdb256fffcbe412d30d64c9a0b32a82b0975ac
+  data.tar.gz: 4db5eed3cc44658511b14d017a3afac43daafc397e3094c1955ae08a95b60886673cfa2196b269a06b9c534f4614300573bf33cc2b43a39981c2bd4500c19cd6

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History
 
+### 0.3.7 / 2018-05-30
+
+* CHANGED: Execution runs in the same scope as the DSL, which lets us use normal methods instead of helper-blocks.
+* CHANGED: Renamed "script" to "run", and allow setting of runnable by defining a "run" method
+* CHANGED: Set up a constant scope for each config file, to make constant lookup make sense.
+* CHANGED: Removed run_toys and dropped EXIT_ON_NONZERO_STATUS key in favor of using cli directly.
+* CHANGED: Renamed definition_path to source_path
+* CHANGED: LineOutput util changed to a simple Terminal util, and folded spinner into it.
+* CHANGED: Removed spinner helper and added terminal helper.
+* CHANGED: Organized DSL and definition classes
+* ADDED: Helper modules scoped to the tool hierarchy
+* ADDED: Utility that installs and activates third-party gems.
+
 ### 0.3.6 / 2018-05-21
 
 * CHANGED: Renamed show_version middleware to show_root_version.

data/lib/toys-core.rb

@@ -27,8 +27,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 ;
 
-gem "highline", "~> 1.7"
-
 ##
 # Toys is a Ruby library and command line tool that lets you build your own
 # command line suite of tools (with commands and subcommands) using a Ruby DSL.
@@ -40,17 +38,34 @@ module Toys
   # Namespace for common utility classes.
   #
   module Utils; end
+
+  ##
+  # Namespace for object definition classes.
+  #
+  module Definition; end
+
+  ##
+  # Namespace for DSL classes.
+  #
+  module DSL; end
 end
 
-require "toys/alias"
 require "toys/cli"
-require "toys/config_dsl"
-require "toys/context"
 require "toys/core_version"
+require "toys/definition/acceptor"
+require "toys/definition/alias"
+require "toys/definition/arg"
+require "toys/definition/flag"
+require "toys/definition/tool"
+require "toys/dsl/arg"
+require "toys/dsl/flag"
+require "toys/dsl/tool"
 require "toys/errors"
 require "toys/helpers"
+require "toys/input_file"
 require "toys/loader"
 require "toys/middleware"
+require "toys/runner"
 require "toys/template"
 require "toys/templates"
 require "toys/tool"

data/lib/toys/cli.rb

@@ -28,9 +28,8 @@
 ;
 
 require "logger"
-require "highline"
 
-require "toys/utils/line_output"
+require "toys/utils/terminal"
 
 module Toys
   ##
@@ -99,7 +98,7 @@ module Toys
       @loader = Loader.new(
         index_file_name: index_file_name,
         preload_file_name: preload_file_name,
-        middleware_stack: middleware_stack
+        middleware_stack: @middleware_stack
       )
       @error_handler = error_handler || DefaultErrorHandler.new
     end
@@ -209,10 +208,15 @@ module Toys
     # @return [Integer] The resulting status code
     #
     def run(*args, verbosity: 0)
-      tool, remaining = ContextualError.capture("Error finding tool definition") do
+      tool_definition, remaining = ContextualError.capture("Error finding tool definition") do
         @loader.lookup(args.flatten)
       end
-      tool.execute(self, remaining, verbosity: verbosity)
+      ContextualError.capture_path(
+        "Error during tool execution!", tool_definition.source_path,
+        tool_name: tool_definition.full_name, tool_args: remaining
+      ) do
+        Runner.new(self, tool_definition).run(remaining, verbosity: verbosity)
+      end
     rescue ContextualError => e
       @error_handler.call(e)
     end
@@ -247,16 +251,20 @@ module Toys
       ##
       # Create an error handler.
       #
-      # @param [IO,Logger,nil] sink Where to write errors. Default is `$stderr`.
+      # @param [IO] output Where to write errors. Default is `$stderr`.
       #
-      def initialize(sink = $stderr)
-        @line_output = Utils::LineOutput.new(sink, log_level: ::Logger::FATAL)
+      def initialize(output = $stderr)
+        @terminal = Utils::Terminal.new(output: output)
       end
 
-      ## @private
+      ##
+      # The error handler routine. Prints out the error message and backtrace.
+      #
+      # @param [Exception] error The error that occurred.
+      #
       def call(error)
-        @line_output.puts(cause_string(error.cause))
-        @line_output.puts(context_string(error), :bold)
+        @terminal.puts(cause_string(error.cause))
+        @terminal.puts(context_string(error), :bold)
         -1
       end
 
@@ -315,13 +323,14 @@ module Toys
       end
 
       ##
-      # Returns a default logger that logs to `STDERR`.
+      # Returns a default logger that logs to `$stderr`.
       #
       # @param [IO] stream Stream to write to. Defaults to `$stderr`.
       # @return [Logger]
       #
       def default_logger(stream = $stderr)
         logger = ::Logger.new(stream)
+        terminal = Utils::Terminal.new(output: stream)
         logger.formatter = proc do |severity, time, _progname, msg|
           msg_str =
             case msg
@@ -332,7 +341,7 @@ module Toys
             else
               msg.inspect
             end
-          format_log(stream.tty?, time, severity, msg_str)
+          format_log(terminal, time, severity, msg_str)
         end
         logger.level = ::Logger::WARN
         logger
@@ -340,27 +349,25 @@ module Toys
 
       private
 
-      def format_log(is_tty, time, severity, msg)
+      def format_log(terminal, time, severity, msg)
         timestr = time.strftime("%Y-%m-%d %H:%M:%S")
         header = format("[%s %5s]", timestr, severity)
-        if is_tty
-          header =
-            case severity
-            when "FATAL"
-              ::HighLine.color(header, :bright_magenta, :bold, :underline)
-            when "ERROR"
-              ::HighLine.color(header, :bright_red, :bold)
-            when "WARN"
-              ::HighLine.color(header, :bright_yellow)
-            when "INFO"
-              ::HighLine.color(header, :bright_cyan)
-            when "DEBUG"
-              ::HighLine.color(header, :white)
-            else
-              header
-            end
-        end
-        "#{header}  #{msg}\n"
+        styled_header =
+          case severity
+          when "FATAL"
+            terminal.apply_styles(header, :bright_magenta, :bold, :underline)
+          when "ERROR"
+            terminal.apply_styles(header, :bright_red, :bold)
+          when "WARN"
+            terminal.apply_styles(header, :bright_yellow)
+          when "INFO"
+            terminal.apply_styles(header, :bright_cyan)
+          when "DEBUG"
+            terminal.apply_styles(header, :white)
+          else
+            header
+          end
+        "#{styled_header}  #{msg}\n"
       end
     end
   end

data/lib/toys/core_version.rb

@@ -32,5 +32,5 @@ module Toys
   # Current version of Toys core
   # @return [String]
   #
-  CORE_VERSION = "0.3.6".freeze
+  CORE_VERSION = "0.3.7".freeze
 end

data/lib/toys/{tool → definition}/acceptor.rb

@@ -28,7 +28,7 @@
 ;
 
 module Toys
-  class Tool
+  module Definition
     ##
     # An Acceptor validates and converts arguments. It is designed to be
     # compatible with the OptionParser accept mechanism.
@@ -47,16 +47,19 @@ module Toys
       ##
       # Create a base acceptor.
       #
-      # The basic acceptor does not do any validation (i.e. it accepts all
-      # arguments). You may subclass this object and implement the {#match}
+      # The base acceptor does not do any validation (i.e. it accepts all
+      # arguments). You may subclass this object and override the {#match}
       # method to change this behavior.
       #
-      # The converter should take one or more arguments, the first of which is
-      # the entire argument string, and the others of which may be returned
-      # from validation. The converter should return the final converted value
-      # of the argument. If you do not provide a converter, this acceptor will
-      # set the final value to the input argument string by default.
-      # You may provide a converter either as a proc or a block.
+      # The base acceptor lets you provide a converter as a proc. The proc
+      # should take one or more arguments, the first of which is the entire
+      # argument string, and the others of which are any additional values
+      # returned from validation. The converter should return the final
+      # converted value of the argument.
+      #
+      # The converter may be provided either as a proc in the `converter`
+      # parameter, or as a block. If neither is provided, the base acceptor
+      # performs no conversion and uses the argument string.
       #
       # @param [String] name A visible name for the acceptor, shown in help.
       # @param [Proc] converter A converter function. May also be given as a
@@ -105,7 +108,8 @@ module Toys
       end
 
       ##
-      # Convert the given input.
+      # Convert the given input. Uses the converter provided to this object's
+      # constructor. Subclasses may also override this method.
       #
       # @param [String] str Original argument string
       # @param [Object...] extra Zero or more additional arguments comprising
@@ -123,10 +127,11 @@ module Toys
     #
     class PatternAcceptor < Acceptor
       ##
-      # Create an acceptor.
+      # Create a pattern acceptor.
       #
       # You must provide a regular expression as a validator. You may also
-      # provide a converter.
+      # provide a converter proc. See {Toys::Definition::Acceptor} for details
+      # on the converter.
       #
       # @param [String] name A visible name for the acceptor, shown in help.
       # @param [Regexp] regex Regular expression defining value values.
@@ -140,7 +145,7 @@ module Toys
       end
 
       ##
-      # Overrides match to match from the given regex.
+      # Overrides {Toys::Definition::Acceptor#match} to use the given regex.
       #
       def match(str)
         @regex.match(str)
@@ -173,14 +178,15 @@ module Toys
       end
 
       ##
-      # Overrides match to find the value.
+      # Overrides {Toys::Definition::Acceptor#match} to find the value.
       #
       def match(str)
         @values.find { |s, _e| s == str }
       end
 
       ##
-      # Overrides convert to return the original element.
+      # Overrides {Toys::Definition::Acceptor#convert} to return the original
+      # element.
       #
       def convert(_str, elem)
         elem

data/lib/toys/{utils/line_output.rb → definition/alias.rb}

@@ -27,95 +27,83 @@
 # POSSIBILITY OF SUCH DAMAGE.
 ;
 
-require "highline"
-
 module Toys
-  module Utils
+  module Definition
     ##
-    # Something that outputs lines to the console or log.
+    # An alias is a name that refers to another name.
     #
-    class LineOutput
+    class Alias
       ##
-      # Create a line output.
+      # Create a new alias.
       #
-      # @param [IO,Logger,nil] sink Where to write lines.
+      # @param [Array<String>] full_name The name of the alias.
+      # @param [String,Array<String>] target The name of the target. May either
+      #     be a local reference (a single string) or a global reference (an
+      #     array of strings)
       #
-      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?
+      def initialize(loader, full_name, target, priority)
+        @target_name =
+          if target.is_a?(::String)
+            full_name[0..-2] + [target]
           else
-            styled ? true : false
+            target.dup
           end
-        @buffer = ""
+        @target_name.freeze
+        @full_name = full_name.dup.freeze
+        @priority = priority
+        @tool_class = DSL::Tool.new_class(@full_name, priority, loader)
       end
 
       ##
-      # Where to write lines
-      # @return [IO,Logger,nil]
+      # Return the tool class.
+      # @return [Class]
       #
-      attr_reader :sink
+      attr_reader :tool_class
 
       ##
-      # Whether output is styled
-      # @return [Boolean]
+      # Return the name of the tool as an array of strings.
+      # This array may not be modified.
+      # @return [Array<String>]
       #
-      attr_accessor :styled
+      attr_reader :full_name
 
       ##
-      # If the sink is a Logger, the level to log, otherwise `nil`.
-      # @return [Integer,nil]
+      # Return the priority of this alias.
+      # @return [Integer]
       #
-      attr_reader :log_level
+      attr_reader :priority
 
       ##
-      # Write a line.
-      #
-      # @param [String] str The line to write
-      # @param [Symbol...] styles Styles to apply to the entire line.
+      # Return the name of the target as an array of strings.
+      # This array may not be modified.
+      # @return [Array<String>]
       #
-      def puts(str = "", *styles)
-        str = @buffer + apply_styles(str, styles)
-        @buffer = ""
-        case sink
-        when ::Logger
-          sink.log(log_level, str)
-        when ::IO
-          sink.puts(str)
-          sink.flush
-        end
-        self
-      end
+      attr_reader :target_name
 
       ##
-      # Write a newline and flush the current line.
+      # Returns the local name of this tool.
+      # @return [String]
       #
-      def newline
-        puts
+      def simple_name
+        full_name.last
       end
 
       ##
-      # Buffer a partial line but do not write it out yet because the line
-      # may not yet be complete.
-      #
-      # @param [String] str The line to write
-      # @param [Symbol...] styles Styles to apply to the partial line.
+      # Returns a displayable name of this tool, generally the full name
+      # delimited by spaces.
+      # @return [String]
       #
-      def write(str = "", *styles)
-        @buffer << apply_styles(str, styles)
-        self
+      def display_name
+        full_name.join(" ")
       end
 
-      private
-
-      def apply_styles(str, styles)
-        if styled
-          styles.empty? ? str : ::HighLine.color(str, *styles)
-        else
-          ::HighLine.uncolor(str)
-        end
+      ##
+      # Returns a displayable name of the target, generally the full name
+      # delimited by spaces.
+      # @return [String]
+      #
+      def display_target
+        target_name.join(" ")
       end
     end
   end