kamaze-project 1.0.0

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

@@ -0,0 +1,6 @@
+# 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.

data/lib/kamaze/project/tasks/sources/license.rb

@@ -0,0 +1,35 @@
+# 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.
+
+writer = tools.fetch(:gemspec_writer)
+
+desc 'Apply license on (ruby) source files'
+task 'sources:license', [:output] => [writer.to_s] do |task, args|
+  output  = args[:output] ? Pathname.new(args[:output]) : nil
+  builder = tools.fetch(:gemspec_builder)
+
+  begin
+    tools.fetch(:licenser).process do |process|
+      process.output  = output if output
+      process.license = project.version.license_header
+      process.files   = builder.source_files.select do |file|
+        # @todo use a better ruby files recognition
+        # @todo implement better exclusion
+        if file.extname.gsub(/^\./, '') == 'rb'
+          file.basename.to_s != 'gems.rb'
+        else
+          false
+        end
+      end
+    end
+  rescue SystemExit, Interrupt
+    exit(Errno::ECANCELED::Errno)
+  rescue Errno::EPIPE => e
+    exit(e.class.const_get(:Errno))
+  end
+end

data/lib/kamaze/project/tasks/test.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.
+
+desc 'Run test suites'
+task :test do |task, args|
+  tags = args.extras
+
+  tools.fetch(:rspec).tap do |rspec|
+    rspec.tags = tags
+  end.run
+end

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

@@ -0,0 +1,71 @@
+# 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 'shellwords'
+require 'yaml'
+
+vagrant = tools.fetch(:vagrant)
+
+CLOBBER.include('Vagrantfile')
+
+file 'Vagrantfile': vagrant.sources do
+  vagrant.install
+end
+
+task 'vagrant:init': ['Vagrantfile']
+
+# :vagrant -----------------------------------------------------------
+{
+  'rsync-auto': 'Watch all rsync synced folders',
+  'status': 'Current machine states',
+}.each do |k, v|
+  desc v
+  task "vagrant:#{k}" => ['vagrant:init'] do |task|
+    vagrant.execute(k.to_s)
+
+    task.reenable
+  end
+end
+
+desc 'Dump config'
+task 'vagrant:dump', [:box_id] => ['vagrant:init'] do |task, args|
+  dump = args[:box_id] ? vagrant.boxes.fetch(args[:box_id]) : vagrant.boxes
+
+  $stdout.puts(YAML.dump(dump))
+
+  task.reenable
+end
+
+# :vagrant:vm --------------------------------------------------------
+vagrant.boxes.each do |box_id, config|
+  next if config['disabled']
+
+  task_ns = "vagrant:vm:#{box_id}"
+  {
+    up: [:halt],
+    halt: [:up],
+    reload: [:reload, :halt],
+    provision: [:provision],
+    rsync: [:rsync]
+  }.each do |command, tasks|
+    desc "#{command.to_s.gsub(/(\w+)/, &:capitalize)} #{box_id}"
+    task "#{task_ns}:#{command}" => ['vagrant:init'] do
+      vagrant.execute(command.to_s, box_id)
+
+      tasks.each { |tid| Rake::Task["#{task_ns}:#{tid}"].reenable }
+    end
+  end
+
+  desc "Ssh #{box_id}"
+  task "#{task_ns}:ssh", [:command] => ['vagrant:init'] do |task, args|
+    vagrant.ssh(box_id, args[:command])
+
+    task.reenable
+  end
+end

data/lib/kamaze/project/tasks/version/edit.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.
+
+desc 'Edit version file'
+task 'version:edit' do |task|
+  require 'tty/editor'
+
+  TTY::Editor.open(project.version.to_path).yield_self do |b|
+    task.reenable if b
+  end
+end

data/lib/kamaze/project/tools.rb

@@ -0,0 +1,18 @@
+# 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 'tools_provider'
+
+# rubocop:disable Style/Documentation
+
+module Kamaze::Project::Tools
+  require_relative 'tools/base_tool'
+end
+
+# rubocop:enable Style/Documentation

data/lib/kamaze/project/tools/base_tool.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 '../tools'
+require_relative '../observable'
+
+# Provides base for tools
+#
+# @abstract
+class Kamaze::Project::Tools::BaseTool < Kamaze::Project::Observable
+  def initialize
+    super()
+
+    dispatch_event(:before_setup)
+    setup
+    dispatch_event(:after_setup)
+
+    attrs_mute!
+  end
+
+  # Mutable attributes
+  #
+  # Mutable attributes become ``ro`` after initialization
+  #
+  # @return [Array]
+  def mutable_attributes
+    []
+  end
+
+  protected
+
+  # Execute additionnal setup
+  def setup
+    nil
+  end
+
+  # Mut(at)e attributes
+  #
+  # After initialization, attributes given has mutable
+  # become ``ro`` (protected setter)
+  #
+  # @return [self]
+  def attrs_mute!
+    mutable_attributes.each do |m|
+      self.singleton_class.class_eval { protected "#{m}=" }
+    end
+
+    self
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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 '../tools'
+
+# rubocop:disable Style/Documentation
+
+module Kamaze::Project::Tools
+  class Console < BaseTool
+  end
+
+  require_relative 'console/output'
+end
+
+# rubocop:enable Style/Documentation
+
+# Provide access to a [console](https://en.wikipedia.org/wiki/System_console)
+# having two outputs: ``stdout`` and ``stderr``
+#
+# @see Kamaze::Project::Tools::Console::Output
+class Kamaze::Project::Tools::Console
+  attr_writer :stdout
+  attr_writer :stderr
+
+  def setup
+    @stdout ||= $stdout
+    @stderr ||= $stderr
+  end
+
+  # @return [Output]
+  def stdout
+    Output.new(@stdout)
+  end
+
+  # @return [Output]
+  def stderr
+    Output.new(@stderr)
+  end
+
+  def mutable_attributes
+    [:stdout, :stderr]
+  end
+end

data/lib/kamaze/project/tools/console/output.rb

@@ -0,0 +1,120 @@
+# 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 '../console'
+require_relative 'output/buffer'
+
+# Provide a console output
+#
+# Console output can be initialized from a ``IO``
+# (``STDOUT`` and/or ``STDERR``)
+# a ``File``, using ``File.open()``, or a ``StringIO``.
+#
+# As a result, console provides a convenient way to suppress or replace
+# standard outputs (keeping them untouched).
+#
+# Console output uses ``cli-ui`` to provide colored formatting.
+#
+# @see https://github.com/Shopify/cli-ui
+# @see http://ruby-doc.org/core-2.1.3/IO.html
+class Kamaze::Project::Tools::Console::Output
+  # @param [IO] to
+  def initialize(to = $stdout)
+    @output = to
+  end
+
+  # Denote is a tty
+  #
+  # @return [Boolean]
+  def tty?
+    output.respond_to?(:'tty?') ? output.tty? : false
+  end
+
+  # Flushes any buffered data to the underlying operating system
+  #
+  # note that this is Ruby internal buffering only;
+  # the OS may buffer the data as well
+  #
+  # @return [self]
+  def flush
+    output.flush if output.respond_to?(:flush)
+
+    self
+  end
+
+  def method_missing(method, *args, &block)
+    if respond_to_missing?(method)
+      args = bufferize(*args) if formattable_on?(method.to_sym)
+
+      return output.public_send(method, *args, &block)
+    end
+
+    super
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    return true if output.respond_to?(method, include_private)
+
+    super(method, include_private)
+  end
+
+  # @!method puts(s)
+  #   Writes the given objects to ``ios`` as with ``IO#print``.
+  #
+  #   Writes a record separator (typically a newline) after any that
+  #   do not already end with a newline sequence.
+  #   If called with an array argument, writes each element on a new line.
+  #   If called without arguments, outputs a single record separator.
+  #
+  #   @param [String] s
+  #   @return [nil]
+
+  # @!method print(s)
+  #   Writes the given objects to ios as with IO#print.
+  #
+  #   Writes the given object(s) to ``ios``.
+  #
+  #   The stream must be opened for writing.
+  #   If the output field separator (``$,``) is not nil,
+  #   it will be inserted between each object.
+  #   If the output record separator (``$\``) is not nil,
+  #   it will be appended to the output.
+  #   If no arguments are given, prints ``$_``.
+  #   Objects that aren't strings will be converted by calling
+  #   their ``to_s`` method.
+  #   With no argument, prints the contents of the variable ``$_``.
+  #   Returns nil.
+  #   @param [String] s
+  #   @return [nil]
+
+  protected
+
+  attr_reader :output
+
+  # Formattable methods
+  #
+  # @return [Array<Symbol>]
+  def formattables
+    [:puts, :print, :write]
+  end
+
+  # Denote given method is formattable
+  #
+  # @param [Symbol] method
+  def formattable_on?(method)
+    formattables.include?(method.to_sym)
+  end
+
+  # Bufferize given arguments
+  #
+  # @param [Array<String>] strings
+  # @return [Array<String>]
+  def bufferize(*strings)
+    strings.to_a.map { |s| Buffer.new(self, s) }
+  end
+end

data/lib/kamaze/project/tools/console/output/buffer.rb

@@ -0,0 +1,48 @@
+# 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 '../output'
+require 'cli/ui'
+
+class Kamaze::Project::Tools::Console::Output
+  class Buffer
+  end
+end
+
+# Describe a buffer
+class Kamaze::Project::Tools::Console::Output::Buffer
+  # Get content
+  #
+  # @return [String]
+  attr_reader :content
+
+  # @param [Kamaze::Project::Tools::Console::Output] output
+  # @param [String] content
+  def initialize(output, content)
+    @output = output
+    @content = content
+  end
+
+  # @return [String]
+  def to_s
+    self.decorate(content)
+  end
+
+  protected
+
+  # @return [Kamaze::Project::Tools::Console::Output]
+  attr_reader :output
+
+  # Decorate given string depending ``output`` is a tty
+  #
+  # @param [String] str
+  # @return [String]
+  def decorate(str)
+    CLI::UI.fmt(str.to_s, enable_color: output.tty?)
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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 '../tools'
+require_relative 'packager'
+
+# Module providng several tools based on gemspec reader/writer
+module Kamaze::Project::Tools::Gemspec
+  class Reader < Kamaze::Project::Tools::BaseTool
+  end
+
+  class Writer < Kamaze::Project::Tools::BaseTool
+  end
+
+  # @abstract
+  class Packager < Kamaze::Project::Tools::Packager
+  end
+
+  class Builder < Packager
+  end
+
+  class Packer < Packager
+  end
+
+  [:packager,
+   :reader, :writer,
+   :builder, :packer].each { |req| require_relative "gemspec/#{req}" }
+end