kamaze-project 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3d3de9a01cef1fcc14728ff56abe9d82b60d7e6039e5610c1e043fcf653b2e9
-  data.tar.gz: 28434374dfe48306f3c76ba3ddbe2ebb6e4cee676296eabc5d4622953ff20acc
+  metadata.gz: 73295f0f7906e0a30f2e93dc9b21f85bc52d8e86549b6b8f83815ec627ee1d48
+  data.tar.gz: 1ec30804e058002c7e573113584128c990766141cf4da77cba508aba99637b76
 SHA512:
-  metadata.gz: 3f02d01bd1800a1eb8bd6b2da00739039963e132237c1ab18fd5d37286f5a420527c334b038674f94984bbab41b4d6984524343e9b364dcbdfbbaac03f91f531
-  data.tar.gz: ffc864e04d8bd36bf4b145f9c643dec12bee52f2361faacbc137210c9659e9dbbd40934611f4a42f7a65e04061eb03d45a0e0399968a576a388d96a5c8ba17f4
+  metadata.gz: 473533f87853e0ccbdf50215f512253cfd81c9179f4dccd88a1001403b63440ab49b496a62f94bf10a94dc2d93e3820029ac2c403dcf967cf3a14efe028ee976
+  data.tar.gz: 0245a0642542dd33d33764528d43234921bc78031d1ed06748602a0fd671c28931de47b9aa0e98d81211312bdd7949b06fcdf4f2c355d620a20d6acc9a3f461a

data/.yardopts

@@ -1,16 +1,16 @@
 # vim: ft=sh
 
-lib/**/*.rb                                   \
-    --no-progress                             \
-    --markup-provider 'redcarpet'             \
-    --markup 'markdown'                       \
-    --charset 'utf-8'                         \
-    --protected --private --embed-mixins      \
-    --tag type:'type' --hide-tag 'type'       \
-    --readme README.md                        \
+lib/**/*.rb                                 \
+    --no-progress                           \
+    --markup-provider 'redcarpet'           \
+    --markup 'markdown'                     \
+    --charset 'utf-8'                       \
+    --protected --private --embed-mixins    \
+    --tag type:'type' --hide-tag 'type'     \
+    --readme README.md                      \
     --exclude 'lib/kamaze/project/tasks/.*' \
     --exclude 'lib/kamaze/project/boot/.*'  \
-    --exclude '_flymake\\.rb$'                \
+    --exclude '_flymake\\.rb$'              \
     --exclude '/\\.#'
 
 # Local Variables:

data/lib/kamaze-project.rb

@@ -1,39 +1,9 @@
 # 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.
 
 $LOAD_PATH.unshift(__dir__)
-
-lock = Dir.chdir("#{__dir__}/..") do
-  [['gems.rb', 'gems.locked'], ['Gemfile', 'Gemfile.lock']]
-    .map { |m| Dir.glob(m).size >= 2 }
-    .include?(true)
-end
-mode = (ENV['PROJECT_MODE'] || lock ? 'development' : 'production').to_sym
-
-if lock
-  require 'rubygems'
-  require 'bundler/setup'
-end
-
-if lock and :development == mode
-  require 'yaml'
-
-  unless YAML.safe_load(ENV['BOOTSNAP_DISABLE'].to_s)
-    require 'bootsnap'
-
-    Bootsnap.setup(
-      cache_dir:            "#{__dir__}/../cache",
-      development_mode:     true,
-      load_path_cache:      true,
-      autoload_paths_cache: false,
-      disable_trace:        true,
-      compile_cache_iseq:   true,
-      compile_cache_yaml:   true
-    )
-  end
-end

data/lib/kamaze/project.rb

@@ -1,49 +1,38 @@
 # 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'
-
-# Base module (almost a namespace)
+# Kamaze namesapace
 module Kamaze
-  # rubocop:disable Style/Documentation
-
-  class Project
-    module Concern
-      [nil, :env, :mode, :helper,
-       :tasks, :tools].each do |req|
-        require_relative "project/concern/#{req}".gsub(%r{/$}, '')
-      end
-    end
-
-    require_relative 'project/version'
-
-    VERSION = Version.new.freeze
-
-    # @see Kamaze::Project::Version
-    # @return [Object]
-    def version
-      subject.const_get('VERSION')
+  class Project # rubocop:disable Style/Documentation
+    # @formatter:off
+    {
+      YAML: 'yaml',
+      Pathname: 'pathname',
+      Autoload: "#{__dir__}/project/autoload"
+    }.each { |s, fp| autoload(s, fp) }
+    # @formatter:on
+
+    Autoload.new.call("#{__dir__}/project")
+
+    include(Bundled).tap do
+      self.base_path = self.base_path.join('..')
+      require 'bundler/setup' if bundled?
+      require_relative './project/core_ext/pp' if development?
     end
   end
 
-  # rubocop:enable Style/Documentation
-end
-
-# Base namespace
-module Kamaze
   class << self
-    include Project::Concern::Helper
-
     # Get an instance of project
     #
+    # @deprecated
     # @return [Kamaze::Project]
     def project(&block)
-      helper.get(:project).setup(&block)
+      Project.instance(&block)
     end
   end
 end
@@ -65,6 +54,23 @@ class Kamaze::Project
   include Concern::Tasks
   include Concern::Tools
 
+  class << self
+    include Concern::Helper
+
+    # Get an instance of project
+    #
+    # @return [Kamaze::Project]
+    def instance(&block)
+      helper.get(:project).setup(&block)
+    end
+  end
+
+  # @see Kamaze::Project::Version
+  # @return [Object]
+  def version
+    subject.const_get('VERSION')
+  end
+
   # Project name
   #
   # @return [Symbol]
@@ -121,7 +127,7 @@ class Kamaze::Project
 
   # @return [Pathname]
   def pwd
-    ::Pathname.new(Dir.pwd)
+    Pathname.new(Dir.pwd)
   end
 
   protected

data/lib/kamaze/project/autoload.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# 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.
+
+# Autoload class
+class Kamaze::Project::Autoload < ::Hash
+  def initialize # rubocop:disable Metrics/MethodLength
+    # @formatter:off
+    {
+      VERSION: 'version',
+      Bundled: 'bundled',
+      Concern: 'concern',
+      Config: 'config',
+      Debug: 'debug',
+      DSL: 'dsl',
+      Helper: 'helper',
+      Inflector: 'inflector',
+      Observable: 'observable',
+      Observer: 'observer',
+      Struct: 'struct',
+      Tools: 'tools',
+      ToolsProvider: 'tools_provider',
+    }.each { |k, v| self[k] = v }
+    # @formatter:on
+  end
+
+  def call(path)
+    self.tap do
+      self.each do |s, fp|
+        Kamaze::Project.__send__(:autoload, s, "#{path}/#{fp}")
+      end
+    end
+  end
+end

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

@@ -1,16 +1,16 @@
 # 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.
 
-{
-  pp: proc { ENV['PROJECT_MODE'] == 'development' },
-  object: proc { true },
-}.each do |requirement, conditionner|
-  next unless conditionner.call
-
-  require_relative "../core_ext/#{requirement}"
+# @formatter:off
+[
+  ENV['PROJECT_MODE'] =~ /^dev.*/ ? :pp : nil,
+  :object,
+].compact.each do |requirement|
+  require "#{__dir__}/../core_ext/#{requirement}"
 end
+# @formatter:on

data/lib/kamaze/project/boot/listen.rb

@@ -1,18 +1,18 @@
 # 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.
 
+autoload(:YAML, 'yaml')
+autoload(:Gem, 'rubygems')
+
 patchable = lambda do
-  if Gem::Specification.find_all_by_name('listen').any?
-    require 'listen'
-    return YAML.safe_load(ENV['SILENCE_DUPLICATE_DIRECTORY_ERRORS'].to_s)
-  end
+  return false unless Gem::Specification.find_all_by_name('listen').any?
 
-  false
+  YAML.safe_load(ENV['SILENCE_DUPLICATE_DIRECTORY_ERRORS'].to_s)
 end
 
 # rubocop:disable all
@@ -22,14 +22,12 @@ end
 # Listen >=2.8
 # patch to silence duplicate directory errors. USE AT YOUR OWN RISK
 if patchable.call
+  require 'listen'
+
   if Gem::Version.new(Listen::VERSION) >= Gem::Version.new('2.8.0')
-    module Listen
-      class Record
-        class SymlinkDetector
-          def _fail(_, _)
-            fail Error, "Don't watch locally-symlinked directory twice"
-          end
-        end
+    class Listen::Record::SymlinkDetector
+      def _fail(_, _)
+        fail Error, "Don't watch locally-symlinked directory twice"
       end
     end
   end

data/lib/kamaze/project/bundled.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# 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.
+
+# Copyright (C) 2019-2020 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')
+
+# Bundled behavior.
+#
+# Allow to detect bundled execution due to ``gems.rb`` and ``gems.locked``
+# files presence, and``development`` execution (``gemspec.tpl`` file presence).
+module Kamaze::Project::Bundled
+  autoload(:Pathname, 'pathname')
+
+  class << self
+    def included(base)
+      base.extend(ClassMethods)
+
+      Pathname.new(caller_locations.first.path).dirname.tap do |caller_path|
+        (base.__send__(:base_path) || caller_path).tap do |basepath|
+          base.__send__(:base_path=, Pathname(basepath).join('..'))
+        end
+      end
+    end
+  end
+
+  # Class methods
+  module ClassMethods
+    protected
+
+    # Set `base_path` from given `path`.
+    #
+    # @param [String] path
+    # @return [Pathname]
+    def base_path=(path)
+      @base_path = Pathname.new(path).realpath
+    end
+
+    # @return [Pathname]
+    def base_path
+      @base_path
+    end
+
+    # Denote current class is used in a bundled context.
+    #
+    # @return [Boolean]
+    def bundled?
+      # @formatter:off
+      [%w[gems.rb gems.locked], %w[Gemfile Gemfile.lock]].map do |m|
+        Dir.chdir(base_path) do
+          m.map { |f| Pathname(f).file? }.uniq
+        end
+      end.include?([true])
+      # @formatter:on
+    end
+
+    # Denote current class is used in development context.
+    #
+    # @return [Boolean]
+    def development?
+      # @formatter:off
+      bundled? and [['gemspec.tpl']].map do |m|
+        Dir.chdir(base_path) do
+          m.map { |f| Pathname(f).file? }
+        end
+      end.include?([true])
+      # @formatter:on
+    end
+  end
+end

data/lib/kamaze/project/concern.rb

@@ -1,13 +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 'kamaze/project'
+require_relative '../project'
 
 # Namespace for ``Concern``
 module Kamaze::Project::Concern
+  # @formatter:off
+  {
+    Cli: 'cli',
+    Env: 'env',
+    Helper: 'helper',
+    Mode: 'mode',
+    Observable: 'observable',
+    Sh: 'sh',
+    Tasks: 'tasks',
+  }.each { |s, fp| autoload(s, "#{__dir__}/concern/#{fp}") }
+  # @formatter:on
+
+  [nil, :env, :mode, :helper, :tasks, :tools].each do |req|
+    require_relative "./concern/#{req}".gsub(%r{/$}, '')
+  end
 end

data/lib/kamaze/project/concern/cli.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.
@@ -12,6 +12,7 @@ require_relative '../concern'
 #
 # This module provides base methods focused on ``retcode``.
 module Kamaze::Project::Concern::Cli
+  autoload(:WithExitOnFailure, "#{__dir__}/cli/with_exit_on_failure")
 
   # @!attribute [r] retcode
   #   @return [Fixnum] retcode
@@ -37,6 +38,7 @@ module Kamaze::Project::Concern::Cli
   #
   # @return [Boolean]
   def success?
+    # noinspection RubyResolve
     Errno::NOERROR::Errno == retcode
   end
 

data/lib/kamaze/project/concern/cli/with_exit_on_failure.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.
@@ -27,10 +27,6 @@ module Kamaze::Project::Concern::Cli::WithExitOnFailure
   # @raise [SystemExit]
   # @return [Object]
   def with_exit_on_failure
-    result = yield(self)
-
-    exit(retcode) if failure?
-
-    result
+    yield(self).tap { exit(retcode) if failure? }
   end
 end