cartage-rack 2.1 → 2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f2ff5b79fccc786f315f9269e5b4029dc3712210
-  data.tar.gz: a926ac738731f626e7aef89051432d0f2ddeea0f
+SHA256:
+  metadata.gz: c6357c37ee4d9d28e1f86c9c9b6faf08e1055cbc984728e5b36fdfee1ed6d5f6
+  data.tar.gz: e9a6fb9b02d54955114bddfe1dfa33c36232da0fe940f5ad10a884245ae55f08
 SHA512:
-  metadata.gz: 195ad85dddd5128cced2f1104502d103d864c8a0d569ee5bfd2daf77d010a72294410db537febd1095c3d3fa5ab373227a6155854634bd9ca62de9e74769d7f7
-  data.tar.gz: d6e8ba01329def7fe85668577434553b5749a7d79f7852eb4a95c8906cd57faaf1b6721ade8cebe2048ab6520b0ff9323fce290357fca1ccc4de20d7611165f7
+  metadata.gz: 74dc05db4625ba79f1cf4001f39381aef8d44ad3bcd62553372a501e1109c42ad7cda2ebafc925a0b1b45617f15486309cd44ffd2324160d307f7f28699ae7b7
+  data.tar.gz: e22dc98cd990f1b15b90fe9f68efb30b6bb082b0cc3ffded72ee124e0ea4b15bf0c9fe169963691d3512a9f121e6f61623d81c98d1fc8bae5dc3938757d230cd

data/Contributing.md

@@ -59,6 +59,7 @@ Here's the most direct way to get your work merged into the project:
 ### Contributors
 
 *   Austin Ziegler created cartage-rack.
+*   Jesse Mignac added support for `$APP_ENV`.
 
 [Minitest]: https://github.com/seattlerb/minitest
 [quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

data/History.md

@@ -1,51 +1,81 @@
-### 2.1 / 2016-06-28
+# Change History
 
-*   Fix default env issue where ENV['RAILS_ENV'] nor ENV['RACK_ENV'] is set
-    by adding default string.
+## 2.3 / 2022-12-16
 
-### 2.0 / 2016-05-31
+This is primarily a (mostly-mechanical) modernization of the codebase,
+bringing it up to Kinetic Commerce 2022 standards.
 
-*   Rewrote for compatibility with cartage 2.0.
+- Remove dead development files: `.autotest`, `.gemtest`, `.minitest.rb`,
+  `.rubocop.yml`, `.simplecov-prelude.rb`, `.travis.yml`
 
-    *   Renamed Cartage::Rack to Cartage::Rack::Simple and created a *new*
-        Cartage::Rack that returns more information.
+- Add new development files: `.github/workflows/ruby.yml`, `.rdoc_options`,
+  `.standard.yml`, `Appraisals`, `gemfiles/*.gemfile`
 
-    *   Extracted metadata gathering out of Cartage::Rack and into
-        Cartage::Rack::Metadata.
+- Clean up configuration: `.gitignore`, `.hoerc`, `Rakefile`
 
-    *   Deprecated Cartage::Rack.mount in favour of Cartage::Rack() and
-        Cartage::Rack::Simple() methods.
+- Updated generated files: `Manifest.txt`, `cartage-rack.gemspec`
 
-*   1 governance change
+- Renamed `test/minitest_config.rb` to `test/minitest_helper.rb` to reflect
+  consistent naming.
 
-    *   cartage-rack is now under the Kinetic Cafe Open Source [Code of
-        Conduct][kccoc].
+- Removed `context` alias for `describe`.
 
-### 1.1 / 2015-04-11
+- Apply formatting from `standardrb` after dropping raw rubocop.
 
-*   2 minor enhancements
+- Sunset cartage-rack as of this version.
 
-    *   Implemented Cartage::Rack#inspect to prevent `rake routes` from
-        presenting badly.
+## 2.2 / 2018-03-23
 
-    *   Preparing for a future Cartage change to the contents of the
-        `release_hashref` file. The future `release_hashref` will be two lines:
+- Add support for ENV['APP_ENV'] per Sinatra documentation recommendations.
 
-            hashref
-            timestamp
+## 2.1 / 2016-06-28
 
-        If `release_hashref` has two lines, the timestamp will be included in
-        the response. A timestamp will not be included if there is no
-        `release_hashref` file.
+- Fix default env issue where ENV['RAILS_ENV'] nor ENV['RACK_ENV'] is set
+  by adding default string.
 
-*   1 development change
+## 2.0 / 2016-05-31
 
-    *   Implemented tests for Cartage::Rack.
+- Rewrote for compatibility with cartage 2.0.
 
-### 1.0 / 2015-03-20
+  - Renamed Cartage::Rack to Cartage::Rack::Simple and created a _new_
+    Cartage::Rack that returns more information.
 
-*   1 major enhancement
+  - Extracted metadata gathering out of Cartage::Rack and into
+    Cartage::Rack::Metadata.
 
-    *   Birthday!
+  - Deprecated Cartage::Rack.mount in favour of Cartage::Rack() and
+    Cartage::Rack::Simple() methods.
+
+- 1 governance change
+
+  - cartage-rack is now under the Kinetic Cafe Open Source [Code of
+    Conduct][kccoc].
+
+## 1.1 / 2015-04-11
+
+- 2 minor enhancements
+
+  - Implemented Cartage::Rack#inspect to prevent `rake routes` from
+    presenting badly.
+
+  - Preparing for a future Cartage change to the contents of the
+    `release_hashref` file. The future `release_hashref` will be two lines:
+
+        hashref
+        timestamp
+
+    If `release_hashref` has two lines, the timestamp will be included in
+    the response. A timestamp will not be included if there is no
+    `release_hashref` file.
+
+- 1 development change
+
+  - Implemented tests for Cartage::Rack.
+
+## 1.0 / 2015-03-20
+
+- 1 major enhancement
+
+  - Birthday!
 
 [kccoc]: https://github.com/KineticCafe/code-of-conduct

data/Manifest.txt

@@ -7,7 +7,7 @@ Rakefile
 lib/cartage/rack.rb
 lib/cartage/rack/metadata.rb
 lib/cartage/rack/simple.rb
-test/minitest_config.rb
+test/minitest_helper.rb
 test/test_cartage_rack.rb
 test/test_cartage_rack_metadata.rb
 test/test_cartage_rack_simple.rb

data/README.rdoc

@@ -6,14 +6,19 @@ continuous integration :: {<img src="https://travis-ci.org/KineticCafe/cartage-r
 
 == Description
 
-cartage-rack is a plug-in for {cartage}[https://github.com/KineticCafe/cartage]
-to provide a Rack application that reports on release metadata.
-
-Cartage provides a repeatable means to create a package for a Rails application
-that can be used in deployment with a configuration tool like Ansible, Chef,
-Puppet, or Salt. The package is created with its dependencies bundled in
-+vendor/bundle+, so it can be deployed in environments with strict access
-control rules and without requiring development tool access.
+This release is the *last* version of cartage-rack. It will be replaced with
+a different tool in the future, but this release will allow installation in
+modern Ruby versions.
+
+cartage-rack is a plug-in for
+{cartage}[https://github.com/KineticCafe/cartage] to provide a Rack
+application that reports on release metadata.
+
+Cartage provides a repeatable means to create a package for a Rails
+application that can be used in deployment with a configuration tool like
+Ansible, Chef, Puppet, or Salt. The package is created with its dependencies
+bundled in +vendor/bundle+, so it can be deployed in environments with strict
+access control rules and without requiring development tool access.
 
 == Synopsis
 

data/Rakefile

@@ -1,69 +1,71 @@
 # frozen_string_literal: true
 
-require 'rubygems'
-require 'hoe'
-require 'rake/clean'
+require "rubygems"
+require "hoe"
+require "rake/clean"
 
 Hoe.plugin :doofus
-Hoe.plugin :email unless ENV['CI'] || ENV['TRAVIS']
 Hoe.plugin :gemspec2
-Hoe.plugin :git
-Hoe.plugin :minitest
+Hoe.plugin :git2
 Hoe.plugin :rubygems
-Hoe.plugin :travis
 
-spec = Hoe.spec 'cartage-rack' do
-  developer('Austin Ziegler', 'aziegler@kineticcafe.com')
+Hoe.spec "cartage-rack" do
+  developer("Austin Ziegler", "aziegler@kineticcommerce.com")
+  developer("Kinetic Commerce", "dev@kineticcommerce.com")
 
-  self.history_file = 'History.md'
-  self.readme_file = 'README.rdoc'
+  self.history_file = "History.md"
+  self.readme_file = "README.rdoc"
 
-  license 'MIT'
-
-  ruby20!
-
-  # This gem *explicitly* does not have a hard link to cartage.
-
-  extra_dev_deps << ['rake', '>= 10.0']
-  extra_dev_deps << ['rdoc', '~> 4.2']
-  extra_dev_deps << ['rack-test', '~> 0.6']
-  extra_dev_deps << ['hoe-doofus', '~> 1.0']
-  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
-  extra_dev_deps << ['hoe-git', '~> 1.5']
-  extra_dev_deps << ['hoe-travis', '~> 1.2']
-  extra_dev_deps << ['minitest', '~> 5.4']
-  extra_dev_deps << ['minitest-autotest', '~> 1.0']
-  extra_dev_deps << ['minitest-bisect', '~> 1.2']
-  extra_dev_deps << ['minitest-bonus-assertions', '~> 2.0']
-  extra_dev_deps << ['minitest-focus', '~> 1.1']
-  extra_dev_deps << ['minitest-hooks', '~> 1.4']
-  extra_dev_deps << ['minitest-moar', '~> 0.0']
-  extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
-  extra_dev_deps << ['timecop', '~> 0.8']
-  extra_dev_deps << ['simplecov', '~> 0.7']
-end
-
-ENV['RUBYOPT'] = '-W0'
+  # This is a hack because of an issue with Hoe 3.26, but I'm not sure which
+  # hoe version introduced this issue or if it's a JRuby issue. This issue is
+  # demonstrable in lib/hoe.rb at line 676, which is (reformatted for space):
+  #
+  # ```ruby
+  # readme =
+  #   input
+  #     .lines
+  #     .chunk { |l| l[/^(?:=+|#+)/] || "" } # # chunk is different somehow
+  #     .map(&:last) # <-- HERE: "#" does not respond to #last
+  #     .each_slice(2)
+  #     .map { |k, v|
+  #       kp = k.join
+  #       kp = kp.strip.chomp(":").split.last.downcase if k.size == 1
+  #       [kp, v.join.strip]
+  #     }
+  #     .to_h
+  # ```
+  #
+  # We don't *ship* with JRuby, but use it in CI only, so this is here at least
+  # temporarily.
+  if RUBY_PLATFORM.match?(/java/)
+    self.summary = self.description = "Description for testing"
+    self.homepage = "https://github.com/KineticCafe/app-identity/tree/main/ruby/"
+  end
 
-module Hoe::Publish #:nodoc:
-  alias __make_rdoc_cmd__cartage__ make_rdoc_cmd
+  license "MIT"
 
-  def make_rdoc_cmd(*extra_args) # :nodoc:
-    spec.extra_rdoc_files.delete_if { |f| f == 'Manifest.txt' }
-    __make_rdoc_cmd__cartage__(*extra_args)
-  end
-end
+  require_ruby_version ">= 2.7", "< 4"
 
-namespace :test do
-  if File.exist?('.simplecov-prelude.rb')
-    task :coverage do
-      spec.test_prelude = 'load ".simplecov-prelude.rb"'
+  spec_extras[:metadata] = ->(val) { val["rubygems_mfa_required"] = "true" }
 
-      Rake::Task['test'].execute
-    end
-  end
+  # This gem *explicitly* does not have a hard link to cartage.
 
-  CLOBBER << 'coverage'
+  extra_dev_deps << ["appraisal", "~> 2.4"]
+  extra_dev_deps << ["hoe-doofus", "~> 1.0"]
+  extra_dev_deps << ["hoe-gemspec2", "~> 1.1"]
+  extra_dev_deps << ["hoe-git2", "~> 1.7"]
+  extra_dev_deps << ["hoe-rubygems", "~> 1.0"]
+  extra_dev_deps << ["minitest", "~> 5.16"]
+  extra_dev_deps << ["minitest-autotest", "~> 1.0"]
+  extra_dev_deps << ["minitest-bisect", "~> 1.2"]
+  extra_dev_deps << ["minitest-focus", "~> 1.1"]
+  extra_dev_deps << ["minitest-hooks", "~> 1.4"]
+  extra_dev_deps << ["minitest-moar", "~> 0.0"]
+  extra_dev_deps << ["minitest-pretty_diff", "~> 0.1"]
+  extra_dev_deps << ["rack-test", "~> 2.0"]
+  extra_dev_deps << ["rake", ">= 10.0", "< 14"]
+  extra_dev_deps << ["rdoc", "~> 6.4"]
+  extra_dev_deps << ["simplecov", "~> 0.7"]
+  extra_dev_deps << ["standard", "~> 1.0"]
+  extra_dev_deps << ["timecop", "~> 0.8"]
 end
-
-CLOBBER << 'tmp'

data/lib/cartage/rack/metadata.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'json'
+require "pathname"
+require "json"
 
 ##
 # A representation for Cartage metadata for use with Cartage::Rack and
 # Cartage::Rack::Simple.
 class Cartage::Rack::Metadata
-  METADATA_CLEANER = ->(_, v) { #:nodoc:
-    v.delete_if(&METADATA_CLEANER) if v.kind_of?(Hash)
+  METADATA_CLEANER = ->(_, v) { # :nodoc:
+    v.delete_if(&METADATA_CLEANER) if v.is_a?(Hash)
     v.nil? || (v.respond_to?(:empty?) && v.empty?)
   }
   private_constant :METADATA_CLEANER
@@ -31,7 +31,7 @@ class Cartage::Rack::Metadata
     @filter = filter
     @content = read_release_metadata_json || read_release_hashref
 
-    fail 'Cannot find release-metadata.json or release_hashref' if required && !@content
+    fail "Cannot find release-metadata.json or release_hashref" if required && !@content
 
     @source ||= :live
   end
@@ -41,11 +41,11 @@ class Cartage::Rack::Metadata
   # content data.
   def resolve
     content.merge(application_env).tap do |data|
-      @filter.call(data) if @filter
+      @filter&.call(data)
     end.delete_if(&METADATA_CLEANER)
   end
 
-  def inspect #:nodoc:
+  def inspect # :nodoc:
     "#{@root_path.expand_path.basename} (#{@source})"
   end
 
@@ -53,7 +53,7 @@ class Cartage::Rack::Metadata
 
   def application_env
     @application_env ||= {
-      'env' => { 'name' => ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'UNKNOWN' }
+      "env" => {"name" => ENV["RAILS_ENV"] || ENV["APP_ENV"] || ENV["RACK_ENV"] || "UNKNOWN"}
     }
   end
 
@@ -61,24 +61,24 @@ class Cartage::Rack::Metadata
     return @content if @content
 
     {
-      'package' => {}
+      "package" => {}
     }.tap do |result|
-      package = result['package']
-      package['name'] = @root_path.basename.to_s
-      package['hashref'] = release_hashref
-      package['timestamp'] = Time.now.utc.strftime('%Y%m%d%H%M%S')
+      package = result["package"]
+      package["name"] = @root_path.basename.to_s
+      package["hashref"] = release_hashref
+      package["timestamp"] = Time.now.utc.strftime("%Y%m%d%H%M%S")
 
       if repo?
-        package['repo'] = {
-          'type' => 'git', # Hardcoded until we have other support
-          'url' => repo_url
+        package["repo"] = {
+          "type" => "git", # Hardcoded until we have other support
+          "url" => repo_url
         }
       end
     end
   end
 
   def read_release_metadata_json
-    file = @root_path.join('release-metadata.json')
+    file = @root_path.join("release-metadata.json")
 
     return unless file.exist?
 
@@ -87,7 +87,7 @@ class Cartage::Rack::Metadata
   end
 
   def read_release_hashref
-    file = @root_path.join('release_hashref')
+    file = @root_path.join("release_hashref")
 
     return unless file.exist?
 
@@ -96,10 +96,10 @@ class Cartage::Rack::Metadata
     hashref, timestamp, = file.read.split($/)
 
     {
-      'package' => {
-        'name' => @root_path.basename.to_s,
-        'hashref' => hashref,
-        'timestamp' => timestamp
+      "package" => {
+        "name" => @root_path.basename.to_s,
+        "hashref" => hashref,
+        "timestamp" => timestamp
       }
     }.delete_if(&METADATA_CLEANER)
   end
@@ -107,22 +107,22 @@ class Cartage::Rack::Metadata
   def repo_url
     return unless repo?
     unless defined?(@repo_url)
-      @repo_url = %x(git remote show -n origin).
-        match(/\n\s+Fetch URL: (?<fetch>[^\n]+)/)[:fetch]
+      @repo_url = `git remote show -n origin`
+        .match(/\n\s+Fetch URL: (?<fetch>[^\n]+)/)[:fetch]
     end
     @repo_url
   end
 
   def release_hashref
     if repo?
-      "(git) #{%x(git rev-parse --abbrev-ref HEAD).chomp}"
+      "(git) #{`git rev-parse --abbrev-ref HEAD`.chomp}"
     else
-      'UNKNOWN - no .git directory'
+      "UNKNOWN - no .git directory"
     end
   end
 
   def repo?
-    @is_repo = @root_path.join('.git').directory? unless defined?(@is_repo)
+    @is_repo = @root_path.join(".git").directory? unless defined?(@is_repo)
     @is_repo
   end
 end

data/lib/cartage/rack/simple.rb

@@ -6,9 +6,9 @@ class Cartage::Rack
     # Creates a new instance of the Cartage::Rack::Simple application to the
     # specified +root_path+, or +Dir.pwd+. This method has been deprecated.
     def mount(root_path = nil)
-      warn <<-warning
-Cartage::Rack.mount(path) is deprecated; use Cartage::Rack::Simple(path) instead.
-      warning
+      warn <<~WARNING
+        Cartage::Rack.mount(path) is deprecated; use Cartage::Rack::Simple(path) instead.
+      WARNING
       Simple(root_path)
     end
 
@@ -36,21 +36,21 @@ Cartage::Rack.mount(path) is deprecated; use Cartage::Rack::Simple(path) instead
 
       content = {}
 
-      content[:env] = dig(full_content, 'env', 'name')
-      content[:release_hashref] = dig(full_content, 'package', 'hashref')
-      content[:timestamp] = dig(full_content, 'package', 'timestamp')
+      content[:env] = dig(full_content, "env", "name")
+      content[:release_hashref] = dig(full_content, "package", "hashref")
+      content[:timestamp] = dig(full_content, "package", "timestamp")
 
-      case env['PATH_INFO']
+      case env["PATH_INFO"]
       when /\.json\z/
-        type = 'application/json'
+        type = "application/json"
         body = content.to_json
       else
-        type = 'text/plain'
+        type = "text/plain"
         body = "#{content[:env]}: #{content[:release_hashref]}"
         body += " (#{content[:timestamp]})" if content[:timestamp]
       end
 
-      [ type, body ]
+      [type, body]
     end
   end
 end

data/lib/cartage/rack.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'json'
+require "pathname"
+require "json"
 
 # Cartage, a package builder.
 class Cartage
@@ -15,7 +15,7 @@ class Cartage
   # +application/json+ value, or as a +text/plain+ string if called with
   # +.text+ or +.txt+.
   class Rack
-    VERSION = '2.1' #:nodoc:
+    VERSION = "2.3" # :nodoc:
 
     class << self
       # When +true+, Cartage::Rack and Cartage::Rack::Simple will raise an
@@ -23,7 +23,7 @@ class Cartage
       # +release_hashref+). May be explicitly turned off.
       #
       # Defaults to +true+ except in development or test environments (based on
-      # <tt>$RAILS_ENV</tt> and <tt>$RACK_ENV</tt>).
+      # <tt>$RAILS_ENV</tt>, <tt>$APP_ENV</tt> and <tt>$RACK_ENV</tt>).
       def require_metadata(value = (arg = false; nil)) # rubocop:disable Style/Semicolon
         @require_metadata = value unless arg == false
         @require_metadata || default_require_metadata
@@ -32,7 +32,7 @@ class Cartage
       private
 
       def default_require_metadata
-        environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+        environment = ENV["RAILS_ENV"] || ENV["APP_ENV"] || ENV["RACK_ENV"] || "development"
         environment !~ /\A(?:development|test)\z/i
       end
     end
@@ -41,12 +41,12 @@ class Cartage
       @metadata = Cartage::Rack::Metadata.new(root_path, filter: filter)
     end
 
-    def call(env) #:nodoc:
+    def call(env) # :nodoc:
       type, body = resolve_content(env)
-      [ '200', { 'Content-Type' => type }, [ body ] ]
+      ["200", {"Content-Type" => type}, [body]]
     end
 
-    def inspect #:nodoc:
+    def inspect # :nodoc:
       "#{self.class} for #{@metadata.inspect}"
     end
 
@@ -55,32 +55,32 @@ class Cartage
     def resolve_content(env)
       content = @metadata.resolve
 
-      case env['PATH_INFO']
+      case env["PATH_INFO"]
       when /\.te?xt\z/
-        type = 'text/plain'
+        type = "text/plain"
         body = [
-          "name: #{dig(content, 'package', 'name')}",
-          "environment: #{dig(content, 'env', 'name')}",
-          "hashref: #{dig(content, 'package', 'hashref')}"
+          "name: #{dig(content, "package", "name")}",
+          "environment: #{dig(content, "env", "name")}",
+          "hashref: #{dig(content, "package", "hashref")}"
         ]
 
-        value = dig(content, 'package', 'timestamp')
+        value = dig(content, "package", "timestamp")
         body << "timestamp: #{value}" if value
 
-        repo = dig(content, 'package', 'repo')
-        body << "#{repo['type']}: #{repo['url']}" if repo
+        repo = dig(content, "package", "repo")
+        body << "#{repo["type"]}: #{repo["url"]}" if repo
         body = body.join("\n")
       else
-        type = 'application/json'
+        type = "application/json"
         body = content.to_json
       end
 
-      [ type, body ]
+      [type, body]
     end
 
     attr_reader :metadata
 
-    #:nocov:
+    # :nocov:
     def dig(hash, key, *rest)
       if hash.respond_to?(:dig)
         hash.dig(key, *rest)
@@ -89,7 +89,7 @@ class Cartage
       end
     end
 
-    DIGGER = ->(h, k, *r) { #:nodoc:
+    DIGGER = ->(h, k, *r) { # :nodoc:
       v = h[k]
       if v.nil? || r.empty?
         v
@@ -98,9 +98,9 @@ class Cartage
       end
     }
     private_constant :DIGGER
-    #:nocov:
+    # :nocov:
   end
 end
 
-require_relative 'rack/simple'
-require_relative 'rack/metadata'
+require_relative "rack/simple"
+require_relative "rack/metadata"

data/test/{minitest_config.rb → minitest_helper.rb}

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
-gem 'minitest'
-require 'rack/test'
-require 'minitest/autorun'
-require 'minitest/pretty_diff'
-require 'minitest/focus'
-require 'minitest/moar'
-require 'minitest/bisect'
-require 'minitest/hooks/default'
-require 'timecop'
+gem "minitest"
+
+require "minitest/autorun"
+require "minitest/hooks/default"
+require "minitest/moar"
+require "rack/test"
+require "timecop"
 
 Timecop.safe_mode = true
 
-require 'cartage/rack'
+require "cartage/rack"
 
 module Minitest::CartageRackStubs
   def stub_dir_pwd value, *block_args, &block
@@ -24,8 +22,6 @@ module Minitest::CartageRackStubs
       env.fetch(key) { |k|
         if options[:passthrough]
           ENV.send(:"__minitest_stub__[]", k)
-        else
-          nil
         end
       }
     }
@@ -75,8 +71,3 @@ module Minitest::CartageRackStubs
 
   Minitest::Test.send(:include, self)
 end
-
-class << Minitest::Spec
-  alias context describe
-  private :context
-end