kamaze-project 1.0.0 → 1.1.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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.
@@ -10,4 +10,9 @@ require_relative '../gemspec'
 
 # Concern for ``Gemspec``
 module Kamaze::Project::Tools::Gemspec::Concern
+  # @formatter:off
+  {
+    Reading: 'reading',
+  }.each { |k, v| autoload(k, "#{__dir__}/concern/#{v}") }
+  # @formatter:on
 end

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

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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 '../reader'
 require_relative '../concern'
 
 # Provides gemspec reader
@@ -29,9 +28,7 @@ module Kamaze::Project::Tools::Gemspec::Concern::Reading
 
   # @return [Kamaze::Project::Tools::Gemspec::Reader]
   def gemspec_reader
-    @gemspec_reader ||= Kamaze.project.fetch(:gemspec_reader)
-
-    @gemspec_reader
+    @gemspec_reader ||= Kamaze::Project.instance.tools.fetch(:gemspec_reader)
   end
 
   # Get specification

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

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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 'concern/reading'
 
 # Provide a specialized packager, for ``gemspec`` based projects
 #
@@ -21,7 +20,7 @@ require_relative 'concern/reading'
 # can be dynamically retrieved through the project.
 #
 # @abstract
-class Kamaze::Project::Tools::Gemspec::Packager
+class Kamaze::Project::Tools::Gemspec::Packager < Kamaze::Project::Tools::Packager
   include Kamaze::Project::Tools::Gemspec::Concern::Reading
 
   def mutable_attributes
@@ -44,17 +43,18 @@ class Kamaze::Project::Tools::Gemspec::Packager
   #
   # @return [Array<String>]
   def package_files
-    (Dir.glob([
-                '*.gemspec',
-                'Gemfile', 'Gemfile.lock',
-                'gems.rb', 'gems.locked',
-              ]) + (gemspec_reader.read&.files).to_a).sort
+    # @formatter: off
+    (gemspec_reader.read&.files).to_a.yield_self do |files| # rubocop:disable Style/RedundantParentheses
+      Dir.glob(%w[*.gemspec Gemfile Gemfile.lock gems.rb gems.locked])
+         .concat(files)
+    end.sort
+    # @formatter: on
   end
 
   def setup
-    @gemspec_reader ||= Kamaze.project.tools.fetch(:gemspec_reader)
+    @gemspec_reader ||= Kamaze::Project.instance.tools.fetch(:gemspec_reader)
 
-    self.verbose      = false
+    self.verbose = false
     self.source_files = package_files if self.source_files.to_a.empty?
   end
 

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

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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'
-require 'rubygems'
-require_relative 'reader'
-require_relative 'packer/command'
+require_relative '../gemspec'
 
 # Provides a ready to use interface based on rubyc (aka ruby-packer)
 #
 # @see https://github.com/pmq20/ruby-packer
-class Kamaze::Project::Tools::Gemspec::Packer
+class Kamaze::Project::Tools::Gemspec::Packer < Kamaze::Project::Tools::Gemspec::Packager
+  autoload(:Gem, 'rubygems')
+  autoload(:Pathname, 'pathname')
+  autoload(:Command, "#{__dir__}/packer/")
+
   # Binary (executable) used to pack the project
   #
   # @see https://github.com/pmq20/ruby-packer
@@ -25,10 +26,12 @@ class Kamaze::Project::Tools::Gemspec::Packer
   # @return [Array<Pathname>]
   def packables
     specification.executables.map do |executable|
+      # @formatter:off
       package_dirs.fetch(:bin)
                   .join(executable)
                   .to_s.gsub(%r{^./}, '')
                   .yield_self { |path| ::Pathname.new(path) }
+      # @formatter:on
     end
   end
 
@@ -44,12 +47,7 @@ class Kamaze::Project::Tools::Gemspec::Packer
   # @param [String] packable
   # @return [Pathname]
   def pack(packable)
-    bin_dir = ::Pathname.new(specification.bin_dir)
-
-    prepare
-    command_for(packable).execute
-
-    bin_dir.join(packable)
+    prepare.tap { command_for(packable).execute }
   end
 
   def mutable_attributes
@@ -74,14 +72,12 @@ class Kamaze::Project::Tools::Gemspec::Packer
   # @param [String] packable
   # @return [Command]
   def command_for(packable)
-    bin_dir = ::Pathname.new(specification.bin_dir)
-
     Dir.chdir(pwd) do
       Command.new do |command|
         command.executable = compiler
         command.src_dir    = package_dirs.fetch(:src)
         command.tmp_dir    = package_dirs.fetch(:tmp)
-        command.bin_dir    = bin_dir
+        command.bin_dir    = Pathname.new(specification.bin_dir)
         command.packable   = packable
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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.

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

@@ -1,26 +1,27 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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
+class Kamaze::Project::Tools::Gemspec::Reader < Kamaze::Project::Tools::BaseTool
+  autoload(:Pathname, 'pathname')
+  autoload(:Gem, 'rubygems')
+  autoload(:Decorator, "#{__dir__}/reader/decorator")
+
   # @return [String]
   attr_accessor :gem_name
 
+  # @return [Kamaze::Project]
   attr_writer :project
 
   def mutable_attributes
@@ -29,7 +30,7 @@ class Kamaze::Project::Tools::Gemspec::Reader
 
   # @return [Pathname]
   def pwd
-    ::Pathname.new(Dir.pwd)
+    Pathname.new(Dir.pwd)
   end
 
   # Read gemspec (as given ``type``)
@@ -40,11 +41,7 @@ class Kamaze::Project::Tools::Gemspec::Reader
   # @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
+    type ? Decorator.new(spec).to(type) : spec
   end
 
   # Get (gem)spec file path
@@ -56,10 +53,9 @@ class Kamaze::Project::Tools::Gemspec::Reader
 
   # Get project
   #
-  # @see Kamaze.project
   # @return [Object|Kamaze::Project]
   def project
-    @project || Kamaze.project
+    @project || Kamaze::Project.instance
   end
 
   protected
@@ -67,4 +63,16 @@ class Kamaze::Project::Tools::Gemspec::Reader
   def setup
     @gem_name ||= project.name
   end
+
+  # Read sepc file.
+  #
+  # @see Gem::Specification.load()
+  # @return [Gem::Specification|Object]
+  def spec
+    Dir.chdir(pwd) do
+      return Gem::Specification.new unless spec_file.file?
+
+      eval(self.spec_file.read, binding, self.spec_file.to_s) # rubocop:disable Security/Eval
+    end
+  end
 end

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

@@ -1,21 +1,18 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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
+require_relative '../reader'
 
 # Decorator for ``Gem::Specification``
 #
 # @note Decorator is not recursive
 class Kamaze::Project::Tools::Gemspec::Reader::Decorator
+  autoload(:OpenStruct, 'ostruct')
   # @param [Gem::Specification] spec
   def initialize(spec)
     @spec = spec

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

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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
 #
@@ -18,7 +16,12 @@ require 'tenjin'
 #
 # @see templated
 # @see Kamaze::Project
-class Kamaze::Project::Tools::Gemspec::Writer
+class Kamaze::Project::Tools::Gemspec::Writer < Kamaze::Project::Tools::BaseTool
+  autoload(:FileUtils, 'fileutils')
+  autoload(:Pathname, 'pathname')
+  autoload(:Tenjin, 'tenjin')
+  autoload(:DepGen, "#{__dir__}/writer/dep_gen")
+
   # Set path (almost filename) to templated gemspec
   #
   # @type [String|Pathname]
@@ -26,6 +29,7 @@ class Kamaze::Project::Tools::Gemspec::Writer
 
   # @see Kamaze.project
   # @type [Object|Kamaze::Project]
+  #
   # @return [Kamaze::Project]
   attr_accessor :project
 
@@ -59,18 +63,18 @@ class Kamaze::Project::Tools::Gemspec::Writer
   #
   # @return [String]
   def spec_id
+    # @formatter:off
     templated
       .read
       .scan(/Gem::Specification\.new\s+do\s+\|([a-z]+)\|/)
       .flatten.fetch(0)
+    # @formatter:on
   end
 
   # Get dependency
   #
   # @return [Dependency]
   def dependency
-    require_relative 'writer/dep_gen'
-
     DepGen.new(spec_id).dependency
   end
 
@@ -78,6 +82,7 @@ class Kamaze::Project::Tools::Gemspec::Writer
   #
   # @return [Hahsh]
   def context
+    # @formatter:off
     {
       name: project.name,
       version: project.version,
@@ -85,6 +90,7 @@ class Kamaze::Project::Tools::Gemspec::Writer
     }.yield_self do |variables|
       project.version.to_h.merge(variables)
     end
+    # @formatter:on
   end
 
   # Get generated/templated content
@@ -94,28 +100,46 @@ class Kamaze::Project::Tools::Gemspec::Writer
     template.render(templated.to_s, context)
   end
 
+  # Get status for current gemspec file.
+  #
+  # @return [Hash{Symbol => Object}]
+  def status
+    Pathname.new(self.to_s).yield_self do |file|
+      # @formatter:off
+      {
+        mtime: -> { return File.mtime(file) if file.file? }.call,
+        content: -> { return file.read if file.file? }.call
+      }
+      # @formatter:on
+    end
+  end
+
   # Write gemspec file
   #
   # @return [self]
-  def write
-    generated.write(content)
-
-    self
+  def write(preserve_mtime: false)
+    self.tap do
+      (preserve_mtime ? status : {}).tap do |meta|
+        generated.write(content)
+
+        if preserve_mtime
+          if content == meta.fetch(:content, nil)
+            fs.touch(self.to_s, mtime: meta.fetch(:mtime), nocreate: true)
+          end
+        end
+      end
+    end
   end
 
   protected
 
+  # @return [FileUtils]
+  attr_reader :fs
+
   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
+    @project ||= Kamaze::Project.instance
+    @fs ||= FileUtils
   end
 
   # Get template engine

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# Copyright (C) 2017-2021 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.
@@ -43,18 +43,21 @@ class Kamaze::Project::Tools::Gemspec::Writer::DepGen
 
   protected
 
+  # @return [Bundler::Runtime]
+  def runtime
+    # Bundler.environment has been removed in favor of Bundler.load
+    Bundler.public_send(Bundler.respond_to?(:load) ? :load : :environment)
+  end
+
   # 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
+    runtime.dependencies.select { |d| d.groups.include?(group.to_sym) }.to_a
   end
 
-  # @return [Kamaze::Project::Tools::Gemspec::Writer::Dependency]
+  # @return [Class<Kamaze::Project::Tools::Gemspec::Writer::Dependency>]
   def decorator
     Kamaze::Project::Tools::Gemspec::Writer::Dependency
   end