kamaze-project 1.0.0 → 1.1.0

data/lib/kamaze/project/tasks/gem/install.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/tasks/gem/push.rb

@@ -1,27 +1,26 @@
 # 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.
 
-[nil, :gem_runner, :exceptions].each do |req|
-  require "rubygems/#{req}".rstrip('/')
-end
-
-# Code mostly based on gem executable
-#
-# @see http://guides.rubygems.org/publishing/
-# @see rubygems-tasks
-builder = tools.fetch(:gemspec_builder)
-desc 'Push gem up to the gem server'
-task 'gem:push': [builder.buildable] do
-  args = [:push, builder.buildable].map(&:to_s)
+[nil, :gem_runner, :exceptions].each { |req| require ['rubygems', req].compact.join('/') }
 
-  begin
-    Gem::GemRunner.new.run(args.map(&:to_s))
-  rescue Gem::SystemExitException => e
-    exit(e.exit_code)
+tools.fetch(:gemspec_builder).tap do |builder|
+  # Code mostly based on gem executable
+  #
+  # @see http://guides.rubygems.org/publishing/
+  # @see rubygems-tasks
+  runner = lambda do
+    [:push, builder.buildable].map(&:to_s).yield_self do |args|
+      Gem::GemRunner.new.run(args.map(&:to_s))
+    rescue Gem::SystemExitException => e
+      exit(e.exit_code)
+    end
   end
+
+  desc 'Push gem up to the gem server'
+  task('gem:push': [builder.buildable]) { runner.call }
 end

data/lib/kamaze/project/tasks/misc/gitignore.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/tasks/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/tasks/sources.rb

@@ -1,5 +1,5 @@
 # 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/tasks/sources/license.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/tasks/test.rb

@@ -1,16 +1,14 @@
 # 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.
 
 desc 'Run test suites'
-task :test do |task, args|
-  tags = args.extras
-
+task :test do |_task, args|
   tools.fetch(:rspec).tap do |rspec|
-    rspec.tags = tags
+    rspec.tags = args.extras
   end.run
 end

data/lib/kamaze/project/tasks/vagrant.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/tasks/version/edit.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.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,10 +9,22 @@
 require_relative '../project'
 require_relative 'tools_provider'
 
-# rubocop:disable Style/Documentation
-
+# Namespace for tools
 module Kamaze::Project::Tools
-  require_relative 'tools/base_tool'
+  # @formatter:off
+  {
+    BaseTool: 'base_tool',
+    Console: 'console',
+    Gemspec: 'gemspec',
+    Git: 'git',
+    Licenser: 'licenser',
+    Packager: 'packager',
+    ProcessLocker: 'process_locker',
+    Rspec: 'rspec',
+    Rubocop: 'rubocop',
+    Shell: 'shell',
+    Vagrant: 'vagrant',
+    Yardoc: 'yardoc',
+  }.each { |k, v| autoload(k, "#{__dir__}/tools/#{v}") }
+  # @formatter:on
 end
-
-# rubocop:enable Style/Documentation

data/lib/kamaze/project/tools/base_tool.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 '../tools'
-require_relative '../observable'
 
 # Provides base for tools
 #
@@ -28,6 +27,7 @@ class Kamaze::Project::Tools::BaseTool < Kamaze::Project::Observable
   # Mutable attributes become ``ro`` after initialization
   #
   # @return [Array]
+  # @abstract
   def mutable_attributes
     []
   end
@@ -35,6 +35,8 @@ class Kamaze::Project::Tools::BaseTool < Kamaze::Project::Observable
   protected
 
   # Execute additionnal setup
+  #
+  # @abstract
   def setup
     nil
   end
@@ -47,7 +49,9 @@ class Kamaze::Project::Tools::BaseTool < Kamaze::Project::Observable
   # @return [self]
   def attrs_mute!
     mutable_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/console.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,22 +8,13 @@
 
 require_relative '../tools'
 
-# rubocop:disable Style/Documentation
-
-module Kamaze::Project::Tools
-  class Console < BaseTool
-  end
-
-  require_relative 'console/output'
-end
-
-# rubocop:enable Style/Documentation
-
 # Provide access to a [console](https://en.wikipedia.org/wiki/System_console)
 # having two outputs: ``stdout`` and ``stderr``
 #
 # @see Kamaze::Project::Tools::Console::Output
-class Kamaze::Project::Tools::Console
+class Kamaze::Project::Tools::Console < Kamaze::Project::Tools::BaseTool
+  autoload(:Output, "#{__dir__}/console/output")
+
   attr_writer :stdout
   attr_writer :stderr
 

data/lib/kamaze/project/tools/console/output.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 '../console'
-require_relative 'output/buffer'
 
 # Provide a console output
 #
@@ -23,6 +22,14 @@ require_relative 'output/buffer'
 # @see https://github.com/Shopify/cli-ui
 # @see http://ruby-doc.org/core-2.1.3/IO.html
 class Kamaze::Project::Tools::Console::Output
+  # @formatter:off
+  {
+    Buffer: 'buffer'
+  }.each do |s, fp|
+    autoload(s, "#{__dir__}/output/#{fp}")
+  end
+  # @formatter:on
+
   # @param [IO] to
   def initialize(to = $stdout)
     @output = to
@@ -42,9 +49,9 @@ class Kamaze::Project::Tools::Console::Output
   #
   # @return [self]
   def flush
-    output.flush if output.respond_to?(:flush)
-
-    self
+    self.tap do
+      output.flush if output.respond_to?(:flush)
+    end
   end
 
   def method_missing(method, *args, &block)
@@ -113,7 +120,8 @@ class Kamaze::Project::Tools::Console::Output
   # Bufferize given arguments
   #
   # @param [Array<String>] strings
-  # @return [Array<String>]
+  #
+  # @return [Array<Buffer>|Array<String>]
   def bufferize(*strings)
     strings.to_a.map { |s| Buffer.new(self, s) }
   end

data/lib/kamaze/project/tools/console/output/buffer.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 '../output'
-require 'cli/ui'
 
 class Kamaze::Project::Tools::Console::Output
   class Buffer
@@ -43,6 +42,12 @@ class Kamaze::Project::Tools::Console::Output::Buffer
   # @param [String] str
   # @return [String]
   def decorate(str)
-    CLI::UI.fmt(str.to_s, enable_color: output.tty?)
+    ui.fmt(str.to_s, enable_color: output.tty?)
+  end
+
+  def ui
+    require 'cli/ui'
+
+    CLI::UI
   end
 end

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

@@ -1,33 +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_relative '../tools'
-require_relative 'packager'
 
 # Module providng several tools based on gemspec reader/writer
 module Kamaze::Project::Tools::Gemspec
-  class Reader < Kamaze::Project::Tools::BaseTool
-  end
-
-  class Writer < Kamaze::Project::Tools::BaseTool
-  end
-
-  # @abstract
-  class Packager < Kamaze::Project::Tools::Packager
-  end
-
-  class Builder < Packager
-  end
-
-  class Packer < Packager
-  end
-
-  [:packager,
-   :reader, :writer,
-   :builder, :packer].each { |req| require_relative "gemspec/#{req}" }
+  # @formatter:off
+  {
+    Reader: 'reader',
+    Writer: 'writer',
+    Packager: 'packager',
+    Builder: 'builder',
+    Concern: 'concern',
+    Packer: 'packer',
+  }.each { |s, fp| autoload(s, "#{__dir__}/gemspec/#{fp}") }
+  # @formatter:on
 end

data/lib/kamaze/project/tools/gemspec/builder.rb

@@ -1,16 +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 'fileutils'
-require 'rubygems'
-require 'rubygems/gem_runner'
-
-require_relative 'packager'
+require_relative '../gemspec'
 
 # Package a ``gem`` from its own ``gemspec`` file
 #
@@ -25,39 +21,46 @@ require_relative 'packager'
 # builder = Kamaze.project.tools.fetch(:gemspec_builder)
 # builder.build if builder.ready?
 # ```
-class Kamaze::Project::Tools::Gemspec::Builder
+class Kamaze::Project::Tools::Gemspec::Builder < Kamaze::Project::Tools::Gemspec::Packager
+  autoload(:FileUtils, 'fileutils')
+  autoload(:Pathname, 'pathname')
+
   # Build ``.gem`` file
   #
   # @return [self]
   def build
-    prepare
+    self.tap do
+      prepare
 
-    buildable_dir = self.buildable.dirname.realpath
+      buildable_dir = self.buildable.dirname.realpath
 
-    # dive into ``src`` file
-    Dir.chdir(gemspec_srcfile.dirname) do
-      Gem::GemRunner.new.run(build_args).yield_self do |file|
-        FileUtils.mv(file, buildable_dir)
+      # dive into ``src`` file
+      Dir.chdir(gemspec_srcfile.dirname) do
+        self.gem_runner.run(build_args).yield_self do |file|
+          FileUtils.mv(file, buildable_dir)
 
-        buildable_dir.join(file)
+          buildable_dir.join(file)
+        end
       end
     end
-
-    self
   end
 
   # Get buildable (relative path)
   #
   # @return [Pathname]
   def buildable
-    full_name = gemspec_reader.read(Hash).fetch(:full_name)
-    file_path = fs.package_dirs
-                  .fetch(:gem)
-                  .join("#{full_name}.gem")
-                  .to_s
-                  .gsub(%r{^\./}, '')
-
-    ::Pathname.new(file_path)
+    return nil unless ready? # @todo raise an explicit exception
+
+    gemspec_reader.read(Hash).fetch(:full_name).tap do |full_name|
+      # @formatter:off
+      return fs.package_dirs
+               .fetch(:gem)
+               .join("#{full_name}.gem")
+               .to_s
+               .gsub(%r{^\./}, '')
+               .yield_self { |file_path| Pathname.new(file_path) }
+      # @formatter:on
+    end
   end
 
   def ready?
@@ -70,12 +73,13 @@ class Kamaze::Project::Tools::Gemspec::Builder
   #
   # @return [Pathname]
   def gemspec_srcfile
+    # @formatter:off
     (package_dirs.fetch(:src)
-                 .realpath
-                 .join(buildable.basename('.*')).to_s
-                 .gsub(/-([0-9 \.])+$/, '') + '.gemspec').yield_self do |s|
-      Pathname.new(s)
-    end
+         .realpath
+         .join(buildable.basename('.*')).to_s
+         .gsub(/-([0-9 \.])+$/, '') + '.gemspec')
+      .yield_self { |s| Pathname.new(s) }
+    # @formatter:on
   end
 
   protected
@@ -84,8 +88,16 @@ class Kamaze::Project::Tools::Gemspec::Builder
     super
 
     self.package_labels = [:src, :gem]
-    self.purgeables     = [:gem]
-    self.package_name   = "ruby/gem-#{Gem::VERSION}"
+    self.purgeables = [:gem]
+    self.package_name = "ruby/gem-#{Gem::VERSION}"
+  end
+
+  # @return [Gem::GemRunner]
+  def gem_runner
+    require 'rubygems'
+    require 'rubygems/gem_runner'
+
+    Gem::GemRunner.new
   end
 
   # Get args used by ``gem`` command