dry-auto_inject 0.7.0 → 0.8.0

data/.rubocop_todo.yml

@@ -1,6 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-08-19 22:11:28 +0100 using RuboCop version 0.32.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -1,29 +0,0 @@
-# Issue Guidelines
-
-## Reporting bugs
-
-If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
-
-## Reporting feature requests
-
-Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
-
-## Reporting questions, support requests, ideas, concerns etc.
-
-**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
-
-# Pull Request Guidelines
-
-A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
-
-Other requirements:
-
-1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
-2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
-3) Add API documentation if it's a new feature
-4) Update API documentation if it changes an existing feature
-5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
-
-# Asking for help
-
-If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in dry-auto_inject.gemspec
-gemspec
-
-group :test do
-  gem "simplecov"
-  gem "codeclimate-test-reporter", require: nil
-end
-
-group :tools do
-  gem 'byebug', platforms: :mri
-  gem 'pry'
-  gem "ossy", git: "https://github.com/solnic/ossy.git", branch: "master"
-end

data/Rakefile

@@ -1,14 +0,0 @@
-#!/usr/bin/env rake
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-task default: :spec
-
-desc 'Run all specs in spec directory'
-RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'dry-auto_inject'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require 'pry'
-Pry.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docsite/source/basic-usage.html.md

@@ -1,104 +0,0 @@
----
-title: Basic usage
-layout: gem-single
-name: dry-auto_inject
----
-
-### Requirements
-
-You need only one thing before you can use dry-auto\_inject: a container to hold your application’s dependencies. These are commonly known as “inversion of control” containers.
-
-A [dry-container](/gems/dry-container) will work well, but the only requirement is that the container responds to the `#[]` interface. For example, `my_container["users_repository"]` should return the “users_repository” object registered with the container.
-
-### Creating an injector
-
-To create an injector, pass the container to `Dry::AutoInject`:
-
-```ruby
-Import = Dry::AutoInject(my_container)
-```
-
-Assign the injector to a constant (or make it globally accessible somehow) so you can refer to it from within your classes.
-
-### Specifying dependencies
-
-To specify the dependencies for a class, mix in the injector and provide the container identifiers for each dependency:
-
-```ruby
-class MyClass
-  include Import["users_repository", "deliver_welcome_email"]
-end
-```
-
-### Using dependencies
-
-Each dependency is available via a reader with a matching name:
-
-```ruby
-class MyClass
-  include Import["users_repository"]
-
-  def call
-    puts users_repository.inspect
-  end
-end
-```
-
-If your container identifiers include delimiters (like `"."`) or other characters that are not allowed within variable or method names, then the final part of the name will be used instead:
-
-```ruby
-class MyClass
-  include Import["repositories.users"]
-
-  def call
-    puts users.inspect
-  end
-end
-```
-
-### Specifying aliases for dependencies
-
-You can specify dependencies as a hash to provide your own names for each one:
-
-```ruby
-class MyClass
-  include Import[users_repo: "repositories.users"]
-
-  def call
-    puts users_repo.inspect
-  end
-end
-```
-
-If you want to provide a mix of inferred names and aliases, provide the aliases last:
-
-```ruby
-class MyClass
-  include Import[
-    "repositories.users",
-    deliver_email: "operations.deliver_welcome_email",
-  ]
-end
-```
-
-### Initializing your object
-
-Initialize your object without any arguments and all the dependencies will be resolved from the the container automatically:
-
-```ruby
-my_obj = MyClass.new
-```
-
-### Passing manual dependencies
-
-To provide an alternative object for a dependency, pass it to the initializer with a keyword argument matching the dependency’s name:
-
-```ruby
-class MyClass
-  include Import["repositories.users"]
-end
-
-my_obj = MyClass.new(users: different_repo)
-```
-
-This technique is useful when testing your class in isolation. You can pass in test doubles to verify your class’ behaviour under various different circumstances.

data/docsite/source/how-does-it-work.html.md

@@ -1,45 +0,0 @@
----
-title: How does it work?
-layout: gem-single
-name: dry-auto_inject
----
-
-dry-auto\_inject enables _constructor dependency injection_ for your objects. It achieves this by defining two methods in the module that you include in your class.
-
-First, it defines `.new`, which resolves your dependencies from the container, if you haven't otherwise provided them as explicit arguments. It then passes these dependencies as arguments onto `#initialize`, as per Ruby’s usual behaviour.
-
-It also defines `#initialize`, which receives these dependencies as arguments and then assigns them to instance variables. These variables are made available via `attr_reader`s.
-
-So when you specify dependencies like this:
-
-```ruby
-Import = Dry::AutoInject(MyContainer)
-
-class MyClass
-  include Import["users_repository"]
-end
-```
-
-You’re building something like this (this isn’t a line-for-line copy of what is mixed into your class; it’s intended as a guide only):
-
-```ruby
-class MyClass
-  attr_reader :users_repository
-
-  def self.new(**args)
-    deps = {
-      users_repository: args[:users_repository] || MyContainer["users_repository"]
-    }
-
-    super(**deps)
-  end
-
-  def initialize(users_repository: nil)
-    super()
-
-    @users_repository = users_repository
-  end
-end
-```
-
-Since these methods are defined in the module that you include in your class, you can still override them in your class if you wish to provide custom behavior.

data/docsite/source/index.html.md

@@ -1,53 +0,0 @@
----
-title: Introduction
-description: Container-agnostic dependency resolution mixin
-layout: gem-single
-order: 4
-type: gem
-name: dry-auto_inject
-sections:
-  - basic-usage
-  - how-does-it-work
-  - injection-strategies
----
-
-dry-auto\_inject provides low-impact dependency injection and resolution support for your classes.
-
-It’s designed to work with a container that holds your application’s dependencies. It works well with [dry-container](/gems/dry-container), but supports any container that responds to the `#[]` interface.
-
-### Usage example
-
-```ruby
-# Set up a container (using dry-container here)
-class MyContainer
-  extend Dry::Container::Mixin
-
-  register "users_repository" do
-    UsersRepository.new
-  end
-
-  register "operations.create_user" do
-    CreateUser.new
-  end
-end
-
-# Set up your auto-injection mixin
-Import = Dry::AutoInject(MyContainer)
-
-class CreateUser
-  include Import["users_repository"]
-
-  def call(user_attrs)
-    users_repository.create(user_attrs)
-  end
-end
-
-create_user = MyContainer["operations.create_user"]
-create_user.call(name: "Jane")
-```
-
-### Why use dry-auto\_inject?
-
-Splitting your application’s behavior into smaller, more focused units makes for logic that is easier to understand, test, and refactor. Dependency injection is what then allows you to combine these small units to create more sophisticated behavior.
-
-By using a container and dry-auto\_inject, this process becomes easy. You don’t need to worry about building constructors or accessors, and adding extra dependencies is as easy as adding a string to a list.

data/docsite/source/injection-strategies.html.md

@@ -1,94 +0,0 @@
----
-title: Injection strategies
-layout: gem-single
-name: dry-auto_inject
----
-
-dry-auto\_inject supports three _injection strategies_, allowing you to design and integrate with different kinds of classes.
-
-These strategies all provide _constructor dependency injection_: dependencies are passed when creating your objects. The strategies differ in how they expect dependencies to be passed to the initializer.
-
-## Choosing a strategy
-
-Choose a strategy when you build the injector:
-
-```ruby
-# Default keyword arguments strategy
-Import = Dry::AutoInject(MyContainer)
-
-# Positional arguments strategy
-Import = Dry::AutoInject(MyContainer).args
-```
-
-Strategies can also be chained from existing injectors, which means you can set up a single injector for your most commonly used strategy, then use a different strategy directly in particular classes if they have differing requirements. For example:
-
-```ruby
-# Set up a standard strategy for your app
-Import = Dry::AutoInject(MyContainer)
-
-class MyClass
- # Use the standard strategy here
- include Import["users_repository"]
-end
-
-class SpecialClass
- # Use a different strategy in this particular class
- include Import.args["users_repository"]
-end
-```
-
-## Strategies
-
-### Keyword arguments (`kwargs`)
-
-This is the default strategy.
-
-Pass dependencies to the initializer using keyword arguments.
-
-```ruby
-Import = Dry::AutoInject(MyContainer)
-
-class MyClass
- include Import["users_repository"]
-end
-
-MyClass.new(users_repository: my_repo)
-```
-
-The `#initialize` method has two possible argument signatures:
-
-- If there is no `super` method for `#initialize`, or the `super` method takes no arguments, then the keyword arguments will be explicit, e.g. `#initialize(users_repository: nil)`.
-- If the `super` method for `#initialize` takes its own set of keyword arguments, then the arguments will be a single splat, e.g. `#initialize(**args)`.
-
-### Options hash (`hash`)
-
-Pass the dependencies to the initializer as a single hash.
-
-```ruby
-Import = Dry::AutoInject(MyContainer).hash
-
-class MyClass
- include Import["users_repository"]
-end
-
-# This can also take `{users_repo: my_repo}`
-MyClass.new(users_repository: my_repo)
-```
-
-The `#initialize` method has an argument signature of `#initialize(options)`, where `options` is expected to be a hash.
-
-### Positional arguments (`args`)
-
-Pass dependencies to the initializer using standard positional arguments.
-
-```ruby
-Import = Dry::AutoInject(MyContainer).args
-
-class MyClass
- include Import["users_repository"]
-end
-
-MyClass.new(my_repo)
-```
-
-The `#initialize` method has an argument signature with a named positional argument for each dependency, e.g. `#initialize(users_repository)`.

data/rakelib/rubocop.rake

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-begin
-  require 'rubocop/rake_task'
-
-  Rake::Task[:default].enhance [:rubocop]
-
-  RuboCop::RakeTask.new do |task|
-    task.options << '--display-cop-names'
-  end
-
-  namespace :rubocop do
-    desc 'Generate a configuration file acting as a TODO list.'
-    task :auto_gen_config do
-      exec 'bundle exec rubocop --auto-gen-config'
-    end
-  end
-
-rescue LoadError
-end