kamaze-project 1.0.0

data/lib/kamaze/project/resources/config/tools.yml

@@ -0,0 +1,15 @@
+---
+console:         'kamaze/project/tools/console'
+gemspec_builder: 'kamaze/project/tools/gemspec/builder'
+gemspec_packer:  'kamaze/project/tools/gemspec/packer'
+gemspec_reader:  'kamaze/project/tools/gemspec/reader'
+gemspec_writer:  'kamaze/project/tools/gemspec/writer'
+git:             'kamaze/project/tools/git'
+licenser:        'kamaze/project/tools/licenser'
+process_locker:  'kamaze/project/tools/process_locker'
+rspec:           'kamaze/project/tools/rspec'
+rubocop:         'kamaze/project/tools/rubocop'
+shell:           'kamaze/project/tools/shell'
+vagrant:         'kamaze/project/tools/vagrant'
+yardoc:          'kamaze/project/tools/yardoc'
+yardoc_watcher:  'kamaze/project/tools/yardoc/watcher'

data/lib/kamaze/project/struct.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'
+require 'ostruct'
+
+# Generic struct (ala`` OpenStruct``)
+class Kamaze::Project::Struct < OpenStruct
+  # Introduces some strictness on ``OpenStruct#method_missing``
+  #
+  # @raise [NoMethodError]
+  # @see https://apidock.com/ruby/OpenStruct/method_missing
+  # @return [Object]
+  def method_missing(method, *args)
+    if method[-1] != '='
+      unless self.to_h.include?(method.to_sym)
+        message = "undefined method `#{method}' for #{self}"
+
+        raise NoMethodError, message, caller(1)
+      end
+    end
+
+    super
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    super
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# A Ruby static code analyzer, based on the community Ruby style guide.
+#
+# @see http://batsov.com/rubocop/
+# @see https://github.com/bbatsov/rubocop
+#
+# Share RuboCop rules across repos
+# @see https://blog.percy.io/share-rubocop-rules-across-all-of-your-repos-f3281fbd71f8
+# @see https://github.com/percy/percy-style
+#
+# ~~~~
+# # .rubocop.yml
+# inherit_gem:
+#   percy-style: [ default.yml ]
+# ~~~~
+
+# 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.
+
+[:control, :correct].each { |req| require_relative "cs/#{req}" }

data/lib/kamaze/project/tasks/cs/control.rb

@@ -0,0 +1,17 @@
+# 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.
+
+desc 'Run static code analyzer'
+task 'cs:control', [:path] do |t, args|
+  tools.fetch(:rubocop).prepare do |c|
+    c.patterns = args.fetch(:path)
+    c.options = ['--parallel']
+  end.run
+
+  task.reenable
+end

data/lib/kamaze/project/tasks/cs/correct.rb

@@ -0,0 +1,17 @@
+# 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.
+
+desc 'Run static code analyzer, auto-correcting offenses'
+task 'cs:correct', [:path] do |t, args|
+  tools.fetch(:rubocop).prepare do |c|
+    c.patterns = args.fetch(:path)
+    c.options = ['--auto-correct']
+  end.run
+
+  task.reenable
+end

data/lib/kamaze/project/tasks/cs/pre_commit.rb

@@ -0,0 +1,66 @@
+# 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.
+
+# Sample of use (``.git/hooks/pre-commit``):
+#
+# ```sh
+# #!/usr/bin/env sh
+#
+# exec bundle exec rake cs:pre-commit
+# ```
+
+# process files (index) ----------------------------------------------
+process = lambda do
+  hook = tools.fetch(:git).hooks[:pre_commit]
+
+  hook.process_index(allow_empty: true) do |files|
+    return nil if files.reject(&:deleted?).empty?
+
+    tools.fetch(:rubocop).prepare do |c|
+      c.patterns = files.reject(&:deleted?).map(&:to_s)
+    end.run
+  end
+end
+
+# after process ------------------------------------------------------
+after = lambda do |retcode|
+  # @raise ArgumentError
+  retcode = ('%<retcode>d' % { retcode: retcode }).to_i
+  messages = { out: nil, err: nil }
+  # rubocop:disable Style/FormatStringToken
+  case retcode
+  when Errno::EOPNOTSUPP::Errno
+    messages[:err] = "%s\n\n" % [
+      'Changed files both present in index and worktree:',
+      '  (use "git reset HEAD <file>..." to unstage)',
+      '  (use "git add <file>..." to update what will be committed)',
+    ].join("\n")
+
+    tools.fetch(:git).status.index.unsafe_files.each do |file|
+      messages[:err] += "{{red:%smodified:\s\s\s#{file}}}\n" % ("\s" * 8)
+    end
+  end
+  # rubocop:enable Style/FormatStringToken
+
+  messages.each do |type, message|
+    unless message.nil?
+      tools.fetch(:console).public_send("std#{type}").puts(message + "\n")
+    end
+  end
+
+  exit(retcode) unless retcode.zero?
+end
+
+# task ---------------------------------------------------------------
+task 'cs:pre-commit' do
+  begin
+    process.call
+  rescue SystemExit => e
+    after.call(e.status)
+  end
+end

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

@@ -0,0 +1,21 @@
+# coding: utf-8
+# 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 'rake/clean'
+
+tools.fetch(:yardoc).tap do |yardoc|
+  CLOBBER.include(yardoc.output_dir)
+end.yield_self do |yardoc|
+  desc 'Generate documentation (using YARD)'
+  task doc: [] do |task|
+    yardoc.run
+
+    task.reenable
+  end
+end

data/lib/kamaze/project/tasks/doc/watch.rb

@@ -0,0 +1,41 @@
+# 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 'rake/clean'
+
+# rubocop:disable Lint/UselessAssignment
+
+# Display start time
+#
+# @todo add observer on watcher
+# @return [Boolean]
+time = proc do
+  stime = Time.now.to_s.split(/\s+/)[0..1].reverse.join(' ')
+
+  tools.fetch(:console).stdout.puts("{{green:#{stime}}}")
+end
+
+# rubocop:enable Lint/UselessAssignment
+
+# clobber -----------------------------------------------------------
+tools.fetch(:yardoc).tap do |yardoc|
+  CLOBBER.include(yardoc.output_dir)
+end
+
+# watch --------------------------------------------------------------
+desc 'Watch documentation changes'
+task :'doc:watch' do |task|
+  # ENV['LISTEN_GEM_DEBUGGING'] = '2'
+  tools.fetch(:process_locker).lock!(:doc_watch) do
+    begin
+      tools.fetch(:yardoc_watcher).watch(true)
+    rescue SystemExit, Interrupt
+      exit(Errno::ECANCELED::Errno)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# 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 base tasks -------------------------------------------------
+[:gemspec, :build].each { |req| require_relative "gem/#{req}" }
+
+# Default task -------------------------------------------------------
+desc 'Build all the packages'
+task gem: [:'gem:build']

data/lib/kamaze/project/tasks/gem/build.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 'rake/clean'
+
+builder = tools.fetch(:gemspec_builder)
+writer = tools.fetch(:gemspec_writer)
+
+# Generate gemspec file (when missing) -------------------------------
+writer.write unless builder.buildable?
+
+# clobber ------------------------------------------------------------
+CLOBBER.include(builder.package_dir)
+
+# task ---------------------------------------------------------------
+file builder.buildable => builder.source_files.to_a.map(&:to_s) do
+  builder.build
+
+  Rake::Task['clobber'].reenable
+end
+
+# task ---------------------------------------------------------------
+task 'gem:build' do |task|
+  [writer.to_s, builder.buildable].each do |t|
+    Rake::Task[t].invoke
+  end
+
+  task.reenable
+end

data/lib/kamaze/project/tasks/gem/compile.rb

@@ -0,0 +1,30 @@
+# 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 'rake/clean'
+require_relative '../gem'
+
+packer = tools.fetch(:gemspec_packer)
+writer = tools.fetch(:gemspec_writer)
+
+# generate gemspec file (when missing) -------------------------------
+writer.write unless packer.ready?
+
+# tasks --------------------------------------------------------------
+packer.packables.each do |packable|
+  CLOBBER.include(packable)
+
+  desc "Compile executable: #{packable.basename}"
+  file packable => packer.source_files.to_a.map(&:to_s) do
+    tools.fetch(:process_locker).lock!(:gemspec_packer) do
+      packer.pack(packable)
+
+      Rake::Task['clobber'].reenable
+    end
+  end
+end

data/lib/kamaze/project/tasks/gem/gemspec.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.
+
+reader = tools.fetch(:gemspec_reader)
+writer = tools.fetch(:gemspec_writer)
+
+files = [writer.templated]
+        .concat((reader.read&.files).to_a)
+        .concat(Dir.glob(['gems.rb', 'gems.locked'])).map(&:to_s).sort
+
+# task 'gem:gemspec': [writer.to_s]
+desc 'Update gemspec'
+file writer.to_s => files do
+  writer.write
+end

data/lib/kamaze/project/tasks/gem/install.rb

@@ -0,0 +1,32 @@
+# 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.
+
+builder = tools.fetch(:gemspec_builder)
+
+desc 'Install gem'
+task 'gem:install': [builder.buildable] do |task|
+  require 'cliver'
+
+  command = [
+    [Cliver.detect(:sudo) ? [:sudo, '-H'] : nil],
+    [Cliver.detect!(:gem),
+     :install,
+     '--update-sources',
+     '--clear-sources',
+     '--no-user-install',
+     '--norc',
+     '--no-document',
+     builder.buildable]
+  ].flatten.compact.map(&:to_s)
+
+  begin
+    sh(*command, verbose: false)
+  rescue SystemExit, Interrupt
+    exit(Errno::ECANCELED::Errno)
+  end
+end

data/lib/kamaze/project/tasks/gem/push.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.
+
+[nil, :gem_runner, :exceptions].each do |req|
+  require "rubygems/#{req}".rstrip('/')
+end
+
+# Code mostly based on gem executable
+#
+# @see http://guides.rubygems.org/publishing/
+# @see rubygems-tasks
+builder = tools.fetch(:gemspec_builder)
+desc 'Push gem up to the gem server'
+task 'gem:push': [builder.buildable] do
+  args = [:push, builder.buildable].map(&:to_s)
+
+  begin
+    Gem::GemRunner.new.run(args.map(&:to_s))
+  rescue Gem::SystemExitException => e
+    exit(e.exit_code)
+  end
+end

data/lib/kamaze/project/tasks/misc/gitignore.rb

@@ -0,0 +1,29 @@
+# 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'
+
+::Pathname.new('.gitignore').tap do |file|
+  if file.exist?
+    # desc "Reformat #{file} file"
+    task file.to_s do
+      lines = file.read.lines
+                  .map(&:rstrip)
+                  .reject(&:empty?)
+                  .reject { |m| m[0] == '#' }
+                  .sort_by(&:downcase)
+
+      {
+        regular: lines.clone.reject { |m| m[0] == '!' }.freeze,
+        inverse: lines.clone.keep_if { |m| m[0] == '!' }.freeze,
+      }.values.flatten.yield_self do |rules|
+        rules.join("\n").tap { |content| file.write(content) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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.
+
+# Start a REPL
+#
+# @see [Kamaze::Project::Tools::Shell]
+
+# task ---------------------------------------------------------------
+desc 'Start ruby REPL'
+task :shell do
+  tools.fetch(:shell).start
+end