cartage 2.0 → 2.2.1

data/lib/cartage/core.rb

@@ -4,7 +4,7 @@
 class Cartage
   # Extensions for us to use to help define Cartage with its attr_readers with
   # defaults and attr_writers with transforms.
-  module Core #:nodoc:
+  module Core # :nodoc:
     private
 
     # Define an attr_reader with a memoized default value. The +default+ is
@@ -25,8 +25,8 @@ class Cartage
     #    # Does the same thing
     #    attr_reader_with_default :answer, 42
     def attr_reader_with_default(name, default = nil, &block)
-      fail ArgumentError, 'No default provided.' unless default || block
-      fail ArgumentError, 'Too many defaults provided.' if default && block
+      fail ArgumentError, "No default provided." unless default || block
+      fail ArgumentError, "Too many defaults provided." if default && block
 
       default_ivar = :"@default_#{name}"
       default_name = :"default_#{name}"
@@ -43,10 +43,10 @@ class Cartage
       end
 
       dblk = if default.respond_to?(:call)
-               default
-             else
-               block || -> { default }
-             end
+        default
+      else
+        block || -> { default }
+      end
 
       define_method(default_name) do
         if instance_variable_defined?(default_ivar)
@@ -64,18 +64,18 @@ class Cartage
     # The +transform+ may be provided as a callable (such as a proc), an object
     # that responds to #to_proc (such as a Symbol), or a block.
     def attr_writer_with_transform(name, transform = nil, &block)
-      fail ArgumentError, 'No transform provided.' unless transform || block
-      fail ArgumentError, 'Too many transforms provided.' if transform && block
+      fail ArgumentError, "No transform provided." unless transform || block
+      fail ArgumentError, "Too many transforms provided." if transform && block
 
       tblk = if transform.respond_to?(:call)
-               transform
-             elsif transform.respond_to?(:to_proc)
-               transform.to_proc
-             elsif block
-               block
-             else
-               fail ArgumentError, 'Transform is not callable.'
-             end
+        transform
+      elsif transform.respond_to?(:to_proc)
+        transform.to_proc
+      elsif block
+        block
+      else
+        fail ArgumentError, "Transform is not callable."
+      end
 
       define_method(:"#{name}=") do |v|
         instance_variable_set(:"@#{name}", tblk.call(v))
@@ -109,4 +109,4 @@ class Cartage
   extend Core
 end
 
-require_relative 'backport'
+require_relative "backport"

data/lib/cartage/gli_ext.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'gli'
+require "gli"
 
 ##
-module Cartage::CLIOptionsSupport #:nodoc:
+module Cartage::CLIOptionsSupport # :nodoc:
   # Clears defaults from a flag-set. By default, only clears symbolic defaults
   # (e.g., <tt>:'default-value'</tt>.)
   def clear_defaults_from(opts, flag_set: flags, symbol_defaults_only: true)
     flag_set.each do |name, flag|
       next unless flag.default_value
-      next if symbol_defaults_only && !flag.default_value.kind_of?(Symbol)
+      next if symbol_defaults_only && !flag.default_value.is_a?(Symbol)
       next unless opts[name] == flag.default_value
 
-      aliases = [ name, *flag.aliases ].compact
+      aliases = [name, *flag.aliases].compact
       aliases += aliases.map(&:to_s)
       aliases.each { |aka| opts[aka] = nil }
     end
@@ -20,7 +20,7 @@ module Cartage::CLIOptionsSupport #:nodoc:
 end
 
 # Work around a bug with the RdocDocumentListener
-module RdocDocumentListenerAppFix #:nodoc:
+module RdocDocumentListenerAppFix # :nodoc:
   def initialize(_global_options, _options, _arguments, app)
     super
     @app = app
@@ -28,12 +28,12 @@ module RdocDocumentListenerAppFix #:nodoc:
 end
 
 ##
-class GLI::Commands::RdocDocumentListener #:nodoc:
+class GLI::Commands::RdocDocumentListener # :nodoc:
   prepend RdocDocumentListenerAppFix
 end
 
 ##
-module GLI::App #:nodoc:
+module GLI::App # :nodoc:
   include Cartage::CLIOptionsSupport
 
   # Indicate the parent GLI application.
@@ -43,7 +43,7 @@ module GLI::App #:nodoc:
 end
 
 ##
-class GLI::Command #:nodoc:
+class GLI::Command # :nodoc:
   include Cartage::CLIOptionsSupport
 
   # Indicate the parent GLI application.
@@ -57,8 +57,8 @@ class GLI::Command #:nodoc:
   end
 
   def plugin_version_command(*plugin_classes)
-    desc 'Show the plug-in version'
-    command 'version' do |version|
+    desc "Show the plug-in version"
+    command "version" do |version|
       version.hide!
       version.action do |_g, _o, _a|
         plugin_classes.each do |plugin_class|

data/lib/cartage/minitest.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'cartage'
+require "cartage"
 
 ##
 # Provide helper methods for testing Cartage and plug-ins using Minitest.
 module Cartage::Minitest
-  #:nocov:
+  # :nocov:
 
   ##
   # A helper to stub ENV lookups against an +env+ hash. If +options+ has a key
@@ -43,7 +43,7 @@ module Cartage::Minitest
 
   # A helper to stub Cartage#repo_url to return +value+.
   def stub_cartage_repo_url(value = nil, &block)
-    stub_instance_method Cartage, :repo_url, -> { value || 'git://host/repo-url.git' },
+    stub_instance_method Cartage, :repo_url, -> { value || "git://host/repo-url.git" },
       &block
   end
 
@@ -76,8 +76,8 @@ module Cartage::Minitest
 
     Dir.singleton_class.send(:alias_method, :__minitest_stub_chdir__, :chdir)
     Dir.singleton_class.send(:define_method, :chdir) do |path, &block|
-      assert_equal.(expected, path)
-      block.call(path) if block
+      assert_equal.call(expected, path)
+      block&.call(path)
     end
 
     yield
@@ -90,14 +90,14 @@ module Cartage::Minitest
   # Stubs Cartage#run and asserts that the array of commands provided are
   # matched for each call and that they are all consumed.
   def stub_cartage_run(*expected)
-    expected = [ expected ].flatten(1)
+    expected = [expected].flatten(1)
     stub_instance_method Cartage, :run, ->(v) { assert_equal expected.shift, v } do
       yield
     end
     assert_empty expected
   end
 
-  #:nocov:
+  # :nocov:
 
   private
 

data/lib/cartage/plugin.rb

@@ -7,7 +7,7 @@ class Cartage
   class Plugin
     class << self
       # Register a plugin.
-      def inherited(plugin) #:nodoc:
+      def inherited(plugin) # :nodoc:
         registered[plugin.plugin_name] = plugin
       end
 
@@ -19,8 +19,8 @@ class Cartage
 
       # The name of the plugin.
       def plugin_name
-        @name ||= name.split(/::/).last.gsub(/([A-Z])/, '_\1').downcase.
-          sub(/^_/, '')
+        @name ||= name.split("::").last.gsub(/([A-Z])/, '_\1').downcase
+          .sub(/^_/, "")
       end
 
       # Iterate the plugins by +name+.
@@ -31,14 +31,14 @@ class Cartage
       # The version of the plug-in.
       def version
         if const_defined?(:VERSION, false)
-          VERSION
+          self::VERSION
         else
           Cartage::VERSION
         end
       end
 
       # A utility method to load and decorate an object with Cartage plug-ins.
-      def load_for(klass) #:nodoc:
+      def load_for(klass) # :nodoc:
         load
         decorate(klass)
       end
@@ -46,13 +46,17 @@ class Cartage
       # A utility method that will find all Cartage plug-ins and load them. A
       # Cartage plug-in is found in the Gems as <tt>cartage/plugins/*.rb</tt>
       # and descends from Cartage::Plugin.
-      def load #:nodoc:
+      def load(rescan: false) # :nodoc:
         @found ||= {}
         @loaded ||= {}
-        @files ||= Gem.find_files('cartage/plugins/*.rb')
+        @files = nil unless defined?(@files)
+
+        if @files.nil? || rescan
+          @files = Gem.find_files("cartage/plugins/*.rb")
+        end
 
         @files.reverse_each do |path|
-          name = File.basename(path, '.rb').to_sym
+          name = File.basename(path, ".rb").to_sym
           @found[name] = path
         end
 
@@ -62,7 +66,7 @@ class Cartage
       end
 
       # Decorate the provided class with lazy initialization methods.
-      def decorate(klass) #:nodoc:
+      def decorate(klass) # :nodoc:
         registered.each do |name, plugin|
           ivar = "@#{name}"
 
@@ -119,7 +123,7 @@ class Cartage
 
     # A plug-in is given, as +cartage+, the instance of Cartage that owns it.
     def initialize(cartage)
-      fail NotImplementedError, 'not a subclass' if instance_of?(Cartage::Plugin)
+      fail NotImplementedError, "not a subclass" if instance_of?(Cartage::Plugin)
       @cartage = cartage
       @disabled = false
     end

data/lib/cartage/plugins/build_tarball.rb

@@ -27,10 +27,10 @@ class Cartage::BuildTarball < Cartage::Plugin
 
   def run_command
     command = [
-      'tar',
+      "tar",
       "cf#{cartage.tar_compression_flag}",
       package_name.to_s,
-      '-C',
+      "-C",
       cartage.tmp_path.to_s,
       cartage.name
     ]

data/lib/cartage/plugins/manifest.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'tempfile'
+require "tempfile"
 
 # Manage and use the package manifest ('Manifest.txt') and the ignore file
 # ('.cartignore').
@@ -8,21 +8,21 @@ class Cartage::Manifest < Cartage::Plugin
   # This exception is raised if the package manifest is missing.
   class MissingError < StandardError
     def message # :nodoc:
-      <<-exception
-Cartage cannot create a package without a Manifest.txt file. You may generate
-or update the Manifest.txt file with the following command:
+      <<~EXCEPTION
+        Cartage cannot create a package without a Manifest.txt file. You may generate
+        or update the Manifest.txt file with the following command:
 
-    cartage manifest generate
+            cartage manifest generate
 
-      exception
+      EXCEPTION
     end
   end
 
-  DIFF = if system('gdiff', __FILE__, __FILE__) #:nodoc:
-           'gdiff'
-         else
-           'diff'
-         end
+  DIFF = if system("gdiff", __FILE__, __FILE__) # :nodoc:
+    "gdiff"
+  else
+    "diff"
+  end
 
   # Resolve the Manifest to something that can be used by <tt>tar -T</tt>. The
   # manifest should be relative to the files in the repository, as reported
@@ -40,13 +40,13 @@ or update the Manifest.txt file with the following command:
   # A block is required and is provided the +resolved_path+.
   def resolve(path = nil) # :yields: resolved_path
     fail MissingError unless manifest_file.exist?
-    fail ArgumentError, 'A block is required.' unless block_given?
+    fail ArgumentError, "A block is required." unless block_given?
 
     data = strip_comments_and_empty_lines(manifest_file.readlines)
-    fail 'Manifest.txt is empty.' if data.empty?
+    fail "Manifest.txt is empty." if data.empty?
 
     path = Pathname(path || Dir.pwd).expand_path.basename
-    tmpfile = Tempfile.new('Manifest.')
+    tmpfile = Tempfile.new("Manifest.")
 
     tmpfile.puts prune(data, with_slugignore: true).map { |line|
       path.join(line).to_s
@@ -70,19 +70,19 @@ or update the Manifest.txt file with the following command:
   # Checks Manifest.txt
   def check
     fail MissingError unless manifest_file.exist?
-    tmp = create_file_list('Manifest.tmp')
+    tmp = create_file_list("Manifest.tmp")
 
-    args = [ DIFF, '-du', manifest_file.basename.to_s, tmp.to_s ]
+    args = [DIFF, "-du", manifest_file.basename.to_s, tmp.to_s]
 
     if cartage.quiet
-      %x(#{(args << '-q').join(' ')})
+      `#{(args << "-q").join(" ")}`
     else
       system(*args)
     end
 
     $?.success?
   ensure
-    tmp.unlink if tmp
+    tmp&.unlink
   end
 
   # Installs the default .cartignore file. Will either +overwrite+ or +merge+
@@ -90,8 +90,8 @@ or update the Manifest.txt file with the following command:
   def install_default_ignore(mode: nil)
     save = mode || !ignore_file.exist?
 
-    if mode == 'merge'
-      cartage.display('Merging .cartignore...')
+    if mode == "merge"
+      cartage.display("Merging .cartignore...")
       data = strip_comments_and_empty_lines(ignore_file.readlines)
 
       if data.empty?
@@ -101,10 +101,10 @@ or update the Manifest.txt file with the following command:
         data = data.uniq.join("\n")
       end
     elsif save
-      cartage.display('Creating .cartignore...')
+      cartage.display("Creating .cartignore...")
       data = DEFAULT_IGNORE
     else
-      cartage.display('.cartignore already exists, skipping...')
+      cartage.display(".cartignore already exists, skipping...")
     end
 
     ignore_file.write(data) if save
@@ -113,37 +113,37 @@ or update the Manifest.txt file with the following command:
   private
 
   def ignore_file
-    @ignore_file ||= @cartage.root_path.join('.cartignore')
+    @ignore_file ||= @cartage.root_path.join(".cartignore")
   end
 
   def slugignore_file
-    @slugignore_file ||= @cartage.root_path.join('.slugignore')
+    @slugignore_file ||= @cartage.root_path.join(".slugignore")
   end
 
   def manifest_file
-    @manifest_file ||= @cartage.root_path.join('Manifest.txt')
+    @manifest_file ||= @cartage.root_path.join("Manifest.txt")
   end
 
   def create_file_list(filename)
-    files = prune(%x(git ls-files).split.map(&:chomp)).sort.uniq.join("\n")
+    files = prune(`git ls-files`.split.map(&:chomp)).sort.uniq.join("\n")
     Pathname(filename).tap { |f| f.write("#{files}\n") }
   end
 
   def ignore_patterns(with_slugignore: false)
     pats = if ignore_file.exist?
-             ignore_file.readlines
-           elsif with_slugignore && slugignore_file.exist?
-             slugignore_file.readlines
-           else
-             DEFAULT_IGNORE.split($/)
-           end
+      ignore_file.readlines
+    elsif with_slugignore && slugignore_file.exist?
+      slugignore_file.readlines
+    else
+      DEFAULT_IGNORE.split($/)
+    end
 
     pats = strip_comments_and_empty_lines(pats)
 
     pats.map { |pat|
-      if pat =~ %r{\A/[^*?]+\z}
+      if %r{\A/[^*?]+\z}.match?(pat)
         Regexp.new(%r{\A#{pat.sub(%r{\A/}, '')}/})
-      elsif pat =~ %r{/\z}
+      elsif pat.end_with?("/")
         Regexp.new(/\A#{pat}/)
       else
         pat
@@ -153,7 +153,7 @@ or update the Manifest.txt file with the following command:
 
   def strip_comments_and_empty_lines(list)
     list.map { |item|
-      item = item.chomp.gsub(/(?:^|[^\\])#.*\z/, '').strip
+      item = item.chomp.gsub(/(?:^|[^\\])#.*\z/, "").strip
       if item.empty?
         nil
       else
@@ -182,55 +182,55 @@ or update the Manifest.txt file with the following command:
     end
   end
 
-  DEFAULT_IGNORE = <<-'EOM' #:nodoc:
-# Some of these are in .gitignore, but let’s remove these just in case they got
-# checked in.
-
-# Exact files to remove. Matches with ==.
-.DS_Store
-.autotest
-.editorconfig
-.env
-.git-wtfrc
-.gitignore
-.local.vimrc
-.lvimrc
-.cartignore
-.powenv
-.rake_tasks~
-.rspec
-.rubocop.yml
-.rvmrc
-.semaphore-cache
-.workenv
-Guardfile
-README.md
-bin/build
-bin/notify-project-board
-bin/osx-bootstrap
-bin/setup
-
-# Patterns to remove. These have a *, **, or ? in them. Uses File.fnmatch with
-# File::FNM_DOTMATCH and File::FNM_EXTGLOB.
-*.rbc
-.*.swp
-**/.DS_Store
-
-# Directories to remove. These should end with a slash. Matches as the regular
-# expression %r{\A#{pattern}}.
-db/seeds/development/
-db/seeds/test/
-# db/seeds/dit/
-# db/seeds/staging/
-log/
-test/
-tests/
-rspec/
-spec/
-specs/
-feature/
-features/
-tmp/
-vendor/bundle/
+  DEFAULT_IGNORE = <<~'EOM' # :nodoc:
+    # Some of these are in .gitignore, but let’s remove these just in case they got
+    # checked in.
+
+    # Exact files to remove. Matches with ==.
+    .DS_Store
+    .autotest
+    .editorconfig
+    .env
+    .git-wtfrc
+    .gitignore
+    .local.vimrc
+    .lvimrc
+    .cartignore
+    .powenv
+    .rake_tasks~
+    .rspec
+    .rubocop.yml
+    .rvmrc
+    .semaphore-cache
+    .workenv
+    Guardfile
+    README.md
+    bin/build
+    bin/notify-project-board
+    bin/osx-bootstrap
+    bin/setup
+
+    # Patterns to remove. These have a *, **, or ? in them. Uses File.fnmatch with
+    # File::FNM_DOTMATCH and File::FNM_EXTGLOB.
+    *.rbc
+    .*.swp
+    **/.DS_Store
+
+    # Directories to remove. These should end with a slash. Matches as the regular
+    # expression %r{\A#{pattern}}.
+    db/seeds/development/
+    db/seeds/test/
+    # db/seeds/dit/
+    # db/seeds/staging/
+    log/
+    test/
+    tests/
+    rspec/
+    spec/
+    specs/
+    feature/
+    features/
+    tmp/
+    vendor/bundle/
   EOM
 end