toys 0.2.1 → 0.2.2

data/lib/toys/helpers/file_utils.rb

@@ -1,7 +1,37 @@
+# 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 "fileutils"
 
-module Toys
-  module Helpers
-    FileUtils = ::FileUtils
-  end
+module Toys::Helpers
+  ##
+  # File system utilities. See the "fileutils" standard library.
+  #
+  FileUtils = ::FileUtils
 end

data/lib/toys/lookup.rb

@@ -1,25 +1,46 @@
+# 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
+  ##
+  # The lookup service that finds a tool given a set of arguments
+  #
   class Lookup
     def initialize(config_dir_name: nil, config_file_name: nil,
                    index_file_name: nil, preload_file_name: nil)
       @config_dir_name = config_dir_name
-      if @config_dir_name && File.extname(@config_dir_name) == ".rb"
-        raise LookupError, "Illegal config dir name #{@config_dir_name.inspect}"
-      end
       @config_file_name = config_file_name
-      if @config_file_name && File.extname(@config_file_name) != ".rb"
-        raise LookupError, "Illegal config file name #{@config_file_name.inspect}"
-      end
       @index_file_name = index_file_name
-      if @index_file_name && File.extname(@index_file_name) != ".rb"
-        raise LookupError, "Illegal index file name #{@index_file_name.inspect}"
-      end
       @preload_file_name = preload_file_name
-      if @preload_file_name && File.extname(@preload_file_name) != ".rb"
-        raise LookupError, "Illegal preload file name #{@preload_file_name.inspect}"
-      end
+      check_init_options
       @load_worklist = []
-      @tools = {[] => [Tool.new(nil, nil), nil]}
+      @tools = {[] => [Tool.new(self, []), nil]}
       @max_priority = @min_priority = 0
     end
 
@@ -27,37 +48,47 @@ module Toys
       paths = Array(paths)
       paths = paths.reverse if high_priority
       paths.each do |path|
-        path = check_path(path)
-        priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
-        @load_worklist << [path, [], priority]
+        add_path(path, high_priority: high_priority)
       end
       self
     end
 
+    def add_path(path, high_priority: false)
+      path = check_path(path)
+      priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
+      @load_worklist << [path, [], priority]
+      self
+    end
+
     def add_config_paths(paths, high_priority: false)
       paths = Array(paths)
       paths = paths.reverse if high_priority
       paths.each do |path|
-        path = check_path(path, type: :dir)
-        priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
-        if @config_file_name
-          p = File.join(path, @config_file_name)
-          if !File.directory?(p) && File.readable?(p)
-            @load_worklist << [p, [], priority]
-          end
+        add_config_path(path, high_priority: high_priority)
+      end
+      self
+    end
+
+    def add_config_path(path, high_priority: false)
+      path = check_path(path, type: :dir)
+      priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
+      if @config_file_name
+        p = ::File.join(path, @config_file_name)
+        if !::File.directory?(p) && ::File.readable?(p)
+          @load_worklist << [p, [], priority]
         end
-        if @config_dir_name
-          p = File.join(path, @config_dir_name)
-          if File.directory?(p) && File.readable?(p)
-            @load_worklist << [p, [], priority]
-          end
+      end
+      if @config_dir_name
+        p = ::File.join(path, @config_dir_name)
+        if ::File.directory?(p) && ::File.readable?(p)
+          @load_worklist << [p, [], priority]
         end
       end
       self
     end
 
     def lookup(args)
-      orig_prefix = args.take_while{ |arg| !arg.start_with?("-") }
+      orig_prefix = args.take_while { |arg| !arg.start_with?("-") }
       cur_prefix = orig_prefix.dup
       loop do
         load_for_prefix(cur_prefix)
@@ -70,15 +101,25 @@ module Toys
       end
     end
 
+    def execute(context_base, args)
+      tool = lookup(args)
+      tool.execute(context_base, args.slice(tool.full_name.length..-1))
+    end
+
+    def exact_tool(words)
+      return nil unless tool_defined?(words)
+      @tools[words].first
+    end
+
     def get_tool(words, priority)
-      if @tools.key?(words)
+      if tool_defined?(words)
         tool, tool_priority = @tools[words]
         return tool if tool_priority.nil? || tool_priority == priority
         return nil if tool_priority > priority
       end
       parent = get_tool(words[0..-2], priority)
       return nil if parent.nil?
-      tool = Tool.new(parent, words.last)
+      tool = Tool.new(self, words)
       @tools[words] = [tool, priority]
       tool
     end
@@ -91,30 +132,48 @@ module Toys
       found_tools = []
       len = words.length
       @tools.each do |n, tp|
-        if n.length > 0
-          if !recursive && n.slice(0..-2) == words ||
-              recursive && n.length > len && n.slice(0, len) == words
-            found_tools << tp.first
-          end
+        next if n.empty?
+        if recursive
+          next if n.length <= len || n.slice(0, len) != words
+        else
+          next unless n.slice(0..-2) == words
         end
+        found_tools << tp.first
       end
-      found_tools.sort do |a, b|
-        a = a.full_name
-        b = b.full_name
-        while !a.empty? && !b.empty? && a.first == b.first
-          a = a.slice(1..-1)
-          b = b.slice(1..-1)
-        end
-        a.first.to_s <=> b.first.to_s
-      end
+      sort_tools_by_name(found_tools)
     end
 
     def include_path(path, words, remaining_words, priority)
       handle_path(check_path(path), words, remaining_words, priority)
     end
 
+    def self.next_remaining_words(remaining_words, word)
+      if remaining_words.nil?
+        nil
+      elsif remaining_words.empty?
+        remaining_words
+      elsif remaining_words.first == word
+        remaining_words.slice(1..-1)
+      end
+    end
+
     private
 
+    def check_init_options
+      if @config_dir_name && ::File.extname(@config_dir_name) == ".rb"
+        raise LookupError, "Illegal config dir name #{@config_dir_name.inspect}"
+      end
+      if @config_file_name && ::File.extname(@config_file_name) != ".rb"
+        raise LookupError, "Illegal config file name #{@config_file_name.inspect}"
+      end
+      if @index_file_name && ::File.extname(@index_file_name) != ".rb"
+        raise LookupError, "Illegal index file name #{@index_file_name.inspect}"
+      end
+      if @preload_file_name && ::File.extname(@preload_file_name) != ".rb"
+        raise LookupError, "Illegal preload file name #{@preload_file_name.inspect}"
+      end
+    end
+
     def load_for_prefix(prefix)
       cur_worklist = @load_worklist
       @load_worklist = []
@@ -132,56 +191,55 @@ module Toys
     end
 
     def load_path(path, words, remaining_words, priority)
-      if File.extname(path) == ".rb"
+      if ::File.extname(path) == ".rb"
         tool = get_tool(words, priority)
         if tool
-          Parser.parse(path, tool, remaining_words, priority, self, IO.read(path))
+          Builder.build(path, tool, remaining_words, priority, self, ::IO.read(path))
         end
       else
-        if @preload_file_name
-          preload_path = File.join(path, @preload_file_name)
-          if File.exist?(preload_path)
-            preload_path = check_path(preload_path, type: :file)
-            require preload_path
-          end
-        end
-        if @index_file_name
-          index_path = File.join(path, @index_file_name)
-          if File.exist?(index_path)
-            index_path = check_path(index_path, type: :file)
-            load_path(index_path, words, remaining_words, priority)
-          end
-        end
-        Dir.entries(path).each do |child|
-          if !child.start_with?(".") && child != @preload_file_name && child != @index_file_name
-            child_path = check_path(File.join(path, child))
-            child_word = File.basename(child, ".rb")
-            next_words = words + [child_word]
-            next_remaining_words =
-              if remaining_words.empty?
-                remaining_words
-              elsif child_word == remaining_words.first
-                remaining_words.slice(1..-1)
-              else
-                nil
-              end
-            handle_path(child_path, next_words, next_remaining_words, priority)
-          end
+        require_preload_in(path)
+        load_index_in(path, words, remaining_words, priority)
+        ::Dir.entries(path).each do |child|
+          load_child_in(path, child, words, remaining_words, priority)
         end
       end
     end
 
+    def require_preload_in(path)
+      return unless @preload_file_name
+      preload_path = ::File.join(path, @preload_file_name)
+      preload_path = check_path(preload_path, type: :file, lenient: true)
+      require preload_path if preload_path
+    end
+
+    def load_index_in(path, words, remaining_words, priority)
+      return unless @index_file_name
+      index_path = ::File.join(path, @index_file_name)
+      index_path = check_path(index_path, type: :file, lenient: true)
+      load_path(index_path, words, remaining_words, priority) if index_path
+    end
+
+    def load_child_in(path, child, words, remaining_words, priority)
+      return if child.start_with?(".")
+      return if [@preload_file_name, @index_file_name].include?(child)
+      child_path = check_path(::File.join(path, child))
+      child_word = ::File.basename(child, ".rb")
+      next_words = words + [child_word]
+      next_remaining = Lookup.next_remaining_words(remaining_words, child_word)
+      handle_path(child_path, next_words, next_remaining, priority)
+    end
+
     def check_path(path, lenient: false, type: nil)
-      path = File.expand_path(path)
-      type ||= File.extname(path) == ".rb" ? :file : :dir
+      path = ::File.expand_path(path)
+      type ||= ::File.extname(path) == ".rb" ? :file : :dir
       case type
       when :file
-        if File.directory?(path) || !File.readable?(path)
+        if ::File.directory?(path) || !::File.readable?(path)
           return nil if lenient
           raise LookupError, "Cannot read file #{path}"
         end
       when :dir
-        if !File.directory?(path) || !File.readable?(path)
+        if !::File.directory?(path) || !::File.readable?(path)
           return nil if lenient
           raise LookupError, "Cannot read directory #{path}"
         end
@@ -191,10 +249,23 @@ module Toys
       path
     end
 
+    def sort_tools_by_name(tools)
+      tools.sort do |a, b|
+        a = a.full_name
+        b = b.full_name
+        while !a.empty? && !b.empty? && a.first == b.first
+          a = a.slice(1..-1)
+          b = b.slice(1..-1)
+        end
+        a.first.to_s <=> b.first.to_s
+      end
+    end
+
     def calc_remaining_words(words1, words2)
       index = 0
+      lengths = [words1.length, words2.length]
       loop do
-        return words1.slice(index..-1) if index == words1.length || index == words2.length
+        return words1.slice(index..-1) if lengths.include?(index)
         return nil if words1[index] != words2[index]
         index += 1
       end

data/lib/toys/template.rb

@@ -1,21 +1,50 @@
+# 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
-  class Template
-    def initialize
-      @opts_initializer = ->(opts){opts}
-      @expander = ->(opts){}
+  ##
+  # A template definition. Template classes should include this module.
+  #
+  module Template
+    def self.included(mod)
+      mod.extend(ClassMethods)
     end
 
-    def to_init_opts(&block)
-      @opts_initializer = block
-      self
-    end
+    ##
+    # Class methods that will be added to a template class.
+    #
+    module ClassMethods
+      def to_expand(&block)
+        @expander = block
+      end
 
-    def to_expand(&block)
-      @expander = block
-      self
+      attr_accessor :expander
     end
-
-    attr_reader :opts_initializer
-    attr_reader :expander
   end
 end

data/lib/toys/templates/clean.rb

@@ -0,0 +1,67 @@
+# 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::Templates
+  ##
+  # A template for tools that clean build artifacts
+  #
+  class Clean
+    include ::Toys::Template
+
+    def initialize(opts = {})
+      @name = opts[:name] || "clean"
+      @paths = opts[:paths] || []
+    end
+
+    attr_accessor :name
+    attr_accessor :paths
+
+    to_expand do |template|
+      name(template.name) do
+        short_desc "Clean built files and directories"
+
+        use :file_utils
+
+        execute do
+          files = []
+          patterns = Array(template.paths)
+          patterns = ["lib/**/*.rb"] if patterns.empty?
+          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