kamaze-project 1.0.0

data/lib/kamaze/project/debug.rb

@@ -0,0 +1,136 @@
+# 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 'tty/screen'
+require 'active_support/inflector'
+
+# Provides colored pretty-printer automagically
+#
+# @see http://ruby-doc.org/stdlib-2.0.0/libdoc/pp/rdoc/PP.html
+# @see https://github.com/pry/pry
+class Kamaze::Project::Debug
+  def initialize
+    @inflector ||= ActiveSupport::Inflector
+    @printers = available_printers
+  end
+
+  class << self
+    # @return [Boolean]
+    def warned?
+      @warned || false
+    end
+
+    protected
+
+    # @return [Boolean]
+    attr_accessor :warned
+  end
+
+  # @return [Array<PP>]
+  attr_reader :printers
+
+  # @return [Boolean]
+  def warned?
+    self.class.warned?
+  end
+
+  # Outputs obj to out in pretty printed format of width columns in width.
+  #
+  # If out is omitted, ``STDOUT`` is assumed.
+  # If width is omitted, ``79`` is assumed.
+  #
+  # @param [Object] obj
+  # @param [IO] out
+  # @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
+
+    printer_for(out).pp(obj, out, width)
+  end
+
+  # Get printer for given output
+  #
+  # @param [IO] out
+  # @return [PP]
+  def printer_for(out)
+    out_tty = out.respond_to?(:isatty) and out.isatty
+
+    printers[out_tty ? 0 : 1]
+  end
+
+  # Get printers
+  #
+  # First printer SHOULD be the color printer, secund is the default printer
+  #
+  # @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
+  end
+
+  protected
+
+  # @return [Boolean|nil]
+  attr_reader :warned
+
+  # @return [Class]
+  attr_reader :inflector
+
+  # Load printers requirements (on demand)
+  #
+  # @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?
+    end
+
+    self
+  end
+
+  # @raise [LoadError]
+  # @return [self]
+  def load_printer_requirements
+    ['pp',
+     'coderay',
+     'pry/pager',
+     'pry/color_printer'].each { |req| require req }
+
+    self
+  end
+
+  # Display the given exception message (followed by a newline) on STDERR
+  #
+  # unless warnings are disabled (for example with the -W0 flag).
+  #
+  # @param [Exception] error
+  # @return [Array<String>]
+  def warn_error(error)
+    formats = { from: caller(1..1).first, mssg: error.message }
+    message = '%<from>s: %<mssg>s' % formats
+
+    warn(message)
+
+    formats.values
+  end
+end

data/lib/kamaze/project/dsl.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.
+
+require_relative '../project'
+
+# rubocop:disable Style/Documentation
+class Kamaze::Project
+  module DSL
+  end
+end
+# rubocop:enable Style/Documentation

data/lib/kamaze/project/dsl/definition.rb

@@ -0,0 +1,43 @@
+# 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 '../dsl'
+
+# rubocop:disable Style/Documentation
+module Kamaze::Project::DSL
+  module Definition
+  end
+end
+# rubocop:enable Style/Documentation
+
+# ``DSL::Definition`` provides access to ``project`` and ``tools`` methods
+module Kamaze::Project::DSL::Definition
+  protected
+
+  # Get project
+  #
+  # @return [Kamaze::Project]
+  def project
+    @project_dsl_stored ||= Kamaze.project
+  end
+
+  # Get tools
+  #
+  # @return [Kamaze::Project::ToolsProvider]
+  def tools
+    project.tools
+  end
+
+  private
+
+  def project_dsl_reset
+    @project_dsl_stored = nil
+
+    self
+  end
+end

data/lib/kamaze/project/dsl/setup.rb

@@ -0,0 +1,11 @@
+# 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 'definition'
+
+self.extend Kamaze::Project::DSL::Definition

data/lib/kamaze/project/helper.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 'kamaze/project'
+require 'singleton'
+
+# Provides access to helper classes
+class Kamaze::Project::Helper
+  include ::Singleton
+
+  class << self
+    attr_reader :ns
+  end
+
+  @ns = :'kamaze/project/helper'
+
+  # @param [String|Symbol] name
+  # @return [Object]
+  #
+  # @raise [NotImplementedError]
+  def get(name)
+    name = name.to_sym
+
+    return items[name] if items[name]
+
+    begin
+      @items[name] = inflector.resolve("#{self.class.ns}/#{name}").new
+    rescue LoadError
+      raise NotImplementedError, "helper not loadable: #{name}"
+    end
+  end
+
+  protected
+
+  attr_reader :items
+
+  def initialize
+    @items = {
+      inflector: proc do
+        require "#{self.class.ns}/inflector"
+
+        Inflector.new
+      end.call
+    }
+
+    super
+  end
+
+  # @return [Hash]
+  def to_h
+    items
+  end
+
+  # @return [Sys::Proc::Helper::Inflector]
+  def inflector
+    to_h.fetch(:inflector)
+  end
+end

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

@@ -0,0 +1,44 @@
+# 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/helper'
+
+# Inflector built on top of ``Dry::Inflector``
+class Kamaze::Project::Helper::Inflector
+  def initialize
+    require 'dry/inflector'
+
+    @inflector = Dry::Inflector.new
+  end
+
+  # Load constant from a loadable/requirable path
+  #
+  # @param [String] loadable
+  # @return [Object]
+  def resolve(loadable)
+    loadable = loadable.to_s.empty? ? nil : loadable.to_s
+
+    require loadable
+
+    @inflector.constantize(@inflector.classify(loadable))
+  end
+
+  def method_missing(method, *args, &block)
+    if respond_to_missing?(method)
+      @inflector.public_send(method, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    return true if @inflector.respond_to?(method, include_private)
+
+    super(method, include_private)
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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/helper'
+
+# Store last configured project
+#
+# @see Kamaze::Project
+class Kamaze::Project::Helper::Project
+  # @return [Kamaze::Project]
+  attr_reader :memo
+
+  # @return [Kamaze::Project]
+  def setup(&block)
+    @memo = Kamaze::Project.new(&block) if block
+    @memo = Kamaze::Project.new if memo.nil? and block.nil?
+
+    self.memo
+  end
+
+  # Forget stored state
+  #
+  # return [self]
+  def forget
+    @memo = nil
+
+    self
+  end
+end

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

@@ -0,0 +1,25 @@
+# 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 '../../config'
+
+# Config used to configure ``Kamaze::Project``
+#
+# @see Kamaze::Project.initialize
+class Kamaze::Project::Helper::Project::Config < Kamaze::Project::Config
+  # @return [Hash]
+  def defaults
+    {
+      tasks: nil,
+      name: nil,
+      subject: nil,
+      tools: {}
+    }
+  end
+end

data/lib/kamaze/project/observable.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 '../project'
+require_relative 'concern/observable'
+# implicitely require observer
+require_relative 'observer'
+
+# Observable provides the methods for managing the associated observers.
+#
+# @abstract
+# @see Kamaze::Project::Concern::Observable
+class Kamaze::Project::Observable
+  include Kamaze::Project::Concern::Observable
+end

data/lib/kamaze/project/observer.rb

@@ -0,0 +1,37 @@
+# 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'
+
+# Observer class
+#
+# @abstract
+# @see Kamaze::Project::Observable
+# @see Kamaze::Project::Concern::Observable
+class Kamaze::Project::Observer
+  class << self
+    # Subscribe to given class.
+    #
+    # @param [Class] observed_class
+    # @return [self]
+    def observe(observed_class, func = nil)
+      observed_class.add_observer(*[self, func].compact)
+
+      self
+    end
+  end
+
+  # Callback for observer.
+  #
+  # @return [self]
+  def handle_event(func, *args)
+    self.__send__(func, *args) if self.respond_to?(func, true)
+
+    self
+  end
+end

data/lib/kamaze/project/resources/Vagrantfile

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Vagrant CAN NOT cohabitate well with bundler,
+# this bootstrap DOES NOT load any project sources.
+# This file is used as a kind of template.
+# ``boxes`` variable is defined at runtime.
+#
+# @see Kamaze::Project::Tools::Vagrant
+
+require 'pp'
+require 'pathname'
+
+# requires -----------------------------------------------------------
+requires_from_boxes = lambda do |boxes|
+  pwd = ::Pathname.new(Dir.pwd)
+
+  Array.new.tap do |requires|
+    boxes.each do |box, box_config|
+      requires.concat(box_config['requires'] || [])
+    end
+  end.map do |req|
+    req = pwd.join(req.to_s).realpath if pwd.join(req.to_s).file?
+    require req.to_s
+    req
+  end
+end
+
+# synced folders -----------------------------------------------------
+synced_folders_config = lambda do |config, box_config|
+  (box_config['synced_folders'] || []).each do |s|
+    folders = s.delete(:folders)
+
+    config.vm.synced_folder(*folders, **s)
+  end
+end
+
+# modifyvm config ----------------------------------------------------
+modifyvm_config = lambda do |config, box_config|
+  provider = box_config.fetch('provider')
+  modifyvm = box_config['modifyvm']
+
+  (modifyvm || []).each do |c|
+    config.vm.provider(provider) do |v|
+      c[0] = "--#{c[0]}" if c[0] and c[0].slice(0, 2) != '--'
+
+      v.customize(['modifyvm', :id] + c.map(&:to_s))
+    end
+  end
+end
+
+# machine config -----------------------------------------------------
+machine_config = lambda do |config, name, box_config, &block|
+  config.vm.define name, autostart: false do |machine|
+    box, version = box_config.fetch('image').split(':')
+    machine.vm.box = box
+    machine.vm.box_version = version if version
+
+    block&.call(machine)
+  end
+end
+
+# machine networks config ---------------------------------------------
+machine_networks_config = lambda do |machine, box_config|
+  (box_config['networks'] || []).each do |c|
+    machine.vm.network(*(c[0] || []), **(c[1] || {}))
+  end
+end
+
+# machine config vm --------------------------------------------------
+# @see https://www.vagrantup.com/docs/vagrantfile/machine_settings.html
+machine_vm_config = lambda do |machine, box_config|
+  ['guest', 'hostname', 'communicator'].each do |k|
+    next unless box_config.member?(k)
+
+    box_config.fetch(k).tap do |v|
+      machine.vm.public_send("#{k}=", v)
+    end
+  end
+end
+
+# machine provisions -------------------------------------------------
+machine_provisions_config = lambda do |machine, box_config|
+  provisions = box_config['provisions']
+  (provisions || []).each do |provision|
+    type = provision.delete(:type)&.to_s
+
+    machine.vm.provision(type, **provision)
+  end
+end
+
+# @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 YAML.safe_load(ENV['SILENCE_DUPLICATE_DIRECTORY_ERRORS'].to_s)
+  require 'listen'
+
+  # rubocop:disable all
+  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
+  # rubocop:enable all
+end
+
+# configure ----------------------------------------------------------
+Vagrant.configure(2) do |config|
+  requires_from_boxes.call(boxes)
+  boxes.each do |box, box_config|
+    next if box_config['disabled']
+
+    modifyvm_config.call(config, box_config)
+    synced_folders_config.call(config, box_config)
+
+    machine_config.call(config, box, box_config) do |machine|
+      machine_networks_config.call(machine, box_config)
+      machine_vm_config.call(machine, box_config)
+      machine_provisions_config.call(machine, box_config)
+    end
+  end
+end