kettle-jem 7.0.0 → 7.1.3

data/lib/kettle/jem/templates/shim/.github/workflows/current.yml.example

@@ -0,0 +1,40 @@
+name: Shim
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+      - '*-stable'
+    tags:
+      - '!*'
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  spec:
+    if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
+    name: Specs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        with:
+          persist-credentials: false
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - name: Specs
+        run: bundle exec rake spec

data/lib/kettle/jem/templates/shim/.rspec.example

@@ -0,0 +1,5 @@
+--format progress
+--color
+--order random
+--require spec_helper
+--exclude-pattern spec/tmp/**/*_spec.rb

data/lib/kettle/jem/templates/shim/.structuredmerge/kettle-jem.yml.example

@@ -0,0 +1,28 @@
+project_emoji: "{KJ|PROJECT_EMOJI}"
+
+ruby:
+  test_minimum: "{KJ|MIN_TEST_RUBY}"
+
+rubygems:
+  name: "{KJ|GEM_NAME}"
+  entrypoint_require: "{KJ|ENTRYPOINT_REQUIRE}"
+  namespace: "{KJ|NAMESPACE}"
+  min_ruby: "{KJ|MIN_RUBY}"
+
+shim:
+  replacement_gem: "{KJ|SHIMMED_GEM_NAME}"
+  replacement_require: "{KJ|SHIMMED_REQUIRE}"
+  legacy_requires:
+    - "{KJ|ENTRYPOINT_REQUIRE}"
+  version:
+    strategy: shim
+
+templates:
+  root: packaged
+  apply: true
+  profile: shim
+
+defaults:
+  preference: "template"
+  add_template_only_nodes: true
+  freeze_token: "kettle-jem"

data/lib/kettle/jem/templates/shim/CHANGELOG.md.example

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+### Changed
+
+- Converted `{KJ|GEM_NAME}` to a compatibility shim for `{KJ|SHIMMED_GEM_NAME}`.

data/lib/kettle/jem/templates/shim/Gemfile.example

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://gem.coop"
+
+shimmed_gem_path = ENV["KETTLE_JEM_SHIMMED_GEM_PATH"].to_s
+gem "{KJ|SHIMMED_GEM_NAME}", path: shimmed_gem_path unless shimmed_gem_path.empty?
+
+# Local workspace dependency wiring for templating_local.gemfile overrides.
+gem "nomono", "~> 1.1", ">= 1.1.4", require: false # ruby >= 3.2.0
+
+# Templating (env-switched: STRUCTUREDMERGE_DEV=/path/to/structuredmerge/ruby/gems for local paths)
+eval_gemfile "gemfiles/modular/templating.gemfile" if ENV.fetch("K_JEM_TEMPLATING", "false").casecmp("true").zero?
+
+gemspec

data/lib/kettle/jem/templates/shim/README.md.example

@@ -0,0 +1,25 @@
+# {KJ|NAMESPACE}
+
+`{KJ|GEM_NAME}` is a compatibility shim for `{KJ|SHIMMED_GEM_NAME}`.
+
+New applications should depend on `{KJ|SHIMMED_GEM_NAME}` directly. This gem exists so existing applications that still depend on `{KJ|GEM_NAME}` can load the replacement implementation without changing all require paths at once.
+
+## Installation
+
+```ruby
+gem "{KJ|GEM_NAME}"
+```
+
+## Runtime behavior
+
+Loading this gem requires `{KJ|SHIMMED_REQUIRE}` and leaves implementation behavior to `{KJ|SHIMMED_GEM_NAME}`.
+
+The generated compatibility require paths are:
+
+```text
+{KJ|SHIM_COMPAT_REQUIRES}
+```
+
+## Migration
+
+When you are ready to remove the compatibility layer, replace `{KJ|GEM_NAME}` with `{KJ|SHIMMED_GEM_NAME}` in your dependency list and require `{KJ|SHIMMED_REQUIRE}` directly.

data/lib/kettle/jem/templates/shim/Rakefile.example

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/kettle/jem/templates/shim/gem.gemspec.example

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "{KJ|GEM_NAME}"
+  spec.version = "{KJ|GEM_VERSION}"
+  spec.authors = {KJ|AUTHOR:NAMES}
+  spec.email = ["{KJ|AUTHOR:EMAIL}"]
+
+  spec.summary = "{KJ|GEMSPEC_PACKAGE_SUMMARY}"
+  spec.description = "{KJ|GEM_NAME} is a compatibility shim for {KJ|SHIMMED_GEM_NAME}."
+  spec.homepage = "{KJ|README:GH_REPOSITORY_URL}"
+  spec.licenses = ["MIT"]
+  spec.required_ruby_version = ">= {KJ|MIN_RUBY}"
+
+  spec.metadata["homepage_uri"] = "{KJ|HOMEPAGE_URI}"
+  spec.metadata["source_code_uri"] = "#{spec.homepage}/tree/v#{spec.version}"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}"
+  spec.metadata["mailing_list_uri"] = "{KJ|RUBYFORUM:URL}"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.glob("lib/**/*.rb") + %w[
+    CHANGELOG.md
+    LICENSE.md
+    README.md
+  ].select { |path| File.exist?(path) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "{KJ|SHIMMED_GEM_NAME}"
+
+  # Dev, Test, & Release Tasks
+  spec.add_development_dependency("kettle-dev", "~> 3.0", ">= 3.0.0")             # ruby >= {KJ|MIN_TEST_RUBY}
+
+  # Tasks
+  spec.add_development_dependency "rake", "~> 13.0"
+
+  # Testing
+  spec.add_development_dependency("kettle-test", "~> 2.0", ">= 2.0.19")            # ruby >= {KJ|MIN_TEST_RUBY}
+  spec.add_development_dependency "rspec", "~> 3.12"
+
+  # Releasing
+  spec.add_development_dependency("ruby-progressbar", "~> 1.13")                    # ruby >= 0
+  spec.add_development_dependency("stone_checksums", "~> 1.0", ">= 1.0.8")          # ruby >= 2.2.0
+end

data/lib/kettle/jem/templates/shim/lib/compat_require.rb.example

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "{KJ|ENTRYPOINT_REQUIRE}"

data/lib/kettle/jem/templates/shim/lib/entrypoint.rb.example

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "{KJ|SHIMMED_REQUIRE}"

data/lib/kettle/jem/templates/shim/lib/version.rb.example

@@ -0,0 +1 @@
+{KJ|VERSION_GEM:VERSION_RB}

data/lib/kettle/jem/templates/shim/spec/shim_spec.rb.example

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe "{KJ|GEM_NAME} shim" do
+  it "loads the replacement gem" do
+    expect(require("{KJ|SHIMMED_REQUIRE}")).to be(false).or be(true)
+  end
+
+  it "loads the primary compatibility require path" do
+    expect(require("{KJ|ENTRYPOINT_REQUIRE}")).to be(false).or be(true)
+  end
+
+  it "has a shim gem version" do
+    expect(Gem.loaded_specs.fetch("{KJ|GEM_NAME}").version.to_s).not_to be_empty
+  end
+end

data/lib/kettle/jem/templates/shim/spec/spec_helper.rb.example

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+begin
+  require "kettle-soup-cover"
+  if Kettle::Soup::Cover::DO_COV
+    # Requiring simplecov loads the project-local `.simplecov`.
+    require "simplecov"
+    require "kettle/soup/cover/config"
+    SimpleCov.start
+  end
+rescue LoadError => error
+  raise error unless error.message.include?("kettle")
+end
+
+require "{KJ|ENTRYPOINT_REQUIRE}"
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+end

data/lib/kettle/jem/templates/sig/gem.rbs.example

@@ -0,0 +1 @@
+{KJ|VERSION_GEM:VERSION_RBS}

data/lib/kettle/jem/templates/spec/README.md.example

@@ -0,0 +1,28 @@
+# Specs
+
+This project uses `kettle-test` as its RSpec harness. The generated
+`spec/spec_helper.rb` requires `kettle/test/rspec`, which installs the shared
+test configuration and helper APIs used throughout the suite.
+
+## Harness Helpers
+
+These helpers are available in specs after `spec/spec_helper.rb` loads:
+
+- `stub_env("NAME" => "value")` temporarily sets environment variables and
+  restores them after the example.
+- `hide_env("NAME")` temporarily removes environment variables and restores
+  them after the example.
+- `block_is_expected` supports expectation syntax for blocks.
+- `:check_output` disables default stream silencing for examples that need to
+  assert output.
+- `:freeze` and `:travel` metadata integrate with Timecop for example-level
+  time control.
+- `:skip_global_travel` opts an example out of global time travel.
+- `pending_for` marks examples pending for selected runtimes or dependency
+  versions.
+- `include_context "with rake", "task_name"` is available when `rake` was
+  loaded before `kettle/test/rspec`.
+
+Prefer these helpers over ad hoc ENV mutation, direct Timecop setup, or direct
+stdout/stderr plumbing. They keep specs isolated across parallel workers and
+make local runs match CI behavior.

data/lib/kettle/jem/templates/spec/spec_helper.rb.example

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Config for development dependencies of this library
+# i.e., not configured by this library
+#
+# SimpleCov & related config (must run BEFORE any other requires)
+# NOTE: Gemfiles for non-coverage appraisals may not have kettle-soup-cover.
+#       The rescue LoadError handles that scenario.
+begin
+  require "kettle-soup-cover"
+  if Kettle::Soup::Cover::DO_COV
+    # Requiring simplecov loads the project-local `.simplecov`.
+    require "simplecov"
+    require "kettle/soup/cover/config"
+    SimpleCov.start
+  end
+rescue LoadError => error
+  # check the error message and re-raise when unexpected
+  raise error unless error.message.include?("kettle")
+end
+
+# External RSpec & related config
+require "kettle/test/rspec"
+# `kettle/test/rspec` installs harness helpers documented in spec/README.md.
+
+# This library
+require "{KJ|ENTRYPOINT_REQUIRE}"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/lib/kettle/jem/version.rb

@@ -2,10 +2,12 @@
 
 module Kettle
   module Jem
+    # Version namespace for this gem.
     module Version
-      VERSION = "7.0.0"
+      # Current gem version.
+      VERSION = "7.1.3"
     end
-
-    VERSION = Version::VERSION
+    # Current gem version exposed at the traditional constant location.
+    VERSION = Version::VERSION # Traditional Constant Location
   end
 end

data/lib/kettle/jem/version_gem.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "version_gem"
+require_relative "version"
+
+Kettle::Jem::Version.class_eval do
+  extend VersionGem::Basic
+end