kamaze-project 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3d3de9a01cef1fcc14728ff56abe9d82b60d7e6039e5610c1e043fcf653b2e9
+  data.tar.gz: 28434374dfe48306f3c76ba3ddbe2ebb6e4cee676296eabc5d4622953ff20acc
+SHA512:
+  metadata.gz: 3f02d01bd1800a1eb8bd6b2da00739039963e132237c1ab18fd5d37286f5a420527c334b038674f94984bbab41b4d6984524343e9b364dcbdfbbaac03f91f531
+  data.tar.gz: ffc864e04d8bd36bf4b145f9c643dec12bee52f2361faacbc137210c9659e9dbbd40934611f4a42f7a65e04061eb03d45a0e0399968a576a388d96a5c8ba17f4

data/.yardopts

@@ -0,0 +1,18 @@
+# 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                        \
+    --exclude 'lib/kamaze/project/tasks/.*' \
+    --exclude 'lib/kamaze/project/boot/.*'  \
+    --exclude '_flymake\\.rb$'                \
+    --exclude '/\\.#'
+
+# Local Variables:
+# mode: sh
+# End:

data/bin/plop

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby 
+
+require 'pp'
+
+pp(ENV)

data/lib/kamaze-project.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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)
+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')
+    end
+  end
+
+  # rubocop:enable Style/Documentation
+end
+
+# Base namespace
+module Kamaze
+  class << self
+    include Project::Concern::Helper
+
+    # Get an instance of project
+    #
+    # @return [Kamaze::Project]
+    def project(&block)
+      helper.get(:project).setup(&block)
+    end
+  end
+end
+
+# Represent a project
+#
+# Sample of use:
+#
+# ```ruby
+# Kamaze.project do |c|
+#   c.subject     = Kamaze::Project
+#   c.name        = :'kamaze-project'
+#   c.tasks       = [ :doc, :gem ]
+# end
+# ```
+class Kamaze::Project
+  include Concern::Mode
+  include Concern::Helper
+  include Concern::Tasks
+  include Concern::Tools
+
+  # Project name
+  #
+  # @return [Symbol]
+  attr_reader :name
+
+  # Project subject, main class
+  #
+  # @return [Class]
+  attr_reader :subject
+
+  class << self
+    include Concern::Env
+
+    # Load "env file" + ruby files from ``boot`` directory
+    #
+    # @return [self]
+    def boot
+      env_load
+
+      Dir.glob("#{__dir__}/project/boot/*.rb").each do |bootable|
+        require_relative bootable
+      end
+
+      self
+    end
+  end
+
+  def initialize(&block)
+    self.class.boot
+
+    if block
+      config = helper.get('project/config')
+      yield(config)
+      config.configure(self)
+    end
+
+    self.name ||= ENV.fetch('PROJECT_NAME')
+    self.subject ||= subject!
+
+    self.tools.freeze
+  end
+
+  # @return [Pathname]
+  def path(*args)
+    pwd.join(*args)
+  end
+
+  # Load project
+  #
+  # @return [self]
+  def load!
+    tasks_load!
+  end
+
+  # @return [Pathname]
+  def pwd
+    ::Pathname.new(Dir.pwd)
+  end
+
+  protected
+
+  alias gem_name name
+
+  # Set name
+  def name=(name)
+    @name = name.to_s.empty? ? nil : name.to_s.to_sym
+  end
+
+  # Set subject
+  #
+  # @param [Class] subject
+  def subject=(subject)
+    unless subject.is_a?(Class)
+      # @todo raise error
+    end
+
+    @subject = subject
+  end
+
+  # Main class (subject of project)
+  #
+  # @return [Class]
+  def subject!
+    resolvable = name.to_s.tr('-', '/')
+
+    helper.get(:inflector).resolve(resolvable)
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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}"
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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.
+
+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
+
+  false
+end
+
+# rubocop:disable all
+
+# @see https://github.com/guard/listen/wiki/Duplicate-directory-errors
+#
+# Listen >=2.8
+# patch to silence duplicate directory errors. USE AT YOUR OWN RISK
+if patchable.call
+  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
+      end
+    end
+  end
+end
+
+# rubocop:enable all

data/lib/kamaze/project/concern.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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'
+
+# Namespace for ``Concern``
+module Kamaze::Project::Concern
+end

data/lib/kamaze/project/concern/cli.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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'
+
+# Concern for CLI
+#
+# This module provides base methods focused on ``retcode``.
+module Kamaze::Project::Concern::Cli
+
+  # @!attribute [r] retcode
+  #   @return [Fixnum] retcode
+
+  class << self
+    def included(base)
+      base.class_eval <<-"ACCESSORS", __FILE__, __LINE__ + 1
+        protected
+
+        attr_writer :retcode
+      ACCESSORS
+    end
+  end
+
+  # Status code usable to eventually initiates the termination.
+  #
+  # @return [Fixnum]
+  def retcode
+    @retcode || Errno::NOERROR::Errno
+  end
+
+  # Denote execution is a success.
+  #
+  # @return [Boolean]
+  def success?
+    Errno::NOERROR::Errno == retcode
+  end
+
+  # Denote execution is a failure.
+  #
+  # @return [Boolean]
+  def failure?
+    !success?
+  end
+
+  alias failed? failure?
+
+  alias successful? success?
+end

data/lib/kamaze/project/concern/cli/with_exit_on_failure.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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 '../cli'
+
+# Concern exit on failure
+#
+# Use ``retcode`` to exit in ``with_exit_on_failure`` blocks.
+#
+# @todo Add (rspec) test and examples
+module Kamaze::Project::Concern::Cli::WithExitOnFailure
+  include Kamaze::Project::Concern::Cli
+
+  protected
+
+  # Initiates termination by raising ``SystemExit`` exception
+  # depending on ``success`` of given block.
+  #
+  # @yield [Object]
+  # @yieldparam [self]
+  #
+  # @raise [SystemExit]
+  # @return [Object]
+  def with_exit_on_failure
+    result = yield(self)
+
+    exit(retcode) if failure?
+
+    result
+  end
+end

data/lib/kamaze/project/concern/env.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 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
+#
+# Storing configuration in the environment is one of the tenets of a
+# twelve-factor app. Anything that is likely to change between
+# deployment environments, such as resource handles for databases or
+# credentials for external services should be extracted
+# from the code into environment variables.
+#
+# @see https://github.com/bkeepers/dotenv
+# @see http://12factor.net/config
+module Kamaze::Project::Concern::Env
+  # @!attribute [r] env_loaded
+  #   @return [Hash] loaded environment
+
+  class << self
+    def included(base)
+      base.class_eval <<-"ACCESSORS", __FILE__, __LINE__ + 1
+        protected
+
+        attr_writer :env_loaded
+      ACCESSORS
+    end
+  end
+
+  # Loaded environment
+  #
+  # @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'
+
+    [options.fetch(:pwd).join(options.fetch(:file))].each do |file|
+      env_loaded.merge!(::Dotenv.load(file))
+    end
+
+    self
+  end
+end