toys 0.2.2 → 0.3.0

data/lib/toys/helpers/file_utils.rb

@@ -29,9 +29,11 @@
 
 require "fileutils"
 
-module Toys::Helpers
-  ##
-  # File system utilities. See the "fileutils" standard library.
-  #
-  FileUtils = ::FileUtils
+module Toys
+  module Helpers
+    ##
+    # File system utilities. See the "fileutils" standard library.
+    #
+    FileUtils = ::FileUtils
+  end
 end

data/lib/toys/{lookup.rb → loader.rb}

@@ -31,45 +31,49 @@ module Toys
   ##
   # The lookup service that finds a tool given a set of arguments
   #
-  class Lookup
+  class Loader
     def initialize(config_dir_name: nil, config_file_name: nil,
-                   index_file_name: nil, preload_file_name: nil)
+                   index_file_name: nil, preload_file_name: nil,
+                   middleware: [], root_desc: nil)
       @config_dir_name = config_dir_name
       @config_file_name = config_file_name
       @index_file_name = index_file_name
       @preload_file_name = preload_file_name
+      @middleware = middleware
       check_init_options
       @load_worklist = []
-      @tools = {[] => [Tool.new(self, []), nil]}
+      root_tool = Tool.new([], middleware)
+      root_tool.long_desc = root_desc if root_desc
+      @tools = {[] => [root_tool, nil]}
       @max_priority = @min_priority = 0
     end
 
-    def add_paths(paths, high_priority: false)
+    def add_config_paths(paths, high_priority: false)
       paths = Array(paths)
       paths = paths.reverse if high_priority
       paths.each do |path|
-        add_path(path, high_priority: high_priority)
+        add_config_path(path, high_priority: high_priority)
       end
       self
     end
 
-    def add_path(path, high_priority: false)
+    def add_config_path(path, high_priority: false)
       path = check_path(path)
       priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
       @load_worklist << [path, [], priority]
       self
     end
 
-    def add_config_paths(paths, high_priority: false)
+    def add_paths(paths, high_priority: false)
       paths = Array(paths)
       paths = paths.reverse if high_priority
       paths.each do |path|
-        add_config_path(path, high_priority: high_priority)
+        add_path(path, high_priority: high_priority)
       end
       self
     end
 
-    def add_config_path(path, high_priority: false)
+    def add_path(path, high_priority: false)
       path = check_path(path, type: :dir)
       priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
       if @config_file_name
@@ -101,9 +105,9 @@ module Toys
       end
     end
 
-    def execute(context_base, args)
+    def execute(context_base, args, verbosity: 0)
       tool = lookup(args)
-      tool.execute(context_base, args.slice(tool.full_name.length..-1))
+      tool.execute(context_base, args.slice(tool.full_name.length..-1), verbosity: verbosity)
     end
 
     def exact_tool(words)
@@ -111,19 +115,26 @@ module Toys
       @tools[words].first
     end
 
-    def get_tool(words, priority)
+    def get_tool(words, priority, assume_parent: false)
       if tool_defined?(words)
         tool, tool_priority = @tools[words]
-        return tool if tool_priority.nil? || tool_priority == priority
+        return tool if priority.nil? || tool_priority.nil? || tool_priority == priority
         return nil if tool_priority > priority
       end
-      parent = get_tool(words[0..-2], priority)
-      return nil if parent.nil?
-      tool = Tool.new(self, words)
+      unless assume_parent
+        parent = get_tool(words[0..-2], priority)
+        return nil if parent.nil?
+      end
+      tool = Tool.new(words, @middleware)
       @tools[words] = [tool, priority]
       tool
     end
 
+    def put_tool!(tool, priority = nil)
+      @tools[tool.full_name] = [tool, priority]
+      self
+    end
+
     def tool_defined?(words)
       @tools.key?(words)
     end
@@ -194,7 +205,7 @@ module Toys
       if ::File.extname(path) == ".rb"
         tool = get_tool(words, priority)
         if tool
-          Builder.build(path, tool, remaining_words, priority, self, ::IO.read(path))
+          Builder.build(path, tool, remaining_words, priority, self, ::IO.read(path), :tool)
         end
       else
         require_preload_in(path)
@@ -225,7 +236,7 @@ module Toys
       child_path = check_path(::File.join(path, child))
       child_word = ::File.basename(child, ".rb")
       next_words = words + [child_word]
-      next_remaining = Lookup.next_remaining_words(remaining_words, child_word)
+      next_remaining = Loader.next_remaining_words(remaining_words, child_word)
       handle_path(child_path, next_words, next_remaining, priority)
     end
 

data/lib/toys/middleware.rb

@@ -0,0 +1,41 @@
+# 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 middleware
+  #
+  module Middleware
+    def self.lookup(name)
+      Utils::ModuleLookup.lookup(:middleware, name)
+    end
+  end
+end

data/lib/toys/middleware/base.rb

@@ -0,0 +1,45 @@
+# 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
+    ##
+    # A base middleware with a no-op implementation
+    #
+    class Base
+      def config(_tool)
+        yield
+      end
+
+      def execute(_context)
+        yield
+      end
+    end
+  end
+end

data/lib/toys/middleware/group_default.rb

@@ -0,0 +1,57 @@
+# 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"
+require "toys/utils/usage"
+
+module Toys
+  module Middleware
+    ##
+    # A middleware that provides a default implementation for groups
+    #
+    class GroupDefault < Base
+      def config(tool)
+        if tool.includes_executor?
+          yield
+        else
+          tool.add_switch(:_recursive, "-r", "--[no-]recursive",
+                          doc: "Show all subcommands recursively")
+        end
+      end
+
+      def execute(context)
+        if context[Context::TOOL].includes_executor?
+          yield
+        else
+          puts(Utils::Usage.from_context(context).string(recursive: context[:_recursive]))
+        end
+      end
+    end
+  end
+end

data/lib/toys/middleware/set_verbosity.rb

@@ -0,0 +1,51 @@
+# 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
+    #
+    class SetVerbosity < Base
+      def config(tool)
+        tool.add_switch(Context::VERBOSITY, "-v", "--verbose",
+                        doc: "Increase verbosity",
+                        handler: ->(_val, cur) { cur + 1 },
+                        only_unique: true)
+        tool.add_switch(Context::VERBOSITY, "-q", "--quiet",
+                        doc: "Decrease verbosity",
+                        handler: ->(_val, cur) { cur - 1 },
+                        only_unique: true)
+        yield
+      end
+    end
+  end
+end

data/lib/toys/middleware/show_tool_help.rb

@@ -0,0 +1,57 @@
+# 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"
+require "toys/utils/usage"
+
+module Toys
+  module Middleware
+    ##
+    # A middleware that shows usage documentation
+    #
+    class ShowToolHelp < Base
+      def config(tool)
+        if tool.includes_executor?
+          tool.add_switch(:_help, "-?", "--help",
+                          doc: "Show help message",
+                          only_unique: true)
+        end
+        yield
+      end
+
+      def execute(context)
+        if context[:_help]
+          puts(Utils::Usage.from_context(context).string(recursive: context[:_recursive]))
+        else
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/toys/middleware/show_usage_errors.rb

@@ -0,0 +1,51 @@
+# 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"
+require "toys/utils/usage"
+
+module Toys
+  module Middleware
+    ##
+    # A middleware that shows usage errors
+    #
+    class ShowUsageErrors < Base
+      def execute(context)
+        if context[Context::USAGE_ERROR]
+          puts(context[Context::USAGE_ERROR])
+          puts("")
+          puts(Utils::Usage.from_context(context).string)
+          context.exit(-1)
+        else
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/toys/templates.rb

@@ -0,0 +1,41 @@
+# 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
+    def self.lookup(name)
+      Utils::ModuleLookup.lookup(:templates, name)
+    end
+  end
+end