cartage 2.0 → 2.2.1

data/lib/cartage/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'cartage'
-require_relative 'gli_ext'
+require "cartage"
+require_relative "gli_ext"
 
 ::GLI::Commands::Help.skips_pre = false
 
@@ -14,7 +14,7 @@ class Cartage
     class QuietExit < StandardError
       include ::GLI::StandardException
 
-      def initialize(exit_code) #:nodoc:
+      def initialize(exit_code) # :nodoc:
         @exit_code = exit_code
       end
 
@@ -38,7 +38,7 @@ class Cartage
 
     Cartage::Plugin.load
 
-    include ::GLI::App #:nodoc:
+    include ::GLI::App # :nodoc:
 
     class << self
       # When called with a block, this method reopens Cartage::CLI to add new
@@ -48,7 +48,7 @@ class Cartage
       # +mods+ are the modules to extend onto Cartage::CLI. +block+ is the
       # block that contains CLI command extensions (using the GLI DSL).
       def extend(*mods, &block)
-        return super(*mods) unless block_given?
+        return super(*mods) unless block
         cli.instance_eval(&block)
       end
 
@@ -72,7 +72,7 @@ class Cartage
     # +config+ (which must be a Cartage::Config object) may be provided.
     def cartage(config = nil)
       if defined?(@cartage) && @cartage && config
-        fail 'Cannot provide another configuration after initialization.'
+        fail "Cannot provide another configuration after initialization."
       end
       @cartage ||= Cartage.new(config)
     end
@@ -90,11 +90,11 @@ class Cartage
       Cartage::Config.load(value)
     end
 
-    program_desc 'Manage releaseable packages'
-    program_long_desc <<-'DESC'
-Cartage provides a repeatable means to create a package for a server-side
-application that can be used in deployment with a configuration tool like
-Ansible, Chef, Puppet, or Salt.
+    program_desc "Manage releaseable packages"
+    program_long_desc <<~'DESC'
+      Cartage provides a repeatable means to create a package for a server-side
+      application that can be used in deployment with a configuration tool like
+      Ansible, Chef, Puppet, or Salt.
     DESC
     version Cartage::VERSION
 
@@ -102,77 +102,77 @@ Ansible, Chef, Puppet, or Salt.
     arguments :strict
     synopsis_format :terminal
 
-    desc 'Silence normal output.'
-    switch %i(q quiet)
+    desc "Silence normal output."
+    switch %i[q quiet]
 
-    desc 'Show verbose output.'
-    switch %i(v verbose)
+    desc "Show verbose output."
+    switch %i[v verbose]
 
-    desc 'Show the backtrace when an error occurs.'
-    switch %i(T trace), negatable: false
+    desc "Show the backtrace when an error occurs."
+    switch %i[T trace], negatable: false
 
-    desc 'Use the specified Cartage configuration file.'
-    long_desc <<-'DESC'
-Use the specified configuration file. If not specified, the configuration is
-found relative to the current working directory (assumed to be the project
-root) at one of the following locations:
-
-1.  config/cartage.yml
-2.  cartage.yml
-3.  .cartage.yml
+    desc "Use the specified Cartage configuration file."
+    long_desc <<~'DESC'
+      Use the specified configuration file. If not specified, the configuration is
+      found relative to the current working directory (assumed to be the project
+      root) at one of the following locations:
+      
+      1.  config/cartage.yml
+      2.  cartage.yml
+      3.  .cartage.yml
     DESC
-    flag [ :C, 'config-file' ],
+    flag [:C, "config-file"],
       type: Cartage::Config,
       arg_name: :FILE,
       default_value: :'<project-config>'
 
-    desc 'The name of the package.'
-    long_desc <<-'DESC'
-The name of the package is used with the timestamp to create the final package
-name. Defaults to the last part of the repo URL.
+    desc "The name of the package."
+    long_desc <<~'DESC'
+      The name of the package is used with the timestamp to create the final package
+      name. Defaults to the last part of the repo URL.
     DESC
-    flag %i(n name), arg_name: :NAME, default_value: :'<repo-name>'
+    flag %i[n name], arg_name: :NAME, default_value: :'<repo-name>'
 
-    desc 'The destination of the created package.'
-    long_desc 'Where the final package will be written.'
-    flag %i(t target), arg_name: :PATH, default_value: :tmp
+    desc "The destination of the created package."
+    long_desc "Where the final package will be written."
+    flag %i[t target], arg_name: :PATH, default_value: :tmp
 
-    desc 'The package source root path.'
-    long_desc <<-'DESC'
-Where the package is built from. Defaults to the root of the repository.
+    desc "The package source root path."
+    long_desc <<~'DESC'
+      Where the package is built from. Defaults to the root of the repository.
     DESC
-    flag [ :r, 'root-path' ], arg_name: :PATH, default_value: :'<repo-root-path>'
+    flag [:r, "root-path"], arg_name: :PATH, default_value: :'<repo-root-path>'
 
-    desc 'The timestamp used for building the package.'
-    long_desc <<-'DESC'
-The timestamp is used with the name of the package is used to create the final
-package name.
+    desc "The timestamp used for building the package."
+    long_desc <<~'DESC'
+      The timestamp is used with the name of the package is used to create the final
+      package name.
     DESC
-    flag [ :timestamp ], arg_name: :TIMESTAMP
+    flag [:timestamp], arg_name: :TIMESTAMP
 
-    desc 'Disable the use of vendor dependency caching.'
-    switch [ 'disable-dependency-cache' ], negatable: false
+    desc "Disable the use of vendor dependency caching."
+    switch ["disable-dependency-cache"], negatable: false
 
-    desc 'The path where vendored dependencies will be cached between builds.'
-    long_desc <<-'DESC'
-Dependencies for deployable packages are vendored. To reduce network calls and
-build time, Cartage will cache the vendored dependencies in a tarball
-(dependency-cache.tar.bz2) in this path.
+    desc "The path where vendored dependencies will be cached between builds."
+    long_desc <<~'DESC'
+      Dependencies for deployable packages are vendored. To reduce network calls and
+      build time, Cartage will cache the vendored dependencies in a tarball
+      (dependency-cache.tar.bz2) in this path.
     DESC
-    flag [ 'dependency-cache-path' ],
+    flag ["dependency-cache-path"],
       arg_name: :PATH,
       default_value: :'<default-dependency-cache-path>'
 
-    commands_from 'cartage/commands'
+    commands_from "cartage/commands"
 
-    desc 'Save the computed configuration as a configuration file.'
+    desc "Save the computed configuration as a configuration file."
     arg :'CONFIG-FILE'
-    command '_save' do |save|
+    command "_save" do |save|
       save.hide!
 
       save.action do |_global, _options, args|
         name = args.first
-        name = "#{name}.yml" unless name == '-' || name.end_with?('.yml')
+        name = "#{name}.yml" unless name == "-" || name.end_with?(".yml")
 
         Cartage::Config.new(cartage.config).tap do |config|
           config.name ||= cartage.name
@@ -185,7 +185,7 @@ build time, Cartage will cache the vendored dependencies in a tarball
           config.quiet = cartage.quiet || false
           config.verbose = cartage.verbose || false
 
-          if name == '-'
+          if name == "-"
             puts config.to_yaml
           else
             Pathname(name).write(config.to_yaml)
@@ -195,7 +195,7 @@ build time, Cartage will cache the vendored dependencies in a tarball
     end
 
     on_error do |ex|
-      unless ex.kind_of?(Cartage::CLI::QuietExit)
+      unless ex.is_a?(Cartage::CLI::QuietExit)
         output_error_message(ex)
         ex.backtrace.each { |l| puts l } if backtrace?
       end
@@ -206,26 +206,26 @@ build time, Cartage will cache the vendored dependencies in a tarball
 
       clear_defaults_from(global)
 
-      config = case global['config-file']
-               when Cartage::Config
-                 global['config-file']
-               when nil
-                 Cartage::Config.load(:default)
-               else
-                 fail 'Invalid config-file'
-               end
+      config = case global["config-file"]
+      when Cartage::Config
+        global["config-file"]
+      when nil
+        Cartage::Config.load(:default)
+      else
+        fail "Invalid config-file"
+      end
 
       # Configure Cartage from the config file and global switches.
-      config.disable_dependency_cache ||= global['disable-dependency-cache']
-      config.quiet ||= global['quiet']
-      config.verbose ||= global['verbose']
-
-      config.name = global['name'] if global['name']
-      config.target = global['target'] if global['target']
-      config.root_path = global['root-path'] if global['root-path']
-      config.timestamp = global['timestamp'] if global['timestamp']
-      if global['dependency-cache-path']
-        config.dependency_cache_path = global['dependency-cache-path']
+      config.disable_dependency_cache ||= global["disable-dependency-cache"]
+      config.quiet ||= global["quiet"]
+      config.verbose ||= global["verbose"]
+
+      config.name = global["name"] if global["name"]
+      config.target = global["target"] if global["target"]
+      config.root_path = global["root-path"] if global["root-path"]
+      config.timestamp = global["timestamp"] if global["timestamp"]
+      if global["dependency-cache-path"]
+        config.dependency_cache_path = global["dependency-cache-path"]
       end
 
       cartage(config)

data/lib/cartage/commands/echo.rb

@@ -3,16 +3,16 @@
 ##
 # Call +extend+ Cartage::CLI to add the commands defined in the block.
 Cartage::CLI.extend do
-  desc 'Echo the provided text'
+  desc "Echo the provided text"
   arg :TEXT, :multiple
-  command 'echo' do |echo|
+  command "echo" do |echo|
     echo.hide!
-    echo.desc 'Suppress newlines'
-    echo.switch [ :c, 'no-newlines' ], negatable: false
+    echo.desc "Suppress newlines"
+    echo.switch [:c, "no-newlines"], negatable: false
     echo.action do |_g, options, args|
       unless cartage.quiet
-        message = args.join(' ')
-        if options['no-newlines'] || cartage.config(for_command: 'echo').no_newlines
+        message = args.join(" ")
+        if options["no-newlines"] || cartage.config(for_command: "echo").no_newlines
           puts message
         else
           print message

data/lib/cartage/commands/info.rb

@@ -4,33 +4,33 @@
 # Call +extend+ Cartage::CLI to add the commands defined in the block.
 Cartage::CLI.extend do
   # Use +desc+ to write a description about the next command.
-  desc 'Show information about Cartage itself'
+  desc "Show information about Cartage itself"
 
   # Use +long_desc+ to write a long description about the next command that can
   # be included in a generated RDoc file.
-  long_desc <<-'DESC'
-Shows various bits of information about Cartage based on the running instance.
-Some plug-ins do run-time resolution of configuration values, so what is shown
-through these subcommands will not represent that resolution.
+  long_desc <<~'DESC'
+    Shows various bits of information about Cartage based on the running instance.
+    Some plug-ins do run-time resolution of configuration values, so what is shown
+    through these subcommands will not represent that resolution.
   DESC
 
   # Declare a new command with +command+ and one or more names for the command.
   # This command is available as both <tt>cartage info</tt> and <tt>cartage
   # i</tt>. The block contains the definition of the switches, flags,
   # subcommands, and actions for this command.
-  command %w(info i) do |info|
+  command %w[info i] do |info|
     # Use this extension method to hide this command. GLI 2.13 does not support
     # hiding subcommands.
     info.hide!
 
     # The same GLI::DSL works on the command being created, Here, we are
     # creating <tt>cartage info plugins</tt>.
-    info.desc 'Show the plug-ins that have been found.'
-    info.long_desc <<-'DESC'
-Only plug-ins using the class plug-in protocol are found this way. Plug-ins
-that just provide commands are not reported as plugins.
+    info.desc "Show the plug-ins that have been found."
+    info.long_desc <<~'DESC'
+      Only plug-ins using the class plug-in protocol are found this way. Plug-ins
+      that just provide commands are not reported as plugins.
     DESC
-    info.command 'plugins' do |plugins|
+    info.command "plugins" do |plugins|
       # Implement the #action as a block. It accepts three parameters: the
       # global options hash, the local command options hash, and any arguments
       # passed on the command-line.
@@ -40,16 +40,16 @@ that just provide commands are not reported as plugins.
       plugins.action do |_global, _options, _args|
         plugs = cartage.plugins.enabled
         if plugs.empty?
-          puts 'No active plug-ins.'
+          puts "No active plug-ins."
         else
           plugs.map! do |plug|
             "* #{plug.plugin_name} (#{plug.version})"
           end
-          puts <<-plugins
-Active Plug-ins:
-
-#{plugs.join("\n")}
-          plugins
+          puts <<~PLUGINS
+            Active Plug-ins:
+            
+            #{plugs.sort.join("\n")}
+          PLUGINS
         end
       end
     end

data/lib/cartage/commands/manifest.rb

@@ -1,74 +1,74 @@
 # frozen_string_literal: true
 
 Cartage::CLI.extend do
-  desc 'Work with the Manifest.txt file'
-  long_desc <<-'DESC'
-Commands that manage the Cartage manifest (Manifest.txt) and ignore
-(.cartignore) files for a project.
+  desc "Work with the Manifest.txt file"
+  long_desc <<~'DESC'
+    Commands that manage the Cartage manifest (Manifest.txt) and ignore
+    (.cartignore) files for a project.
   DESC
-  command 'manifest' do |manifest|
-    manifest.desc 'Check the Manifest.txt file against the current repository'
-    manifest.long_desc <<-'DESC'
-Compares the current Cartage manifest against what would be calculated. If
-there is a difference, it will be displayed in unified ('diff -u') format and a
-non-zero exit status will be returned.
-
-The diff output can be suppressed by specifying -q on cartage:
-
-    cartage -q manifest check
+  command "manifest" do |manifest|
+    manifest.desc "Check the Manifest.txt file against the current repository"
+    manifest.long_desc <<~'DESC'
+      Compares the current Cartage manifest against what would be calculated. If
+      there is a difference, it will be displayed in unified ('diff -u') format and a
+      non-zero exit status will be returned.
+      
+      The diff output can be suppressed by specifying -q on cartage:
+      
+          cartage -q manifest check
     DESC
-    manifest.command 'check' do |check|
+    manifest.command "check" do |check|
       check.action do |_global, _options, _args|
         cartage.manifest.check or
           fail Cartage::CLI::QuietExit, $?.exitstatus
       end
     end
 
-    manifest.desc 'Install or update the .cartignore file'
-    manifest.long_desc <<-'DESC'
-Creates, replaces, or updates the Cartage ignore file (.cartignore). Will not
-modify an existing .cartignore unless the --mode is overwrite or merge.
+    manifest.desc "Install or update the .cartignore file"
+    manifest.long_desc <<~'DESC'
+      Creates, replaces, or updates the Cartage ignore file (.cartignore). Will not
+      modify an existing .cartignore unless the --mode is overwrite or merge.
     DESC
-    manifest.command 'cartignore' do |cartignore|
-      cartignore.desc 'Overwrite or merge an existing .cartignore'
-      cartignore.long_desc <<-'DESC'
-Sets the mode for updating the ignore file. When --mode overwrite, the ignore
-file will be replaced with the default ignore file contents. When --mode merge,
-the existing ignore file will be merged with the default ignore file contents.
+    manifest.command "cartignore" do |cartignore|
+      cartignore.desc "Overwrite or merge an existing .cartignore"
+      cartignore.long_desc <<~'DESC'
+        Sets the mode for updating the ignore file. When --mode overwrite, the ignore
+        file will be replaced with the default ignore file contents. When --mode merge,
+        the existing ignore file will be merged with the default ignore file contents.
       DESC
-      cartignore.flag :mode, must_match: %w(overwrite merge), arg_name: :MODE
+      cartignore.flag :mode, must_match: %w[overwrite merge], arg_name: :MODE
 
-      cartignore.desc 'Overwrite an existing .cartignore (--mode overwrite)'
-      cartignore.switch %i(f force overwrite), negatable: false
+      cartignore.desc "Overwrite an existing .cartignore (--mode overwrite)"
+      cartignore.switch %i[f force overwrite], negatable: false
 
-      cartignore.desc 'Merge an existing .cartignore (--mode merge)'
-      cartignore.switch %i(m merge), negatable: false
+      cartignore.desc "Merge an existing .cartignore (--mode merge)"
+      cartignore.switch %i[m merge], negatable: false
 
       cartignore.action do |_global, options, _args|
-        message = if options['merge'] && options['force']
-                    'Cannot mix options --force and --merge'
-                  elsif options['merge'] && options['mode'] == 'overwrite'
-                    'Cannot mix option --merge and --mode overwrite'
-                  elsif options['force'] && options['mode'] == 'merge'
-                    'Cannot mix option --force and --mode merge'
-                  end
+        message = if options["merge"] && options["force"]
+          "Cannot mix options --force and --merge"
+        elsif options["merge"] && options["mode"] == "overwrite"
+          "Cannot mix option --merge and --mode overwrite"
+        elsif options["force"] && options["mode"] == "merge"
+          "Cannot mix option --force and --mode merge"
+        end
 
         if message
           fail Cartage::CLI::CommandException.new(message, cartignore.name_for_help, 64)
         end
 
-        mode = if options['merge'] || options['mode'] == 'merge'
-                 'merge'
-               elsif options['force'] || options['mode'] == 'overwrite'
-                 'overwrite'
-               end
+        mode = if options["merge"] || options["mode"] == "merge"
+          "merge"
+        elsif options["force"] || options["mode"] == "overwrite"
+          "overwrite"
+        end
 
         cartage.manifest.install_default_ignore(mode: mode)
       end
     end
 
-    manifest.desc 'Show the files that will be included in the package'
-    manifest.command 'show' do |show|
+    manifest.desc "Show the files that will be included in the package"
+    manifest.command "show" do |show|
       show.action do |_global, _options, _args|
         cartage.manifest.resolve do |tmpfile|
           puts Pathname(tmpfile).read
@@ -76,8 +76,8 @@ the existing ignore file will be merged with the default ignore file contents.
       end
     end
 
-    manifest.desc 'Generate or update the Manifest.txt file'
-    manifest.command %w(generate update) do |generate|
+    manifest.desc "Generate or update the Manifest.txt file"
+    manifest.command %w[generate update] do |generate|
       generate.action do |_global, _options, _args|
         cartage.manifest.generate
       end

data/lib/cartage/commands/metadata.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Cartage::CLI.extend do
+  desc "Create a release_metadata.json file in the current directory."
+  command %w[metadata] do |metadata|
+    metadata.action do |_global, _options, _args|
+      cartage.save_release_metadata(local: true)
+    end
+  end
+end

data/lib/cartage/commands/pack.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 Cartage::CLI.extend do
-  desc 'Create a package with Cartage based on the Manifest.'
-  command %w(pack build) do |pack|
-    pack.desc 'Do not check the status of the Manifest file before packaging.'
-    pack.switch 'skip-check', negatable: false
+  desc "Create a package with Cartage based on the Manifest."
+  command %w[pack build] do |pack|
+    pack.desc "Do not check the status of the Manifest file before packaging."
+    pack.switch "skip-check", negatable: false
 
     pack.action do |_global, options, _args|
-      unless options['skip-check'] || cartage.manifest.check
+      unless options["skip-check"] || cartage.manifest.check
         puts
-        fail Cartage::CLI::CustomExit.new 'Manifest.txt is not up-to-date.',
+        fail Cartage::CLI::CustomExit.new "Manifest.txt is not up-to-date.",
           $?.exitstatus
       end
       cartage.build_package

data/lib/cartage/config.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 begin
-  require 'psych'
+  require "psych"
 rescue LoadError
   nil # This has been intentionally suppressed.
 end
-require 'ostruct'
-require 'pathname'
-require 'erb'
-require 'yaml'
+require "ostruct"
+require "pathname"
+require "erb"
+require "yaml"
 
 class Cartage
   # The Cartage configuration structure. The supported Cartage-wide
@@ -80,13 +80,15 @@ class Cartage
   # The contents of the configuration file are evaluated through ERB and then
   # parsed from YAML and converted to nested OpenStruct objects.
   class Config < OpenStruct
-    #:stopdoc:
-    DEFAULT_CONFIG_FILES = %w(
-      ./config/cartage.yml
-      ./cartage.yml
-      ./.cartage.yml
-    ).each(&:freeze).freeze
-    #:startdoc:
+    # :stopdoc:
+    unless defined?(DEFAULT_CONFIG_FILES)
+      DEFAULT_CONFIG_FILES = %w[
+        ./config/cartage.yml
+        ./cartage.yml
+        ./.cartage.yml
+      ].each(&:freeze).freeze
+    end
+    # :startdoc:
 
     class << self
       # Load a Cartage configuration file as specified by +filename+. If
@@ -94,7 +96,7 @@ class Cartage
       # configuration files will be located.
       def load(filename)
         config_file = resolve_config_file(filename)
-        config = ::YAML.load(ERB.new(config_file.read, nil, '%<>-').result)
+        config = ::YAML.unsafe_load(ERB.new(config_file.read, trim_mode: "%-").result)
         new(config)
       end
 
@@ -112,10 +114,10 @@ class Cartage
         filename = nil if filename == :default
 
         files = if filename
-                  [ filename ]
-                else
-                  DEFAULT_CONFIG_FILES
-                end
+          [filename]
+        else
+          DEFAULT_CONFIG_FILES
+        end
 
         file = files.find { |f| Pathname(f).expand_path.exist? }
 
@@ -124,7 +126,7 @@ class Cartage
         elsif filename
           fail ArgumentError, "Configuration file #{filename} does not exist."
         else
-          StringIO.new('{}')
+          StringIO.new("{}")
         end
       end
 
@@ -168,13 +170,13 @@ class Cartage
         {}.tap { |h|
           object.each_pair { |k, v|
             k = case convert_keys
-                when :to_s
-                  k.to_s
-                when :to_sym
-                  k.to_sym
-                else
-                  k
-                end
+            when :to_s
+              k.to_s
+            when :to_sym
+              k.to_sym
+            else
+              k
+            end
             h[k.to_s] = hashify(v)
           }
         }