toys-core 0.7.0 → 0.8.0

data/lib/toys/dsl/arg.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-;
-
-module Toys
-  module DSL
-    ##
-    # DSL for an arg definition block. Lets you set arg attributes in a block
-    # instead of a long series of keyword arguments.
-    #
-    # These directives are available inside a block passed to
-    # {Toys::DSL::Tool#required_arg}, {Toys::DSL::Tool#optional_arg}, or
-    # {Toys::DSL::Tool#remaining_args}.
-    #
-    class Arg
-      ## @private
-      def initialize(accept, default, display_name, desc, long_desc)
-        @accept = accept
-        @default = default
-        @display_name = display_name
-        @desc = desc
-        @long_desc = long_desc || []
-      end
-
-      ##
-      # Set the OptionParser acceptor.
-      #
-      # @param [Object] accept
-      # @return [Toys::DSL::Tool] self, for chaining.
-      #
-      def accept(accept)
-        @accept = accept
-        self
-      end
-
-      ##
-      # Set the default value.
-      #
-      # @param [Object] default
-      # @return [Toys::DSL::Tool] self, for chaining.
-      #
-      def default(default)
-        @default = default
-        self
-      end
-
-      ##
-      # Set the name of this arg as it appears in help screens.
-      #
-      # @param [String] display_name
-      # @return [Toys::DSL::Tool] self, for chaining.
-      #
-      def display_name(display_name)
-        @display_name = display_name
-        self
-      end
-
-      ##
-      # Set the short description. See {Toys::DSL::Tool#desc} for the allowed
-      # formats.
-      #
-      # @param [String,Array<String>,Toys::Utils::WrappableString] desc
-      # @return [Toys::DSL::Tool] self, for chaining.
-      #
-      def desc(desc)
-        @desc = desc
-        self
-      end
-
-      ##
-      # Adds to the long description. This may be called multiple times, and
-      # the results are cumulative. See {Toys::DSL::Tool#long_desc} for the
-      # allowed formats.
-      #
-      # @param [String,Array<String>,Toys::Utils::WrappableString...] long_desc
-      # @return [Toys::DSL::Tool] self, for chaining.
-      #
-      def long_desc(*long_desc)
-        @long_desc += long_desc
-        self
-      end
-
-      ## @private
-      def _add_required_to(tool, key)
-        tool.add_required_arg(key,
-                              accept: @accept, display_name: @display_name,
-                              desc: @desc, long_desc: @long_desc)
-      end
-
-      ## @private
-      def _add_optional_to(tool, key)
-        tool.add_optional_arg(key,
-                              accept: @accept, default: @default, display_name: @display_name,
-                              desc: @desc, long_desc: @long_desc)
-      end
-
-      ## @private
-      def _set_remaining_on(tool, key)
-        tool.set_remaining_args(key,
-                                accept: @accept, default: @default, display_name: @display_name,
-                                desc: @desc, long_desc: @long_desc)
-      end
-    end
-  end
-end

data/lib/toys/runner.rb

@@ -1,188 +0,0 @@
-# frozen_string_literal: true
-
-# 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 "optparse"
-
-module Toys
-  ##
-  # An internal class that orchestrates execution of a tool.
-  #
-  # Generaly, you should not need to use this class directly. Instead, run a
-  # tool using {Toys::CLI#run}.
-  #
-  class Runner
-    ##
-    # Create a runner for a particular tool in a particular CLI.
-    #
-    # @param [Toys::CLI] cli The CLI that is running the tool. This will
-    #     provide needed context information.
-    # @param [Toys::Definition::Tool] tool_definition The tool to run.
-    #
-    def initialize(cli, tool_definition)
-      @cli = cli
-      @tool_definition = tool_definition
-    end
-
-    ##
-    # Run the tool, provided given arguments.
-    #
-    # @param [Array<String>] args Command line arguments passed to the tool.
-    # @param [Integer] verbosity Initial verbosity. Default is 0.
-    #
-    # @return [Integer] The resulting status code
-    #
-    def run(args, verbosity: 0)
-      data = create_data(args, verbosity)
-      parse_args(args, data) unless @tool_definition.argument_parsing_disabled?
-      tool = @tool_definition.tool_class.new(@cli, data)
-      @tool_definition.run_initializers(tool)
-
-      original_level = @cli.logger.level
-      @cli.logger.level = @cli.base_level - data[Tool::Keys::VERBOSITY]
-      begin
-        perform_execution(tool)
-      ensure
-        @cli.logger.level = original_level
-      end
-    end
-
-    private
-
-    def create_data(args, base_verbosity)
-      data = @tool_definition.default_data.dup
-      data[Tool::Keys::TOOL_DEFINITION] = @tool_definition
-      data[Tool::Keys::TOOL_SOURCE] = @tool_definition.source_info
-      data[Tool::Keys::TOOL_NAME] = @tool_definition.full_name
-      data[Tool::Keys::VERBOSITY] = base_verbosity
-      data[Tool::Keys::ARGS] = args
-      data[Tool::Keys::USAGE_ERROR] = nil
-      data
-    end
-
-    def parse_args(args, data)
-      optparse, seen = create_option_parser(data)
-      remaining = optparse.parse(args)
-      validate_flags(args, seen)
-      remaining = parse_required_args(remaining, args, data)
-      remaining = parse_optional_args(remaining, data)
-      parse_remaining_args(remaining, args, data)
-    rescue ::OptionParser::ParseError => e
-      data[Tool::Keys::USAGE_ERROR] = e.message
-    end
-
-    def create_option_parser(data)
-      seen = []
-      optparse = ::OptionParser.new
-      # The following clears out the Officious (hidden default flags).
-      optparse.remove
-      optparse.remove
-      optparse.new
-      optparse.new
-      @tool_definition.flag_definitions.each do |flag|
-        optparse.on(*flag.optparser_info) do |val|
-          seen << flag.key
-          data[flag.key] = flag.handler.call(val, data[flag.key])
-        end
-      end
-      @tool_definition.custom_acceptors do |accept|
-        optparse.accept(accept)
-      end
-      [optparse, seen]
-    end
-
-    def validate_flags(args, seen)
-      @tool_definition.flag_groups.each do |group|
-        error = group.validation_error(seen)
-        raise create_parse_error(args, error) if error
-      end
-    end
-
-    def parse_required_args(remaining, args, data)
-      @tool_definition.required_arg_definitions.each do |arg_info|
-        if remaining.empty?
-          reason = "No value given for required argument #{arg_info.display_name}"
-          raise create_parse_error(args, reason)
-        end
-        data[arg_info.key] = arg_info.process_value(remaining.shift)
-      end
-      remaining
-    end
-
-    def parse_optional_args(remaining, data)
-      @tool_definition.optional_arg_definitions.each do |arg_info|
-        break if remaining.empty?
-        data[arg_info.key] = arg_info.process_value(remaining.shift)
-      end
-      remaining
-    end
-
-    def parse_remaining_args(remaining, args, data)
-      return if remaining.empty?
-      unless @tool_definition.remaining_args_definition
-        if @tool_definition.runnable?
-          raise create_parse_error(remaining, "Extra arguments provided")
-        else
-          raise create_parse_error(@tool_definition.full_name + args, "Tool not found")
-        end
-      end
-      data[@tool_definition.remaining_args_definition.key] =
-        remaining.map { |arg| @tool_definition.remaining_args_definition.process_value(arg) }
-    end
-
-    def create_parse_error(path, reason)
-      ::OptionParser::ParseError.new(*path).tap do |e|
-        e.reason = reason
-      end
-    end
-
-    def perform_execution(tool)
-      executor = proc do
-        if @tool_definition.runnable?
-          tool.run
-        else
-          @cli.logger.fatal("No implementation for tool #{@tool_definition.display_name.inspect}")
-          tool.exit(-1)
-        end
-      end
-      @tool_definition.middleware_stack.reverse_each do |middleware|
-        executor = make_executor(middleware, tool, executor)
-      end
-      catch(:result) do
-        executor.call
-        0
-      end
-    end
-
-    def make_executor(middleware, tool, next_executor)
-      proc { middleware.run(tool, &next_executor) }
-    end
-  end
-end

data/lib/toys/standard_middleware.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-;
-
-module Toys
-  ##
-  # Namespace for standard middleware classes.
-  #
-  module StandardMiddleware
-    ## @private
-    COMMON_FLAG_GROUP = :__common
-
-    ## @private
-    def self.append_common_flag_group(tool)
-      tool.add_flag_group(type: :optional, name: COMMON_FLAG_GROUP,
-                          desc: "Common Flags", report_collisions: false)
-      COMMON_FLAG_GROUP
-    end
-  end
-end

data/lib/toys/utils/module_lookup.rb

@@ -1,135 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-;
-
-module Toys
-  module Utils
-    ##
-    # A helper module that provides methods to do module lookups. This is
-    # used to obtain named helpers, middleware, and templates from the
-    # respective modules.
-    #
-    class ModuleLookup
-      class << self
-        ##
-        # Convert the given string to a path element. Specifically, converts
-        # to `lower_snake_case`.
-        #
-        # @param [String,Symbol] str String to convert.
-        # @return [String] Converted string
-        #
-        def to_path_name(str)
-          str = str.to_s.sub(/^_/, "").sub(/_$/, "").gsub(/_+/, "_")
-          while str.sub!(/([^_])([A-Z])/, "\\1_\\2") do end
-          str.downcase
-        end
-
-        ##
-        # Convert the given string to a module name. Specifically, converts
-        # to `UpperCamelCase`, and then to a symbol.
-        #
-        # @param [String,Symbol] str String to convert.
-        # @return [Symbol] Converted name
-        #
-        def to_module_name(str)
-          str = str.to_s.sub(/^_/, "").sub(/_$/, "").gsub(/_+/, "_")
-          str.to_s.gsub(/(^|_)([a-zA-Z])/) { |_m| $2.upcase }.to_sym
-        end
-
-        ##
-        # Given a require path, return the module expected to be defined.
-        #
-        # @param [String] path File path, delimited by forward slash
-        # @return [Module] The module loaded from that path
-        #
-        def path_to_module(path)
-          path.split("/").reduce(::Object) do |running_mod, seg|
-            mod_name = to_module_name(seg)
-            unless running_mod.constants.include?(mod_name)
-              raise ::NameError, "Module #{running_mod.name}::#{mod_name} not found"
-            end
-            running_mod.const_get(mod_name)
-          end
-        end
-      end
-
-      ##
-      # Create an empty ModuleLookup
-      #
-      def initialize
-        @paths = []
-      end
-
-      ##
-      # Add a lookup path for modules.
-      #
-      # @param [String] path_base The base require path
-      # @param [Module] module_base The base module, or `nil` (the default) to
-      #     infer a default from the path base.
-      # @param [Boolean] high_priority If true, add to the head of the lookup
-      #     path, otherwise add to the end.
-      #
-      def add_path(path_base, module_base: nil, high_priority: false)
-        module_base ||= ModuleLookup.path_to_module(path_base)
-        if high_priority
-          @paths.unshift([path_base, module_base])
-        else
-          @paths << [path_base, module_base]
-        end
-        self
-      end
-
-      ##
-      # Obtain a named module. Returns `nil` if the name is not present.
-      #
-      # @param [String,Symbol] name The name of the module to return.
-      #
-      # @return [Module] The specified module
-      #
-      def lookup(name)
-        @paths.each do |path_base, module_base|
-          path = "#{path_base}/#{ModuleLookup.to_path_name(name)}"
-          begin
-            require path
-          rescue ::LoadError
-            next
-          end
-          mod_name = ModuleLookup.to_module_name(name)
-          unless module_base.constants.include?(mod_name)
-            raise ::NameError,
-                  "File #{path.inspect} did not define #{module_base.name}::#{mod_name}"
-          end
-          return module_base.const_get(mod_name)
-        end
-        nil
-      end
-    end
-  end
-end