kamaze-project 1.0.4 → 1.1.0

data/lib/kamaze/project/tools/packager/filesystem/operator/utils.rb

@@ -1,20 +1,23 @@
 # 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 'pathname'
-require 'fileutils'
-require 'rake/file_utils'
-
 require_relative '../operator'
 
 # Utilities related to files/paths manipulations
 module Kamaze::Project::Tools::Packager::Filesystem::Operator::Utils
-  include FileUtils
+  autoload(:Pathname, 'pathname')
+
+  lambda do
+    require 'fileutils'
+    require 'rake/file_utils'
+
+    include FileUtils
+  end.call
 
   protected
 
@@ -24,11 +27,11 @@ module Kamaze::Project::Tools::Packager::Filesystem::Operator::Utils
   # @return [Pathname]
   def purge(dir, options = {})
     options = { verbose: true }.merge(options)
-    dir = ::Pathname.new(dir)
+    dir = Pathname.new(dir)
 
     if dir.exist?
       ls(dir).each do |entry|
-        rm_rf(dir.join(entry), options)
+        rm_rf(dir.join(entry), **options)
       end
     end
 
@@ -40,13 +43,12 @@ module Kamaze::Project::Tools::Packager::Filesystem::Operator::Utils
   # @param [String|Pathname] basedir
   # @param [Array<>] entries
   # @param [Hash] options
+  #
   # @return [Pathname]
   def skel_dirs(basedir, entries, options = {})
-    basedir = ::Pathname.new(basedir)
-
-    map_dirs(entries).each { |dir| mkdir_p(basedir.join(dir), options) }
-
-    basedir
+    Pathname.new(basedir).tap do
+      map_dirs(entries).each { |dir| mkdir_p(basedir.join(dir), **options) }
+    end
   end
 
   # List entries
@@ -54,9 +56,11 @@ module Kamaze::Project::Tools::Packager::Filesystem::Operator::Utils
   # @param [String] dir
   # @return [Array<Pathname>]
   def ls(dir)
-    ::Pathname.new(dir).entries
-              .map { |path| ::Pathname.new(path) }
-              .delete_if { |path| ['.', '..'].include?(path.basename.to_s) }
+    # @formatter:off
+    Pathname.new(dir).entries
+            .map { |path| ::Pathname.new(path) }
+            .delete_if { |path| ['.', '..'].include?(path.basename.to_s) }
+    # @formatter:on
   end
 
   # Extract directories from given paths
@@ -64,10 +68,12 @@ module Kamaze::Project::Tools::Packager::Filesystem::Operator::Utils
   # @param [Array<String>] paths
   # @return [Array<Pathname>]
   def map_dirs(paths)
+    # @formatter:off
     paths.map { |path| ::Pathname.new(path) }
          .map(&:dirname)
          .delete_if { |path| ['.', '..'].include?(path.basename.to_s) }
          .uniq.sort
+    # @formatter:on
   end
 
   # @return [Array<Symbol>]

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

@@ -1,27 +1,45 @@
 # 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 'etc'
-require 'fileutils'
-require 'pathname'
-require 'tmpdir'
-require 'process_lock'
-
-module Kamaze::Project::Tools
-  class ProcessLocker < BaseTool
-  end
-end
 
 # Process Locker
 #
 # @see https://github.com/ianheggie/process_lock
 class Kamaze::Project::Tools::ProcessLocker < Kamaze::Project::Tools::BaseTool
+  autoload(:Digest, 'digest')
+
+  # @formatter:off
+  {
+    Etc: 'etc',
+    FileUtils: 'fileutils',
+    Pathname: 'pathname',
+    ProcessLock: 'process_lock',
+  }.each { |s, fp| autoload(s, fp) }
+  # @formatter:on
+
+  # @return [String]
+  attr_reader :lockdir
+
+  def mutable_attributes
+    [:lockdir]
+  end
+
+  # Set name for lockdir.
+  #
+  # @see #tmpdir
+  # @see #setup
+  def lockdir=(lockdir)
+    inflector.classify(lockdir).yield_self { |s| inflector.underscore(s) }.tap do |name|
+      @lockdir = name
+    end
+  end
+
   # Manage lock on given block
   #
   # @return [Object]
@@ -37,26 +55,31 @@ class Kamaze::Project::Tools::ProcessLocker < Kamaze::Project::Tools::BaseTool
   def lock!(lockname)
     mklock(lockname).acquire! { yield }
   rescue ProcessLock::AlreadyLocked
+    # noinspection RubyResolve
     raise Errno::EALREADY if mklock(lockname).alive?
+
     raise
   end
 
+  # Get tmpdir where lock files are stored.
+  #
   # @return [Pathname]
   def tmpdir
-    tmp = Pathname.new(Dir.tmpdir)
-    uid = Etc.getpwnam(Etc.getlogin).uid
-    dir = [inflector.underscore(self.class.name).tr('/', '-'), uid].join('.')
+    require 'tmpdir' unless Dir.respond_to?(:tmpdir)
 
-    tmp.join(dir)
+    Pathname.new(Dir.tmpdir).join('%<libname>s.%<uid>s' % { # @formatter:off
+      libname: inflector.underscore(self.class.name).split('/')[0..1].join('-'),
+      uid: Etc.getpwnam(Etc.getlogin).uid, # @formatter:on
+    }, lockdir)
   end
 
   class << self
     def method_missing(method, *args, &block)
       if respond_to_missing?(method)
-        self.new.public_send(method, *args, &block)
-      else
-        super
+        return self.new.public_send(method, *args, &block)
       end
+
+      super
     end
 
     def respond_to_missing?(method, include_private = false)
@@ -68,12 +91,29 @@ class Kamaze::Project::Tools::ProcessLocker < Kamaze::Project::Tools::BaseTool
 
   protected
 
+  # @return [Dry::Inflector]
+  attr_reader :inflector
+
+  # @return [Module<FileUtils>]
+  attr_reader :fs
+
+  def setup
+    @fs ||= FileUtils
+    @inflector ||= Kamaze::Project::Inflector.new
+
+    unless lockdir # rubocop:disable Style/GuardClause
+      self.lockdir = lambda do
+        return Kamaze::Project.instance.name if Kamaze::Project.instance
+
+        Digest::SHA1.hexdigest(__FILE__) # Does not avoid collision if package is globally installed
+      end.call
+    end
+  end
+
   # @param [String] lockname
   # @return [ProcessLock]
   def mklock(lockname)
-    lockfile = mktemp(lockname)
-
-    ProcessLock.new(lockfile)
+    mktemp(lockname).yield_self { |lockfile| ProcessLock.new(lockfile) }
   end
 
   # Create a temporary file
@@ -81,28 +121,17 @@ class Kamaze::Project::Tools::ProcessLocker < Kamaze::Project::Tools::BaseTool
   # @param [String] lockname
   # @return [Pathname]
   def mktemp(lockname)
-    lockname = Pathname.new(lockname.to_s).basename('.*')
-
-    mktmpdir.join(lockname)
+    Pathname.new(lockname.to_s).basename('.*').yield_self { |fp| mktmpdir.join(fp) }
   end
 
   # Create ``tmpdir``
   #
-  # @param [Hash] options
   # @return [Pathname]
-  def mktmpdir(options = {})
-    tmpdir = self.tmpdir
-    options[:mode] ||= 0o700
+  def mktmpdir(**options)
+    self.tmpdir.tap do |tmpdir|
+      options[:mode] ||= 0o700
 
-    FileUtils.mkdir_p(tmpdir, options)
-
-    tmpdir
-  end
-
-  # @return [Dry::Inflector]
-  def inflector
-    require 'dry/inflector'
-
-    Dry::Inflector.new
+      fs.mkdir_p(tmpdir, **options)
+    end
   end
 end

data/lib/kamaze/project/tools/rspec.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.
@@ -67,10 +67,12 @@ class Kamaze::Project::Tools::Rspec < Kamaze::Project::Tools::BaseTool
       @arguments += ['--tag', tag]
     end
 
+    # @formatter:off
     {
-      true  => @arguments,
+      true => @arguments,
       false => @arguments.clone.concat(options_arguments).map(&:to_s).freeze
-    }.fetch(caller_locations(1..1).first.path == __FILE__)
+    }.fetch(caller_locations(1..1).first&.path == __FILE__)
+    # @formatter:on
   end
 
   protected

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

@@ -1,30 +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 '../tools'
-require_relative '../concern/cli/with_exit_on_failure'
-require 'pathname'
-
-# rubocop:disable Style/Documentation
-
-module Kamaze::Project::Tools
-  class Rubocop < BaseTool
-    class Arguments < Array
-      require_relative 'rubocop/arguments'
-    end
-
-    class Config
-      require_relative 'rubocop/config'
-    end
-  end
-end
-
-# rubocop:enable Style/Documentation
 
 # Tool to run ``Rubocop::CLI``
 #
@@ -36,7 +18,17 @@ end
 #   c.options = ['--fail-level', 'E']
 # end.run
 # ```
-class Kamaze::Project::Tools::Rubocop
+class Kamaze::Project::Tools::Rubocop < Kamaze::Project::Tools::BaseTool
+  # @formatter:off
+  {
+    Arguments: 'arguments',
+    Config: 'config',
+  }.each { |s, fp| autoload(s, "#{__dir__}/rubocop/#{fp}") }
+  # @formatter:on
+
+  autoload(:Pathname, 'pathname')
+  autoload(:RuboCop, 'rubocop')
+
   include Kamaze::Project::Concern::Cli::WithExitOnFailure
 
   # Default arguments used by ``Rubocop::CLI``
@@ -50,17 +42,18 @@ class Kamaze::Project::Tools::Rubocop
   end
 
   def prepare
-    reset
+    self.tap do
+      reset
 
-    if block_given?
-      config = Config.new
-      yield(config)
-      arguments.concat(config.freeze.to_a)
-    end
-
-    arguments.freeze
+      if block_given?
+        Config.new.tap do |config|
+          yield(config)
+          arguments.concat(config.freeze.to_a)
+        end
+      end
 
-    self
+      arguments.freeze
+    end
   end
 
   # Arguments used by ``CLI`` (during execution/``run``)
@@ -92,10 +85,8 @@ class Kamaze::Project::Tools::Rubocop
 
     if runnable?
       with_exit_on_failure do
-        core.run(arguments.to_a).yield_self do |retcode|
-          self.retcode = retcode
-          reset
-        end
+        core.run(arguments.to_a).tap { |retcode| self.retcode = retcode }
+        reset
       end
     end
 
@@ -107,23 +98,21 @@ class Kamaze::Project::Tools::Rubocop
   attr_writer :arguments
 
   def setup
-    @defaults = Arguments.new(@defaults.to_a)
+    @defaults = Arguments.new((@defaults || ['--only-recognized-file-types']).to_a)
   end
 
   # Reset arguments + retcode
   #
   # @return [self]
   def reset
-    @arguments = nil
-    self.retcode = nil if retcode.to_i.zero?
-
-    self
+    self.tap do
+      @arguments = nil
+      self.retcode = nil if retcode.to_i.zero?
+    end
   end
 
-  # @return [YARD::CLI::Yardoc]
+  # @return [RuboCop::CLI]
   def core
-    require 'rubocop'
-
     RuboCop::CLI.new
   end
 end

data/lib/kamaze/project/tools/rubocop/arguments.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/rubocop/config.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.
@@ -26,9 +26,7 @@ class Kamaze::Project::Tools::Rubocop::Config
 
   # @return [Array<String>]
   def to_a
-    filepaths = match_patterns(patterns)
-
-    self.options.to_a.clone.concat(['--'] + filepaths)
+    self.options.to_a.clone.concat(['--']).concat(match_patterns(patterns))
   end
 
   protected

data/lib/kamaze/project/tools/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.
@@ -43,7 +43,7 @@ class Kamaze::Project::Tools::Shell < Kamaze::Project::Tools::BaseTool
 
   def setup
     @console ||= Kamaze.project.tools.fetch(:console)
-    @provider ||= require_any(:pry) ? Pry : nil
+    @provider ||= require_any(:pry) ? Object.const_get(:Pry) : nil
     @banner ||= nil
   end
 
@@ -69,16 +69,15 @@ class Kamaze::Project::Tools::Shell < Kamaze::Project::Tools::BaseTool
   # Require any gem based on ``Gem::Specification``
   #
   # @param [String|Symbol] gem_name
-  # @param [String|Symbol] req_name
+  # @param [Array|nil] requirements
   # @return [Boolean]
-  def require_any(gem_name, req_name = nil)
+  def require_any(gem_name, requirements = nil)
     gem_name = gem_name.to_s
-    req_name ||= gem_name
-    spec = Gem::Specification
+    requirements ||= [gem_name]
 
-    return false unless spec.find_all_by_name(gem_name).any?
+    return false unless Gem::Specification.find_all_by_name(gem_name).any?
 
-    require req_name
+    requirements.each { |req| require req.to_s }
 
     true
   end