toys-core 0.3.2

data/lib/toys/middleware/show_version.rb

@@ -0,0 +1,99 @@
+# 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/middleware/base"
+
+module Toys
+  module Middleware
+    ##
+    # A middleware that displays a version string for certain tools if the
+    # `--version` switch is given. You can specify which tools respond to
+    # this switch, and the string that will be displayed.
+    #
+    class ShowVersion < Base
+      ##
+      # Default version switches
+      # @return [Array<String>]
+      #
+      DEFAULT_VERSION_SWITCHES = ["--version"].freeze
+
+      ##
+      # Return a simple version displayer that returns the given string for
+      # the root tool.
+      #
+      # @return [Proc]
+      #
+      def self.root_version_displayer(version)
+        proc { |tool| tool.root? ? version : false }
+      end
+
+      ##
+      # Create a ShowVersion middleware
+      #
+      # @param [Proc] version_displayer A proc that takes a tool and returns
+      #     either the version string that should be displayed, or a falsy
+      #     value to indicate the tool should not have a `--version` switch.
+      #     Defaults to a "null" displayer that returns false for all tools.
+      # @param [Array<String>] version_switches A list of switches that should
+      #     trigger displaying the version. Default is
+      #     {DEFAULT_VERSION_SWITCHES}.
+      #
+      def initialize(version_displayer: nil,
+                     version_switches: DEFAULT_VERSION_SWITCHES)
+        @version_displayer = version_displayer || proc { |_| false }
+        @version_switches = version_switches
+      end
+
+      ##
+      # Adds the version switch if requested.
+      #
+      def config(tool)
+        version = @version_displayer.call(tool)
+        if version
+          tool.add_switch(:_show_version, *@version_switches,
+                          doc: "Show version",
+                          handler: ->(_val, _prev) { version },
+                          only_unique: true)
+        end
+        yield
+      end
+
+      ##
+      # This middleware displays the version.
+      #
+      def execute(context)
+        if context[:_show_version]
+          puts context[:_show_version]
+        else
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/toys/template.rb

@@ -0,0 +1,123 @@
+# 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
+  ##
+  # A template definition. Template classes should include this module.
+  #
+  # A template is a configurable set of DSL code that can be run in a toys
+  # configuration to automate tool defintion. For example, toys provides a
+  # "minitest" template that generates a "test" tool that invokes minitest.
+  # Templates will often support configuration; for example the minitest
+  # template lets you configure the paths to the test files.
+  #
+  # ## Usage
+  #
+  # To create a template, define a class and include this module.
+  # The class defines the "configuration" of the template. If your template
+  # has options/parameters, you should provide a constructor, and methods
+  # appropriate to edit those options. The arguments given to the
+  # {Toys::ConfigDSL#expand} method are passed to your constructor, and your
+  # template object is passed to any block given to {Toys::ConfigDSL#expand}.
+  #
+  # Next, in your template class, call the `to_expand` method, which is defined
+  # in {Toys::Template::ClassMethods#to_expand}. Pass this a block which
+  # defines the implementation of the template. Effectively, the contents of
+  # this block are "inserted" into the user's configuration. The template
+  # object is passed to the block so you have access to the template options.
+  #
+  # ## Example
+  #
+  # This is a simple template that generates a "hello" tool. The tool simply
+  # prints a `"Hello, #{name}!"` greeting. The name is set as a template
+  # option; it is defined when the template is expanded in a toys
+  # configuration.
+  #
+  #     # Define a template by creating a class that includes Toys::Template.
+  #     class MyHelloTemplate
+  #       include Toys::Template
+  #
+  #       # A user of the template may pass an optional name as a parameter to
+  #       # `expand`, or leave it as the default of "world".
+  #       def initialize(name: "world")
+  #         @name = name
+  #       end
+  #
+  #       # The template is passed to the expand block, so a user of the
+  #       # template may also call this method to set the name.
+  #       attr_accessor :name
+  #
+  #       # The following block is inserted when the template is expanded.
+  #       to_expand do |template|
+  #         desc "Prints a greeting to #{template.name}"
+  #         tool "templated-greeting" do
+  #           execute do
+  #             puts "Hello, #{template.name}!"
+  #           end
+  #         end
+  #       end
+  #     end
+  #
+  # Now you can use the template in your `.toys.rb` file like this:
+  #
+  #     expand(MyHelloTemplate, name: "rubyists")
+  #
+  # or alternately:
+  #
+  #     expand(MyHelloTemplate) do |template|
+  #       template.name = "rubyists"
+  #     end
+  #
+  # And it will create a tool called "templated-greeting".
+  #
+  module Template
+    ## @private
+    def self.included(mod)
+      mod.extend(ClassMethods)
+    end
+
+    ##
+    # Class methods that will be added to a template class.
+    #
+    module ClassMethods
+      ##
+      # Provide the block that implements the template.
+      #
+      def to_expand(&block)
+        @expander = block
+      end
+
+      ##
+      # You may alternately set the expander block using this accessor.
+      # @return [Proc]
+      #
+      attr_accessor :expander
+    end
+  end
+end

data/lib/toys/templates.rb

@@ -0,0 +1,55 @@
+# 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

@@ -0,0 +1,82 @@
+# 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
+
+      ##
+      # Default tool name
+      # @return [String]
+      #
+      DEFAULT_TOOL_NAME = "clean".freeze
+
+      ##
+      # Create the template settings for the Clean template.
+      #
+      # @param [String] name Name of the tool to create. Defaults to
+      #     {DEFAULT_TOOL_NAME}.
+      # @param [Array<String>] paths An array of glob patterns indicating what
+      #     to clean.
+      #
+      def initialize(name: DEFAULT_TOOL_NAME, paths: [])
+        @name = name
+        @paths = 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

@@ -0,0 +1,121 @@
+# 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}"
+
+          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