toys 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4a2d413fba0285f718e4d586832a78010060e68e52ad2f0ef7df54e4295a71b6
-  data.tar.gz: 431cbcb0425cf2bcde91c145a574238293d83c47b81668abf9c67de6cc16d6cc
+SHA1:
+  metadata.gz: f036d1f723d27ed317a4aaac039147badbc21c55
+  data.tar.gz: 72974b402f863e4f07da29411393021c80728128
 SHA512:
-  metadata.gz: 2f7988dd0108eb50afc3a44dabf5b2d3a04f272af2c6d58135a525250d50c42d5e7902e1f1c07768cabb80fb88cfca0e8a2513fe2a5274a7c1a1d1ac90c02650
-  data.tar.gz: b5199ca795795821bc7ba6605ec276995e9a29b73c597c5700424de0a0f01ba5d9a39392d24528c981e9d05956dbbd2691aeb513a22413ff84610ce122d29ee1
+  metadata.gz: 4d1b8ab307213db7030cceee42c910bb21fa253cdc953654a7bcb611c2cd0ec71c2509c75b5e18bc833394d08b4d4c1bf8f3e8a707c486fe16de277cc6e7a0f1
+  data.tar.gz: 82177adaf1bd37799aaa83a031690fc8e908a0292d3ad618cb51afbc192f269e148a6a192727ed91cc95dd3e042e1660e3d47f338731f4f6db6ebc57b960d44f

data/LICENSE.md

@@ -0,0 +1,29 @@
+# License
+
+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.

data/README.md

@@ -0,0 +1,36 @@
+# Toys
+
+Toys is a Ruby library and command line tool that lets you build your own
+command line suite of tools (with commands and subcommands) using a Ruby DSL.
+You can define commands globally or configure special commands scoped to
+individual directories.
+
+## Installation
+
+This software is distributed as a Ruby gem and may be installed using:
+
+```
+gem install toys
+```
+
+## Usage
+
+(TODO)
+
+## Contributing
+
+While we appreciate contributions, please note that this software is currently
+highly experimental, and the code is evolving very rapidly. Please contact the
+author before embarking on a major pull request. More detailed contribution
+guidelines will be provided when the software stabilizes further.
+
+The source can be found on Github at
+[https://github.com/dazuma/toys](https://github.com/dazuma/toys)
+
+## License
+
+Copyright 2018 Daniel Azuma
+
+This software is licensed under the 3-clause BSD license.
+
+See the LICENSE.md file for more information.

data/bin/toys

@@ -1,6 +1,35 @@
 #!/usr/bin/env ruby
 
-$:.unshift(File.absolute_path(File.join(File.dirname(__dir__), "lib")))
+# 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.
+;
+
+$LOAD_PATH.unshift(::File.absolute_path(::File.join(::File.dirname(__dir__), "lib")))
 require "toys"
 
-Toys::Cli.create_standard.run(ARGV)
+::Toys::CLI.create_standard.run(::ARGV)

data/lib/toys.rb

@@ -1,11 +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.
+;
+
+##
+# Toys is a Ruby library and command line tool that lets you build your own
+# command line suite of tools (with commands and subcommands) using a Ruby DSL.
+# You can define commands globally or configure special commands scoped to
+# individual directories.
+#
 module Toys
+  ##
+  # Namespace for common helper modules
+  #
+  module Helpers; end
+
+  ##
+  # Namespace for common templates
+  #
+  module Templates; end
 end
 
+require "toys/builder"
 require "toys/cli"
 require "toys/context"
 require "toys/errors"
 require "toys/lookup"
-require "toys/parser"
 require "toys/template"
 require "toys/tool"
 require "toys/version"

data/lib/toys/builder.rb

@@ -0,0 +1,162 @@
+# 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 object context in effect in a toys configuration file
+  #
+  class Builder
+    def initialize(path, tool, remaining_words, priority, lookup)
+      @path = path
+      @tool = tool
+      @remaining_words = remaining_words
+      @priority = priority
+      @lookup = lookup
+    end
+
+    def name(word, alias_of: nil, &block)
+      word = word.to_s
+      subtool = @lookup.get_tool(@tool.full_name + [word], @priority)
+      return self if subtool.nil?
+      if alias_of
+        if block
+          raise ToolDefinitionError, "Cannot take a block with alias_of"
+        end
+        subtool.make_alias_of_word(alias_of.to_s)
+        return self
+      end
+      next_remaining = Lookup.next_remaining_words(@remaining_words, word)
+      Builder.build(@path, subtool, next_remaining, @priority, @lookup, block)
+      self
+    end
+
+    def alias_as(word)
+      if @tool.root?
+        raise ToolDefinitionError, "Cannot make an alias of the root tool"
+      end
+      alias_name = @tool.full_name.slice(0..-2) + [word.to_s]
+      alias_tool = @lookup.get_tool(alias_name, @priority)
+      alias_tool.make_alias_of(@tool.simple_name) if alias_tool
+      self
+    end
+
+    def alias_of(word)
+      @tool.make_alias_of(word.to_s)
+      self
+    end
+
+    def include(path)
+      @tool.yield_definition do
+        @lookup.include_path(path, @tool.full_name, @remaining_words, @priority)
+      end
+      self
+    end
+
+    def expand(template_class, *args)
+      unless template_class.is_a?(::Class)
+        template_class = template_class.to_s
+        file_name =
+          template_class
+          .gsub(/([a-zA-Z])([A-Z])/) { |_m| "#{$1}_#{$2.downcase}" }
+          .downcase
+        require "toys/templates/#{file_name}"
+        const_name = template_class.gsub(/(^|_)([a-zA-Z0-9])/) { |_m| $2.upcase }
+        template_class = Templates.const_get(const_name)
+      end
+      template = template_class.new(*args)
+      yield template if block_given?
+      instance_exec(template, &template_class.expander)
+      self
+    end
+
+    def long_desc(desc)
+      @tool.long_desc = desc
+      self
+    end
+
+    def short_desc(desc)
+      @tool.short_desc = desc
+      self
+    end
+
+    def switch(key, *switches, accept: nil, default: nil, doc: nil)
+      @tool.add_switch(key, *switches, accept: accept, default: default, doc: doc)
+      self
+    end
+
+    def required_arg(key, accept: nil, doc: nil)
+      @tool.add_required_arg(key, accept: accept, doc: doc)
+      self
+    end
+
+    def optional_arg(key, accept: nil, default: nil, doc: nil)
+      @tool.add_optional_arg(key, accept: accept, default: default, doc: doc)
+      self
+    end
+
+    def remaining_args(key, accept: nil, default: [], doc: nil)
+      @tool.set_remaining_args(key, accept: accept, default: default, doc: doc)
+      self
+    end
+
+    def execute(&block)
+      @tool.executor = block
+      self
+    end
+
+    def helper(name, &block)
+      @tool.add_helper(name, &block)
+      self
+    end
+
+    def use(mod)
+      @tool.use_module(mod)
+      self
+    end
+
+    def _binding
+      binding
+    end
+
+    def self.build(path, tool, remaining_words, priority, lookup, source)
+      builder = new(path, tool, remaining_words, priority, lookup)
+      tool.defining_from(path) do
+        case source
+        when String
+          # rubocop:disable Security/Eval
+          eval(source, builder._binding, path, 1)
+          # rubocop:enable Security/Eval
+        when ::Proc
+          builder.instance_eval(&source)
+        end
+      end
+      tool
+    end
+  end
+end

data/lib/toys/builtins/system.rb

@@ -1,20 +1,43 @@
-short_desc "A collection of system commands for toys"
-long_desc "A collection of system commands for toys"
+# 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.
+;
 
+short_desc "A collection of system commands for toys"
 
 name "version" do
-
   short_desc "Print current toys version"
 
   execute do
-    puts Toys::VERSION
+    puts ::Toys::VERSION
   end
-
 end
 
-
 name "update" do
-
   short_desc "Update toys if a newer version is available"
 
   use :exec
@@ -22,8 +45,8 @@ name "update" do
   execute do
     version_info = capture("gem query -q -r -e toys")
     if version_info =~ /toys\s\((.+)\)/
-      latest_version = Gem::Version.new($1)
-      cur_version = Gem::Version.new(Toys::VERSION)
+      latest_version = ::Gem::Version.new($1)
+      cur_version = ::Gem::Version.new(::Toys::VERSION)
       if latest_version > cur_version
         logger.warn("Updating toys from #{cur_version} to #{latest_version}...")
         sh("gem install toys")
@@ -35,5 +58,4 @@ name "update" do
       exit(1)
     end
   end
-
 end

data/lib/toys/cli.rb

@@ -1,10 +1,68 @@
+# 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 "logger"
+
 module Toys
-  class Cli
-    BUILTINS_PATH = File.join(__dir__, "builtins")
-    DEFAULT_DIR_NAME = ".toys"
-    DEFAULT_FILE_NAME = ".toys.rb"
-    DEFAULT_BINARY_NAME = "toys"
-    DEFAULT_PRELOAD_NAME = ".preload.rb"
+  ##
+  # A Toys-based CLI
+  #
+  class CLI
+    ##
+    # Path to default builtins
+    # @return [String]
+    #
+    BUILTINS_PATH = ::File.join(__dir__, "builtins").freeze
+
+    ##
+    # Default name of toys configuration directory
+    # @return [String]
+    #
+    DEFAULT_DIR_NAME = ".toys".freeze
+
+    ##
+    # Default name of toys configuration file
+    # @return [String]
+    #
+    DEFAULT_FILE_NAME = ".toys.rb".freeze
+
+    ##
+    # Default name of toys preload file
+    # @return [String]
+    #
+    DEFAULT_PRELOAD_NAME = ".preload.rb".freeze
+
+    ##
+    # Default name of toys binary
+    # @return [String]
+    #
+    DEFAULT_BINARY_NAME = "toys".freeze
 
     def initialize(
       binary_name: nil,
@@ -14,15 +72,13 @@ module Toys
       index_file_name: nil,
       preload_file_name: nil
     )
-      @lookup = Toys::Lookup.new(
+      @lookup = Lookup.new(
         config_dir_name: config_dir_name,
         config_file_name: config_file_name,
         index_file_name: index_file_name,
-        preload_file_name: preload_file_name)
-      @context = Context.new(
-        @lookup,
-        logger: logger || self.class.default_logger,
-        binary_name: binary_name)
+        preload_file_name: preload_file_name
+      )
+      @context_base = Context::Base.new(@lookup, binary_name, logger || self.class.default_logger)
     end
 
     def add_paths(paths)
@@ -35,13 +91,13 @@ module Toys
       self
     end
 
-    def add_config_path_hierarchy(path=nil, base="/")
-      path ||= Dir.pwd
+    def add_config_path_hierarchy(path = nil, base = "/")
+      path ||= ::Dir.pwd
       paths = []
       loop do
         paths << path
         break if !base || path == base
-        next_path = File.dirname(path)
+        next_path = ::File.dirname(path)
         break if next_path == path
         path = next_path
       end
@@ -50,16 +106,16 @@ module Toys
     end
 
     def add_standard_config_paths
-      toys_path = ENV["TOYS_PATH"].to_s.split(File::PATH_SEPARATOR)
-      if toys_path.size == 0
-        toys_path << ENV["HOME"] if ENV["HOME"]
-        toys_path << "/etc" if File.directory?("/etc") && File.readable?("/etc")
+      toys_path = ::ENV["TOYS_PATH"].to_s.split(::File::PATH_SEPARATOR)
+      if toys_path.empty?
+        toys_path << ::ENV["HOME"] if ::ENV["HOME"]
+        toys_path << "/etc" if File.directory?("/etc") && ::File.readable?("/etc")
       end
       @lookup.add_config_paths(toys_path)
     end
 
     def run(*args)
-      @context.run(*args)
+      @context_base.run(*args)
     end
 
     class << self
@@ -78,21 +134,21 @@ module Toys
       end
 
       def default_logger
-        logger = Logger.new(STDERR)
-        logger.formatter = ->(severity, time, progname, msg) {
+        logger = ::Logger.new(::STDERR)
+        logger.formatter = proc do |severity, time, _progname, msg|
           msg_str =
             case msg
-            when String
+            when ::String
               msg
-            when Exception
+            when ::Exception
               "#{msg.message} (#{msg.class})\n" << (msg.backtrace || []).join("\n")
             else
               msg.inspect
             end
           timestr = time.strftime("%Y-%m-%d %H:%M:%S")
-          "[%s %5s]  %s\n" % [timestr, severity, msg_str]
-        }
-        logger.level = Logger::WARN
+          format("[%s %5s]  %s\n", timestr, severity, msg_str)
+        end
+        logger.level = ::Logger::WARN
         logger
       end
     end