Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chocolateboy/wireless
A lightweight, declarative dependency-provider
https://github.com/chocolateboy/wireless
declarative dependencies dependency dependency-injection dependency-provider di service-locator service-provider zero-dependency
Last synced: 14 days ago
JSON representation
A lightweight, declarative dependency-provider
- Host: GitHub
- URL: https://github.com/chocolateboy/wireless
- Owner: chocolateboy
- License: mit
- Created: 2018-06-15T22:06:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T02:16:56.000Z (over 3 years ago)
- Last Synced: 2024-12-17T19:37:36.255Z (16 days ago)
- Topics: declarative, dependencies, dependency, dependency-injection, dependency-provider, di, service-locator, service-provider, zero-dependency
- Language: Ruby
- Homepage:
- Size: 42 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Wireless
[](https://github.com/chocolateboy/wireless/actions?query=workflow%3Atest)
[](https://rubygems.org/gems/wireless)
- [NAME](#name)
- [INSTALLATION](#installation)
- [SYNOPSIS](#synopsis)
- [DESCRIPTION](#description)
- [WHY?](#why)
- [Why Wireless?](#why-wireless)
- [Why Service Locators?](#why-service-locators)
- [COMPATIBILITY](#compatibility)
- [VERSION](#version)
- [SEE ALSO](#see-also)
- [Gems](#gems)
- [Articles](#articles)
- [AUTHOR](#author)
- [COPYRIGHT AND LICENSE](#copyright-and-license)
# NAME
Wireless - a lightweight, declarative dependency-provider
# INSTALLATION
```ruby
gem "wireless"
```
# SYNOPSIS
```ruby
require "wireless"
WL = Wireless.new do
count = 0
# factory: return a new value every time
on(:foo) do
[:foo, count += 1]
end
# singleton: return the cached value
once(:bar) do
[:bar, count += 1]
end
# depend on other dependencies
on(:baz) do |wl|
[:baz, wl[:foo], wl[:bar]]
end
end
# factory
WL[:foo] # [:foo, 1]
WL[:foo] # [:foo, 2]
# singleton
WL[:bar] # [:bar, 3]
WL[:bar] # [:bar, 3]
# dependencies
WL[:baz] # [:baz, [:foo, 4], [:bar, 3]]
WL[:baz] # [:baz, [:foo, 5], [:bar, 3]]
# mixin
class Example
include WL.mixin %i[foo bar baz]
def test
foo # [:foo, 6]
bar # [:bar, 3]
baz # [:baz, [:foo, 7], [:bar, 3]]
end
end
```
# DESCRIPTION
Wireless is a declarative dependency-provider (AKA [service locator](https://en.wikipedia.org/wiki/Service_locator_pattern)),
which has the following features:
* Simplicity
It's just an object which dependencies can be added to and retrieved from.
It can be passed around and stored like any other object. No "injection",
containers, framework, or dependencies.
* Convenience
Include dependency getters into a class or module with control over their
visibility.
* Laziness
As well as being resolved lazily, dependencies can also be *registered*
lazily, i.e. at the point of creation. There's no need to declare
everything up front.
* Safety
Dependency resolution is thread-safe. Dependency cycles are checked and
raise a fatal error as soon as they are detected.
# WHY?
## Why Wireless?
I wanted a simple service locator like
[DiFtw](https://github.com/jhollinger/ruby-diftw), with cycle detection and
control over the [visibility of getters](https://github.com/jhollinger/ruby-diftw/issues/1).
## Why Service Locators?
Service locators make it easy to handle shared (AKA
[cross-cutting](https://en.wikipedia.org/wiki/Cross-cutting_concern))
dependencies, i.e. values and services that are required by multiple
otherwise-unrelated parts of a system. Examples include:
* logging
* configuration data
* storage backends
* authorisation
Rather than wiring these dependencies together manually, service locators allow
them to be registered and retrieved in a declarative way. This is similar to
the difference between imperative build tools like Ant or Gulp, and declarative
build tools like Make or Rake, which allow prerequisites to be acquired without
coordinating their construction.
# COMPATIBILITY
- [Maintained ruby versions](https://www.ruby-lang.org/en/downloads/branches/)
# VERSION
0.1.0
# SEE ALSO
## Gems
- [Canister](https://github.com/mlibrary/canister) - a simple service-locator inspired by Jim Weirich's [article](https://archive.li/shxeA) on Dependency Injection
- [DiFtw](https://github.com/jhollinger/ruby-diftw) - the original inspiration for this module: a similar API with a focus on testing/mocking
- [dry-container](https://github.com/dry-rb/dry-container) - a standalone service-locator which can also be paired with a [dependency injector](https://github.com/dry-rb/dry-auto_inject)
## Articles
- Martin Fowler - [Inversion of Control Containers and the Dependency Injection pattern](https://www.martinfowler.com/articles/injection.html) [2004]
- Jim Weirich - [Dependency Injection in Ruby](https://archive.li/shxeA) [2004]
# AUTHOR
[chocolateboy](mailto:[email protected])
# COPYRIGHT AND LICENSE
Copyright © 2018-2021 by chocolateboy.
This is free software; you can redistribute it and/or modify it under the terms
of the [MIT license](https://opensource.org/licenses/MIT).