toys 0.3.1 → 0.3.2

data/lib/toys/templates.rb

@@ -1,55 +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 "toys/utils/module_lookup"
-
-module Toys
-  ##
-  # Namespace for common templates
-  #
-  module Templates
-    ##
-    # Return a template class by name.
-    #
-    # Currently recognized template names are:
-    #
-    # *  `:clean` : Creates a tool that cleans build artifacts.
-    # *  `:gem_build` : Creates a tool that builds and/or releases gems.
-    # *  `:minitest` : Creates a tool that runs unit tests.
-    # *  `:rubocop` : Creates a tool that runs rubocop.
-    # *  `:yardoc` : Creates a tool that generates YARD documentation.
-    #
-    # @param [String,Symbol] name Name of the template class to return
-    # @return [Class,nil] The class, or `nil` if not found
-    #
-    def self.lookup(name)
-      Utils::ModuleLookup.lookup(:templates, name)
-    end
-  end
-end

data/lib/toys/templates/clean.rb

@@ -1,80 +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 clean build artifacts
-    #
-    class Clean
-      include Template
-
-      ##
-      # Create the template settings for the Clean template.
-      #
-      # You may provide a hash of options when expanding this template.
-      # Supported options include:
-      #
-      # *  `:name` (String) Name of the tool to create. Defaults to "clean".
-      # *  `:paths` (Array<String>) An array of glob patterns indicating what
-      #    to clean.
-      #
-      # @param [Hash] opts Options.
-      #
-      def initialize(opts = {})
-        @name = opts[:name] || "clean"
-        @paths = opts[:paths] || []
-      end
-
-      attr_accessor :name
-      attr_accessor :paths
-
-      to_expand do |template|
-        tool(template.name) do
-          desc "Clean built files and directories."
-
-          use :file_utils
-
-          execute do
-            files = []
-            patterns = Array(template.paths)
-            patterns.each do |pattern|
-              files.concat(::Dir.glob(pattern))
-            end
-            files.uniq!
-
-            files.each do |file|
-              rm_rf file
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/toys/templates/gem_build.rb

@@ -1,115 +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
-
-      ##
-      # Create the template settings for the GemBuild template.
-      #
-      # You may provide a hash of options when expanding this template.
-      # Supported options include:
-      #
-      # *  `:name` (String) Name of the tool to create. Defaults to "build".
-      # *  `:gem_name` (String) Name of the gem to build. If not provided,
-      #    defaults to the first gemspec file it finds.
-      # *  `:push_gem` (Boolean) If true, pushes the built gem to rubygems.
-      # *  `:tag` (Boolean) If true, tags the git repo with the gem version.
-      # *  `:push_tag` (Boolean,String) 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.
-      #
-      # @param [Hash] opts Options.
-      #
-      def initialize(opts = {})
-        @name = opts[:name] || "build"
-        @gem_name = opts[:gem_name]
-        @push_gem = opts[:push_gem]
-        @tag = opts[:tag]
-        @push_tag = opts[: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}"
-
-          use :file_utils
-          use :exec
-
-          execute 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
-              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,108 +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
-
-      ##
-      # Create the template settings for the Minitest template.
-      #
-      # You may provide a hash of options when expanding this template.
-      # Supported options include:
-      #
-      # *  `:name` (String) Name of the tool to create. Defaults to "test".
-      # *  `:lib` (Array<String>) An array of library paths to add to the
-      #    ruby require path.
-      # *  `:files` (Array<String>) An array of globs indicating the test
-      #    files to load.
-      # *  `:warnings` (Boolean) If true, runs tests with Ruby warnings.
-      #
-      # @param [Hash] opts Options.
-      #
-      def initialize(opts = {})
-        @name = opts[:name] || "test"
-        @libs = opts[:libs] || ["lib"]
-        @files = opts[:files] || ["test/**/test*.rb"]
-        @warnings = opts.include?(:warnings) ? opts[:warnings] : true
-      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."
-
-          use :exec
-
-          switch(
-            :warnings, "-w", "--[no-]warnings",
-            default: template.warnings,
-            doc: "Turn on Ruby warnings (defaults to #{template.warnings})"
-          )
-          remaining_args(:tests, doc: "Paths to the tests to run (defaults to all tests)")
-
-          execute 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,81 +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
-
-      ##
-      # Create the template settings for the Rubocop template.
-      #
-      # You may provide a hash of options when expanding this template.
-      # Supported options include:
-      #
-      # *  `:name` (String) Name of the tool to create. Defaults to "rubocop".
-      # *  `:fail_on_error` (Boolean) If true, exits with a nonzero code if
-      #    Rubocop fails. Defaults to true.
-      # *  `:options` (Hash) Additional options passed to the Rubocop CLI.
-      #
-      # @param [Hash] opts Options.
-      #
-      def initialize(opts = {})
-        @name = opts[:name] || "rubocop"
-        @fail_on_error = opts.include?(:fail_on_error) ? opts[:fail_on_error] : true
-        @options = opts[: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."
-
-          use :exec
-
-          execute 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,95 +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
-
-      ##
-      # Create the template settings for the Yardoc template.
-      #
-      # You may provide a hash of options when expanding this template.
-      # Supported options include:
-      #
-      # *  `:name` (String) Name of the tool to create. Defaults to "yardoc".
-      # *  `:files` (Array<String>) An array of globs indicating the files
-      #    to document.
-      # *  `:options` (Hash) Additional options passed to YARD
-      # *  `:stats_options` (Hash) Additional options passed to YARD stats
-      #
-      # @param [Hash] opts Options.
-      #
-      def initialize(opts = {})
-        @name = opts[:name] || "yardoc"
-        @files = opts[:files] || []
-        @options = opts[:options] || []
-        @stats_options = opts[: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."
-
-          use :exec
-
-          execute 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