toys 0.3.8 → 0.3.9

data/lib/toys/standard_cli.rb

@@ -97,11 +97,11 @@ module Toys
     # Create a standard CLI, configured with the appropriate paths and
     # middleware.
     #
-    # @param [String,nil] directory Starting search directory for configs.
+    # @param [String,nil] cur_dir Starting search directory for configs.
     #     Defaults to the current working directory.
     # @return [Toys::CLI]
     #
-    def self.create(directory: nil)
+    def self.create(cur_dir: nil)
       cli = CLI.new(
         binary_name: BINARY_NAME,
         config_dir_name: CONFIG_DIR_NAME,
@@ -111,7 +111,7 @@ module Toys
         middleware_stack: default_middleware_stack,
         template_lookup: default_template_lookup
       )
-      add_standard_paths(cli, directory: directory)
+      add_standard_paths(cli, cur_dir: cur_dir)
       cli
     end
 
@@ -127,17 +127,16 @@ module Toys
     # *  The builtins for the standard toys binary.
     #
     # @param [Toys::CLI] cli Add paths to this CLI
-    # @param [String,nil] directory Starting search directory for configs.
+    # @param [String,nil] cur_dir Starting search directory for configs.
     #     Defaults to the current working directory.
-    #
-    def self.add_standard_paths(cli, directory: nil)
-      cli.add_search_path_hierarchy(start: directory)
-      paths = ::ENV["TOYS_PATH"].to_s.split(::File::PATH_SEPARATOR)
-      if paths.empty?
-        paths << ::ENV["HOME"] if ::ENV["HOME"]
-        paths << "/etc" if ::File.directory?("/etc") && ::File.readable?("/etc")
-      end
-      paths.each { |path| cli.add_search_path(path) }
+    # @param [Array<String>,nil] global_dirs Optional list of global
+    #     directories, or `nil` to use the defaults.
+    #
+    def self.add_standard_paths(cli, cur_dir: nil, global_dirs: nil)
+      cur_dir ||= ::Dir.pwd
+      global_dirs ||= default_global_dirs
+      cli.add_search_path_hierarchy(start: cur_dir, terminate: global_dirs)
+      global_dirs.each { |path| cli.add_search_path(path) }
       cli.add_config_path(BUILTINS_PATH)
       cli
     end
@@ -145,7 +144,7 @@ module Toys
     # rubocop:disable Metrics/MethodLength
 
     ##
-    # Returns a the middleware for the standard Toys CLI.
+    # Returns the middleware for the standard Toys CLI.
     #
     # @return [Array]
     #
@@ -192,6 +191,25 @@ module Toys
 
     # rubocop:enable Metrics/MethodLength
 
+    ##
+    # Returns the default set of global config directories.
+    #
+    # @return [Array<String>]
+    #
+    def self.default_global_dirs
+      paths = ::ENV["TOYS_PATH"].to_s.split(::File::PATH_SEPARATOR)
+      if paths.empty?
+        paths << ::ENV["HOME"] if ::ENV["HOME"]
+        paths << "/etc" if ::File.directory?("/etc") && ::File.readable?("/etc")
+      end
+      paths.map { |path| ::File.realpath(::File.expand_path(path)) }
+    end
+
+    ##
+    # Returns a ModuleLookup for the default templates.
+    #
+    # @return [Toys::Utils::ModuleLookup]
+    #
     def self.default_template_lookup
       Utils::ModuleLookup.new.add_path("toys/templates")
     end

data/lib/toys/templates/clean.rb

@@ -73,7 +73,7 @@ module Toys
 
             files.each do |file|
               if ::File.exist?(file)
-                rm_rf file
+                rm_rf(file)
                 puts "Cleaned: #{file}"
               end
             end

data/lib/toys/templates/gem_build.rb

@@ -27,8 +27,6 @@
 # POSSIBILITY OF SUCH DAMAGE.
 ;
 
-require "rubygems/package"
-
 module Toys
   module Templates
     ##
@@ -95,25 +93,26 @@ module Toys
           include :terminal
 
           run do
+            require "rubygems/package"
             configure_exec(exit_on_nonzero_status: true)
-            gemspec = ::Gem::Specification.load "#{template.gem_name}.gemspec"
+            gemspec = ::Gem::Specification.load("#{template.gem_name}.gemspec")
             version = gemspec.version
             gemfile = "#{template.gem_name}-#{version}.gem"
-            ::Gem::Package.build gemspec
-            mkdir_p "pkg"
-            mv gemfile, "pkg"
+            ::Gem::Package.build(gemspec)
+            mkdir_p("pkg")
+            mv(gemfile, "pkg")
             if template.push_gem
               if ::File.directory?(".git") && capture("git status -s").strip != ""
                 logger.error "Cannot push the gem when there are uncommited changes"
                 exit(1)
               end
               exit(1) unless option(:yes) || confirm("Release #{gemfile}?")
-              sh "gem push pkg/#{gemfile}"
+              exec(["gem", "push", "pkg/#{gemfile}"])
               if template.tag
-                sh "git tag v#{version}"
+                exec(["git", "tag", "v#{version}"])
                 if template.push_tag
                   template.push_tag = "origin" if template.push_tag == true
-                  sh "git push #{template.push_tag} v#{version}"
+                  exec(["git", "push", template.push_tag, "v#{version}"])
                 end
               end
             end

data/lib/toys/templates/minitest.rb

@@ -35,6 +35,12 @@ module Toys
     class Minitest
       include Template
 
+      ##
+      # Default version requirements for the minitest gem.
+      # @return [Array<String>]
+      #
+      DEFAULT_GEM_VERSION_REQUIREMENTS = "~> 5.0".freeze
+
       ##
       # Default tool name
       # @return [String]
@@ -58,6 +64,8 @@ module Toys
       #
       # @param [String] name Name of the tool to create. Defaults to
       #     {DEFAULT_TOOL_NAME}.
+      # @param [String,Array<String>] gem_version Version requirements for
+      #     the minitest gem. Defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS}.
       # @param [Array<String>] libs An array of library paths to add to the
       #     ruby require path. Defaults to {DEFAULT_LIBS}.
       # @param [Array<String>] files An array of globs indicating the test
@@ -65,17 +73,20 @@ module Toys
       # @param [Boolean] warnings If true, runs tests with Ruby warnings.
       #     Defaults to true.
       #
-      def initialize(name: DEFAULT_TOOL_NAME,
-                     libs: DEFAULT_LIBS,
-                     files: DEFAULT_FILES,
+      def initialize(name: nil,
+                     gem_version: nil,
+                     libs: nil,
+                     files: nil,
                      warnings: true)
-        @name = name
-        @libs = libs
-        @files = files
+        @name = name || DEFAULT_TOOL_NAME
+        @gem_version = gem_version || DEFAULT_GEM_VERSION_REQUIREMENTS
+        @libs = libs || DEFAULT_LIBS
+        @files = files || DEFAULT_FILES
         @warnings = warnings
       end
 
       attr_accessor :name
+      attr_accessor :gem_version
       attr_accessor :libs
       attr_accessor :files
       attr_accessor :warnings
@@ -93,6 +104,7 @@ module Toys
           remaining_args :tests, desc: "Paths to the tests to run (defaults to all tests)"
 
           run do
+            gem("minitest", *Array(template.gem_version))
             ruby_args = []
             unless template.libs.empty?
               lib_path = template.libs.join(::File::PATH_SEPARATOR)

data/lib/toys/templates/rdoc.rb

@@ -0,0 +1,145 @@
+# 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 that generates rdoc tools.
+    #
+    class Rdoc
+      include Template
+
+      ##
+      # Default version requirements for the rdoc gem.
+      # @return [Array<String>]
+      #
+      DEFAULT_GEM_VERSION_REQUIREMENTS = ">= 5.0.0".freeze
+
+      ##
+      # Default tool name
+      # @return [String]
+      #
+      DEFAULT_TOOL_NAME = "rdoc".freeze
+
+      ##
+      # Default output directory
+      # @return [String]
+      #
+      DEFAULT_OUTPUT_DIR = "html".freeze
+
+      ##
+      # Create the template settings for the Rdoc template.
+      #
+      # @param [String] name Name of the tool to create. Defaults to
+      #     {DEFAULT_TOOL_NAME}.
+      # @param [String,Array<String>] gem_version Version requirements for
+      #     the rdoc gem. Defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS}.
+      # @param [Array<String>] files An array of globs indicating the files
+      #     to document.
+      # @param [String] output_dir Name of directory to receive html output
+      #     files. Defaults to {DEFAULT_OUTPUT_DIR}.
+      # @param [String,nil] markup Markup format. Allowed values include
+      #     "rdoc", "rd", and "tomdoc". Default is "rdoc".
+      # @param [String,nil] title Title of RDoc documentation. If `nil`, RDoc
+      #     will use a default title.
+      # @param [String,nil] main Name of the file to use as the main top level
+      #     document. Default is none.
+      # @param [String,nil] template Name of the template to use. If `nil`,
+      #     RDoc will use its default template.
+      # @param [String,nil] generator Name of the format generator. If `nil`,
+      #     RDoc will use its default generator.
+      # @param [Array<String>] options Additional options to pass to RDoc.
+      #
+      def initialize(name: nil,
+                     gem_version: nil,
+                     files: [],
+                     output_dir: nil,
+                     markup: nil,
+                     title: nil,
+                     main: nil,
+                     template: nil,
+                     generator: nil,
+                     options: [])
+        @name = name || DEFAULT_TOOL_NAME
+        @gem_version = gem_version || DEFAULT_GEM_VERSION_REQUIREMENTS
+        @files = files
+        @output_dir = output_dir || DEFAULT_OUTPUT_DIR
+        @markup = markup
+        @title = title
+        @main = main
+        @template = template
+        @generator = generator
+        @options = options
+      end
+
+      attr_accessor :name
+      attr_accessor :gem_version
+      attr_accessor :files
+      attr_accessor :output_dir
+      attr_accessor :markup
+      attr_accessor :title
+      attr_accessor :main
+      attr_accessor :template
+      attr_accessor :generator
+      attr_accessor :options
+
+      to_expand do |template|
+        tool(template.name) do
+          desc "Run rdoc on the current project."
+
+          include :exec
+
+          run do
+            gem("rdoc", *Array(template.gem_version))
+            require "rdoc"
+
+            files = []
+            patterns = Array(template.files)
+            patterns = ["lib/**/*.rb"] if patterns.empty?
+            patterns.each do |pattern|
+              files.concat(::Dir.glob(pattern))
+            end
+            files.uniq!
+
+            args = template.options.dup
+            args << "-o" << template.output_dir
+            args << "--markup" << template.markup if template.markup
+            args << "--main" << template.main if template.main
+            args << "--title" << template.title if template.title
+            args << "-T" << template.template if template.template
+            args << "-f" << template.generator if template.generator
+
+            exec_proc(proc { RDoc::RDoc.new.document(args + files) },
+                      exit_on_nonzero_status: true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/toys/templates/rubocop.rb

@@ -35,6 +35,12 @@ module Toys
     class Rubocop
       include Template
 
+      ##
+      # Default version requirements for the rubocop gem.
+      # @return [Array<String>]
+      #
+      DEFAULT_GEM_VERSION_REQUIREMENTS = [].freeze
+
       ##
       # Default tool name
       # @return [String]
@@ -46,20 +52,25 @@ module Toys
       #
       # @param [String] name Name of the tool to create. Defaults to
       #     {DEFAULT_TOOL_NAME}.
+      # @param [String,Array<String>] gem_version Version requirements for
+      #     the rubocop gem. Defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS}.
       # @param [Boolean] fail_on_error If true, exits with a nonzero code if
       #     Rubocop fails. Defaults to true.
       # @param [Array<String>] options Additional options passed to the Rubocop
       #     CLI.
       #
       def initialize(name: DEFAULT_TOOL_NAME,
+                     gem_version: nil,
                      fail_on_error: true,
                      options: [])
         @name = name
+        @gem_version = gem_version || DEFAULT_GEM_VERSION_REQUIREMENTS
         @fail_on_error = fail_on_error
         @options = options
       end
 
       attr_accessor :name
+      attr_accessor :gem_version
       attr_accessor :fail_on_error
       attr_accessor :options
 
@@ -67,10 +78,10 @@ module Toys
         tool(template.name) do
           desc "Run rubocop on the current project."
 
-          include :exec
-
           run do
+            gem("rubocop", *Array(template.gem_version))
             require "rubocop"
+
             cli = ::RuboCop::CLI.new
             logger.info "Running RuboCop..."
             result = cli.run(template.options)

data/lib/toys/templates/yardoc.rb

@@ -30,11 +30,17 @@
 module Toys
   module Templates
     ##
-    # A template for tools that run yardoc
+    # A template that generates yardoc tools.
     #
     class Yardoc
       include Template
 
+      ##
+      # Default version requirements for the yard gem.
+      # @return [String]
+      #
+      DEFAULT_GEM_VERSION_REQUIREMENTS = "~> 0.9".freeze
+
       ##
       # Default tool name
       # @return [String]
@@ -46,24 +52,98 @@ module Toys
       #
       # @param [String] name Name of the tool to create. Defaults to
       #     {DEFAULT_TOOL_NAME}.
+      # @param [String,Array<String>] gem_version Version requirements for
+      #     the yard gem. Defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS}.
       # @param [Array<String>] files An array of globs indicating the files
       #     to document.
+      # @param [Boolean] generate_output Whether to generate output. Setting to
+      #     false causes yardoc to emit warnings/errors but not generate html.
+      #     Defaults to true.
+      # @param [Boolean] generate_output_flag Whether to create a flag
+      #     `--[no-]output` that can control whether output is generated.
+      #     Defaults to false.
+      # @param [String,nil] output_dir Output directory. Defaults to "doc".
+      # @param [Boolean] fail_on_warning Whether the tool should return a
+      #     nonzero error code if any warnings happen. Defaults to false.
+      # @param [Boolean] fail_on_undocumented_objects Whether the tool should
+      #     return a nonzero error code if any objects remain undocumented.
+      #     Defaults to false.
+      # @param [Boolean] show_public Show public methods. Defaults to true.
+      # @param [Boolean] show_protected Show protected methods. Defaults to
+      #     false.
+      # @param [Boolean] show_private Show private methods. Defaults to false.
+      # @param [Boolean] hide_private_tag Hide methods with the `@private` tag.
+      #     Defaults to false.
+      # @param [String,nil] readme Name of the readme file used as the title
+      #     page, or `nil` to use the default.
+      # @param [String,nil] markup Markup style used in documentation. Defaults
+      #     to "rdoc".
+      # @param [String,nil] template Template to use. Defaults to "default".
+      # @param [String,nil] template_path The optional template path to look
+      #     for templates in.
+      # @param [String,nil] format The output format for the template. Defaults
+      #     to "html".
       # @param [Array<String>] options Additional options passed to YARD
       # @param [Array<String>] stats_options Additional options passed to YARD
       #     stats
       #
-      def initialize(name: DEFAULT_TOOL_NAME,
+      def initialize(name: nil,
+                     gem_version: nil,
                      files: [],
+                     generate_output: true,
+                     generate_output_flag: false,
+                     output_dir: nil,
+                     fail_on_warning: false,
+                     fail_on_undocumented_objects: false,
+                     show_public: true,
+                     show_protected: false,
+                     show_private: false,
+                     hide_private_tag: false,
+                     readme: nil,
+                     markup: nil,
+                     template: nil,
+                     template_path: nil,
+                     format: nil,
                      options: [],
                      stats_options: [])
-        @name = name
+        @name = name || DEFAULT_TOOL_NAME
+        @gem_version = gem_version || DEFAULT_GEM_VERSION_REQUIREMENTS
         @files = files
+        @generate_output = generate_output
+        @generate_output_flag = generate_output_flag
+        @output_dir = output_dir
+        @fail_on_warning = fail_on_warning
+        @fail_on_undocumented_objects = fail_on_undocumented_objects
+        @show_public = show_public
+        @show_protected = show_protected
+        @show_private = show_private
+        @hide_private_tag = hide_private_tag
+        @readme = readme
+        @markup = markup
+        @template = template
+        @template_path = template_path
+        @format = format
         @options = options
         @stats_options = stats_options
       end
 
       attr_accessor :name
+      attr_accessor :gem_version
       attr_accessor :files
+      attr_accessor :generate_output
+      attr_accessor :generate_output_flag
+      attr_accessor :output_dir
+      attr_accessor :fail_on_warning
+      attr_accessor :fail_on_undocumented_objects
+      attr_accessor :show_public
+      attr_accessor :show_protected
+      attr_accessor :show_private
+      attr_accessor :hide_private_tag
+      attr_accessor :readme
+      attr_accessor :markup
+      attr_accessor :template
+      attr_accessor :template_path
+      attr_accessor :format
       attr_accessor :options
       attr_accessor :stats_options
 
@@ -71,10 +151,21 @@ module Toys
         tool(template.name) do
           desc "Run yardoc on the current project."
 
+          if template.generate_output_flag
+            flag :generate_output, "--[no-]output",
+                 default: template.generate_output,
+                 desc: "Whether to generate output"
+          else
+            set :generate_output, template.generate_output
+          end
+
           include :exec
+          include :terminal
 
           run do
+            gem("yard", *Array(template.gem_version))
             require "yard"
+
             files = []
             patterns = Array(template.files)
             patterns = ["lib/**/*.rb"] if patterns.empty?
@@ -83,15 +174,46 @@ module Toys
             end
             files.uniq!
 
-            unless template.stats_options.empty?
-              template.options << "--no-stats"
-              template.stats_options << "--use-cache"
+            run_options = template.options.dup
+            stats_options = template.stats_options.dup
+            stats_options << "--list-undoc" if template.fail_on_undocumented_objects
+            run_options << "--fail-on-warning" if template.fail_on_warning
+            run_options << "--no-output" unless option(:generate_output)
+            run_options << "--output-dir" << template.output_dir if template.output_dir
+            run_options << "--no-public" unless template.show_public
+            run_options << "--protected" if template.show_protected
+            run_options << "--private" if template.show_private
+            run_options << "--no-private" if template.hide_private_tag
+            run_options << "-r" << template.readme if template.readme
+            run_options << "-m" << template.markup if template.markup
+            run_options << "-t" << template.template if template.template
+            run_options << "-p" << template.template_path if template.template_path
+            run_options << "-f" << template.format if template.format
+            unless stats_options.empty?
+              run_options << "--no-stats"
+              stats_options << "--use-cache"
             end
+            run_options.concat(files)
 
-            yardoc = ::YARD::CLI::Yardoc.new
-            yardoc.run(*(template.options + files))
-            unless template.stats_options.empty?
-              ::YARD::CLI::Stats.run(*template.stats_options)
+            result = exec_proc(proc { ::YARD::CLI::Yardoc.run(*run_options) })
+            if result.error?
+              puts("Yardoc encountered errors", :red, :bold) unless verbosity < 0
+              exit(1)
+            end
+            unless stats_options.empty?
+              result = exec_proc(proc { ::YARD::CLI::Stats.run(*stats_options) }, out: :capture)
+              puts result.captured_out
+              if result.error?
+                puts("Yardoc encountered errors", :red, :bold) unless verbosity < 0
+                exit(1)
+              end
+              exit_on_nonzero_status(result)
+              if template.fail_on_undocumented_objects
+                if result.captured_out =~ /Undocumented\sObjects:/
+                  puts("Yardoc encountered undocumented objects", :red, :bold) unless verbosity < 0
+                  exit(1)
+                end
+              end
             end
           end
         end