kamaze-project 1.0.4 → 1.1.0

data/lib/kamaze/project/tools/gemspec/writer/dependency.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/git.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.
@@ -10,30 +10,18 @@ require_relative '../tools'
 require_relative 'base_tool'
 require 'pathname'
 
-# rubocop:disable Style/Documentation
-
-module Kamaze::Project::Tools
-  class Git < BaseTool
-    # @abstract
-    class Util
-    end
-
-    class Status
-    end
-
-    class Hooks < Util
-    end
-  end
-
-  [:util,
-   :hooks,
-   :status].each { |req| require_relative "git/#{req}" }
-end
+# Provide a wrapper based on ``rugged`` (``libgit2``}
+class Kamaze::Project::Tools::Git < Kamaze::Project::Tools::BaseTool
+  autoload(:Rugged, 'rugged')
 
-# rubocop:enable Style/Documentation
+  # @formatter:off
+  {
+    Util: 'util',
+    Hooks: 'hooks',
+    Status: 'status',
+  }.each { |k, v| autoload(k, "#{__dir__}/git/#{v}") }
+  # @formatter:on
 
-# Provide a wrapper based on ``rugged`` (``libgit2``}
-class Kamaze::Project::Tools::Git
   # @return [String]
   attr_writer :base_dir
 
@@ -65,7 +53,7 @@ class Kamaze::Project::Tools::Git
 
   # Get status
   #
-  # @return [Hash]
+  # @return [Status]
   def status
     status = {}
     repository.status { |file, data| status[file] = data }
@@ -84,12 +72,6 @@ class Kamaze::Project::Tools::Git
 
   def setup
     @base_dir ||= Dir.pwd
-    begin
-      require 'rugged'
-      @repository = Rugged::Repository.new(base_dir.to_s)
-    rescue LoadError, Rugged::RepositoryError
-      # @todo Load error SHOULD be stored (as a boolean?)
-      @repository = nil
-    end
+    @repository = Rugged::Repository.new(base_dir.to_s)
   end
 end

data/lib/kamaze/project/tools/git/hooks.rb

@@ -1,19 +1,25 @@
 # 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 '../git'
-require_relative 'hooks/base_hook'
 require 'kamaze/project/concern/helper'
 
 # Provide hooks
 #
 # Kind of factory registering and building hooks
-class Kamaze::Project::Tools::Git::Hooks
+class Kamaze::Project::Tools::Git::Hooks < Kamaze::Project::Tools::Git::Util
+  # @formatter:off
+  {
+    BaseHook: 'base_hook',
+    PreCommit: 'pre_commit',
+  }.each { |k, v| autoload(k, "#{__dir__}/hooks/#{v}") }
+  # @formatter:on
+
   class << self
     include Kamaze::Project::Concern::Helper
 
@@ -43,9 +49,9 @@ class Kamaze::Project::Tools::Git::Hooks
 
     [:pre_commit].each { |n| self.class.register(n) }
 
-    self.class
-        .registered_hooks
-        .each { |name, klass| @hooks[name] = klass.new(repository) }
+    self.class.registered_hooks.each do |name, klass|
+      @hooks[name] = klass.new(repository)
+    end
   end
 
   # @return [Hash]

data/lib/kamaze/project/tools/git/hooks/base_hook.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.
@@ -9,18 +9,10 @@
 require_relative '../hooks'
 require_relative '../../../concern/cli/with_exit_on_failure'
 
-# rubocop:disable Style/Documentation
-
-class Kamaze::Project::Tools::Git::Hooks
-  class BaseHook
-    include Kamaze::Project::Concern::Cli::WithExitOnFailure
-  end
-end
-
-# rubocop:enable Style/Documentation
-
 # Base Hook
 class Kamaze::Project::Tools::Git::Hooks::BaseHook
+  include Kamaze::Project::Concern::Cli::WithExitOnFailure
+
   # @param [Kamaze::Project::Tools::Git] repository
   def initialize(repository)
     @repository = repository

data/lib/kamaze/project/tools/git/hooks/pre_commit.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.
@@ -9,11 +9,6 @@
 require_relative '../hooks'
 require_relative 'base_hook'
 
-class Kamaze::Project::Tools::Git::Hooks
-  class PreCommit < BaseHook
-  end
-end
-
 # PreCommit hook
 #
 # Provide helper methods intended to write hooks relating to pre-commit
@@ -29,7 +24,7 @@ end
 #   exit(retcode) unless retcode.zero?
 # end
 # ```
-class Kamaze::Project::Tools::Git::Hooks::PreCommit
+class Kamaze::Project::Tools::Git::Hooks::PreCommit < Kamaze::Project::Tools::Git::Hooks::BaseHook
   # Process index (files)
   #
   # Exits with a status code, raising ``SystemExit``.
@@ -72,6 +67,7 @@ class Kamaze::Project::Tools::Git::Hooks::PreCommit
         options[key] = options.keys.include?(key) ? !!options[key] : false
 
         next if options[key]
+
         self.retcode = v.const_get(:Errno) if index.public_send("#{type}?")
       end
     end

data/lib/kamaze/project/tools/git/status.rb

@@ -1,17 +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 '../git'
-require_relative 'status/file'
-require_relative 'status/index'
-require_relative 'status/worktree'
-require_relative 'status/decorator'
-require 'pathname'
 
 # Provide status
 #
@@ -22,6 +17,17 @@ require 'pathname'
 #
 # @see Kamaze::Project::Tools::Git::Status::File
 class Kamaze::Project::Tools::Git::Status
+  autoload(:Pathname, 'pathname')
+
+  # @formatter:off
+  {
+    File: 'file',
+    Index: 'index',
+    Worktree: 'worktree',
+    Decorator: 'decorator',
+  }.each { |k, v| autoload(k, "#{__dir__}/status/#{v}") }
+  # @formatter:on
+
   # @return [Pathname]
   attr_reader :base_dir
 
@@ -77,9 +83,7 @@ class Kamaze::Project::Tools::Git::Status
   #
   # @return [Hash]
   def cached
-    @cached ||= prepared
-
-    @cached
+    (@cached ||= prepared)
   end
 
   # Get prepared filepaths with symbols (states)

data/lib/kamaze/project/tools/git/status/decorator.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/git/status/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.
@@ -45,6 +45,7 @@ class Kamaze::Project::Tools::Git::Status::File
   # @return [String]
   def status
     return '??' if untracked?
+
     states = [' ', ' ']
     mapping = { new: 'A', modified: 'M', deleted: 'D' }
     { index: 0, worktree: 1 }.each do |from, index|

data/lib/kamaze/project/tools/git/status/files_array.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/git/status/index.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/git/status/worktree.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/git/util.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/licenser.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.
@@ -170,7 +170,7 @@ class Kamaze::Project::Tools::Licenser < Kamaze::Project::Tools::BaseTool
   # @return [Pathname] file
   def apply_license(file)
     content    = file.read
-    licensable = !content.scan(license_regexp)[0] and !license.strip.empty?
+    licensable = !!(!content.scan(license_regexp)[0] and !license.strip.empty?)
     output     = self.output || file
 
     if licensable

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

@@ -1,38 +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_relative 'base_tool'
-
-# rubocop:disable Style/Documentation
-
-module Kamaze::Project::Tools
-  class Packager < BaseTool
-    class Filesystem
-      class Operator
-        module Utils
-        end
-      end
-    end
-
-    require_relative 'packager/filesystem'
-    require_relative 'packager/filesystem/operator'
-    require_relative 'packager/filesystem/operator/utils'
-  end
-end
-
-# rubocop:enable Style/Documentation
 
 # Provides a packager
 #
 # Packager is intended to provide basic packaging operations
 # @abstract
-class Kamaze::Project::Tools::Packager
+class Kamaze::Project::Tools::Packager < Kamaze::Project::Tools::BaseTool
+  # @formatter:off
+  {
+    FileSystem: 'filesystem',
+  }.each { |k, v| autoload(k, "#{__dir__}/packager/#{v}") }
+  # @formatter:on
+
+  require_relative 'packager/filesystem'
+  require_relative 'packager/filesystem/operator'
+  require_relative 'packager/filesystem/operator/utils'
+
   # Get filesystem
   #
   # @return [Kamaze::Project::Tools::Packager::Filesystem]

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

@@ -1,14 +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 '../packager'
-require_relative 'filesystem/operator'
-require 'pathname'
 
 # Filesystem description used during packaging
 #
@@ -20,6 +18,14 @@ require 'pathname'
 # Labels are used to constitute the complete directory path
 # (relative to ``pwd``).
 class Kamaze::Project::Tools::Packager::Filesystem
+  autoload(:Pathname, 'pathname')
+
+  # @formatter:off
+  {
+    Operator: 'operator',
+  }.each { |k, v| autoload(k, "#{__dir__}/filesystem/#{v}") }
+  # @formatter:on
+
   # Package dir (root directory)
   #
   # Relative to current pwd
@@ -170,7 +176,9 @@ class Kamaze::Project::Tools::Packager::Filesystem
   # @return [self]
   def mute_attributes!(attributes)
     attributes.each do |m|
+      # rubocop:disable Style/AccessModifierDeclarations
       self.singleton_class.class_eval { protected "#{m}=" }
+      # rubocop:enable Style/AccessModifierDeclarations
     end
 
     self

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

@@ -1,19 +1,25 @@
 # 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_relative '../filesystem'
-require_relative 'operator/utils'
 
 # Filesystem operator (manipulator)
 #
 # This class is intended to manipulate a ``Filesystem``.
 class Kamaze::Project::Tools::Packager::Filesystem::Operator
+  autoload(:Pathname, 'pathname')
+
+  # @formatter:off
+  {
+    Utils: 'utils',
+  }.each { |k, v| autoload(k, "#{__dir__}/operator/#{v}") }
+  # @formatter:on
+
   include Utils
 
   # @return [Kamaze::Project::Tools::Packager::Filesystem]
@@ -28,9 +34,11 @@ class Kamaze::Project::Tools::Packager::Filesystem::Operator
 
     # Pass included methods to protected
     utils_methods.each do |m|
-      if self.public_methods.include?(m)
-        self.singleton_class.class_eval { protected m }
-      end
+      next unless self.public_methods.include?(m)
+
+      # rubocop:disable Style/AccessModifierDeclarations
+      self.singleton_class.class_eval { protected m }
+      # rubocop:enable Style/AccessModifierDeclarations
     end
   end
 
@@ -38,7 +46,7 @@ class Kamaze::Project::Tools::Packager::Filesystem::Operator
   #
   # @return [self]
   def prepare
-    fs.package_dirs.each_value { |dir| mkdir_p(dir, options) }
+    fs.package_dirs.each_value { |dir| mkdir_p(dir, **options) }
 
     self.purge_purgeables.prepare_srcdir
   end
@@ -47,7 +55,7 @@ class Kamaze::Project::Tools::Packager::Filesystem::Operator
   #
   # @return [self]
   def purge_purgeables
-    fs.purgeable_dirs.each_value { |dir| purge(dir, options) }
+    fs.purgeable_dirs.each_value { |dir| purge(dir, **options) }
 
     self
   end
@@ -58,7 +66,7 @@ class Kamaze::Project::Tools::Packager::Filesystem::Operator
   #
   # @return [self]
   def prepare_srcdir
-    src_dir = ::Pathname.new(fs.package_dirs.fetch(:src))
+    src_dir = Pathname.new(fs.package_dirs.fetch(:src))
 
     purge(src_dir, options)
     skel_dirs(src_dir, fs.source_files, options)
@@ -66,7 +74,7 @@ class Kamaze::Project::Tools::Packager::Filesystem::Operator
     fs.source_files.map do |path|
       origin = path.realpath # resolves symlinks
 
-      cp(origin, src_dir.join(path), options.merge(preserve: true))
+      cp(origin, src_dir.join(path), **options.merge(preserve: true))
     end
 
     self
@@ -78,6 +86,6 @@ class Kamaze::Project::Tools::Packager::Filesystem::Operator
 
   protected
 
-  # @return [Hash]
+  # @return [Hash{Symbol => Object}]
   attr_reader :options
 end