kamaze-project 1.0.4 → 1.1.0

data/lib/kamaze/project/tools/vagrant.rb

@@ -1,29 +1,15 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.
 # There is NO WARRANTY, to the extent permitted by law.
 
 require_relative '../tools'
-require_relative 'base_tool'
 require 'base64'
 require 'pathname'
 
-# rubocop:disable Style/Documentation
-
-module Kamaze::Project::Tools
-  class Vagrant < BaseTool
-  end
-
-  [:composer, :shell, :writer, :remote].each do |req|
-    require_relative "vagrant/#{req}"
-  end
-end
-
-# rubocop:enable Style/Documentation
-
 # Vagrant based,
 # this class provides a easy and ready to use wrapper around ``vagrant``
 # executable. VM configuration is easyfied by the use of YAML files.
@@ -53,7 +39,11 @@ end
 #
 # @see http://yaml.org/YAML_for_ruby.html
 # @see https://friendsofvagrant.github.io/v1/docs/boxes.html
-class Kamaze::Project::Tools::Vagrant
+class Kamaze::Project::Tools::Vagrant < Kamaze::Project::Tools::BaseTool
+  [:composer, :shell, :writer, :remote].each do |req|
+    require_relative "vagrant/#{req}"
+  end
+
   # Template file (used for code generation)
   #
   # @return [String]

data/lib/kamaze/project/tools/vagrant/composer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.

data/lib/kamaze/project/tools/vagrant/composer/file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.

data/lib/kamaze/project/tools/vagrant/remote.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.

data/lib/kamaze/project/tools/vagrant/shell.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.

data/lib/kamaze/project/tools/vagrant/writer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.

data/lib/kamaze/project/tools/yardoc.rb

@@ -1,30 +1,28 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.
 # There is NO WARRANTY, to the extent permitted by law.
 
 require_relative '../tools'
-require 'pathname'
-
-# rubocop:disable Style/Documentation
-
-module Kamaze::Project::Tools
-  class Yardoc < BaseTool
-  end
-
-  require_relative 'yardoc/file'
-  require_relative 'yardoc/watchable'
-end
-
-# rubocop:enable Style/Documentation
 
 # Tool to run ``CLI::Yardoc`` and generate documentation
 #
 # @see https://github.com/lsegal/yard/blob/49d885f29075cfef4cb954bb9247b6fbc8318cac/lib/yard/rake/yardoc_task.rb
-class Kamaze::Project::Tools::Yardoc
+class Kamaze::Project::Tools::Yardoc < Kamaze::Project::Tools::BaseTool
+  autoload(:Pathname, 'pathname')
+  autoload(:YARD, 'yard')
+
+  # @formatter:off
+  {
+    File: 'file',
+    Watchable: 'watchable',
+    Watcher: 'watcher',
+  }.each { |s, fp| autoload(s, "#{__dir__}/yardoc/#{fp}") }
+  # @formatter:on
+
   include Watchable
 
   # Options used by ``YARD::CLI::Yardoc``
@@ -65,10 +63,8 @@ class Kamaze::Project::Tools::Yardoc
 
   # @return [YARD::CLI::Yardoc]
   def core
-    require 'yard'
-
     YARD::CLI::Yardoc.new.tap do |yard|
-      yard.parse_arguments([])
+      yard.parse_arguments
 
       options.to_h.each { |k, v| yard.options[k.to_sym] = v }
     end

data/lib/kamaze/project/tools/yardoc/file.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.
 # There is NO WARRANTY, to the extent permitted by law.
 
 require_relative '../yardoc'
-require 'pathname'
 
 # Describe a "file"
 #
@@ -16,9 +15,12 @@ require 'pathname'
 # as a glob expression, else file (``filepath``)  is a fixed string.
 # Thus, file is castable to ``Array``.
 class Kamaze::Project::Tools::Yardoc::File
+  autoload(:Pathname, 'pathname')
+
   # @param [String] filepath
   # @param [Boolean] glob
   def initialize(filepath, glob = false)
+    # noinspection RubySimplifyBooleanInspection
     @glob = !!glob
     @filepath = filepath.to_s
   end
@@ -27,13 +29,11 @@ class Kamaze::Project::Tools::Yardoc::File
   def paths
     proc do
       if glob?
-        Dir.glob(filepath).map { |f| ::Pathname.new(f).dirname }
+        Dir.glob(filepath).map { |f| Pathname.new(f).dirname }
       else
-        [::Pathname.new(filepath).dirname]
+        [Pathname.new(filepath).dirname]
       end
-    end.call.uniq.sort.map do |f|
-      ::Pathname.new(f.to_s.gsub('./', ''))
-    end
+    end.call.uniq.sort.map { |f| Pathname.new(f.to_s.gsub('./', '')) }
   end
 
   # Denote file MUST be evaluated as a glob expression

data/lib/kamaze/project/tools/yardoc/watchable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.
@@ -8,19 +8,6 @@
 
 require_relative '../yardoc'
 
-# rubocop:disable Style/Documentation
-
-class Kamaze::Project::Tools::Yardoc
-  module Watchable
-    class File < Kamaze::Project::Tools::Yardoc::File
-    end
-
-    private_constant :File
-  end
-end
-
-# rubocop:enable Style/Documentation
-
 # Provide watch related methods
 #
 # Yardoc (wrapper class) is used by a Watcher using tools
@@ -31,12 +18,17 @@ end
 #
 # Instance of ``YARD::CLI::Yardoc`` is retrieved through ``core`` method
 module Kamaze::Project::Tools::Yardoc::Watchable
+  class File < Kamaze::Project::Tools::Yardoc::File
+  end
+
+  private_constant :File
+
   # Get paths
   #
   # @return [Array<Pathname>]
   def paths
     files.map do |file|
-      file.to_a.sort[0]
+      file.to_a.min
     end.flatten.compact.uniq.sort
   end
 
@@ -55,10 +47,12 @@ module Kamaze::Project::Tools::Yardoc::Watchable
   #
   # @return [Array<Kamaze::Project::Tools::Yardoc::File>]
   def files
+    # @formatter:off
     [
       core.files.to_a.flatten.map { |f| File.new(f, true) },
       core.options.files.to_a.map { |f| File.new(f.filename, false) }
     ].flatten
+    # @formatter:on
   end
 
   # Ignores files matching path match (regexp)

data/lib/kamaze/project/tools/yardoc/watcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.
@@ -8,13 +8,13 @@
 
 require_relative '../yardoc'
 
-class Kamaze::Project::Tools::Yardoc
-  class Watcher < Kamaze::Project::Tools::BaseTool
-  end
-end
-
 # Provide a watcher built on top of Yardoc
-class Kamaze::Project::Tools::Yardoc::Watcher
+class Kamaze::Project::Tools::Yardoc::Watcher < Kamaze::Project::Tools::BaseTool
+  autoload(:Listen, 'listen')
+
+  # @return [Kamaze::Project::Tools::Yardoc]
+  attr_accessor :yardoc
+
   # @type [Array<String>]
   attr_writer :paths
 
@@ -26,21 +26,18 @@ class Kamaze::Project::Tools::Yardoc::Watcher
 
   # Watch for changes
   #
-  # Non-blocking, unless ``wait``
+  # Non-blocking, unless ``wait`` (bool)
   #
   # @param [Boolean] wait
   # @return [self]
   def watch(wait = false)
-    listener = ::Listen.to(*paths, options) do |mod, add, rem|
-      if trigger?(mod + add + rem)
-        yardoc.run
-      end
-    end
-
-    listener.start
-    sleep if wait
+    self.tap do
+      Listen.to(*paths, options) do |mod, add, rem|
+        yardoc.run if trigger?(*mod.concat(add).concat(rem))
+      end.tap(&:start)
 
-    self
+      sleep if wait
+    end
   end
 
   # @return [Array<String>]
@@ -50,13 +47,13 @@ class Kamaze::Project::Tools::Yardoc::Watcher
 
   # @return [Array<String>]
   def paths
-    paths = @paths.map(&:to_s)
-
-    paths.include?('.') ? ['.'] : paths
+    @paths.map(&:to_s).tap do |paths|
+      return paths.include?('.') ? ['.'] : paths
+    end
   end
 
   def mutable_attributes
-    [:paths, :options, :patterns]
+    [:yardoc, :paths, :options, :patterns]
   end
 
   protected
@@ -64,10 +61,8 @@ class Kamaze::Project::Tools::Yardoc::Watcher
   # Transform paths to relative paths
   #
   # @param [String|Pathname|Array<String>] paths
-  def rel(paths)
-    paths = [paths] unless paths.is_a?(Array)
-
-    paths.map do |path|
+  def relative(*paths)
+    (paths.is_a?(Array) ? paths : [paths]).map do |path|
       path.to_s.gsub(%r{^#{Dir.pwd}/+}, '')
     end
   end
@@ -76,31 +71,29 @@ class Kamaze::Project::Tools::Yardoc::Watcher
   #
   # @param [String|Pathname|Array<String>] paths
   # @return [Boolean]
-  def trigger?(paths)
-    paths = [paths] unless paths.is_a?(Array)
-
+  def trigger?(*paths)
+    # @formatter:off
     paths.map(&:to_s)
-         .map { |path| rel(path)[0] }
+         .map { |path| relative(path)[0] }
          .each do |path|
       patterns.each do |pattern|
         return true if File.fnmatch(pattern, path, File::FNM_PATHNAME)
       end
+      # @formatter:on
     end
 
     false
   end
 
   def setup
+    @yardoc ||= Kamaze::Project.instance.tools.fetch('yardoc')
     @paths ||= yardoc.paths
     @patterns ||= yardoc.patterns
+    # @formatter:off
     @options = {
-      only:   /\.(rb|md)$/,
+      only: /\.(rb|md)$/,
       ignore: yardoc.excluded.map { |pattern| /#{pattern}/ }
     }.merge(@options.to_h)
-  end
-
-  # @return [Kamaze::Project::Tools::Yardoc]
-  def yardoc
-    Kamaze.project.tools.fetch('yardoc')
+    # @formatter:on
   end
 end

data/lib/kamaze/project/tools_provider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
 # License GPLv3+: GNU GPL version 3 or later
 # <http://www.gnu.org/licenses/gpl.html>.
 # This is free software: you are free to change and redistribute it.
@@ -8,15 +8,6 @@
 
 require_relative '../project'
 
-class Kamaze::Project
-  class ToolsProvider
-    class Resolver
-    end
-  end
-end
-
-require_relative 'tools_provider/resolver'
-
 # Tools provider
 #
 # Tools are instantiated on demand,
@@ -33,6 +24,12 @@ require_relative 'tools_provider/resolver'
 # end
 # ```
 class Kamaze::Project::ToolsProvider
+  # @formatter:off
+  {
+    Resolver: 'resolver',
+  }.each { |s, fp| autoload(s, "#{__dir__}/tools_provider/#{fp}") }
+  # @formatter:on
+
   class << self
     # Default tools
     #
@@ -52,29 +49,26 @@ class Kamaze::Project::ToolsProvider
     #
     # @return [Hash]
     def items
-      config = "#{__dir__}/resources/config/tools.yml"
-      defaults = YAML.load_file(config)
-
-      Hash[defaults.collect { |k, v| [k.to_sym, v] }]
+      "#{__dir__}/resources/config/tools.yml"
+        .yield_self { |file| YAML.load_file(file) }
+        .yield_self do |defaults|
+        defaults.transform_keys(&:to_sym)
+      end
     end
   end
 
   # @param [Hash] items
   def initialize(items = {})
     @items = Hash[self.class.defaults].merge(items)
-    @cache = {}
     @resolver = Resolver.new
   end
 
   # @param [Hash] items
   # @return [self]
   def merge!(items)
-    items = Hash[items.map { |k, v| [k.to_sym, v] }]
-    @cache.delete_if { |k| items.member?(k) }
-
-    @items.merge!(items)
-
-    self
+    self.tap do
+      items.transform_keys(&:to_sym).tap { |h| @items.merge!(h) }
+    end
   end
 
   # Associates the value given by value with the given key.
@@ -82,7 +76,9 @@ class Kamaze::Project::ToolsProvider
   # @param [String|Symbol] name
   # @param [Class] value
   def []=(name, value)
-    merge!(name => value)
+    value.tap do
+      { name => value }.tap { |h| merge!(h) }
+    end
   end
 
   # Prevents further modifications.
@@ -91,8 +87,9 @@ class Kamaze::Project::ToolsProvider
   #
   # @return [self]
   def freeze
-    @items.freeze
-    super
+    super.tap do
+      @items.freeze
+    end
   end
 
   # Get a fresh instance with given name
@@ -115,11 +112,9 @@ class Kamaze::Project::ToolsProvider
 
     return nil unless member?(name)
 
-    @cache[name] ||= @items.fetch(name).yield_self do |klass|
-      resolver.classify(klass)
+    self.items.fetch(name).yield_self do |klass|
+      resolver.classify(klass).new
     end
-
-    @cache.fetch(name).new
   end
 
   alias get fetch
@@ -128,10 +123,10 @@ class Kamaze::Project::ToolsProvider
   #
   # @return [Hash]
   def to_h
-    @items
-      .map { |k, v| [k, @cache[k] ||= resolver.classify(v)] }
-      .yield_self { |results| Hash[results] }
-      .yield_self { |items| Hash[items.collect { |k, v| [k, v.new] }] }
+    self.items
+        .map { |k, v| [k, resolver.classify(v)] }
+        .yield_self { |results| Hash[results] }
+        .yield_self { |items| items.transform_values(&:new) }
   end
 
   # Returns ``true`` if the given key is present
@@ -139,9 +134,7 @@ class Kamaze::Project::ToolsProvider
   # @param [Symbol|String] name
   # @return [Boolean]
   def member?(name)
-    name = name.to_sym
-
-    @items.member?(name)
+    self.items.member?(name.to_sym)
   end
 
   protected
@@ -153,9 +146,4 @@ class Kamaze::Project::ToolsProvider
   #
   # @return [Hash]
   attr_reader :items
-
-  # Used to avoid classes resolution.
-  #
-  # @return [Hash]
-  attr_reader :cache
 end