toys-core 0.3.7.1 → 0.3.8

data/lib/toys/utils/gems.rb

@@ -113,8 +113,8 @@ module Toys
         @terminal.spinner(leading_text: "Getting info on gem #{name.inspect}... ",
                           final_text: "Done.\n") do
           req = ::Gem::Requirement.new(*requirements)
-          result = @exec.exec(["gem", "query", "-q", "-r", "-a", "-e", name], out_to: :capture)
-          if result.captured_out =~ /\(([\w\.,\s]+)\)/
+          result = @exec.capture(["gem", "query", "-q", "-r", "-a", "-e", name])
+          if result =~ /\(([\w\.,\s]+)\)/
             $1.split(", ")
               .map { |v| ::Gem::Version.new(v) }
               .find { |v| !v.prerelease? && req.satisfied_by?(v) }
@@ -128,7 +128,7 @@ module Toys
         @terminal.spinner(leading_text: "Installing gem #{name} #{version}... ",
                           final_text: "Done.\n") do
           result = @exec.exec(["gem", "install", name, "--version", version.to_s],
-                              out_to: :capture, err_to: :capture)
+                              out: :capture, err: :capture)
           if result.error?
             @terminal.puts(result.captured_out + result.captured_err)
             raise InstallFailedError, "Failed to install gem #{name} #{version}"

data/lib/toys/utils/help_text.rb

@@ -27,8 +27,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 ;
 
-require "toys/utils/terminal"
-
 module Toys
   module Utils
     ##

data/lib/toys/utils/module_lookup.rb

@@ -34,11 +34,7 @@ module Toys
     # used to obtain named helpers, middleware, and templates from the
     # respective modules.
     #
-    # You generally do not need to use these module methods directly. Instead
-    # use the convenience methods {Toys::Helpers.lookup},
-    # {Toys::Middleware.lookup}, or {Toys::Templates.lookup}.
-    #
-    module ModuleLookup
+    class ModuleLookup
       class << self
         ##
         # Convert the given string to a path element. Specifically, converts
@@ -66,47 +62,71 @@ module Toys
         end
 
         ##
-        # Obtain a named module from the given collection. Raises an exception
-        # on failure.
-        #
-        # @param [String,Symbol] collection The collection to search. Typical
-        #     values are `:helpers`, `:middleware`, and `:templates`.
-        # @param [String,Symbol] name The name of the module to return.
+        # Given a require path, return the module expected to be defined.
         #
-        # @return [Module] The specified module
-        # @raise [LoadError] No Ruby file containing the given module could
-        #     be found.
-        # @raise [NameError] The given module was not defined.
+        # @param [String] path File path, delimited by forward slash
+        # @return [Module] The module loaded from that path
         #
-        def lookup!(collection, name)
-          require "toys/#{to_path_name(collection)}/#{to_path_name(name)}"
-          collection_sym = to_module_name(collection)
-          unless ::Toys.constants.include?(collection_sym)
-            raise ::NameError, "Module does not exist: Toys::#{collection_sym}"
+        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
-          collection_mod = ::Toys.const_get(collection_sym)
-          name_sym = to_module_name(name)
-          unless collection_mod.constants.include?(name_sym)
-            raise ::NameError, "Module does not exist: Toys::#{collection_sym}::#{name_sym}"
-          end
-          collection_mod.const_get(name_sym)
         end
+      end
 
-        ##
-        # Obtain a named module from the given collection. Returns `nil` on
-        # failure.
-        #
-        # @param [String,Symbol] collection The collection to search. Typical
-        #     values are `:helpers`, `:middleware`, and `:templates`.
-        # @param [String,Symbol] name The name of the module to return.
-        #
-        # @return [Module,nil] The specified module, or `nil` if not found.
-        #
-        def lookup(collection, name)
-          lookup!(collection, name)
-        rescue ::NameError, ::LoadError
-          nil
+      ##
+      # 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

data/lib/toys/utils/wrappable_string.rb

@@ -27,8 +27,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 ;
 
-require "toys/utils/terminal"
-
 module Toys
   module Utils
     ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.3.7.1
+  version: 0.3.8
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -105,28 +105,20 @@ files:
 - lib/toys/dsl/flag.rb
 - lib/toys/dsl/tool.rb
 - lib/toys/errors.rb
-- lib/toys/helpers.rb
-- lib/toys/helpers/exec.rb
-- lib/toys/helpers/fileutils.rb
-- lib/toys/helpers/highline.rb
-- lib/toys/helpers/terminal.rb
 - lib/toys/input_file.rb
 - lib/toys/loader.rb
 - lib/toys/middleware.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_help.rb
-- lib/toys/middleware/show_root_version.rb
 - lib/toys/runner.rb
+- lib/toys/standard_middleware/add_verbosity_flags.rb
+- lib/toys/standard_middleware/handle_usage_errors.rb
+- lib/toys/standard_middleware/set_default_descriptions.rb
+- lib/toys/standard_middleware/show_help.rb
+- lib/toys/standard_middleware/show_root_version.rb
+- lib/toys/standard_mixins/exec.rb
+- lib/toys/standard_mixins/fileutils.rb
+- lib/toys/standard_mixins/highline.rb
+- lib/toys/standard_mixins/terminal.rb
 - lib/toys/template.rb
-- lib/toys/templates.rb
-- lib/toys/templates/clean.rb
-- lib/toys/templates/gem_build.rb
-- lib/toys/templates/minitest.rb
-- lib/toys/templates/rubocop.rb
-- lib/toys/templates/yardoc.rb
 - lib/toys/tool.rb
 - lib/toys/utils/exec.rb
 - lib/toys/utils/gems.rb

data/lib/toys/helpers.rb

@@ -1,54 +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/utils/module_lookup"
-
-module Toys
-  ##
-  # Namespace for common helper modules
-  #
-  module Helpers
-    ##
-    # Return a helper module by name.
-    #
-    # Currently recognized module names are:
-    #
-    # * `:exec` : Methods to help execute subcommands.
-    # * `:fileutils` : The FileUtils standard library methods.
-    # * `:highline` : Methods from the highline gem.
-    # * `:spinner` : Displays a spinner on the terminal.
-    #
-    # @param [String,Symbol] name Name of the helper module to return
-    # @return [Module,nil] The module.
-    #
-    def self.lookup!(name)
-      Utils::ModuleLookup.lookup!(:helpers, name)
-    end
-  end
-end

data/lib/toys/middleware/base.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.
-;
-
-module Toys
-  module Middleware
-    ##
-    # This is a base middleware with a no-op implementation.
-    #
-    # A middleware is an object that has the opportunity to alter the
-    # configuration and runtime behavior of each tool in a Toys CLI. A CLI
-    # contains an ordered list of middleware, known as the *middleware stack*,
-    # that together define the CLI's default behavior.
-    #
-    # Specifically, a middleware can perform two functions.
-    #
-    # First, it can modify the configuration of a tool. After tools are defined
-    # from configuration, the middleware stack can make modifications to each
-    # tool. A middleware can add flags and arguments to the tool, modify the
-    # description, or make any other changes to how the tool is set up.
-    #
-    # Second, a middleware can intercept and change tool execution. Like a Rack
-    # middleware, a Toys middleware can wrap execution with its own code,
-    # replace it outright, or leave it unmodified.
-    #
-    class Base
-      ##
-      # This method is called after a tool has been defined, and gives this
-      # middleware the opportunity to modify the tool definition. It is passed
-      # the tool definition object and the loader, and can make any changes to
-      # the tool definition. In most cases, this method should also call
-      # `yield`, which passes control to the next middleware in the stack. A
-      # middleware can disable modifications done by subsequent middleware by
-      # omitting the `yield` call, but this is uncommon.
-      #
-      # The base middleware implementation does nothing and simply yields to
-      # the next middleware. Subclasses should override this if they want to
-      # alter the tool definition.
-      #
-      # @param [Toys::Definition::Tool] _tool_definition The tool definition
-      #     to modify.
-      # @param [Toys::Loader] _loader The loader that loaded this tool.
-      #
-      def config(_tool_definition, _loader)
-        yield
-      end
-
-      ##
-      # This method is called when the tool is run. It gives the middleware an
-      # opportunity to modify the runtime behavior of the tool. It is passed
-      # the tool instance (i.e. the object that hosts a tool's `run` method),
-      # and you can use this object to access the tool's options and other
-      # context data. In most cases, this method should also call `yield`,
-      # which passes control to the next middleware in the stack. A middleware
-      # can "wrap" normal execution by calling `yield` somewhere in its
-      # implementation of this method, or it can completely replace the
-      # execution behavior by not calling `yield` at all.
-      #
-      # Like a tool's `run` method, this method's return value is unused. If
-      # you want to output from a tool, write to stdout or stderr. If you want
-      # to set the exit status code, call {Toys::Tool#exit} on the tool object.
-      #
-      # The base middleware implementation does nothing and simply yields to
-      # the next middleware. Subclasses should override this if they want to
-      # alter the tool execution.
-      #
-      # @param [Toys::Tool] _tool The tool execution instance.
-      #
-      def run(_tool)
-        yield
-      end
-    end
-  end
-end

data/lib/toys/templates.rb

@@ -1,55 +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/utils/module_lookup"
-
-module Toys
-  ##
-  # Namespace for common templates
-  #
-  module Templates
-    ##
-    # Return a template class by name.
-    #
-    # Currently recognized template names are:
-    #
-    # *  `:clean` : Creates a tool that cleans build artifacts.
-    # *  `:gem_build` : Creates a tool that builds and/or releases gems.
-    # *  `:minitest` : Creates a tool that runs unit tests.
-    # *  `:rubocop` : Creates a tool that runs rubocop.
-    # *  `:yardoc` : Creates a tool that generates YARD documentation.
-    #
-    # @param [String,Symbol] name Name of the template class to return
-    # @return [Class,nil] The class, or `nil` if not found
-    #
-    def self.lookup!(name)
-      Utils::ModuleLookup.lookup!(:templates, name)
-    end
-  end
-end

data/lib/toys/templates/clean.rb

@@ -1,85 +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.
-;
-
-module Toys
-  module Templates
-    ##
-    # A template for tools that clean build artifacts
-    #
-    class Clean
-      include Template
-
-      ##
-      # Default tool name
-      # @return [String]
-      #
-      DEFAULT_TOOL_NAME = "clean".freeze
-
-      ##
-      # Create the template settings for the Clean template.
-      #
-      # @param [String] name Name of the tool to create. Defaults to
-      #     {DEFAULT_TOOL_NAME}.
-      # @param [Array<String>] paths An array of glob patterns indicating what
-      #     to clean.
-      #
-      def initialize(name: DEFAULT_TOOL_NAME, paths: [])
-        @name = name
-        @paths = paths
-      end
-
-      attr_accessor :name
-      attr_accessor :paths
-
-      to_expand do |template|
-        tool(template.name) do
-          desc "Clean built files and directories."
-
-          include :fileutils
-
-          run do
-            files = []
-            patterns = Array(template.paths)
-            patterns.each do |pattern|
-              files.concat(::Dir.glob(pattern))
-            end
-            files.uniq!
-
-            files.each do |file|
-              if ::File.exist?(file)
-                rm_rf file
-                puts "Cleaned: #{file}"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end