plumbum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3ca814e726f5c7d8c17d831ef41acabf3f0d6d823f14856c11be28d62230e39
+  data.tar.gz: ddf9b0cd50e93c5fa1d8e0336d8635a66369e7b2156598865b1787d1d231b2ca
+SHA512:
+  metadata.gz: cd6ba482abe9f0f59461daabc73ca244bf343ec4c76b390304e173469c81577757b599a6d67967377b57f376138e4b1697179392cfcad498c026611ca8db9b08
+  data.tar.gz: 95682a1f51ffc64f707deef2708fd50e523c3df947cc17408be6822d35863e9fcffae5e32191016e776cf31f6b0b6654ce2ff543c4966e73662284bc38088ae3

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+# 0.1.0
+
+Initial development version.
+
+## Consumers
+
+Implemented `Plumbum::Consumer` to manage providers and dependencies.
+
+- Implemented `Plumbum::Parameters` to receive dependencies as constructor parameters.
+
+## Providers
+
+Implemented `Plumbum::Provider` to define dependencies.
+
+- Implemented `Plumbum::ManyProvider`.
+- Implemented `Plumbum::OneProvider`.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+merlin@sleepingkingstudios.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2025 Rob Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,163 @@
+# Plumbum
+
+Plumbum is a minimal dependency injection framework for Ruby, using vanilla Ruby semantics to define and reference dependencies from different providers.
+
+<blockquote>
+  Read The
+  <a href="https://www.sleepingkingstudios.com/plumbum" target="_blank">
+    Documentation
+  </a>
+</blockquote>
+
+Plumbum defines an interface for declaring, providing, and consuming object dependencies. It defines the following concepts:
+
+- Dependencies - A value or object used in some part of your application, such as a data repository, a configuration hash, or an environment name.
+- [Providers](http://sleepingkingstudios.com/plumbum/providers) - A `Provider` makes one or more dependencies available to other parts of the application.
+- [Consumers](http://sleepingkingstudios.com/plumbum/consumers) - A `Consumer` declares what dependencies it relies on and what providers it consumes. Plumbum handles resolving those dependencies.
+
+As an example, consider a data repository. From a query object's perspective, there should be one source of truth as to where the data is read and persisted - but where? In a global singleton? A repository object manually passed to the query? What if we want to use different data sources in the test environment?
+
+Plumbum solves this problem by decoupling the *source* of the dependency from how the dependency is *used*. We start by defining a provider - in this case, let's call it a `RepositoryProvider`. We can initialize the provider with a different *value* in different environments - for example, using static fixtures in the test environment. Inside our query class, then, we declare a *dependency* on a `#repository` value. We also declare a *provider* relationship with our defined `RepositoryProvider`. And that's it - when we call `query.repository`, Plumbum resolves that dependency to the provider. Want to inject a different dependency value in a specific test? Include `Plumbum::Parameters` and you can provide dependencies by passing them in as constructor parameters.
+
+## Why Plumbum?
+
+Plumbum was designed to solve a specific problem: decoupling the *definition* from the *use* of dependent objects and functions. You should use Plumbum when:
+
+- You have dependencies that are used across your application or far from where they are nominally defined. For example, a data repository object could be used across the application - in commands, in queries, in reports, and so on.
+- The *values* of your dependencies can change based on scope or context. For example, an application might use different configuration values in the development, test, and production environments, or you want to use a global logger in most contexts but pass in a mock logger instance in unit tests.
+
+In addition to managing dependencies like configuration and repositories, one critical use case I've found for Plumbum in my own projects is defining a facade service over functionality like reading/writing to the standard IO streams or performing file system operations. Doing so allows me to define and inject mock services that make unit testing both easier and more safe to run.
+
+## About
+
+Plumbum is tested against MRI Ruby 3.2 through 4.0.
+
+### Documentation
+
+Documentation is generated using [YARD](https://yardoc.org/), and can be generated locally using the `yard` gem.
+
+### License
+
+Plumbum is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+### Contribute
+
+The canonical repository for this gem is on [GitHub](https://github.com/sleepingkingstudios/plumbum). Community contributions are welcome - please feel free to fork or submit issues, bug reports or pull requests.
+
+### Code of Conduct
+
+Please note that the `Plumbum` project is released with a [Contributor Code of Conduct](https://github.com/sleepingkingstudios/plumbum/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
+
+## Getting Started
+
+Add the gem to your `Gemfile` or `gemspec`:
+
+```ruby
+gem 'plumbum'
+```
+
+Require `Plumbum` in your code:
+
+```ruby
+require 'plumbum'
+```
+
+### Identify Dependencies
+
+Before writing any code to manage dependencies, stop and consider what your dependencies are. Our example is a library application with entities such as Author, Book, Patron, and Loan, and we want to manage our application's data persistence layer. Each entity is represented by a `collection` that wraps query and update methods for that entity, and we define a `repository` object that returns our collections.
+
+```ruby
+repository = SqlRepository.new(database_url:)
+collection = repository.books
+
+collection.where(author: 'Ursula K. LeGuin')
+```
+
+Lots of places in the code will need to reference the current repository - in particular, any functions that query the existing data or insert or update entities will need the repository, so passing in the value directly will quickly become unwieldy.
+
+We could define a singleton, such as a `Repository.current` class method. But what if we need the *value* of the current repository to depend on context? Here are a few reasons we might want to do so:
+
+- High-priority requests in production use reserved database connections.
+- The repository in the test environment uses a different data store - Redis-backed instead of a SQL database.
+- We define a test repository with specific fixtures for running feature tests against the UI.
+
+### Define Providers
+
+The solution Plumbum defines is a `Provider`, a special type of object that "provides" or returns a dependency when requested. The documentation for providers is <a href="https://www.sleepingkingstudios.com/plumbum/providers" target="_blank">available online</a>.
+
+Each provider implements a simple interface:
+
+- `provider.has?(name)` checks if the provider defines the named dependency.
+- `provider.get(name)` returns the requested dependency.
+
+`Plumbum` has pre-defined providers for wrapping single and plural dependencies. In our case, we want to define a provider for just one dependency, so we'll use the `Plumbum::OneProvider` class. Further, we want to make sure that once the `repository` is set, it can't be changed to a different value, so we use the `write_once:` flag.
+
+```ruby
+require 'plumbum'
+
+module Library
+  REPOSITORY_PROVIDER = Plumbum::OneProvider.new(:repository, write_once: true)
+end
+```
+
+Notice that we are *not* initializing the repository with a value. Instead, we will do so lazily - in an initializer when running the server, or in the test setup when running unit tests.
+
+```ruby
+Library::REPOSITORY_PROVIDER.value = SqlRepository.new(database_url:)
+```
+
+This allows us to define a different value in each environment, and to defer setting the value until later in the startup process (for example, once we have loaded configuration values). However, since the `write_once:` flag is set, we ensure that the value can't be changed at a later point.
+
+### Define Consumers
+
+So, we've defined our `Provider`, allowing us to control how and when our `repository` value is defined and to access the value from anywhere in our application. That solves our immediate problem, but calling `repository = Library::REPOSITORY_PROVIDER.get(:repository)` everywhere isn't very elegant or efficient.
+
+Thus, Plumbum defines the `Consumer` module which you can `include` in your class to manage providers and dependencies. The documentation for consumers is <a href="https://www.sleepingkingstudios.com/plumbum/consumers" target="_blank">available online</a>.
+
+Let's define a query class that finds books with the requested author, using Plumbum to manage our dependencies.
+
+```ruby
+module Library
+  module Queries
+    class FindBooksByAuthor
+      include Plumbum::Consumer
+
+      provider Library::REPOSITORY_PROVIDER
+
+      dependency :repository
+
+      def call(author_name, **filters)
+        author = repository.authors.find(name: author)
+        books  = repository.books.where(**filters, author_id: author.id)
+
+        {
+          author:,
+          books:
+        }
+      end
+    end
+  end
+end
+```
+
+In our query class, we first include `Plumbum::Consumer` to define the DSL methods. We then declare a `provider` - in our case, the `Library::REPOSITORY_PROVIDER`, which makes a `repository` dependency available. Finally, we declare that the query has a `dependency :repository`. Doing so defines the `#repository` method, which searches the providers defined for the class until it finds one that defines a `:repository` dependency.
+
+A more complex example might define multiple providers and dependencies. The `dependency` method in particular provides a number of advanced features:
+
+- Dependency aliases: `dependency :application, as: :app`.
+- Skip memoization: `dependency :request, memoize: false`.
+- Scoped dependencies: `dependency 'config.network.default_server`.
+- Method dependencies: `dependency '#restart', scope: :process_manager`.
+
+Let's solve a specific problem for our query class - testing. We can already declare a different `repository` value in our test environment by assigning it to the provider in our test setup. But what if we want to pass in a `repository` value directly? That would allow us to write tests with a repository scoped to the individual test and with predefined seed data.
+
+Plumbum provides a module to enable this specific functionality. Include `Plumbum::Parameters` in your class and you can pass in dependency values to the constructor.
+
+```ruby
+Library::Queries::FindBooksByAuthor.include(Plumbum::Parameters)
+
+repository = MockRepository.new(authors: [], books: [])
+query      = Library::Queries::FindBooksByAuthor.new(repository:)
+```
+
+For a full list of features, see the <a href="https://www.sleepingkingstudios.com/plumbum" target="_blank">Documentation</a>.

data/lib/plumbum/consumer.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tools'
+
+require 'plumbum'
+require 'plumbum/consumers/class_methods'
+require 'plumbum/consumers/instance_methods'
+
+module Plumbum
+  # Provides methods for defining and accessing injected dependencies.
+  #
+  # @example Define a basic dependency.
+  #   class Orchestrator
+  #     include Plumbum::Consumer
+  #     include ApplicationProvider
+  #
+  #     dependency :application
+  #   end
+  #
+  #   Orchestrator.new.application
+  #   #=> returns the value of ApplicationProvider.value
+  #
+  # @example Define an aliased dependency.
+  #   class Orchestrator
+  #     include Plumbum::Consumer
+  #     include ApplicationProvider
+  #
+  #     dependency :application, as: :app
+  #   end
+  #
+  #   Orchestrator.new.app
+  #   #=> returns the value of ApplicationProvider.value
+  #
+  # @example Define an optional dependency.
+  #   class BillCustomer
+  #     include Plumbum::Consumer
+  #
+  #     dependency :rewards
+  #   end
+  #
+  #   class BillRewardsCustomer < BillCustomer
+  #     include RewardsProvider
+  #   end
+  #
+  #   BillCustomer.new.rewards
+  #   #=> returns nil
+  #
+  #   BillRewardsCustomer.new.rewards
+  #   #=> returns RewardsProvider.value
+  #
+  # @example Define an unmemoized dependency.
+  #   class Action
+  #     include Plumbum::Consumer
+  #     include RequestProvider
+  #
+  #     dependency :request, memoize: false
+  #   end
+  #
+  #   action = Action.new
+  #   action.request
+  #   #=> returns the value of RequestProvider.value
+  #
+  #   request = Request.new
+  #   RequestProvider.value = request
+  #   action.request
+  #   #=> returns the new request
+  #
+  # @example Define a dependency with scoped key.
+  #   class Client
+  #     include Plumbum::Consumer
+  #     include ConfigurationProvider
+  #
+  #     dependency 'config.network.default_server'
+  #   end
+  #
+  #   client = Client.new
+  #   client.default_server
+  #   #=> returns the value of ConfigurationProvider.values[:config][:network][:default_server]
+  #
+  # @example Define multiple dependencies.
+  #   class Rocket
+  #     include Plumbum::Consumer
+  #     include RocketPartsProvider
+  #
+  #     dependency :engine, :fusilage, :payload
+  #   end
+  #
+  #   rocket = Rocket.new
+  #   rocket.engine
+  #   #=> returns the value of RocketPartsProvider.values[:engine]
+  #
+  # @example Define multiple dependencies with scoped keys.
+  #   class Server
+  #     include Plumbum::Consumer
+  #     include ConfigurationProvider
+  #
+  #     dependency :port, :protocol, :timeout, scope: 'config.network'
+  #   end
+  #
+  #   server = Server.new
+  #   server.port
+  #   #=> returns the value of ConfigurationProvider.values[:config][:network][:port]
+  #
+  # @example Define a method depndency.
+  #   class Application
+  #     include Plumbum::Consumer
+  #     include ProcessManagerProvider
+  #
+  #     dependency '#restart', scope: :process_manager
+  #   end
+  #
+  #   application = Application.new
+  #   application.restart(force: true)
+  #   #=> calls ProcessManagerProvider.values[:process_manager].restart(force: true)
+  module Consumer
+    include Plumbum::Consumers::InstanceMethods
+
+    # Class methods to extend when including Plumbum::Consumer.
+    module ClassMethods
+      include Plumbum::Consumers::ClassMethods
+
+      alias dependency plumbum_dependency
+
+      alias dependency_keys plumbum_dependency_keys
+
+      alias provider plumbum_provider
+
+      # Callback invoked when Consumer is included in another module or class.
+      #
+      # This ensures that the Consumer methods propagate correctly across a
+      # chain of included modules.
+      def included(other)
+        super
+
+        other.extend(ClassMethods)
+      end
+    end
+
+    class << self
+      # Callback invoked when Consumer is included in another module or class.
+      def included(other)
+        super
+
+        other.extend(ClassMethods)
+      end
+    end
+  end
+end