kamaze-project 1.0.0

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

@@ -0,0 +1,20 @@
+# 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_relative '../helper'
+
+# Provides access to helpers
+module Kamaze::Project::Concern::Helper
+  protected
+
+  # @return [Sys::Proc::Helper]
+  def helper
+    Kamaze::Project::Helper.instance
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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'
+
+# Provide access to ``mode`` (baed on environment ``PROJECT_MODE``)
+module Kamaze::Project::Concern::Mode
+  # Get project mode
+  #
+  # @return [String]
+  def mode
+    (ENV['PROJECT_MODE'] || 'production').freeze
+  end
+end

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

@@ -0,0 +1,132 @@
+# 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'
+
+# Observable provides the methods for managing the associated observers.
+#
+# The observers SHOULD implement a method called ``update``
+# to receive notifications.
+#
+# The observable object MNUST:
+#
+# * call ``#dispatch_event``
+#
+# Sample of use:
+#
+# ```ruby
+# # @abstract
+# class Observable
+#   include Kamaze::Project::Concern::Observable
+# end
+#
+# class Subject < Observable
+#  attr_accessor :updated_at
+#
+#   def update
+#     # do something
+#     dispatch_event(:after_update)
+#   end
+# end
+#
+# class SubjectObserver < Kamaze::Project::Observer
+#   observe Subject
+#
+#   def after_update(subject)
+#     subject.updated_at = Time.now
+#   end
+# end
+# ```
+module Kamaze::Project::Concern::Observable
+  class << self
+    def included(base)
+      base.extend(ClassMethods)
+    end
+  end
+
+  # Class methods
+  module ClassMethods
+    # Add observer.
+    #
+    # @param [Class] observer_class
+    # @return [self]
+    def add_observer(observer_class, func = :handle_event)
+      func = func.to_sym
+
+      unless observer_class.instance_methods.include?(func)
+        m = "#<#{observer_class}> does not respond to `#{func}'"
+        raise NoMethodError, m
+      end
+
+      observer_peers[observer_class] = func
+
+      self
+    end
+
+    # 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
+    end
+
+    # Remove all observers.
+    #
+    # @return [self]
+    def delete_observers
+      observers.clear
+
+      self
+    end
+
+    protected
+
+    # @return [Hash]
+    def observer_peers
+      @observer_peers ||= {}
+    end
+  end
+
+  def initialize
+    observer_peers_initialize
+  end
+
+  protected
+
+  # @return [Hash|nil]
+  attr_reader :observer_peers
+
+  # Initialize observers (defined from ``self.class.observer_peers``)
+  #
+  # @return [self]
+  def observer_peers_initialize
+    (@observer_peers ||= {}).yield_self do |observer_peers|
+      self.class.__send__(:observer_peers).to_h.each do |k, v|
+        observer_peers[k.new] = v
+      end
+    end
+
+    self
+  end
+
+  # Dispatch given ``event``
+  #
+  # @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))
+    end
+
+    self
+  end
+end

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

@@ -0,0 +1,91 @@
+# 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 Sh
+#
+# This module provides a wrapper around ``Rake::FileUtilsExt.sh()``
+module Kamaze::Project::Concern::Sh
+  # @!attribute [rw] shell_runner_last_status
+  #   @return [Process::Status]
+
+  class << self
+    def included(base)
+      base.class_eval <<-"ACCESSORS", __FILE__, __LINE__ + 1
+        protected
+
+        attr_accessor :shell_runner_last_status
+
+        attr_writer :shell_runner_debug
+      ACCESSORS
+    end
+  end
+
+  # Denote shell runner is in debug mode.
+  #
+  # @return [Boolean]
+  def shell_runner_debug?
+    @shell_runner_debug.nil? ? true : @shell_runner_debug
+  end
+
+  protected
+
+  # Run given (``cmd``) system command.
+  #
+  # If multiple arguments are given the command is run directly
+  # (without the shell, same semantics as Kernel::exec and Kernel::system).
+  #
+  # @see [Rake::FileUtilsExt]
+  # @see https://github.com/ruby/rake/blob/68ef9140c11d083d8bb7ee5da5b0543e3a7df73d/lib/rake/file_utils.rb#L44
+  def sh(*cmd, &block)
+    require 'rake'
+    require 'rake/file_utils'
+
+    block ||= create_shell_runner(cmd)
+
+    ::Rake::FileUtilsExt.sh(*cmd, &block)
+  end
+
+  # Get shell block
+  #
+  # @param [Array] cmd
+  # @return [Proc]
+  def create_shell_runner(cmd)
+    proc do |ok, status|
+      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
+      end
+    end
+  end
+
+  # Print a debug message
+  #
+  # @param [Array] cmd
+  # @return [String]
+  def debug_cmd(cmd)
+    options = cmd.last.is_a?(Hash) ? cmd.delete_at(-1) : {}
+
+    '%<command>s' % {
+      command: [
+        (cmd[0].is_a?(Hash) ? cmd.delete_at(0) : {}).to_a.map do |v|
+          "#{v[0]}=#{Shellwords.shellescape(v[1])}"
+        end.join(' '),
+        Shellwords.shelljoin(cmd),
+        options
+      ].join(' ')
+    }
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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 tasks
+#
+# Stores tasks to enable and provides method to load them
+module Kamaze::Project::Concern::Tasks
+  # Get tasks
+  #
+  # @return [Array<Symbol>]
+  def tasks
+    @tasks ||= []
+
+    @tasks.clone.freeze
+  end
+
+  # Set tasks
+  #
+  # @param [Array] tasks
+  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) }
+
+      tn
+    end.map(&:to_sym).uniq
+  end
+
+  protected
+
+  # Load tasks
+  #
+  # Tasks are loaded only when ``Rake::DSL`` is defined.
+  # ``DSL::Definition`` is loaded during tasks loading.
+  #
+  # @see Kamaze::Project::DSL::Definition
+  # @return [self]
+  def tasks_load!
+    if Kernel.const_defined?('Rake::DSL')
+      ns = Pathname.new('kamaze/project')
+
+      [ns.join('dsl/setup'),
+       tasks.map { |task| ns.join("tasks/#{task}") }]
+        .flatten.map(&:to_s).each { |req| require req }
+    end
+
+    self
+  end
+end

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

@@ -0,0 +1,27 @@
+# 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_relative '../../project/tools_provider'
+
+# Provides access to tools
+#
+# Tools provide an extensibility mechanism
+module Kamaze::Project::Concern::Tools
+  # Get tools
+  #
+  # @return [Hash]
+  def tools
+    @tools ||= Kamaze::Project::ToolsProvider.new
+  end
+
+  # @param [Hash] tools
+  def tools=(tools)
+    @tools = self.tools.merge!(tools)
+  end
+end

data/lib/kamaze/project/config.rb

@@ -0,0 +1,58 @@
+# 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 '../project'
+require_relative 'struct'
+
+# Generic config(urator) class
+#
+# @abstract Subclass and override {#defaults} to implement
+class Kamaze::Project::Config
+  # @return [Kamaze::Project::Struct]
+  attr_reader :attributes
+
+  def initialize
+    @attributes = Kamaze::Project::Struct.new(defaults)
+  end
+
+  # Configure an object (manipulating its properties)
+  #
+  # @param [Object] configurable
+  # @return [Object]
+  def configure(configurable)
+    to_h.each do |k, v|
+      configurable.__send__("#{k}=", v)
+    end
+
+    configurable
+  end
+
+  # @return [Hash]
+  def to_h
+    attributes.to_h
+  end
+
+  def method_missing(method, *args, &block)
+    if respond_to_missing?(method)
+      @attributes.public_send(method, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    return true if attributes.respond_to?(method, include_private)
+
+    super(method, include_private)
+  end
+
+  # @return [Hash]
+  def defaults
+    {}
+  end
+end

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

@@ -0,0 +1,27 @@
+# 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.
+
+# Object is the default root of all Ruby objects
+#
+# Object inherits from BasicObject
+# which allows creating alternate object hierarchies.
+# Methods on Object are available to all classes
+# (unless explicitly overridden).
+#
+# @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)
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# 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 '../debug'
+
+# rubocop:disable Style/Documentation
+
+class Object
+  private
+
+  # Print arguments in pretty form
+  #
+  # @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) }
+
+    objs.size <= 1 ? objs.first : objs
+  end
+end
+
+# rubocop:enable Style/Documentation