Skip to content

A Bundler plugin that adds namespace support for gem resolution, enabling a choice between alternate versions of a single gem in different namespaces, as well as multiple "flavors" of the same gem (partial support), from namespace-aware sources.

License

Notifications You must be signed in to change notification settings

galtzo-floss/bundle-namespace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

31 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
๐Ÿ“ NOTE
RubyGems.org was recently compromised in a hostile takeover about which many lies have been told.
I'm in the process of adding warnings to some important gems because I don't condone the theft of the bundler and rubygems-update projects.
Once publishing to gem.coop is available I will stop publishing to RubyGems.org.
Please see here and here for more info on what comes next.

Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0 ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5

๐Ÿ• Bundle::Namespace

Version GitHub tag (latest SemVer) License: MIT Downloads Rank Open Source Helpers CodeCov Test Coverage Coveralls Test Coverage QLTY Test Coverage QLTY Maintainability CI Heads CI Runtime Dependencies @ HEAD CI Current CI Truffle Ruby Deps Locked Deps Unlocked CI Supported CI Legacy CI Test Coverage CI Style CodeQL Apache SkyWalking Eyes License Compatibility Check

if ci_badges.map(&:color).detect { it != "green"} โ˜๏ธ let me know, as I may have missed the discord notification.


if ci_badges.map(&:color).all? { it == "green"} ๐Ÿ‘‡๏ธ send money so I can do more of this. FLOSS maintenance is now my full-time job.

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate on Polar Donate at ko-fi.com

๐ŸŒป Synopsis

A Bundler plugin that adds namespace support for gem resolution, enabling a choice between alternate versions of a single gem in different namespaces, as well as multiple "flavors" of the same gem (partial support), from namespace-aware sources.

Bundle::Namespace extends Bundler's DSL to support namespaced gem resolution. This allows you to:

  • Use the same gem name from different organizations/namespaces
  • Differentiate between multiple "flavors" of the same gem
  • Organize gems by namespace (similar to GitHub organizations)
  • Maintain separate versions of the same gem for different purposes

๐Ÿ’ก Info you can shake a stick at

Tokens to Remember Gem name Gem namespace
Works with JRuby JRuby 10.0 Compat JRuby HEAD Compat
Works with Truffle Ruby Truffle Ruby 23.1 Compat Truffle Ruby 24.1 Compat
Works with MRI Ruby 3 Ruby 3.1 Compat Ruby 3.2 Compat Ruby 3.3 Compat Ruby 3.4 Compat Ruby HEAD Compat
Support & Community Join Me on Daily.dev's RubyFriends Live Chat on Discord Get help from me on Upwork Get help from me on Codementor
Source Source on GitLab.com Source on CodeBerg.org Source on Github.com The best SHA: dQw4w9WgXcQ!
Documentation Current release on RubyDoc.info YARD on Galtzo.com Maintainer Blog GitLab Wiki GitHub Wiki
Compliance License: MIT Compatible with Apache Software Projects: Verified by SkyWalking Eyes ๐Ÿ“„ilo-declaration-img Security Policy Contributor Covenant 2.1 SemVer 2.0.0
Style Enforced Code Style Linter Keep-A-Changelog 1.0.0 Gitmoji Commits Compatibility appraised by: appraisal2
Maintainer ๐ŸŽ–๏ธ Follow Me on LinkedIn Follow Me on Ruby.Social Follow Me on Bluesky Contact Maintainer My technical writing
... ๐Ÿ’– Find Me on WellFound: Find Me on CrunchBase My LinkTree More About Me ๐ŸงŠ ๐Ÿ™ ๐Ÿ›– ๐Ÿงช

Compatibility

Compatible with MRI Ruby 2.7.0+, and concordant releases of JRuby, and TruffleRuby.

๐Ÿšš Amazing test matrix was brought to you by ๐Ÿ”Ž appraisal2 ๐Ÿ”Ž and the color ๐Ÿ’š green ๐Ÿ’š
๐Ÿ‘Ÿ Check it out! โœจ github.com/appraisal-rb/appraisal2 โœจ

Federated DVCS

Find this repo on federated forges (Coming soon!)
Federated DVCS Repository Status Issues PRs Wiki CI Discussions
๐Ÿงช galtzo-floss/bundle-namespace on GitLab The Truth ๐Ÿ’š ๐Ÿ’š ๐Ÿ’š ๐Ÿญ Tiny Matrix โž–
๐ŸงŠ galtzo-floss/bundle-namespace on CodeBerg An Ethical Mirror (Donate) ๐Ÿ’š ๐Ÿ’š โž– โญ•๏ธ No Matrix โž–
๐Ÿ™ galtzo-floss/bundle-namespace on GitHub Another Mirror ๐Ÿ’š ๐Ÿ’š ๐Ÿ’š ๐Ÿ’ฏ Full Matrix ๐Ÿ’š
๐ŸŽฎ๏ธ Discord Server Live Chat on Discord Let's talk about this library!

Enterprise Support Tidelift

Available as part of the Tidelift Subscription.

Need enterprise-level guarantees?

The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.

Get help from me on Tidelift

  • ๐Ÿ’กSubscribe for support guarantees covering all your FLOSS dependencies
  • ๐Ÿ’กTidelift is part of Sonar
  • ๐Ÿ’กTidelift pays maintainers to maintain the software you depend on!
    ๐Ÿ“Š@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers

Alternatively:

  • Live Chat on Discord
  • Get help from me on Upwork
  • Get help from me on Codementor

โœจ Installation

Install the gem and add to the application's Gemfile by executing:

bundle add bundle-namespace

If bundler is not being used to manage dependencies, install the gem by executing:

gem install bundle-namespace

๐Ÿ”’ Secure Installation

For Medium or High Security Installations

This gem is cryptographically signed, and has verifiable SHA-256 and SHA-512 checksums by stone_checksums. Be sure the gem you install hasnโ€™t been tampered with by following the instructions below.

Add my public key (if you havenโ€™t already, expires 2045-04-29) as a trusted certificate:

gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)

You only need to do that once. Then proceed to install with:

gem install bundle-namespace -P HighSecurity

The HighSecurity trust profile will verify signed gems, and not allow the installation of unsigned dependencies.

If you want to up your security game full-time:

bundle config set --global trust-policy MediumSecurity

MediumSecurity instead of HighSecurity is necessary if not all the gems you use are signed.

NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.

โš™๏ธ Configuration

Configure the plugin via .bundle/config:

# Enable strict mode (raise errors for unsupported sources)
bundle config set namespace.strict_mode true

# Disable warnings for ignored namespaces
bundle config set namespace.warn_on_missing false

# Custom lockfile path
bundle config set namespace.lockfile_path "config/namespace-lock.yaml"

Or in Ruby:

Bundle::Namespace::Configuration.strict_mode = true
Bundle::Namespace::Configuration.warn_on_missing = false
Bundle::Namespace::Configuration.lockfile_path = "custom-path.yaml"

๐Ÿ”ง Basic Usage

Basic Namespace Declaration

Use the namespace macro in your Gemfile, similar to the platform macro:

# Block syntax - namespace within default source
namespace :myorg do
  gem "shared-library", "~> 2.0"
  gem "custom-middleware"
end

# Within a specific source
source "https://gems.mycompany.com" do
  namespace :engineering do
    gem "internal-tools", "~> 1.5"
  end

  namespace :security do
    gem "internal-tools", "~> 2.0"  # Different version, same name!
  end
end

# Option syntax
gem "my-gem", "~> 1.0", namespace: :myorg

Multiple Namespaces

Handle the same gem from different namespaces:

source "https://rubygems.org" do
  namespace :myorganization do
    gem "rails", "~> 7.0", github: "myorganization/rails", branch: "custom"
  end
end

# Or for multi-tenant applications
source "https://gems.saas-platform.com" do
  namespace :tenant_a do
    gem "custom-theme", "~> 1.0"
  end

  namespace :tenant_b do
    gem "custom-theme", "~> 2.0"
  end
end

Nested Namespaces

Namespaces can be nested for complex organization:

namespace :parent do
  namespace :child do
    gem "nested-gem"
  end
end

How It Works

1. DSL Extension (Phase 1)

The plugin adds a namespace macro to Gemfile syntax, tracking which gems belong to which namespaces.

2. Resolution Enhancement (Phase 2)

During dependency resolution, the plugin:

  • Makes gem sources namespace-aware
  • Filters available gems by namespace
  • Resolves dependencies considering namespaces
  • Tracks namespace information in specifications

3. Lockfile Generation (Phase 3)

The plugin generates bundle-namespace-lock.yaml alongside Gemfile.lock:

---
"https://gems.mycompany.com":
  engineering:
    internal-tools:
      version: 1.5.2
      dependencies:
        - thor
      platform: ruby
  security:
    internal-tools:
      version: 2.0.1
      dependencies:
        - thor
        - openssl
      platform: ruby

This lockfile ensures reproducible builds with namespace information.

Requirements

  • Ruby >= 3.1
  • Bundler >= 2.6

Source Compatibility

Namespace-Aware Sources

The plugin automatically detects if a gem source supports namespaces. For sources that do:

  • Gems are fetched from <namespace>/<gem-name> paths
  • Specs are filtered by namespace
  • Multiple versions of the same gem can coexist

Non-Namespace-Aware Sources

For sources that don't support namespaces:

  • Namespace declarations are tracked but not enforced
  • Standard gem resolution applies
  • Warnings are shown (unless disabled)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests.

To install this gem onto your local machine, run bundle exec rake install.

Testing

# Run all tests
bundle exec rspec

# Run with documentation format
bundle exec rspec --format documentation

# Run specific test file
bundle exec rspec spec/bundle/namespace/dsl_extension_spec.rb

Project Structure

lib/bundle/namespace/
โ”œโ”€โ”€ version.rb                    # Version information
โ”œโ”€โ”€ errors.rb                     # Custom error classes
โ”œโ”€โ”€ registry.rb                   # Namespace-to-gem registry
โ”œโ”€โ”€ configuration.rb              # Plugin configuration
โ”œโ”€โ”€ dsl_extension.rb             # Gemfile DSL namespace macro
โ”œโ”€โ”€ dependency_extension.rb       # Namespace-aware dependencies
โ”œโ”€โ”€ source_extensions.rb          # Namespace-aware sources
โ”œโ”€โ”€ resolver_extension.rb         # Namespace-aware resolution
โ”œโ”€โ”€ specification_extension.rb    # Namespace tracking in specs
โ”œโ”€โ”€ lockfile_generator.rb        # Generate namespace lockfile
โ”œโ”€โ”€ lockfile_parser.rb           # Parse namespace lockfile
โ”œโ”€โ”€ lockfile_validator.rb        # Validate lockfile consistency
โ”œโ”€โ”€ bundler_integration.rb       # Auto-integration with Bundler
โ”œโ”€โ”€ hooks.rb                     # Extension installation
โ””โ”€โ”€ plugin.rb                    # Main plugin entry point

Architecture

The plugin uses module prepending to minimally monkey-patch Bundler:

  • Bundler::Dsl โ† DslExtension (adds namespace macro)
  • Bundler::Dependency โ† DependencyExtension (tracks namespaces)
  • Bundler::Source::Rubygems โ† SourceRubygemsExtension (namespace-aware lookups)
  • Bundler::Resolver โ† ResolverExtension (namespace-aware resolution)
  • Bundler::RemoteSpecification โ† SpecificationExtension (namespace tracking)
  • Bundler::LazySpecification โ† SpecificationExtension (namespace tracking)

Use Cases

Enterprise Internal Gems

source "https://gems.mycompany.com" do
  namespace :platform_team do
    gem "core-services", "~> 3.0"
    gem "monitoring-toolkit"
  end

  namespace :security_team do
    gem "core-services", "~> 2.5"  # Legacy compatibility
    gem "security-scanner"
  end
end

Testing Forked Gems

source "https://rubygems.org" do
  namespace :myorganization do
    gem "rails", github: "myorganization/rails", branch: "custom-patches"
  end
end

Multi-Tenant Applications

source "https://gems.saas-platform.com" do
  namespace :tenant_a do
    gem "custom-theme", "~> 1.0"
  end

  namespace :tenant_b do
    gem "custom-theme", "~> 2.0"
  end
end

Troubleshooting

Namespace Not Being Applied

  1. Check if source supports namespaces
  2. Enable warnings: bundle config set namespace.warn_on_missing true
  3. Check bundle-namespace-lock.yaml was generated

Lockfile Validation Errors

# Validate manually
bundle exec ruby -r bundle/namespace -e "
  parser = Bundle::Namespace::LockfileParser.new
  validator = Bundle::Namespace::LockfileValidator.new(parser)
  validator.validate!
  validator.report
"

Reset Namespace Information

# Remove namespace lockfile
rm bundle-namespace-lock.yaml

# Clear registry (in Ruby)
Bundle::Namespace::Registry.clear!

๐Ÿฆท FLOSS Funding

While pboling tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences (although currently Open Collective is our preferred funding platform).

If you're working in a company that's making significant use of pboling tools we'd appreciate it if you suggest to your company to become a pboling sponsor.

You can support the development of pboling tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.

๐Ÿ“ NOTE
If doing a sponsorship in the form of donation is problematic for your company
from an accounting standpoint, we'd recommend the use of Tidelift,
where you can get a support-like subscription instead.

Open Collective for Individuals

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Open Collective for Organizations

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

Another way to support open-source

How wonderful it is that nobody need wait a single moment before starting to improve the world.
โ€”Anne Frank

Iโ€™m driven by a passion to foster a thriving open-source community โ€“ a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions โ€” totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. Iโ€™m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 ๐Ÿ” chickens, 2 ๐Ÿถ dogs, 3 ๐Ÿฐ rabbits, 8 ๐Ÿˆโ€ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

Iโ€™m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: ๐Ÿ‘‰๏ธ No network calls. ๐Ÿ‘‰๏ธ No tracking. ๐Ÿ‘‰๏ธ No oversight. ๐Ÿ‘‰๏ธ Minimal crypto hashing. ๐Ÿ’ก Easily disabled nags

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate on Polar Donate to my FLOSS or refugee efforts at ko-fi.com Donate to my FLOSS or refugee efforts using Patreon

๐Ÿ” Security

See SECURITY.md.

๐Ÿค Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already ๐Ÿ’ฏ (see below) check reek, issues, or PRs, or use the gem and think about how it could be better.

We Keep A Changelog so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

๐Ÿš€ Release Instructions

See CONTRIBUTING.md.

Code Coverage

Coverage Graph

Coveralls Test Coverage

QLTY Test Coverage

๐Ÿช‡ Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the Contributor Covenant 2.1.

๐ŸŒˆ Contributors

Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/bundle-namespace/-/graphs/main

โญ๏ธ Star History Star History Chart

๐Ÿ“Œ Versioning

This Library adheres to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

dropping support for a platform is both obviously and objectively a breaking change
โ€”Jordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716

I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("bundle-namespace", "~> 1.0")
๐Ÿ“Œ Is "Platform Support" part of the public API? More details inside.

SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

See CHANGELOG.md for a list of releases.

๐Ÿ“„ License

The gem is available as open source under the terms of the MIT License License: MIT. See LICENSE.txt for the official Copyright Notice.

ยฉ Copyright

  • Copyright (c) 2023, 2025 Peter H.ย Boling, of Galtzo.com Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0 , and bundle-namespace contributors.

๐Ÿค‘ A request for help

Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March and filled with many dozens of rejections, I'm now spending ~60+ hours a week building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.

To join the community or get help ๐Ÿ‘‡๏ธ Join the Discord.

Live Chat on Discord

To say "thanks!" โ˜๏ธ Join the Discord or ๐Ÿ‘‡๏ธ send money.

Sponsor galtzo-floss/bundle-namespace on Open Source Collective ๐Ÿ’Œ Sponsor me on GitHub Sponsors ๐Ÿ’Œ Sponsor me on Liberapay ๐Ÿ’Œ Donate on PayPal

Please give the project a star โญ โ™ฅ.

Thanks for RTFM. โ˜บ๏ธ

About

A Bundler plugin that adds namespace support for gem resolution, enabling a choice between alternate versions of a single gem in different namespaces, as well as multiple "flavors" of the same gem (partial support), from namespace-aware sources.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •