kamaze-project 1.0.0

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

@@ -0,0 +1,70 @@
+# 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 '../gemspec'
+require_relative 'reader/decorator'
+
+require 'pathname'
+require 'rubygems'
+
+# Read ``gemspec`` file
+#
+# Retrieve ``Gem::Specification`` through ``read`` method.
+#
+# @see Kamaze::Project
+class Kamaze::Project::Tools::Gemspec::Reader
+  # @return [String]
+  attr_accessor :gem_name
+
+  attr_writer :project
+
+  def mutable_attributes
+    [:project, :gem_name]
+  end
+
+  # @return [Pathname]
+  def pwd
+    ::Pathname.new(Dir.pwd)
+  end
+
+  # Read gemspec (as given ``type``)
+  #
+  # Return ``Gem::Specification`` or given ``type``
+  #
+  # @raise [ArgumentError] when type is not supported
+  # @param [nil|Class|Symbol] type
+  # @return [Gem::Specification|Object]
+  def read(type = nil)
+    Dir.chdir(pwd) do
+      spec = Gem::Specification.load(self.spec_file.to_s)
+
+      type ? Decorator.new(spec).to(type) : spec
+    end
+  end
+
+  # Get (gem)spec file path
+  #
+  # @return [Pathname]
+  def spec_file
+    pwd.join("#{project.name}.gemspec")
+  end
+
+  # Get project
+  #
+  # @see Kamaze.project
+  # @return [Object|Kamaze::Project]
+  def project
+    @project || Kamaze.project
+  end
+
+  protected
+
+  def setup
+    @gem_name ||= project.name
+  end
+end

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

@@ -0,0 +1,78 @@
+# 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/tools/gemspec/reader'
+require 'ostruct'
+
+class Kamaze::Project::Tools::Gemspec::Reader
+end
+
+# Decorator for ``Gem::Specification``
+#
+# @note Decorator is not recursive
+class Kamaze::Project::Tools::Gemspec::Reader::Decorator
+  # @param [Gem::Specification] spec
+  def initialize(spec)
+    @spec = spec
+  end
+
+  # Decorate specification to a given type
+  #
+  # @param [Class|symbol] type
+  # @return [Object]
+  #
+  # @raise [ArgumentError]
+  # @see methods
+  def to(type)
+    method = methods_mapping.fetch(type)
+  rescue KeyError
+    raise ArgumentError, "invalid type: #{type}"
+  else
+    self.__send__(method)
+  end
+
+  protected
+
+  # @return [Gem::Specification]
+  attr_reader :spec
+
+  # Provides methods mapping
+  #
+  # @return [Hash]
+  def methods_mapping
+    {
+      Hash => :decorate_to_hash,
+      hash: :decorate_to_hash,
+      OpenStruct => :decorate_to_ostruct,
+      ostruct: :decorate_to_ostruct,
+      open_struct: :decorate_to_ostruct,
+    }
+  end
+
+  # Decorate to obtain a ``Hash``
+  #
+  # @return [Hash]
+  def decorate_to_hash
+    result = {}
+
+    spec.instance_variables.each do |k|
+      k = k.to_s.gsub(/^@/, '').to_sym
+
+      result[k] = spec.__send__(k) if spec.respond_to?(k)
+    end
+
+    result
+  end
+
+  # Decorate to obtain an ``OpenStruct``
+  #
+  # @return [OpenStruct]
+  def decorate_to_ostruct
+    OpenStruct.new(decorate_to_h)
+  end
+end

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

@@ -0,0 +1,127 @@
+# 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 '../gemspec'
+require 'pathname'
+require 'tenjin'
+
+# Class intended to generate ``gemspec`` file from a template
+#
+# Default template filename is ``gemspec.tpl``.
+# Consider to use ``Dir.chdir`` in order read and generate contents
+# from the right directory (especially during tests).
+#
+# @see templated
+# @see Kamaze::Project
+class Kamaze::Project::Tools::Gemspec::Writer
+  # Set path (almost filename) to templated gemspec
+  #
+  # @type [String|Pathname]
+  attr_writer :templated
+
+  # @see Kamaze.project
+  # @type [Object|Kamaze::Project]
+  # @return [Kamaze::Project]
+  attr_accessor :project
+
+  def mutable_attributes
+    [:templated, :project]
+  end
+
+  # Get path (almost filename) to templated gemspec
+  #
+  # @return [Pathname]
+  def templated
+    Pathname.new(@templated)
+  end
+
+  # Get path (almost filename) to generated gemspec
+  #
+  # @return [Pathname]
+  def generated
+    Pathname.new("#{project.name}.gemspec")
+  end
+
+  # Get string representation
+  #
+  # @see generated
+  # @return [String]
+  def to_s
+    generated.to_s
+  end
+
+  # Get variable used in template for ``Gem::Specification`` instantiation
+  #
+  # @return [String]
+  def spec_id
+    templated
+      .read
+      .scan(/Gem::Specification\.new\s+do\s+\|([a-z]+)\|/)
+      .flatten.fetch(0)
+  end
+
+  # Get dependency
+  #
+  # @return [Dependency]
+  def dependency
+    require_relative 'writer/dep_gen'
+
+    DepGen.new(spec_id).dependency
+  end
+
+  # Get template's context (variables)
+  #
+  # @return [Hahsh]
+  def context
+    {
+      name: project.name,
+      version: project.version,
+      dependencies: dependency,
+    }.yield_self do |variables|
+      project.version.to_h.merge(variables)
+    end
+  end
+
+  # Get generated/templated content
+  #
+  # @return [String]
+  def content
+    template.render(templated.to_s, context)
+  end
+
+  # Write gemspec file
+  #
+  # @return [self]
+  def write
+    generated.write(content)
+
+    self
+  end
+
+  protected
+
+  def setup
+    @templated ||= 'gemspec.tpl'
+    @project   ||= Kamaze.project
+  end
+
+  # Get ``GemspecDepsGen`` instance
+  #
+  # @see https://github.com/shvets/gemspec_deps_gen
+  # @return [GemspecDepsGen]
+  def deps_gen
+    GemspecDepsGen.new
+  end
+
+  # Get template engine
+  #
+  # @return [Tenjin::Engine]
+  def template
+    Tenjin::Engine.new(cache: false)
+  end
+end

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

@@ -0,0 +1,61 @@
+# 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 '../writer'
+require_relative 'dependency'
+require 'bundler'
+
+# Dependencies generator (using a kindo of decorator)
+#
+# Inspiration taken from ``GemspecDepsGen``
+#
+# @see https://github.com/shvets/gemspec_deps_gen
+class Kamaze::Project::Tools::Gemspec::Writer::DepGen
+  # @param [String] spec_name
+  def initialize(spec_name = 's')
+    @spec_name = spec_name.to_s
+  end
+
+  # Get dependencies indexed by group
+  #
+  # @return [Hash]
+  def dependencies
+    {}.yield_self do |dependencies|
+      { default: :runtime, development: :development }.each do |k, type|
+        dependencies[type] = gems_by_group(k).to_a.freeze
+      end
+
+      dependencies
+    end.freeze
+  end
+
+  # Get an object describing dependency
+  #
+  # @return [Kamaze::Project::Tools::Gemspec::Writer::Dependency]
+  def dependency
+    decorator.new(dependencies, @spec_name)
+  end
+
+  protected
+
+  # Get gems for given group
+  #
+  # @param [Symbol|String] group
+  # @return [Array]
+  def gems_by_group(group)
+    Bundler.environment
+           .dependencies
+           .select { |d| d.groups.include?(group.to_sym) }
+           .to_a
+  end
+
+  # @return [Kamaze::Project::Tools::Gemspec::Writer::Dependency]
+  def decorator
+    Kamaze::Project::Tools::Gemspec::Writer::Dependency
+  end
+end

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

@@ -0,0 +1,104 @@
+# 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 '../writer'
+
+# Describe dependency as an ``Hash`` indexed by type
+#
+# Sample of use:
+#
+# ```ruby
+# selector = lambda do |type|
+#   Bundler.environment.dependencies
+#          .select { |d| d.groups.include?(type) }.to_a
+# end
+#
+# dependency = Dependency.new({
+#   runtime: selector.call(:default),
+#   development: selector.call(:development),
+# })
+#
+# puts dependency.keep(:runtime).to_s
+# ```
+class Kamaze::Project::Tools::Gemspec::Writer::Dependency
+  # @param [Hash<Symbol, Gem::Dependency>] dependencies
+  # @param [String] spec_name
+  def initialize(dependencies, spec_name = 's')
+    @dependencies = dependencies.to_h.freeze
+    @spec_name = spec_name.to_s
+    @keep = [:runtime, :development]
+  end
+
+  # @return [self]
+  def keep(*keep)
+    @keep = keep
+
+    self
+  end
+
+  # Get dependencies hash representation.
+  #
+  # @return [Hash<Symbol, Gem::Dependency>]
+  def to_h
+    out = {}
+    @dependencies.each do |type, gems|
+      next unless @keep.include?(type)
+
+      out[type] = Array.new(gems.clone)
+    end
+
+    out
+  end
+
+  # Get dependencies string representation.
+  #
+  # @return [String]
+  def to_s
+    lines = []
+
+    self.to_h.each do |type, gems|
+      gems.each do |gem|
+        lines << make_spec_line(gem, type)
+      end
+    end
+
+    lines.join("\n").rstrip
+  end
+
+  # Get dependencies array representation.
+  #
+  # @return [Array<Gem::Dependency>]
+  def to_a
+    out = []
+
+    @dependencies.each do |type, gems|
+      next unless @keep.include?(type)
+
+      out.concat(gems)
+    end
+
+    out
+  end
+
+  protected
+
+  attr_reader :spec_name
+
+  # @param [Bundler::Dependency] gem
+  # @param [String|Symbol] type
+  # @return [String]
+  def make_spec_line(gem, type)
+    '%<spacer>s%<spec_name>s.%<method>s("%<gem>s", %<requirements>s)' % {
+      spacer: "\s" * 2,
+      spec_name: spec_name,
+      method: "add_#{type}_dependency",
+      gem: gem.name,
+      requirements: gem.requirements_list
+    }
+  end
+end

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

@@ -0,0 +1,95 @@
+# 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 'base_tool'
+require 'pathname'
+
+# rubocop:disable Style/Documentation
+
+module Kamaze::Project::Tools
+  class Git < BaseTool
+    # @abstract
+    class Util
+    end
+
+    class Status
+    end
+
+    class Hooks < Util
+    end
+  end
+
+  [:util,
+   :hooks,
+   :status].each { |req| require_relative "git/#{req}" }
+end
+
+# rubocop:enable Style/Documentation
+
+# Provide a wrapper based on ``rugged`` (``libgit2``}
+class Kamaze::Project::Tools::Git
+  # @return [String]
+  attr_writer :base_dir
+
+  # @see https://github.com/libgit2/rugged
+  #
+  # @return [Rugged::Repository]
+  attr_reader :repository
+
+  # Instance attributes altered during initialization
+  #
+  # @return [Array<Symbol>]
+  def mutable_attributes
+    [:base_dir]
+  end
+
+  # Get base directory
+  #
+  # @return [::Pathname]
+  def base_dir
+    ::Pathname.new(@base_dir)
+  end
+
+  # Get hooks
+  #
+  # @return [Hooks]
+  def hooks
+    Hooks.new(self)
+  end
+
+  # Get status
+  #
+  # @return [Hash]
+  def status
+    status = {}
+    repository.status { |file, data| status[file] = data }
+
+    Status.new(status)
+  end
+
+  # Denote is a repository
+  #
+  # @return [Boolean]
+  def repository?
+    !!repository
+  end
+
+  protected
+
+  def setup
+    @base_dir ||= Dir.pwd
+    begin
+      require 'rugged'
+      @repository = Rugged::Repository.new(base_dir.to_s)
+    rescue LoadError, Rugged::RepositoryError
+      # @todo Load error SHOULD be stored (as a boolean?)
+      @repository = nil
+    end
+  end
+end