toys 0.2.2 → 0.3.0

data/lib/toys/utils/module_lookup.rb

@@ -0,0 +1,101 @@
+# 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.
+    #
+    # 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 << 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.to_s.gsub(/([a-zA-Z])([A-Z])/) { |_m| "#{$1}_#{$2.downcase}" }.downcase
+        end
+
+        ##
+        # Convert the given string to a module name. Specifically, converts
+        # to `UpperCamelCase`.
+        #
+        # @param [String,Symbol] str String to convert.
+        # @return [String] Converted string
+        #
+        def to_module_name(str)
+          str.to_s.gsub(/(^|_)([a-zA-Z0-9])/) { |_m| $2.upcase }
+        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.
+        #
+        # @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.
+        #
+        def lookup!(collection, name)
+          require "toys/#{to_path_name(collection)}/#{to_path_name(name)}"
+          ::Toys.const_get(to_module_name(collection)).const_get(to_module_name(name))
+        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
+        end
+      end
+    end
+  end
+end

data/lib/toys/utils/usage.rb

@@ -0,0 +1,119 @@
+# 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
+    ##
+    # Helper that generates usage text
+    #
+    class Usage
+      def self.from_context(context)
+        new(context[Context::TOOL], context[Context::BINARY_NAME], context[Context::LOADER])
+      end
+
+      def initialize(tool, binary_name, loader)
+        @tool = tool
+        @binary_name = binary_name
+        @loader = loader
+      end
+
+      def string(recursive: false)
+        optparse = ::OptionParser.new
+        optparse.banner = @tool.includes_executor? ? tool_banner : group_banner
+        unless @tool.effective_long_desc.empty?
+          optparse.separator("")
+          optparse.separator(@tool.effective_long_desc)
+        end
+        add_switches(optparse)
+        if @tool.includes_executor?
+          add_positional_arguments(optparse)
+        elsif !@tool.alias?
+          add_command_list(optparse, recursive)
+        end
+        optparse.to_s
+      end
+
+      private
+
+      def tool_banner
+        banner = ["Usage:", @binary_name] + @tool.full_name
+        banner << "[<options...>]" unless @tool.switches.empty?
+        @tool.required_args.each do |arg_info|
+          banner << "<#{arg_info.canonical_name}>"
+        end
+        @tool.optional_args.each do |arg_info|
+          banner << "[<#{arg_info.canonical_name}>]"
+        end
+        if @tool.remaining_args
+          banner << "[<#{@tool.remaining_args.canonical_name}...>]"
+        end
+        banner.join(" ")
+      end
+
+      def group_banner
+        (["Usage:", @binary_name] + @tool.full_name + ["<command>", "[<options...>]"]).join(" ")
+      end
+
+      def add_switches(optparse)
+        return if @tool.switches.empty?
+        optparse.separator("")
+        optparse.separator("Options:")
+        @tool.switches.each do |switch|
+          optparse.on(*switch.optparse_info)
+        end
+      end
+
+      def add_positional_arguments(optparse)
+        args_to_display = @tool.required_args + @tool.optional_args
+        args_to_display << @tool.remaining_args if @tool.remaining_args
+        return if args_to_display.empty?
+        optparse.separator("")
+        optparse.separator("Positional arguments:")
+        args_to_display.each do |arg_info|
+          optparse.separator("    #{arg_info.canonical_name.ljust(31)}  #{arg_info.doc.first}")
+          (arg_info.doc[1..-1] || []).each do |d|
+            optparse.separator("                                     #{d}")
+          end
+        end
+      end
+
+      def add_command_list(optparse, recursive)
+        name_len = @tool.full_name.length
+        subtools = @loader.list_subtools(@tool.full_name, recursive)
+        return if subtools.empty?
+        optparse.separator("")
+        optparse.separator("Commands:")
+        subtools.each do |subtool|
+          tool_name = subtool.full_name.slice(name_len..-1).join(" ").ljust(31)
+          optparse.separator("    #{tool_name}  #{subtool.effective_desc}")
+        end
+      end
+    end
+  end
+end

data/lib/toys/version.rb

@@ -32,5 +32,5 @@ module Toys
   # Current version of Toys
   # @return [String]
   #
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.55.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.55.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -88,25 +88,37 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.md
 - README.md
 - bin/toys
 - lib/toys.rb
 - lib/toys/builder.rb
+- lib/toys/builtins/do.rb
 - lib/toys/builtins/system.rb
 - lib/toys/cli.rb
 - lib/toys/context.rb
 - lib/toys/errors.rb
+- lib/toys/helpers.rb
 - lib/toys/helpers/exec.rb
 - lib/toys/helpers/file_utils.rb
-- lib/toys/lookup.rb
+- lib/toys/loader.rb
+- lib/toys/middleware.rb
+- lib/toys/middleware/base.rb
+- lib/toys/middleware/group_default.rb
+- lib/toys/middleware/set_verbosity.rb
+- lib/toys/middleware/show_tool_help.rb
+- lib/toys/middleware/show_usage_errors.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/module_lookup.rb
+- lib/toys/utils/usage.rb
 - lib/toys/version.rb
 homepage: https://github.com/dazuma/toys
 licenses:
@@ -128,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Command line tool framework