kamaze-project 1.0.0 → 1.1.0

data/lib/kamaze/project/concern/env.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 '../concern'
-require 'dotenv'
-require 'pathname'
 
 # Load dotenv file
 #
@@ -21,6 +19,9 @@ require 'pathname'
 # @see https://github.com/bkeepers/dotenv
 # @see http://12factor.net/config
 module Kamaze::Project::Concern::Env
+  autoload(:Dotenv, 'dotenv')
+  autoload(:Pathanme, 'pathname')
+
   # @!attribute [r] env_loaded
   #   @return [Hash] loaded environment
 
@@ -39,23 +40,24 @@ module Kamaze::Project::Concern::Env
   # @return [Hash]
   def env_loaded
     @env_loaded ||= {}
-
-    @env_loaded
   end
 
   protected
 
   # Load ``.env`` file (and store result)
   #
-  # @todo load different (or additionnal) files depending on env/mode
-  #
   # @return [self]
-  def env_load(options = {})
-    options[:pwd] = ::Pathname.new(options[:pwd] || Dir.pwd).realpath
-    options[:file] ||= '.env'
+  def env_load(**options)
+    options = {
+      # @formatter:off
+      pwd: Pathname.new(options[:pwd] || Dir.pwd).realpath,
+      file: '.env',
+      # @formatter:on
+    }.merge(options)
 
-    [options.fetch(:pwd).join(options.fetch(:file))].each do |file|
-      env_loaded.merge!(::Dotenv.load(file))
+    # @todo load different (or additionnal) files depending on env/mode
+    [Pathname.new(options.fetch(:pwd)).join(options.fetch(:file))].each do |file|
+      env_loaded.merge!(Dotenv.load(file))
     end
 
     self

data/lib/kamaze/project/concern/helper.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 '../concern'
-require_relative '../helper'
 
 # Provides access to helpers
 module Kamaze::Project::Concern::Helper

data/lib/kamaze/project/concern/mode.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/concern/observable.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.
@@ -54,6 +54,7 @@ module Kamaze::Project::Concern::Observable
     # Add observer.
     #
     # @param [Class] observer_class
+    #
     # @return [self]
     def add_observer(observer_class, func = :handle_event)
       func = func.to_sym
@@ -71,20 +72,19 @@ module Kamaze::Project::Concern::Observable
     # Remove observer, so that it will no longer receive notifications.
     #
     # @param [Class] observer_class
+    #
     # @return [self]
     def delete_observer(observer_class)
-      observer_peers.delete(observer_class)
-
-      return self
+      self.tap do
+        observer_peers.delete(observer_class)
+      end
     end
 
     # Remove all observers.
     #
     # @return [self]
     def delete_observers
-      observers.clear
-
-      self
+      self.tap { observers.clear }
     end
 
     protected
@@ -121,12 +121,13 @@ module Kamaze::Project::Concern::Observable
   #
   # @param [Symbol|String] event
   # @param [Array<Object>] args
+  #
   # @return [self]
   def dispatch_event(event, *args)
-    observer_peers.to_h.each do |k, v|
-      k.__send__(v, *[event, self].concat(args))
+    self.tap do
+      observer_peers.to_h.each do |k, v|
+        k.__send__(v, *[event, self].concat(args))
+      end
     end
-
-    self
   end
 end

data/lib/kamaze/project/concern/sh.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.
@@ -61,12 +61,12 @@ module Kamaze::Project::Concern::Sh
       self.shell_runner_last_status = status
 
       if !ok and shell_runner_debug?
-        # rubocop:disable Layout/IndentHash
-        warn("Command failed with status (%<retcode>s):\n# %<command>s" % {
-               retcode: status.exitstatus,
-               command: debug_cmd(cmd.clone).gsub(/\{\}$/, '')
-             })
-        # rubocop:enable Layout/IndentHash
+        # @formatter:off
+        "Command failed with status (%<retcode>s):\n# %<command>s" % {
+          retcode: status.exitstatus,
+          command: debug_cmd(cmd.clone).gsub(/\{\}$/, '')
+        }.tap { |message| warn(message) }
+        # @formatter:on
       end
     end
   end

data/lib/kamaze/project/concern/tasks.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,7 +10,11 @@ require_relative '../concern'
 
 # Concern tasks
 #
-# Stores tasks to enable and provides method to load them
+# Stores tasks to enable and provides method to load them.
+#
+# Tasks are deignated by a string, preprocessing is applied on this strings
+# before each ``task`` is required. Task prefixd by a ``@`` character are
+# required without preprocessing, except first char removal.
 module Kamaze::Project::Concern::Tasks
   # Get tasks
   #
@@ -24,11 +28,16 @@ module Kamaze::Project::Concern::Tasks
   # Set tasks
   #
   # @param [Array] tasks
+  # @return [Array<String>]
   def tasks=(tasks)
     @tasks = (@tasks.to_a + tasks.to_a).map(&:to_s).map do |tn|
-      { ':': '/', '-': '_' }.each { |k, v| tn = tn.tr(k.to_s, v) }
+      if tn[0] != '@'
+        { ':': '/', '-': '_' }.each do |k, v|
+          tn = tn.tr(k.to_s, v)
+        end
+      end
 
-      tn
+      tn.to_s
     end.map(&:to_sym).uniq
   end
 
@@ -42,14 +51,31 @@ module Kamaze::Project::Concern::Tasks
   # @see Kamaze::Project::DSL::Definition
   # @return [self]
   def tasks_load!
-    if Kernel.const_defined?('Rake::DSL')
-      ns = Pathname.new('kamaze/project')
+    return self unless Kernel.const_defined?('Rake::DSL')
+
+    require tasks_ns.join('dsl/setup').to_s
 
-      [ns.join('dsl/setup'),
-       tasks.map { |task| ns.join("tasks/#{task}") }]
-        .flatten.map(&:to_s).each { |req| require req }
-    end
+    tasks.map { |task| load_task!(task) }
 
     self
   end
+
+  # Load task by given name
+  #
+  # @param [String] task
+  # @return [String]
+  def load_task!(task)
+    req = task[0] != '@' ? tasks_ns.join("tasks/#{task}") : task[1..-1]
+
+    require req
+
+    req
+  end
+
+  # Get namespace for default tasks
+  #
+  # @return [Pathname]
+  def tasks_ns
+    Pathname.new('kamaze/project')
+  end
 end

data/lib/kamaze/project/concern/tools.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 '../concern'
-require_relative '../../project/tools_provider'
 
 # Provides access to tools
 #
@@ -15,7 +14,7 @@ require_relative '../../project/tools_provider'
 module Kamaze::Project::Concern::Tools
   # Get tools
   #
-  # @return [Hash]
+  # @return [ToolsProvider|Hash]
   def tools
     @tools ||= Kamaze::Project::ToolsProvider.new
   end

data/lib/kamaze/project/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.

data/lib/kamaze/project/core_ext/object.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.
@@ -15,13 +15,22 @@
 #
 # @see https://ruby-doc.org/core-2.5.0/Object.html
 class Object
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.5.0')
-    # Yields self to the block and returns the result of the block.
-    #
-    # @return [Object]
-    # @see https://ruby-doc.org/core-2.5.0/Object.html#method-i-yield_self
-    def yield_self
-      yield(self)
+  autoload(:RbConfig, 'rbconfig')
+  # noinspection RubyEmptyRescueBlockInspection
+  begin
+    autoload(:Gem, 'rubygems')
+  rescue LoadError # rubocop:disable Lint/SuppressedException
+  end
+
+  RbConfig::CONFIG['ruby_version']&.tap do |ruby_version|
+    if defined?(Gem) and Gem::Version.new(ruby_version) < Gem::Version.new('2.5.0')
+      # Yields self to the block and returns the result of the block.
+      #
+      # @return [Object]
+      # @see https://ruby-doc.org/core-2.5.0/Object.html#method-i-yield_self
+      def yield_self
+        yield(self)
+      end
     end
   end
 end

data/lib/kamaze/project/core_ext/pp.rb

@@ -1,28 +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.
 
-require_relative '../debug'
+require_relative '../../project'
 
-# rubocop:disable Style/Documentation
-
-class Object
-  private
-
-  # Print arguments in pretty form
-  #
+Object.tap do |c|
   # @see https://ruby-doc.org/stdlib-2.4.0/libdoc/pp/rdoc/Kernel.html
-  # @see https://github.com/topazproject/topaz/blob/master/lib-ruby/pp.rb
-  def pp(*objs)
-    debug = Kamaze::Project::Debug.new
-    objs.each { |obj| debug.dump(obj) }
+  # @see https://github.com/topazproject/topaz/blob/bf4a56adbe03ae9ab4984729c733fcbc64a164c4/lib-ruby/pp.rb#L58
+  # @see https://github.com/ruby/ruby/blob/a8dc5156e183489c5121fb1759bda5d9406d9175/lib/pp.rb#L602
+  :pp.tap do |defined_method|
+    c.define_method(defined_method) do |*objs|
+      Kamaze::Project::Debug.new.yield_self do |printer|
+        objs.each { |obj| printer.dump(obj) }
 
-    objs.size <= 1 ? objs.first : objs
+        objs.size <= 1 ? objs.first : objs
+      end
+    end
+
+    [:private].each { |method_name| c.__send__(method_name, defined_method) }
   end
 end
-
-# rubocop:enable Style/Documentation

data/lib/kamaze/project/debug.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 '../project'
-require 'tty/screen'
-require 'active_support/inflector'
 
 # Provides colored pretty-printer automagically
 #
@@ -16,8 +14,9 @@ require 'active_support/inflector'
 # @see https://github.com/pry/pry
 class Kamaze::Project::Debug
   def initialize
-    @inflector ||= ActiveSupport::Inflector
-    @printers = available_printers
+    self.tap do
+      @printers = load_printers.yield_self { available_printers }.freeze
+    end.freeze
   end
 
   class << self
@@ -50,7 +49,11 @@ class Kamaze::Project::Debug
   # @param [Fixnum] width
   # @see http://ruby-doc.org/stdlib-2.2.0/libdoc/pp/rdoc/PP.html
   def dump(obj, out = $stdout, width = nil)
-    width ||= TTY::Screen.width || 79
+    width ||= screen_width || 79
+
+    unless out.respond_to?(:isatty)
+      out.singleton_class.define_method(:isatty) { false }
+    end
 
     printer_for(out).pp(obj, out, width)
   end
@@ -60,9 +63,7 @@ class Kamaze::Project::Debug
   # @param [IO] out
   # @return [PP]
   def printer_for(out)
-    out_tty = out.respond_to?(:isatty) and out.isatty
-
-    printers[out_tty ? 0 : 1]
+    printers.fetch(out.isatty ? 0 : 1)
   end
 
   # Get printers
@@ -71,52 +72,53 @@ class Kamaze::Project::Debug
   #
   # @return [Array<PP>]
   def available_printers
-    load_printers
-
-    default = '::PP'
-
-    [
-      proc do
-        target = '::Pry::ColorPrinter'
-
-        Kernel.const_defined?(target) ? target : default
-      end.call,
-      default
-    ].map { |n| inflector.constantize(n) }.freeze
+    require 'dry/inflector'
+
+    '::PP'.yield_self do |default|
+      # @formatter:off
+      [
+        'Pry::ColorPrinter'.yield_self do |cp|
+          Kernel.const_defined?(cp) ? cp : default
+        end,
+        default
+      ].map { |n| Dry::Inflector.new.constantize(n) }.freeze
+      # @formatter:on
+    end
   end
 
   protected
 
-  # @return [Boolean|nil]
-  attr_reader :warned
+  # @return [Integer]
+  def screen_width
+    require 'tty/screen'
 
-  # @return [Class]
-  attr_reader :inflector
+    TTY::Screen.width
+  end
 
-  # Load printers requirements (on demand)
+  # Load printers requirements.
   #
   # @return [self]
   def load_printers
-    Object.const_set('Pry', Class.new) unless Kernel.const_defined?('::Pry')
-
-    begin
-      load_printer_requirements
-    rescue LoadError => e
-      self.class.__send__('warned=', !!warn_error(e)) unless warned?
+    self.tap do
+      Object.const_set('Pry', Class.new) unless Kernel.const_defined?('::Pry')
+
+      begin
+        load_requirements
+      rescue LoadError => e
+        self.class.__send__('warned=', !!warn_error(e)) unless warned?
+      end
     end
-
-    self
   end
 
+  # Load requirements.
+  #
   # @raise [LoadError]
   # @return [self]
-  def load_printer_requirements
-    ['pp',
-     'coderay',
-     'pry/pager',
-     'pry/color_printer'].each { |req| require req }
-
-    self
+  def load_requirements
+    self.tap do
+      # noinspection RubyLiteralArrayInspection,RubyResolve
+      ['pp', 'coderay', 'pry'].each { |req| require req }
+    end
   end
 
   # Display the given exception message (followed by a newline) on STDERR
@@ -124,13 +126,10 @@ class Kamaze::Project::Debug
   # unless warnings are disabled (for example with the -W0 flag).
   #
   # @param [Exception] error
-  # @return [Array<String>]
+  # @return [nil]
   def warn_error(error)
-    formats = { from: caller(1..1).first, mssg: error.message }
-    message = '%<from>s: %<mssg>s' % formats
-
-    warn(message)
-
-    formats.values
+    { from: caller(1..1).first, mssg: error.message }.tap do |formats|
+      return warn('%<from>s: %<mssg>s' % formats)
+    end
   end
 end