toys 0.9.4 → 0.10.0

data/lib/toys/templates/rspec.rb

@@ -1,26 +1,5 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Daniel Azuma
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-;
-
 module Toys
   module Templates
     ##
@@ -33,7 +12,7 @@ module Toys
       # Default version requirements for the rspec gem.
       # @return [Array<String>]
       #
-      DEFAULT_GEM_VERSION_REQUIREMENTS = "~> 3.1"
+      DEFAULT_GEM_VERSION_REQUIREMENTS = ["~> 3.1"].freeze
 
       ##
       # Default tool name
@@ -53,6 +32,12 @@ module Toys
       #
       DEFAULT_ORDER = "defined"
 
+      ##
+      # Default format code
+      # @return [String]
+      #
+      DEFAULT_FORMAT = "p"
+
       ##
       # Default spec file glob
       # @return [String]
@@ -68,16 +53,21 @@ module Toys
       #     the rspec gem. Defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS}.
       # @param libs [Array<String>] An array of library paths to add to the
       #     ruby require path. Defaults to {DEFAULT_LIBS}.
-      # @param options [String] The path to a custom options file.
+      # @param options [String] The path to a custom options file, if any.
       # @param order [String] The order in which to run examples. Default is
       #     {DEFAULT_ORDER}.
-      # @param format [String] Choose a formatter code. Default is `p`.
+      # @param format [String] The formatter code. Default is {DEFAULT_FORMAT}.
       # @param out [String] Write output to a file instead of stdout.
       # @param backtrace [Boolean] Enable full backtrace (default is false).
       # @param pattern [String] A glob indicating the spec files to load.
       #     Defaults to {DEFAULT_PATTERN}.
       # @param warnings [Boolean] If true, runs specs with Ruby warnings.
       #     Defaults to true.
+      # @param bundler [Boolean,Hash] If `false` (the default), bundler is not
+      #     enabled for this tool. If `true` or a Hash of options, bundler is
+      #     enabled. See the documentation for the
+      #     [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      #     for information on available options.
       #
       def initialize(name: nil,
                      gem_version: nil,
@@ -88,29 +78,185 @@ module Toys
                      out: nil,
                      backtrace: false,
                      pattern: nil,
-                     warnings: true)
-        @name = name || DEFAULT_TOOL_NAME
-        @gem_version = gem_version || DEFAULT_GEM_VERSION_REQUIREMENTS
-        @libs = libs || DEFAULT_LIBS
+                     warnings: true,
+                     bundler: false)
+        @name = name
+        @gem_version = gem_version
+        @libs = libs
         @options = options
-        @order = order || DEFAULT_ORDER
-        @format = format || "p"
+        @order = order
+        @format = format
         @out = out
         @backtrace = backtrace
-        @pattern = pattern || DEFAULT_PATTERN
+        @pattern = pattern
         @warnings = warnings
+        @bundler = bundler
       end
 
-      attr_accessor :name
-      attr_accessor :gem_version
-      attr_accessor :libs
-      attr_accessor :options
-      attr_accessor :order
-      attr_accessor :format
-      attr_accessor :out
-      attr_accessor :backtrace
-      attr_accessor :pattern
-      attr_accessor :warnings
+      ##
+      # Name of the tool to create.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :name
+
+      ##
+      # Version requirements for the rspec gem.
+      # If set to `nil`, uses the bundled version if bundler is enabled, or
+      # defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS} if bundler is not
+      # enabled.
+      #
+      # @param value [String,Array<String>,nil]
+      # @return [String,Array<String>,nil]
+      #
+      attr_writer :gem_version
+
+      ##
+      # An array of directories to add to the Ruby require path.
+      # If set to `nil`, defaults to {DEFAULT_LIBS}.
+      #
+      # @param value [Array<String>,nil]
+      # @return [Array<String>,nil]
+      #
+      attr_writer :libs
+
+      ##
+      # Path to the custom options file, or `nil` for none.
+      #
+      # @param value [String,nil]
+      # @return [String,nil]
+      #
+      attr_writer :options
+
+      ##
+      # The order in which to run examples.
+      # If set to `nil`, defaults to {DEFAULT_ORDER}.
+      #
+      # @param value [String,nil]
+      # @return [String,nil]
+      #
+      attr_writer :order
+
+      ##
+      # The formatter code.
+      # If set to `nil`, defaults to {DEFAULT_FORMAT}.
+      #
+      # @param value [String,nil]
+      # @return [String,nil]
+      #
+      attr_writer :format
+
+      ##
+      # Path to a file to write output to.
+      # If set to `nil`, writes output to standard out.
+      #
+      # @param value [String,nil]
+      # @return [String,nil]
+      #
+      attr_writer :out
+
+      ##
+      # Whether to enable full backtraces.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :backtrace
+
+      ##
+      # A glob indicating the spec files to load.
+      # If set to `nil`, defaults to {DEFAULT_PATTERN}.
+      #
+      # @param value [String,nil]
+      # @return [String,nil]
+      #
+      attr_writer :pattern
+
+      ##
+      # Whether to run with Ruby warnings.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :warnings
+
+      ##
+      # Set the bundler state and options for this tool.
+      #
+      # Pass `false` to disable bundler. Pass `true` or a hash of options to
+      # enable bundler. See the documentation for the
+      # [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      # for information on the options that can be passed.
+      #
+      # @param value [Boolean,Hash]
+      # @return [Boolean,Hash]
+      #
+      attr_writer :bundler
+
+      ##
+      # Activate bundler for this tool.
+      #
+      # See the documentation for the
+      # [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      # for information on the options that can be passed.
+      #
+      # @param opts [keywords] Options for bundler
+      # @return [self]
+      #
+      def use_bundler(**opts)
+        @bundler = opts
+        self
+      end
+
+      ## @private
+      attr_reader :options
+      ## @private
+      attr_reader :out
+      ## @private
+      attr_reader :backtrace
+      ## @private
+      attr_reader :warnings
+
+      # @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)
+          {}
+        else
+          @bundler
+        end
+      end
 
       on_expand do |template|
         tool(template.name) do
@@ -119,6 +265,9 @@ module Toys
           include :exec
           include :gems
 
+          bundler_settings = template.bundler_settings
+          include :bundler, **bundler_settings if bundler_settings
+
           flag :order, "--order TYPE",
                default: template.order,
                desc: "Run examples by the specified order type (default: #{template.order})"

data/lib/toys/templates/rubocop.rb

@@ -1,26 +1,5 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Daniel Azuma
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-;
-
 module Toys
   module Templates
     ##
@@ -52,37 +31,133 @@ module Toys
       #     Rubocop fails. Defaults to true.
       # @param options [Array<String>] Additional options passed to the Rubocop
       #     CLI.
+      # @param bundler [Boolean,Hash] If `false` (the default), bundler is not
+      #     enabled for this tool. If `true` or a Hash of options, bundler is
+      #     enabled. See the documentation for the
+      #     [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      #     for information on available options.
       #
       def initialize(name: DEFAULT_TOOL_NAME,
                      gem_version: nil,
                      fail_on_error: true,
-                     options: [])
+                     options: [],
+                     bundler: false)
         @name = name
-        @gem_version = gem_version || DEFAULT_GEM_VERSION_REQUIREMENTS
+        @gem_version = gem_version
         @fail_on_error = fail_on_error
         @options = options
+        @bundler = bundler
       end
 
-      attr_accessor :name
-      attr_accessor :gem_version
-      attr_accessor :fail_on_error
-      attr_accessor :options
+      ##
+      # Name of the tool to create.
+      #
+      # @param value [String]
+      # @return [String]
+      #
+      attr_writer :name
+
+      ##
+      # Version requirements for the rdoc gem.
+      # If set to `nil`, uses the bundled version if bundler is enabled, or
+      # defaults to {DEFAULT_GEM_VERSION_REQUIREMENTS} if bundler is not
+      # enabled.
+      #
+      # @param value [String,Array<String>,nil]
+      # @return [String,Array<String>,nil]
+      #
+      attr_writer :gem_version
+
+      ##
+      # Whether to exit with a nonzero code if Rubocop fails.
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      #
+      attr_writer :fail_on_error
+
+      ##
+      # Additional options to pass to Rubocop
+      #
+      # @param value [Array<String>]
+      # @return [Array<String>]
+      #
+      attr_writer :options
+
+      ##
+      # Set the bundler state and options for this tool.
+      #
+      # Pass `false` to disable bundler. Pass `true` or a hash of options to
+      # enable bundler. See the documentation for the
+      # [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      # for information on the options that can be passed.
+      #
+      # @param value [Boolean,Hash]
+      # @return [Boolean,Hash]
+      #
+      attr_writer :bundler
+
+      ##
+      # Activate bundler for this tool.
+      #
+      # See the documentation for the
+      # [bundler mixin](https://dazuma.github.io/toys/gems/toys-core/latest/Toys/StandardMixins/Bundler)
+      # for information on the options that can be passed.
+      #
+      # @param opts [keywords] Options for bundler
+      # @return [self]
+      #
+      def use_bundler(**opts)
+        @bundler = opts
+        self
+      end
+
+      ## @private
+      attr_reader :fail_on_error
+      ## @private
+      attr_reader :options
+
+      # @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 bundler_settings
+        if @bundler && !@bundler.is_a?(::Hash)
+          {}
+        else
+          @bundler
+        end
+      end
 
       on_expand do |template|
         tool(template.name) do
           desc "Run rubocop on the current project."
 
           include :gems
+          include :exec
+
+          bundler_settings = template.bundler_settings
+          include :bundler, **bundler_settings if bundler_settings
 
           to_run do
-            gem "rubocop", *Array(template.gem_version)
-            require "rubocop"
+            gem "rubocop", *template.gem_version
 
             ::Dir.chdir(context_directory || ::Dir.getwd) do
-              rubocop = ::RuboCop::CLI.new
               logger.info "Running RuboCop..."
-              result = rubocop.run(template.options)
-              if result.nonzero?
+              result = exec_ruby([], in: :controller) do |controller|
+                controller.in.puts("gem 'rubocop', *#{template.gem_version.inspect}")
+                controller.in.puts("require 'rubocop'")
+                controller.in.puts("exit(::RuboCop::CLI.new.run(#{template.options.inspect}))")
+              end
+              if result.error?
                 logger.error "RuboCop failed!"
                 exit(1) if template.fail_on_error
               end