toys 0.12.2 → 0.13.0

data/lib/toys/standard_cli.rb

@@ -93,10 +93,16 @@ module Toys
     # Create a standard CLI, configured with the appropriate paths and
     # middleware.
     #
+    # @param custom_paths [String,Array<String>] Custom paths to use. If set,
+    #     the CLI uses only the given paths. If not, the CLI will search for
+    #     paths from the current directory and global paths.
+    # @param include_builtins [boolean] Add the builtin tools. Default is true.
     # @param cur_dir [String,nil] Starting search directory for configs.
     #     Defaults to the current working directory.
     #
-    def initialize(cur_dir: nil)
+    def initialize(custom_paths: nil,
+                   include_builtins: true,
+                   cur_dir: nil)
       super(
         executable_name: EXECUTABLE_NAME,
         config_dir_name: CONFIG_DIR_NAME,
@@ -110,40 +116,48 @@ module Toys
         middleware_stack: default_middleware_stack,
         template_lookup: default_template_lookup
       )
-      add_standard_paths(cur_dir: cur_dir, toys_dir_name: CONFIG_DIR_NAME)
+      if custom_paths
+        Array(custom_paths).each { |path| add_config_path(path) }
+      else
+        add_current_directory_paths(cur_dir)
+      end
+      add_builtins if include_builtins
     end
 
     private
 
     ##
-    # Add paths for a toys standard CLI. Paths added, in order from high to
-    # low priority, are:
+    # Add paths for builtin tools
     #
-    #  *  Search the current directory and all ancestors for config files and
-    #     directories.
-    #  *  Read the `TOYS_PATH` environment variable and search for config files
-    #     and directories in the given paths. If this variable is empty, use
-    #     `$HOME:/etc` by default.
-    #  *  The builtins for the standard toys executable.
+    def add_builtins
+      builtins_path = ::File.join(::File.dirname(::File.dirname(__dir__)), "builtins")
+      add_config_path(builtins_path, source_name: "(builtin tools)", context_directory: nil)
+      self
+    end
+
+    ##
+    # Add paths for the given current directory and its ancestors, plus the
+    # global paths.
     #
-    # @param cur_dir [String,nil] Starting search directory for configs.
-    #     Defaults to the current working directory.
-    # @param global_dirs [Array<String>,nil] Optional list of global
-    #     directories, or `nil` to use the defaults.
+    # @param cur_dir [String] The starting directory path, or nil to use the
+    #     current directory
     # @return [self]
     #
-    def add_standard_paths(cur_dir: nil, global_dirs: nil, toys_dir_name: nil)
-      cur_dir ||= ::Dir.pwd
-      cur_dir = skip_toys_dir(cur_dir, toys_dir_name) if toys_dir_name
-      global_dirs ||= default_global_dirs
+    def add_current_directory_paths(cur_dir)
+      cur_dir = skip_toys_dir(cur_dir || ::Dir.pwd, CONFIG_DIR_NAME)
+      global_dirs = default_global_dirs
       add_search_path_hierarchy(start: cur_dir, terminate: global_dirs)
       global_dirs.each { |path| add_search_path(path) }
-      builtins_path = ::File.join(::File.dirname(::File.dirname(__dir__)), "builtins")
-      add_config_path(builtins_path, source_name: "(builtin tools)", context_directory: nil)
       self
     end
 
-    # Step out of any toys dir
+    ##
+    # Step out of any toys dir.
+    #
+    # @param dir [String] The starting path
+    # @param toys_dir_name [String] The name of the toys directory to look for
+    # @return [String] The final directory path
+    #
     def skip_toys_dir(dir, toys_dir_name)
       cur_dir = dir
       loop do
@@ -157,6 +171,21 @@ module Toys
       end
     end
 
+    ##
+    # Returns the default set of global config directories.
+    #
+    # @return [Array<String>]
+    #
+    def default_global_dirs
+      paths = ::ENV[TOYS_PATH_ENV].to_s.split(::File::PATH_SEPARATOR)
+      paths = [::Dir.home, "/etc"] if paths.empty?
+      paths
+        .compact
+        .uniq
+        .select { |path| ::File.directory?(path) && ::File.readable?(path) }
+        .map { |path| ::File.realpath(::File.expand_path(path)) }
+    end
+
     ##
     # Returns the middleware for the standard Toys CLI.
     #
@@ -188,21 +217,6 @@ module Toys
       ]
     end
 
-    ##
-    # Returns the default set of global config directories.
-    #
-    # @return [Array<String>]
-    #
-    def default_global_dirs
-      paths = ::ENV[TOYS_PATH_ENV].to_s.split(::File::PATH_SEPARATOR)
-      paths = [::Dir.home, "/etc"] if paths.empty?
-      paths
-        .compact
-        .uniq
-        .select { |path| ::File.directory?(path) && ::File.readable?(path) }
-        .map { |path| ::File.realpath(::File.expand_path(path)) }
-    end
-
     ##
     # Returns a ModuleLookup for the default templates.
     #

data/lib/toys/templates/clean.rb

@@ -56,15 +56,21 @@ module Toys
       #
       attr_writer :context_directory
 
+      ##
       # @private
+      #
       attr_reader :context_directory
 
+      ##
       # @private
+      #
       def paths
         Array(@paths)
       end
 
+      ##
       # @private
+      #
       def name
         @name || DEFAULT_TOOL_NAME
       end
@@ -80,7 +86,9 @@ module Toys
           include :fileutils
           include :exec
 
+          ##
           # @private
+          #
           def run
             cd(context_directory || ::Dir.getwd) do
               template_paths.each do |elem|
@@ -96,7 +104,9 @@ module Toys
             end
           end
 
+          ##
           # @private
+          #
           def clean_gitignore
             result = exec(["git", "rev-parse", "--is-inside-work-tree"], out: :null, err: :null)
             unless result.success?
@@ -106,7 +116,9 @@ module Toys
             clean_gitignore_dir(".")
           end
 
+          ##
           # @private
+          #
           def clean_gitignore_dir(dir)
             children = dir_children(dir)
             result = exec(["git", "check-ignore", "--stdin"],
@@ -118,7 +130,9 @@ module Toys
             children.each { |child| clean_gitignore_dir(child) if ::File.directory?(child) }
           end
 
+          ##
           # @private
+          #
           def dir_children(dir)
             ::Dir.entries(dir)
                  .reject { |entry| entry =~ /^\.\.?$/ }
@@ -126,12 +140,16 @@ module Toys
                  .map { |entry| ::File.join(dir, entry) }
           end
 
+          ##
           # @private
+          #
           def clean_pattern(pattern)
             ::Dir.glob(pattern) { |path| clean_path(path) }
           end
 
+          ##
           # @private
+          #
           def clean_path(path)
             if ::File.exist?(path)
               rm_rf(path)

data/lib/toys/templates/gem_build.rb

@@ -149,23 +149,41 @@ module Toys
       #
       attr_writer :context_directory
 
+      ##
       # @private
+      #
       attr_reader :output
+
+      ##
       # @private
+      #
       attr_reader :push_gem
+
+      ##
       # @private
+      #
       attr_reader :install_gem
+
+      ##
       # @private
+      #
       attr_reader :tag
+
+      ##
       # @private
+      #
       attr_reader :context_directory
 
+      ##
       # @private
+      #
       def name
         @name || DEFAULT_TOOL_NAME
       end
 
+      ##
       # @private
+      #
       def gem_name(context_dir = nil)
         return @gem_name if @gem_name
         glob = "*.gemspec"
@@ -177,17 +195,23 @@ module Toys
         candidates.first.sub(/\.gemspec$/, "")
       end
 
+      ##
       # @private
+      #
       def output_flags
         @output_flags == true ? DEFAULT_OUTPUT_FLAGS : Array(@output_flags)
       end
 
+      ##
       # @private
+      #
       def push_tag
         @push_tag == true ? DEFAULT_PUSH_REMOTE : @push_tag
       end
 
+      ##
       # @private
+      #
       def task_names
         names = []
         names << "Install" if @install_gem

data/lib/toys/templates/minitest.rb

@@ -175,37 +175,58 @@ module Toys
         self
       end
 
+      ##
       # @private
+      #
       attr_reader :seed
+
+      ##
       # @private
+      #
       attr_reader :verbose
+
+      ##
       # @private
+      #
       attr_reader :warnings
+
+      ##
       # @private
+      #
       attr_reader :context_directory
 
+      ##
       # @private
+      #
       def name
         @name || DEFAULT_TOOL_NAME
       end
 
+      ##
       # @private
+      #
       def libs
         @libs ? Array(@libs) : DEFAULT_LIBS
       end
 
+      ##
       # @private
+      #
       def files
         @files ? Array(@files) : DEFAULT_FILES
       end
 
+      ##
       # @private
+      #
       def gem_version
         return Array(@gem_version) if @gem_version
         @bundler ? [] : DEFAULT_GEM_VERSION_REQUIREMENTS
       end
 
+      ##
       # @private
+      #
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
           {}

data/lib/toys/templates/rake.rb

@@ -120,24 +120,38 @@ module Toys
         self
       end
 
+      ##
       # @private
+      #
       attr_reader :only_described
+
+      ##
       # @private
+      #
       attr_reader :use_flags
+
+      ##
       # @private
+      #
       attr_reader :context_directory
 
+      ##
       # @private
+      #
       def gem_version
         Array(@gem_version)
       end
 
+      ##
       # @private
+      #
       def rakefile_path
         @rakefile_path || DEFAULT_RAKEFILE_PATH
       end
 
+      ##
       # @private
+      #
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
           {}
@@ -191,7 +205,9 @@ module Toys
         end
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self.flag_specs(arg)
         name = arg.to_s.gsub(/\W/, "").downcase
         specs = []
@@ -203,7 +219,9 @@ module Toys
         specs
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self.find_rakefile(path, context_dir)
         if path == ::File.absolute_path(path)
           return ::File.file?(path) && ::File.readable?(path) ? path : nil
@@ -220,7 +238,9 @@ module Toys
         nil
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self.prepare_rake(rakefile_path, context_dir)
         ::Rake::TaskManager.record_task_metadata = true
         rake = ::Rake::Application.new

data/lib/toys/templates/rdoc.rb

@@ -214,46 +214,75 @@ module Toys
         self
       end
 
+      ##
       # @private
+      #
       attr_reader :markup
+
+      ##
       # @private
+      #
       attr_reader :title
+
+      ##
       # @private
+      #
       attr_reader :main
+
+      ##
       # @private
+      #
       attr_reader :template
+
+      ##
       # @private
+      #
       attr_reader :generator
+
+      ##
       # @private
+      #
       attr_reader :context_directory
 
+      ##
       # @private
+      #
       def name
         @name || DEFAULT_TOOL_NAME
       end
 
+      ##
       # @private
+      #
       def gem_version
         return Array(@gem_version) if @gem_version
         @bundler ? [] : DEFAULT_GEM_VERSION_REQUIREMENTS
       end
 
+      ##
       # @private
+      #
       def files
         @files ? Array(@files) : DEFAULT_FILES
       end
 
+      ##
       # @private
+      #
       def output_dir
         @output_dir || DEFAULT_OUTPUT_DIR
       end
 
+      ##
       # @private
+      #
       def options
         Array(@options)
       end
 
+      ##
       # @private
+      #
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
           {}

data/lib/toys/templates/rspec.rb

@@ -221,49 +221,77 @@ module Toys
         self
       end
 
-      ## @private
+      ##
+      # @private
+      #
       attr_reader :options
-      ## @private
+
+      ##
+      # @private
+      #
       attr_reader :out
-      ## @private
+
+      ##
+      # @private
+      #
       attr_reader :backtrace
-      ## @private
+
+      ##
+      # @private
+      #
       attr_reader :warnings
+
+      ##
       # @private
+      #
       attr_reader :context_directory
 
+      ##
       # @private
+      #
       def name
         @name || DEFAULT_TOOL_NAME
       end
 
+      ##
       # @private
+      #
       def gem_version
         return Array(@gem_version) if @gem_version
         @bundler ? [] : DEFAULT_GEM_VERSION_REQUIREMENTS
       end
 
+      ##
       # @private
+      #
       def libs
         @libs ? Array(@libs) : DEFAULT_LIBS
       end
 
+      ##
       # @private
+      #
       def order
         @order || DEFAULT_ORDER
       end
 
+      ##
       # @private
+      #
       def format
         @format || DEFAULT_FORMAT
       end
 
+      ##
       # @private
+      #
       def pattern
         @pattern || DEFAULT_PATTERN
       end
 
+      ##
       # @private
+      #
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
           {}

data/lib/toys/templates/rubocop.rb

@@ -124,28 +124,41 @@ module Toys
         self
       end
 
-      ## @private
+      ##
+      # @private
+      #
       attr_reader :fail_on_error
+
+      ##
       # @private
+      #
       attr_reader :context_directory
 
+      ##
       # @private
+      #
       def name
         @name || DEFAULT_TOOL_NAME
       end
 
+      ##
       # @private
+      #
       def gem_version
         return Array(@gem_version) if @gem_version
         @bundler ? [] : DEFAULT_GEM_VERSION_REQUIREMENTS
       end
 
+      ##
       # @private
+      #
       def options
         Array(@options)
       end
 
+      ##
       # @private
+      #
       def bundler_settings
         if @bundler && !@bundler.is_a?(::Hash)
           {}