toys-core 0.3.7.1 → 0.3.8

data/lib/toys/templates/gem_build.rb

@@ -1,125 +0,0 @@
-# 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 "rubygems/package"
-
-module Toys
-  module Templates
-    ##
-    # A template for tools that build and release gems
-    #
-    class GemBuild
-      include Template
-
-      ##
-      # Default tool name
-      # @return [String]
-      #
-      DEFAULT_TOOL_NAME = "build".freeze
-
-      ##
-      # Create the template settings for the GemBuild template.
-      #
-      # @param [String] name Name of the tool to create. Defaults to
-      #     {DEFAULT_TOOL_NAME}.
-      # @param [String] gem_name Name of the gem to build. If not provided,
-      #     defaults to the first gemspec file it finds.
-      # @param [Boolean] push_gem If true, pushes the built gem to rubygems.
-      # @param [Boolean] tag If true, tags the git repo with the gem version.
-      # @param [Boolean,String] push_tag If truthy, pushes the new tag to
-      #     a git remote. You may specify which remote by setting the value to
-      #     a string. Otherwise, if the value is simply `true`, the "origin"
-      #     remote is used by default.
-      #
-      def initialize(name: DEFAULT_TOOL_NAME,
-                     gem_name: nil,
-                     push_gem: false,
-                     tag: false,
-                     push_tag: false)
-        @name = name
-        @gem_name = gem_name
-        @push_gem = push_gem
-        @tag = tag
-        @push_tag = push_tag
-      end
-
-      attr_accessor :name
-      attr_accessor :gem_name
-      attr_accessor :push_gem
-      attr_accessor :tag
-      attr_accessor :push_tag
-
-      to_expand do |template|
-        unless template.gem_name
-          candidates = ::Dir.glob("*.gemspec")
-          if candidates.empty?
-            raise ToolDefinitionError, "Could not find a gemspec"
-          end
-          template.gem_name = candidates.first.sub(/\.gemspec$/, "")
-        end
-        task_type = template.push_gem ? "Release" : "Build"
-
-        tool(template.name) do
-          desc "#{task_type} the gem: #{template.gem_name}"
-
-          flag :yes, "-y", "--yes", desc: "Do not ask for interactive confirmation"
-
-          include :exec
-          include :fileutils
-          include :terminal
-
-          run do
-            configure_exec(exit_on_nonzero_status: true)
-            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"
-            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}"
-              if template.tag
-                sh "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}"
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/toys/templates/minitest.rb

@@ -1,125 +0,0 @@
-# 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 for tools that run minitest
-    #
-    class Minitest
-      include Template
-
-      ##
-      # Default tool name
-      # @return [String]
-      #
-      DEFAULT_TOOL_NAME = "test".freeze
-
-      ##
-      # Default set of library paths
-      # @return [Array<String>]
-      #
-      DEFAULT_LIBS = ["lib"].freeze
-
-      ##
-      # Default set of test file globs
-      # @return [Array<String>]
-      #
-      DEFAULT_FILES = ["test/**/test*.rb"].freeze
-
-      ##
-      # Create the template settings for the Minitest template.
-      #
-      # @param [String] name Name of the tool to create. Defaults to
-      #     {DEFAULT_TOOL_NAME}.
-      # @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
-      #     files to load. Defaults to {DEFAULT_FILES}.
-      # @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,
-                     warnings: true)
-        @name = name
-        @libs = libs
-        @files = files
-        @warnings = warnings
-      end
-
-      attr_accessor :name
-      attr_accessor :libs
-      attr_accessor :files
-      attr_accessor :warnings
-
-      to_expand do |template|
-        tool(template.name) do
-          desc "Run minitest on the current project."
-
-          include :exec
-
-          flag :warnings, "-w", "--[no-]warnings",
-               default: template.warnings,
-               desc: "Turn on Ruby warnings (defaults to #{template.warnings})"
-
-          remaining_args :tests, desc: "Paths to the tests to run (defaults to all tests)"
-
-          run do
-            ruby_args = []
-            unless template.libs.empty?
-              lib_path = template.libs.join(::File::PATH_SEPARATOR)
-              ruby_args << "-I#{lib_path}"
-            end
-            ruby_args << "-w" if self[:warnings]
-
-            tests = self[:tests]
-            if tests.empty?
-              Array(template.files).each do |pattern|
-                tests.concat(::Dir.glob(pattern))
-              end
-              tests.uniq!
-            end
-
-            result = ruby(ruby_args, in_from: :controller) do |controller|
-              tests.each do |file|
-                controller.in.puts("load '#{file}'")
-              end
-            end
-            if result.error?
-              logger.error("Minitest failed!")
-              exit(result.exit_code)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/toys/templates/rubocop.rb

@@ -1,86 +0,0 @@
-# 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 for tools that run rubocop
-    #
-    class Rubocop
-      include Template
-
-      ##
-      # Default tool name
-      # @return [String]
-      #
-      DEFAULT_TOOL_NAME = "rubocop".freeze
-
-      ##
-      # Create the template settings for the Rubocop template.
-      #
-      # @param [String] name Name of the tool to create. Defaults to
-      #     {DEFAULT_TOOL_NAME}.
-      # @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,
-                     fail_on_error: true,
-                     options: [])
-        @name = name
-        @fail_on_error = fail_on_error
-        @options = options
-      end
-
-      attr_accessor :name
-      attr_accessor :fail_on_error
-      attr_accessor :options
-
-      to_expand do |template|
-        tool(template.name) do
-          desc "Run rubocop on the current project."
-
-          include :exec
-
-          run do
-            require "rubocop"
-            cli = ::RuboCop::CLI.new
-            logger.info "Running RuboCop..."
-            result = cli.run(template.options)
-            if result.nonzero?
-              logger.error "RuboCop failed!"
-              exit(1) if template.fail_on_error
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/toys/templates/yardoc.rb

@@ -1,101 +0,0 @@
-# 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 for tools that run yardoc
-    #
-    class Yardoc
-      include Template
-
-      ##
-      # Default tool name
-      # @return [String]
-      #
-      DEFAULT_TOOL_NAME = "yardoc".freeze
-
-      ##
-      # Create the template settings for the Yardoc template.
-      #
-      # @param [String] name Name of the tool to create. Defaults to
-      #     {DEFAULT_TOOL_NAME}.
-      # @param [Array<String>] files An array of globs indicating the files
-      #     to document.
-      # @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,
-                     files: [],
-                     options: [],
-                     stats_options: [])
-        @name = name
-        @files = files
-        @options = options
-        @stats_options = stats_options
-      end
-
-      attr_accessor :name
-      attr_accessor :files
-      attr_accessor :options
-      attr_accessor :stats_options
-
-      to_expand do |template|
-        tool(template.name) do
-          desc "Run yardoc on the current project."
-
-          include :exec
-
-          run do
-            require "yard"
-            files = []
-            patterns = Array(template.files)
-            patterns = ["lib/**/*.rb"] if patterns.empty?
-            patterns.each do |pattern|
-              files.concat(::Dir.glob(pattern))
-            end
-            files.uniq!
-
-            unless template.stats_options.empty?
-              template.options << "--no-stats"
-              template.stats_options << "--use-cache"
-            end
-
-            yardoc = ::YARD::CLI::Yardoc.new
-            yardoc.run(*(template.options + files))
-            unless template.stats_options.empty?
-              ::YARD::CLI::Stats.run(*template.stats_options)
-            end
-          end
-        end
-      end
-    end
-  end
-end