appraisal2 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f60cf90f788c79484aa1f01d218259c1cbb9459afe960a368e3de03bd84b7088
-  data.tar.gz: 8b96fc10c341d3c395e8e6c210ad4a3c98d36cc60d4e92c82ed13ce4cf774c72
+  metadata.gz: 2c2316bffba1559cb55b0c393052bd487630867af9e7a41d37c73c43315bc2b9
+  data.tar.gz: a37397565aa148f422d031621cb715d2b48bffcd3f9ddba06aa773488f984995
 SHA512:
-  metadata.gz: 967d0442aafbbead64cb127c57eab72ecc48f85d9d820619f6eb142ff2aaf3c7d6510bddd32c2c8f6524ea072ebfb7e7fc593719276b2f80259948aba1396c5e
-  data.tar.gz: 45bba8cce0a182a5eacb7614e0e239906d76f8905c9fe057ac8e91cdb013d17fe48e3ddd1c730b61c907c7c0f6ef1b10b42f1eab10063366a1dc72ff9cb47bbc
+  metadata.gz: f9a4fe27e3fb3e5979021df8b565f32ad454c924f2aaa1a15d0517d66b5fa2fd095c2daaae9cf0d422f4445510d44f6e0604d0acd735d3131189d7c54ab79ca9
+  data.tar.gz: 1415ef332fc92e289a1f28fe4b9cfcd401d5699e2556d1bacfb463e67420121fd45b6184fca10c6b88a445c83f59c5e573b4bab5b047bd8707d2667046448a15

data/CHANGELOG.md

@@ -30,6 +30,22 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [3.1.1] - 2026-06-06
+
+- TAG: [v3.1.1][3.1.1t]
+- COVERAGE: 90.23% -- 822/911 lines in 29 files
+- BRANCH COVERAGE: 80.51% -- 157/195 branches in 29 files
+- 42.25% documented
+
+### Added
+
+- Added the `plugin` Appraisals DSL for generator-only companion gems that
+  should be loaded while Appraisal2 generates gemfiles without being serialized
+  into generated appraisal gemfiles.
+- Added the `generator_only` root Gemfile DSL for dependencies that Bundler
+  should install in the active generator bundle but Appraisal2 should not
+  serialize into generated appraisal gemfiles.
+
 ## [3.1.0] - 2026-06-06
 
 - TAG: [v3.1.0][3.1.0t]
@@ -345,7 +361,9 @@ Please file a bug if you notice a violation of semantic versioning.
   - code coverage tracked with Coveralls, QLTY.sh, and the kettle-soup-cover gem
   - other minor fixes and improvements
 
-[Unreleased]: https://github.com/appraisal-rb/appraisal2/compare/v3.1.0...HEAD
+[Unreleased]: https://github.com/appraisal-rb/appraisal2/compare/v3.1.1...HEAD
+[3.1.1]: https://github.com/appraisal-rb/appraisal2/compare/v3.1.0...v3.1.1
+[3.1.1t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.1.1
 [3.1.0]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.9...v3.1.0
 [3.1.0t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.1.0
 [3.0.9]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.8...v3.0.9

data/README.md

@@ -178,6 +178,47 @@ This is intended for plugin gems that need deterministic generated output, such
 as style normalization of appraisal gemfiles, without monkey-patching Appraisal2
 internals.
 
+### Generator Plugins
+
+Use `plugin` in `Appraisals` for companion gems that must be loaded while
+Appraisal2 evaluates and generates appraisal gemfiles, but must not be written
+as dependencies in the generated appraisal gemfiles.
+
+```ruby
+plugin "appraisal2-rubocop",
+  :require => "appraisal2/rubocop",
+  :optional => true
+```
+
+`plugin` requires the requested path in the active generator bundle. It does not
+call `gem`, and it is not serialized into `gemfiles/*.gemfile`. This keeps
+generator-only tooling out of appraisals that target older Rubies, while still
+allowing modern generator workflows to load hooks such as
+`Appraisal.transform_gemfile`.
+
+Set `:optional => true` when some workflows evaluate `Appraisals` without the
+plugin dependency installed. This is useful when a CI matrix uses one generator
+bundle for old-Ruby appraisals and another modern workflow provides the plugin.
+
+If the generator bundle needs dependencies that must not be copied into every
+generated appraisal gemfile, wrap those root Gemfile declarations with
+`generator_only` for Appraisal2 and leave the Bundler branch unchanged:
+
+```ruby
+if respond_to?(:generator_only)
+  generator_only do
+    eval_gemfile "gemfiles/modular/style.gemfile"
+  end
+else
+  eval_gemfile "gemfiles/modular/style.gemfile"
+end
+```
+
+Bundler evaluates the `else` branch while installing the active generator
+bundle. Appraisal2 evaluates the `generator_only` branch while parsing the root
+Gemfile, but intentionally does not serialize that block into generated
+appraisal gemfiles.
+
 ## 🔧 Basic Usage
 
 Once you've configured the appraisals you want to use, you need to install the
@@ -750,7 +791,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.894-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.911-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: https://github.com/appraisal-rb/appraisal2/blob/main/SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

data/lib/appraisal/appraisal_file.rb

@@ -41,6 +41,16 @@ module Appraisal
       Customize.new(args)
     end
 
+    def plugin(name, *args)
+      options = args.last.is_a?(Hash) ? args.last : {}
+      require_path = options.key?(:require) ? options[:require] : name
+      optional = options.key?(:optional) ? options[:optional] : false
+
+      require require_path if require_path
+    rescue LoadError
+      raise unless optional
+    end
+
     private
 
     def run(definitions)

data/lib/appraisal/bundler_dsl.rb

@@ -44,6 +44,10 @@ module Appraisal
       @eval_gemfile << [path, contents]
     end
 
+    def generator_only(&_block)
+      nil
+    end
+
     def gem(name, *requirements)
       @dependencies.add(name, substitute_git_source(requirements))
     end

data/lib/appraisal/version.rb

@@ -2,7 +2,7 @@
 
 module Appraisal
   module Version
-    VERSION = "3.1.0"
+    VERSION = "3.1.1"
   end
   VERSION = Version::VERSION # Traditional constant location
 end

data/lib/appraisal2/version.rb

@@ -2,7 +2,7 @@
 
 module Appraisal2
   module Version
-    VERSION = "3.1.0"
+    VERSION = "3.1.1"
   end
   VERSION = Version::VERSION # Traditional Constant Location
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appraisal2
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Peter Boling
@@ -437,10 +437,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://appraisal2.galtzo.com
-  source_code_uri: https://github.com/appraisal-rb/appraisal2/tree/v3.1.0
-  changelog_uri: https://github.com/appraisal-rb/appraisal2/blob/v3.1.0/CHANGELOG.md
+  source_code_uri: https://github.com/appraisal-rb/appraisal2/tree/v3.1.1
+  changelog_uri: https://github.com/appraisal-rb/appraisal2/blob/v3.1.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/appraisal-rb/appraisal2/issues
-  documentation_uri: https://www.rubydoc.info/gems/appraisal2/3.1.0
+  documentation_uri: https://www.rubydoc.info/gems/appraisal2/3.1.1
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/appraisal-rb/appraisal2/wiki
   news_uri: https://www.railsbling.com/tags/appraisal2