injectable 0.0.5 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc9ea4f80413a4e20a767b34804610ef6f6c5e24ae1670e3ee74909a928d4d33
+  data.tar.gz: f52f528a69f32a026258dd36017762256b410ae954950629190845e752a68c06
+SHA512:
+  metadata.gz: 87a1f36da87711d78b9fa8ac6bcc80d6f4fe107e44e0174d786472efe667d5423482c7250f474c92f59bdbca4c780ca4d3eef6403af3da2e9851a0963588c813
+  data.tar.gz: ce7a234c6105ac0e8eeb5804e8d304a13a343c39147d3df782073bb44603a65100666cbad7593f4319f84dc4803c6c5614d2789f933c85a83420fc67a32089cf

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@rubiconmd.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in injectable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    injectable (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  injectable!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 amrocco
+
+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

@@ -1,209 +1,358 @@
-Injectable [![Build Status](https://secure.travis-ci.org/durran/injectable.png?branch=master&.png)](http://travis-ci.org/durran/injectable) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/durran/injectable)
-========
+# Injectable
 
-Injectable is an extremely simple dependency injection framework for Ruby. It's
-stupid simple and experimental so don't expect support for now - but may turn out
-to be something in the future.
+`Injectable` is an opinionated and declarative [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) library for ruby.
 
-Usage
------
+It is being used in production (under ruby 2.5.1) in [RubiconMD](https://github.com/rubiconmd) and was extracted from its codebase.
 
-Say we have a `UserService` that has some basic logic for performing operations
-related to a `User` and a `FacebookService`. We can tell the `UserService` what
-its dependencies are via `Injectable`. Note that as of `0.0.2` all objects that
-can be injected into others must include the `Injectable` module.
+## Installation
+
+Add this line to your application's Gemfile:
 
 ```ruby
-class User
-  include Injectable
+gem 'injectable', '>= 1.0.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install injectable
+
+## Motivation
+
+The main motivation of `Injectable` is to ease compliance with [SOLID's](https://en.wikipedia.org/wiki/SOLID)\*, [SRP](https://en.wikipedia.org/wiki/Single_responsibility_principle)\* and [Dependency Inversion principle](https://en.wikipedia.org/wiki/Dependency_inversion_principle) by providing a declarative and very readable [DSL](https://en.wikipedia.org/wiki/Domain-specific_language)\* which avoids lots of bolierplate code and thus encourages good practices.*
+
+*Sorry about the acronyms, but using an [Ubiquitous Language](https://martinfowler.com/bliki/UbiquitousLanguage.html) is important.
+
+### Encapsulate domain logic
+
+Using Ruby on Rails recommended practices as an example, when your application grows enough you usually end up with huge model classes with too many responsibilities.
+
+It's way better (although it requires effort and discipline) to split those models and extract domain logic into [Service Objects](https://martinfowler.com/bliki/AnemicDomainModel.html) ("SOs" from now on). You can do this without `Injectable`, but `Injectable` will make your SOs way more readable and a pleasure not only to write but also to test, while encouraging general good practices.
+
+### Avoiding to hardcode dependencies
+
+If you find occurences of `SomeClass.any_instance.expects(:method)` in your **unit** tests, then you are probably hardcoding dependencies:
+
+```rb
+test "MyClass#call"
+  Collaborator.any_instance.expects(:submit!) # hardcoded dependency
+  MyClass.new.call
 end
 
-class FacebookService
-  include Injectable
+class MyClass
+  attr_reader :collaborator
+
+  def initialize
+    @collaborator = Collaborator.new
+  end
+
+  def call
+    collaborator.submit!
+  end
 end
+```
 
-class UserService
-  include Injectable
-  dependencies :user, :facebook_service
+What if you did this instead:
+
+```rb
+test "MyClass#call"
+  collaborator = stub('Collaborator')
+  collaborator.expects(:submit!)
+  MyClass.new(collaborator: collaborator).call
+end
+
+class MyClass
+  attr_reader :collaborator
+
+  def initialize(collaborator: Collaborator.new) # we will just provide a default
+    @collaborator = collaborator
+  end
+
+  def call
+    collaborator.submit!
+  end
 end
 ```
 
-The `UserService` would then get a constructor defined that takes a `User` and
-`FacebookService` as its arguments:
+The benefits are not only for testing, as now your class is more modular and you can swap collaborators as long as they have the proper interface, in this case they have to `respond_to :submit!`
 
-```ruby
-user = User.new
-facebook_service = FacebookService.new
-user_service = UserService.new(user, facebook_service)
+`Injectable` allows you to write the above code like this:
+
+```rb
+class MyClass
+  include Injectable
+
+  dependency :collaborator
+
+  def call
+    collaborator.submit!
+  end
+end
 ```
 
-Reader methods are also automatically provided for each dependency:
+It might not seem a lot but:
 
-```ruby
-user_service.user
-user_service.facebook_service
+1. Imagine that you have 4 dependencies. That's a lot of boilerplate.
+2. `Injectable` is not only this, it has many more features. Please keep reading.
+
+## Usage example
+
+`Injectable` is a mixin that you have to include in your class and it will provide several macros.
+
+This is a real world example:
+
+```rb
+class PdfGenerator
+  include Injectable
+
+  dependency :wicked_pdf
+
+  argument :html
+  argument :render_footer, default: false
+
+  def call
+    wicked_pdf.pdf_from_string(html, options)
+  end
+
+  private
+
+  def options
+    return {} unless render_footer
+
+    {
+      footer: {
+        left: footer,
+      }
+    }
+  end
+
+  def footer
+    "Copyright ® #{Time.current.year}"
+  end
+end
+
+# And you would use it like this:
+PdfGenerator.call(html: '<some html here>')
+# Overriding the wicked_pdf dependency:
+PdfGenerator.new(wicked_pdf: wicked_pdf_replacement).call(html: '<some html>')
 ```
 
-Say we just want to throw a bunch of objects in a container, and ask for an
-object of a specific type and let the container figure out the dependencies:
+## Premises
 
-```ruby
-user = User.new
-facebook_service = FacebookService.new
-container = Injectable::Container.new(user, facebook_service)
-user_service = container.get(:user_service)
+In order to understand how (and why) `Injectable` works, you need to know some principles.
+
+### #1 The `#call` method
+
+`Injectable` classes **must define a public `#call` method that takes no arguments**.
+
+This is **the only public method** you will be defining in your `Injectable` classes.
+
+```rb
+# Correct ✅
+def call
+  # do stuff
+end
+
+# Wrong ❗️
+def call(some_argument)
+  # won't work and will raise an exception at runtime
+end
 ```
 
-Objects can also be added to the container post instantiation.
+If you want your `#call` method to receive arguments, that's what the `#argument` macro is for. BTW, we call those **runtime arguments**.
 
-```ruby
-user = User.new
-facebook_service = FacebookService.new
-container = Injectable::Container.new
-container.put(user, facebook_service)
-user_service = container.get(:user_service)
+Why `#call`?
+
+Because it's a ruby idiom. Many things in ruby are `callable`, like lambdas.
+
+### #2 The `initialize` method
+
+Injectable classes take their **dependencies as keyword arguments** on the `initialize` method. They can also take **configuration arguments** on `initialize`:
+
+```rb
+MyClass.new(some_dep: some_dep_instance, some_config: true).call
 ```
 
-Since `User` and `FacebookService` take no arguments, we don't even need to
-pass them into the container - it will automatically instantiate new ones:
+`Injectable` instantiates **dependencies that you have declared with the `dependency` macro** for you and passes them to `initialize`, so if you don't want to override those you don't even need to instantiate the class and you can use the provided class method **`#call` shortcut**:
 
-```ruby
-container = Injectable::Container.new
-user = container.get(:user)
-user_service = container.get(:user_service)
+```rb
+Myclass.call # This is calling `initialize` under the hood
 ```
 
-Injectable also supports depending on roles rather than concrete classes by
-allowing the registration of classes whose instances perform that role. An
-implementation can be registered on a single container itself as a "one off":
+If you need to override dependencies or configuration options, just call `new` yourself:
 
-```ruby
-container = Injectable::Container.new
-container.register_implementation(:facebook_service, DifferentFacebookService)
-user_service = container.get(:user_service)
-# `user_service`'s facebook_service will be an instance of DifferentFacebookService
+```rb
+Myclass.new(some_dep: Override.new, some_config: false).call
 ```
 
-You can also define concrete implementations at the global level via `configure`:
+If you do that, **any dependency that you didn't pass will be injected by `Injectable`**.
+Notice that **configuration arguments**, which are declared with `#initialize_with` behave in the exact same way.
 
-```ruby
-Injectable.configure do |config|
-  config.register_implementation(:facebook_service, DifferentFacebookService)
-end
+### #3 Keyword arguments
 
-container = Injectable::Container.new
-user_service = container.get(:user_service)
-# `user_service`'s facebook_service will be an instance of DifferentFacebookService
-```
+Both `#initialize` and `#call` take **keyword arguments**.
 
-Multiple implementations for the same role can be configured - the rules on how
-they will be used are as follows: Check for an already instantiated instance in
-the container. If one or both exist, take the first. If none exist, then attempt to
-resolve the dependency with each registered role until one succeeds. An example:
+### #4 Readers
 
-```ruby
-module Portable
-  def charge
-    # Some logic here.
-  end
-end
+All `Injectable` macros define reader methods for you, that's why you define `#call` without arguments, because **you access everything you declare via reader methods**.
 
-class Phone
-  include Injectable
-  include Portable
-end
+## The `#dependency` macro
 
-class Tablet
-  include Injectable
-  include Portable
+This is the main reason why you want to use this library in the first place.
+
+There are several ways of declaring a `#dependency`:
+
+### Bare dependency name
+
+```rb
+class ReportPdfRenderer
+  include Injectable 
+  
+  dependency :some_dependency
 end
+```
+
+1. `Injectable` first tries to find the `SomeDependency` constant in `ReportPdfRenderer`namespace.
+2. If it doesn't find it, then tries without namespace (`::SomeDependency`).
+
+Notice that this happens **at runtime**, not when defining your class.
 
-class Application
+### Explicit, inline class:
+
+```rb
+class MyInjectable
   include Injectable
-  dependencies :portable
+  
+  dependency :client, class: Aws::S3::Client
+  dependency :parser, class: VeryLongClassNameForMyParser 
 end
+```
+
+Nothing fancy here, you are explicitly telling `Injectable` which class to instantiate for you.
+
+You will want to use this style for example if the class is namespaced somewhere else or if you want a different name other than the class', like for example if it's too long.
 
-Injectable.configure do |config|
-  config.register_implementation(:portable, Phone, Tablet)
+Notice that this approach sets the class when ruby interprets the class, **not at runtime**.
+
+### With a block:
+
+```rb
+dependency :complex_client do
+  instance = ThirdPartyLib.new(:foo, bar: 'goo')
+  instance.set_config(:name, 'value')
+  instance
 end
+```
+
+It's important to understand that `Injectable` won't call `#new` on whatever you return from this block.
+
+You probably want to use this when your dependency has a complex setup. We use it a lot when wrapping third party libraries which aren't reused elsewhere.
+
+If you want to wrap a third party library and you need to reuse it, then we recommend that you write a specific `Injectable` class for it, so it adheres to its principles and is easier to use.
+
+### `#dependency` options
+
+#### `:with`
 
-container = Injectable::Container.new
-application = container.get(:application)
-application.portable #=> Returns a new Phone.
+If the dependency takes arguments, you can set them with :with
 
-tablet = Tablet.new
-container = Injectable::Container.new(tablet)
-application = container.get(:application)
-application.portable #=> Returns the existing instance of a Tablet.
+```rb
+# Arrays will be splatted: WithNormalArguments.new(1, 2, 3)
+dependency :with_normal_arguments, with: [1, 2, 3]
+# Hashes will be passed as-is: WithKeywordArguments.new(foo: 'bar)
+dependency :with_keyword_arguments, with: { foo: 'bar' }
 ```
 
-Setter injection is not supported.
+### `:depends_on`
 
-How about the real world
-------------------------
+It allows you to share **memoized instances** of dependencies and supports both a single dependency or multiples as an Array:
 
-Let's look at the above classes, but say we're in a Rails application:
+```rb
+dependency :client # this will be instantiated just once and will be shared
+dependency :reporter, depends_on: :client
+dependency :mailer,   depends_on: %i[client reporter]
+```
 
-```ruby
-class User < ActiveRecord::Base
-  include Injectable
+Dependencies of dependencies will be passed as keyword arguments using the same name they were declared with. In the example above, `Injectable` will instantiate a `Mailer` class passing `{ client: client, reporter: reporter }` to `#initialize`.
+
+If you have a dependency that is defined with a block which also depends_on other dependencies, you'll receive those as keyword arguments:
+
+```rb
+dependency :my_dependency, depends_on: :client do |client:|
+  MyDependency.new(client)
 end
+```
 
-class FacebookService
-  include Injectable
+### `:call`
 
-  def post_to_wall(id, message)
-    # ...
-  end
+Sometimes you have a class that doesn't adhere to `Injectable` principles:
+
+```rb
+dependency :renderer
+
+def call
+  renderer.render # this class does not respond to `call`
 end
+```
 
-class UserService
-  include Injectable
-  dependencies :user, :facebook_service
+`:call` is a way of wrapping such dependency so it behaves like an `Injectable`:
 
-  def post_to_wall(message)
-    facebook_service.post_to_wall(user.id, message)
-  end
+```rb
+dependency :renderer, call: :render
+
+def call
+  renderer.call
 end
 ```
 
-Now in our controller, we can just create a new container the user we find
-and then ask the container to do all the other work. This is more closely
-related to what one might do in a real application.
+It's important to understand that **you can mix and match all dependency configurations and options** described above.
 
-```ruby
-class UsersController < ApplicationController
+## `#initialize_with` macro
 
-  def post_to_wall
-    container.get(:user_service).post_to_wall(params[:message])
-    respond_with container.get(:user)
-  end
+This macro is meant for **configuration arguments** passed to `initialize`:
 
-  private
+```rb
+initialize_with :debug, default: false
+```
 
-  def container
-    @container ||= Injectable::Container.new(User.find(params[:id]))
-  end
-end
+If you don't pass the `:default` option the argument will be required.
+
+## `#argument` macro
+
+`#argument` allows you to define **runtime arguments** passed to `#call`
+
+```rb
+argument :browser, default: 'Unknown'
 ```
 
-Copyright (c) 2012 Durran Jordan
+If you don't pass the `:default` option the argument will be required.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubiconmd/injectable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
 
-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:
+Everyone interacting in the Injectable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+## Credits
 
-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.
+- [RubiconMD](https://github.com/rubiconmd) allowed extracting this gem from its codebase and release it as open source.
+- [Durran Jordan](https://github.com/durran) allowed the usage of the gem name at rubygems.org.
+- [David Marchante](https://github.com/iovis9) brainstormed the `initialize`/`call` approach, did all code reviews and provided lots of insightful feedback and suggestions. He also wrote the inline documentation.
+- [Julio Antequera](https://github.com/jantequera), [Jimmi Carney](https://github.com/ayoformayo) and [Anthony Rocco](https://github.com/amrocco) had the patience to use it and report many bugs. Also most of the features in this gem came up when reviewing their usage of it. Anthony also made the effort of extracting the code from RubiconMD's codebase.
+- [Rodrigo Álvarez](https://github.com/Papipo) had the idea for the DSL and actually wrote the library.