How to remove a gem from only one appraisal in Appraisal?

Use the `remove_gem` declaration within the specific appraisal block in your Appraisals file. For example, to exclude a test gem for Rails 5, add `remove_gem 'gem_name'` in the group section, and it will be omitted from the generated Gemfile for that appraisal.

Appraisal vs manually managing multiple Gemfiles, which is better?

Appraisal automates Gemfile generation and dependency management, reducing errors and ensuring consistency across versions. For simple projects with few dependencies, manual management might be lighter, but Appraisal saves time for complex version matrices.

Can I use Appraisal with Ruby on Rails applications, not just libraries?

Yes, Appraisal works for any Ruby project using Bundler, but it's most beneficial for applications needing to test against multiple gem versions, such as ensuring compatibility during upgrades or supporting different environments.

How to set up Appraisal with GitHub Actions for CI?

Add steps in your workflow YAML to run `bundle exec appraisal install` to set up dependencies, then execute tests with `bundle exec appraisal rake test`. Customize the test command based on your suite, similar to the Circle CI example in the README.

What happens if I edit a generated Gemfile directly instead of the Appraisals file?

Direct edits to generated Gemfiles will be overwritten when you run `appraisal install` or `update`, as Appraisal regenerates them from the Appraisals file. Always modify the Appraisals file to maintain consistency.

Appraisal or bundler-audit for dependency testing?

Appraisal focuses on testing against different dependency versions for compatibility, while bundler-audit checks for security vulnerabilities. They serve complementary roles and can both be used in a CI pipeline for comprehensive dependency management.

Open-Awesome

Appraisal

MITRubyv2.5.0

A Ruby library for testing your library against different versions of dependencies in repeatable scenarios.

Visit Website GitHub

1.3k stars114 forks0 contributors

What is Appraisal?

Appraisal is a Ruby library that helps developers test their libraries against different versions of dependencies. It creates isolated testing scenarios called "appraisals" that combine your main Gemfile with specific version requirements, allowing you to check for regressions across dependency versions without polluting your development environment.

Target Audience

Ruby library maintainers and developers who need to ensure their gems work correctly across multiple versions of dependencies like Rails or other gems.

Value Proposition

Appraisal provides a clean, repeatable way to test against multiple dependency versions without manual Gemfile switching. It integrates seamlessly with bundler and rake, making it easier to maintain compatibility and catch regressions early in the development cycle.

Overview

A Ruby library for testing your library against different versions of dependencies.

Use Cases

Best For

Testing Ruby libraries against multiple Rails versions
Ensuring gem compatibility across dependency version upgrades
Setting up continuous integration tests for multiple dependency configurations
Maintaining backward compatibility for published Ruby gems
Isolating test environments for different gem dependency sets
Automating regression testing across dependency matrices

Not Ideal For

Projects using Bundler's local or vendored gem installations, as Appraisal requires global namespace installation
Teams with single-version dependencies that don't require multi-version regression testing
Environments using non-Rake task runners or custom CI pipelines that conflict with default task overrides

Pros & Cons

Pros

Seamless Bundler Integration

Integrates directly with Bundler to manage and lock dependencies for each appraisal, creating isolated, reproducible test environments without manual Gemfile switching.

Rake Command Automation

Allows running tests across all appraisals with a single command like `bundle exec appraisal rake test`, streamlining regression testing workflows.

Customizable Gemfile Generation

Supports customization of generated Gemfiles with headings and formatting options, including variable substitution for appraisal names and paths, enhancing clarity.

CI-Ready Examples

Provides specific configuration examples for CI systems like Circle CI, making it easy to set up continuous integration for multiple dependency versions.

Cons

Global Gem Pollution

Requires gems to be installed in the global namespace, which can conflict with system gems and isn't compatible with local Bundler paths or isolated environments.

Rakefile Modification Hassles

Needs changes to the Rakefile for default task overriding, which the README admits can conflict with CI setups that split tests into multiple processes.

Version Control Overhead

Recommends checking in generated Gemfiles but excluding lockfiles, adding complexity to repository management and potential for dependency drift.

Frequently Asked Questions

Related Projects

faker

A library for generating fake data such as names, addresses, and phone numbers.

Stars11,623

Forks3,162

Last commit5 days ago

Capybara

Acceptance test framework for web applications

Stars10,165

Forks1,469

Last commit2 months ago

factory_bot

A library for setting up Ruby objects as test data.

Stars8,178

Forks2,554

Last commit12 days ago

VCR

Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.

Stars6,073

Forks508

Last commit11 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub