dry-container 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f11ec3380a6ff086362780a67b687935cff8ddf
-  data.tar.gz: 15db84953170fdc3f249d852d01d106f7a904f23
+SHA256:
+  metadata.gz: 77e050044acc97600020d74da69d2b54a5788a61fcb84b7c9feba51068b2977e
+  data.tar.gz: d7aa97eea6849253f410414c12844f6c04baf4e4a3e9a58f2a26c0211f98ea89
 SHA512:
-  metadata.gz: f36ffd98d0c80ffd158e1554a09dd89919aeb7c780010a276118ad217db89d9ace865746c18b97321b6022d75dc5a4e46523d27927cd01ee182d0bb3b6b105b8
-  data.tar.gz: 7b52ee74e85b40edad15d082ad5fc64a20a00947a8d97d472be013f4f98fe363be5c25f007cd6d089582d0302034b35ed0041ce843e276c896100a9775a2a14a
+  metadata.gz: dd18bbb80600daf28c2ce1ce5ea4a24c688a1cfd7e21b365e3486cb871d5cd2065f4484123b0c5d016a9e637fb4fdc44208c6884bb4fd24a241e7c43d26175cd
+  data.tar.gz: 19d157a7db948b4663b9ced4d5db537cd0b43407afd8e8e852b203202863f8eba279a083d6d302b8cbe05899e5036b24465186683b8d5746f3fc63d3a5debfeb

data/CHANGELOG.md

@@ -1,11 +1,98 @@
-## v0.5.0
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
-## Added
+## 0.7.2 2019-07-09
 
-* `memoize` option to `#register` - memoizes items on first resolve ([ivoanjo](https://github.com/ivoanjo))
 
-## Fixed
+### Added
 
-* `required_ruby_version` set to `>= 2.0.0` ([artofhuman](https://github.com/artofhuman))
+- `.resolve` accepts an optional fallback block, similar to how `Hash#fetch` works ([flash-gordon](https://github.com/flash-gordon))
+  ```ruby
+  container.resolve('missing_key') { :fallback } # => :fallback
+  ```
+- `.decorate` can (again) work with static values. Also, it can take a block instead of `with` ([flash-gordon](https://github.com/flash-gordon))
+  ```ruby
+  container.register('key', 'value')
+  container.decorate('key') { |v| "<'#{v}'>" }
+  container.resolve('key') # => "<'value'>"
+  ```
 
-[Compare v0.4.0...HEAD](https://github.com/dry-rb/dry-container/compare/v0.4.0...HEAD)
+
+[Compare v0.7.1...v0.7.2](https://github.com/dry-rb/dry-container/compare/v0.7.1...v0.7.2)
+
+## 0.7.1 2019-06-07
+
+
+### Fixed
+
+- Added `Mixin#dup` and `Mixin#clone`, now copies don't share underlying containers (flash-gordon)
+
+
+[Compare v0.7.0...v0.7.1](https://github.com/dry-rb/dry-container/compare/v0.7.0...v0.7.1)
+
+## 0.7.0 2019-02-05
+
+
+### Added
+
+- Namespace DSL resolves keys relative to the current namespace, see the corresponding [changes](https://github.com/dry-rb/dry-container/pull/47) ([yuszuv](https://github.com/yuszuv))
+- Registered objects can be decorated with the following API ([igor-alexandrov](https://github.com/igor-alexandrov))
+
+  ```ruby
+  class CreateUser
+    def call(params)
+      # ...
+    end
+  end
+  container.register('create_user') { CreateUser.new }
+  container.decorate('create_user', with: ShinyLogger.new)
+
+  # Now subsequent resolutions will return a wrapped object
+
+  container.resolve('create_user')
+  # => #<ShinyLogger @obj=#<CreateUser:0x...>]>
+  ```
+- Freezing a container now prevents further registrations ([flash-gordon](https://github.com/flash-gordon))
+- ## Internal
+- Handling container items was generalized in [#34](https://github.com/dry-rb/dry-container/pull/34) ([GabrielMalakias](https://github.com/GabrielMalakias))
+
+### Fixed
+
+- Symbols are now coerced to strings when resolving stubbed dependencies ([cthulhu666](https://github.com/cthulhu666))
+- Stubbing keys not present in container will raise an error ([flash-gordon](https://github.com/flash-gordon))
+
+  This means after upgrading you may see errors like this
+  ```
+  ArgumentError (cannot stub "something" - no such key in container)
+  ```
+  Be sure you register dependencies before using them. The new behavior will likely save quite a bit of time when debugging ill-configured container setups.
+
+### Changed
+
+- [BREAKING] Now only Ruby 2.3 and above is supported ([flash-gordon](https://github.com/flash-gordon))
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-container/compare/v0.6.0...v0.7.0)
+
+## 0.6.0 2016-12-09
+
+
+### Added
+
+- `Dry::Container::Mixin#each` - provides a means of seeing what all is registered in the container ([jeremyf](https://github.com/jeremyf))
+
+### Fixed
+
+- Including mixin into a class with a custom initializer ([maltoe](https://github.com/maltoe))
+
+
+[Compare v0.5.0...v0.6.0](https://github.com/dry-rb/dry-container/compare/v0.5.0...v0.6.0)
+
+## 0.5.0 2016-08-31
+
+
+### Added
+
+- `memoize` option to `#register` - memoizes items on first resolve ([ivoanjo](https://github.com/ivoanjo))
+
+### Fixed
+
+- `required_ruby_version` set to `>= 2.0.0` ([artofhuman](https://github.com/artofhuman))

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Ruby Object Mapper
+Copyright (c) 2015-2021 dry-rb team
 
 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

data/README.md

@@ -1,169 +1,29 @@
-[gitter]: https://gitter.im/dry-rb/chat
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-container
-[travis]: https://travis-ci.org/dry-rb/dry-container
-[code_climate]: https://codeclimate.com/github/dry-rb/dry-container
-[inch]: http://inch-ci.org/github/dry-rb/dry-container
+[actions]: https://github.com/dry-rb/dry-container/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-container
+[chat]: https://dry-rb.zulipchat.com
+[inchpages]: http://inch-ci.org/github/dry-rb/dry-container
 
-# dry-container [![Join the Gitter chat](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+# dry-container [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
-[![Gem Version](https://img.shields.io/gem/v/dry-container.svg)][gem]
-[![Build Status](https://img.shields.io/travis/dry-rb/dry-container.svg)][travis]
-[![Code Climate](https://img.shields.io/codeclimate/github/dry-rb/dry-container.svg)][code_climate]
-[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/dry-rb/dry-container.svg)][code_climate]
-[![API Documentation Coverage](http://inch-ci.org/github/dry-rb/dry-container.svg)][inch]
+[![Gem Version](https://badge.fury.io/rb/dry-container.svg)][gem]
+[![CI Status](https://github.com/dry-rb/dry-container/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/227509c9034340b493f769f6277f4ecb)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/227509c9034340b493f769f6277f4ecb)][codacy]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-container.svg?branch=master)][inchpages]
 
+## Links
 
-A simple, configurable container implemented in Ruby
+* [User documentation](https://dry-rb.org/gems/dry-container)
+* [API documentation](http://rubydoc.info/gems/dry-container)
 
-## Synopsis
+## Supported Ruby versions
 
-### Brief Example
+This library officially supports the following Ruby versions:
 
-```ruby
-container = Dry::Container.new
-container.register(:parrot) { |a| puts a }
-
-parrot = container.resolve(:parrot)
-parrot.call("Hello World")
-# Hello World
-# => nil
-```
-
-### Detailed Example
-
-```ruby
-User = Struct.new(:name, :email)
-
-data_store = Concurrent::Map.new.tap do |ds|
-  ds[:users] = Concurrent::Array.new
-end
-
-# Initialize container
-container = Dry::Container.new
-
-# Register an item with the container to be resolved later
-container.register(:data_store, data_store)
-container.register(:user_repository, -> { container.resolve(:data_store)[:users] })
-
-# Resolve an item from the container
-container.resolve(:user_repository) << User.new('Jack', 'jack@dry-container.com')
-# You can also resolve with []
-container[:user_repository] << User.new('Jill', 'jill@dry-container.com')
-# => [
-#      #<struct User name="Jack", email="jack@dry-container.com">,
-#      #<struct User name="Jill", email="jill@dry-container.com">
-#    ]
-
-# If you wish to register an item that responds to call but don't want it to be
-# called when resolved, you can use the options hash
-container.register(:proc, -> { :result }, call: false)
-container.resolve(:proc)
-# => #<Proc:0x007fa75e652c98@(irb):25 (lambda)>
-
-# You can also register using a block
-container.register(:item) do
-  :result
-end
-container.resolve(:item)
-# => :result
-
-container.register(:block, call: false) do
-  :result
-end
-container.resolve(:block)
-# => #<Proc:0x007fa75e6830f0@(irb):36>
-
-# You can also register items under namespaces using the #namespace method
-container.namespace('repositories') do
-  namespace('checkout') do
-    register('orders') { Concurrent::Array.new }
-  end
-end
-container.resolve('repositories.checkout.orders')
-# => []
-
-# Or import a namespace
-ns = Dry::Container::Namespace.new('repositories') do
-  namespace('authentication') do
-    register('users') { Concurrent::Array.new }
-  end
-end
-container.import(ns)
-container.resolve('repositories.authentication.users')
-# => []
-
-# You can also register a block that is used to initialize a dependency and
-# then memoize it, allowing several dependencies to be added without
-# enforcing an instantiation order
-class MessagePrinter
-  def initialize(container)
-    @message = container.resolve(:message)
-    @time = Time.now
-  end
-
-  def print
-    puts "#{@message} at #{@time}"
-  end
-end
-
-container.register(:message_printer, -> { MessagePrinter.new(container) }, memoize: true)
-container.register(:message, 'Hello, world!')
-container.resolve(:message_printer).print
-# => Hello, world! at 2016-08-30 05:32:12 -0700
-
-# Same instance is reused next time
-container.resolve(:message_printer).print
-# => Hello, world! at 2016-08-30 05:32:12 -0700
-```
-
-You can also get container behaviour at both the class and instance level via the mixin:
-
-```ruby
-class Container
-  extend Dry::Container::Mixin
-end
-Container.register(:item, :my_item)
-Container.resolve(:item)
-# => :my_item
-
-class ContainerObject
-  include Dry::Container::Mixin
-end
-container = ContainerObject.new
-container.register(:item, :my_item)
-container.resolve(:item)
-# => :my_item
-```
-### Using a custom registry/resolver
-
-You can configure how items are registered and resolved from the container:
-
-```ruby
-Dry::Container.configure do |config|
-  config.registry = ->(container, key, item, options) { container[key] = item }
-  config.resolver = ->(container, key) { container[key] }
-end
-
-class Container
-  extend Dry::Container::Mixin
-
-  configure do |config|
-    config.registry = ->(container, key, item, options) { container[key] = item }
-    config.resolver = ->(container, key) { container[key] }
-  end
-end
-
-class ContainerObject
-  include Dry::Container::Mixin
-
-  configure do |config|
-    config.registry = ->(container, key, item, options) { container[key] = item }
-    config.resolver = ->(container, key) { container[key] }
-  end
-end
-```
-
-This allows you to customise the behaviour of Dry::Container, for example, the default registry (Dry::Container::Registry) will raise a Dry::Container::Error exception if you try to register under a key that is already used, you may want to just overwrite the existing value in that scenario, configuration allows you to do so.
+* MRI `>= 2.6.0`
+* jruby `>= 9.2`
 
 ## License
 

data/dry-container.gemspec

@@ -1,26 +1,42 @@
-# coding: utf-8
-require File.expand_path('../lib/dry/container/version', __FILE__)
+# frozen_string_literal: true
+
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dry/container/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-container'
-  spec.version       = ::Dry::Container::VERSION
-  spec.authors       = ['Andy Holland']
-  spec.email         = ['andyholland1991@aol.com']
-  spec.summary       = 'A simple container intended for use as an IoC container'
-  spec.homepage      = 'https://github.com/dryrb/dry-container'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = ">= 2.0.0"
-
-  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_runtime_dependency 'dry-configurable', '~> 0.1', '>= 0.1.3'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.name          = "dry-container"
+  spec.authors       = ["Andy Holland"]
+  spec.email         = ["andyholland1991@aol.com"]
+  spec.license       = "MIT"
+  spec.version       = Dry::Container::VERSION.dup
+
+  spec.summary       = "A simple, configurable object container implemented in Ruby"
+  spec.description   = spec.summary
+  spec.homepage      = "https://dry-rb.org/gems/dry-container"
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-container.gemspec", "lib/**/*"]
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-container/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-container"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-container/issues"
+
+  if defined? JRUBY_VERSION
+    spec.required_ruby_version = ">= 2.5.0"
+  else
+    spec.required_ruby_version = ">= 2.6.0"
+  end
+
+  # to update dependencies edit project.yml
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_runtime_dependency "dry-configurable", "~> 0.1", ">= 0.1.3"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/dry-container.rb

@@ -1 +1,3 @@
-require 'dry/container'
+# frozen_string_literal: true
+
+require "dry/container"

data/lib/dry/container.rb

@@ -1,13 +1,13 @@
-require 'concurrent'
-require 'dry-configurable'
-require 'dry/container/error'
-require 'dry/container/item'
-require 'dry/container/namespace'
-require 'dry/container/registry'
-require 'dry/container/resolver'
-require 'dry/container/namespace_dsl'
-require 'dry/container/mixin'
-require 'dry/container/version'
+# frozen_string_literal: true
+
+require "dry-configurable"
+require "dry/container/error"
+require "dry/container/namespace"
+require "dry/container/registry"
+require "dry/container/resolver"
+require "dry/container/namespace_dsl"
+require "dry/container/mixin"
+require "dry/container/version"
 
 # A collection of micro-libraries, each intended to encapsulate
 # a common task in Ruby

data/lib/dry/container/error.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Dry
   class Container
     # @api public
-    class Error < ::StandardError; end
+    Error = Class.new(StandardError)
   end
 end

data/lib/dry/container/item.rb

@@ -1,42 +1,49 @@
+# frozen_string_literal: true
+
 module Dry
   class Container
-    # Container class
+    # Base class to abstract Memoizable and Callable implementations
+    #
+    # @api abstract
     #
-    # @private
     class Item
-      attr_reader :item, :options, :memoize, :memoize_mutex
+      # @return [Mixed] the item to be solved later
+      attr_reader :item
+
+      # @return [Hash] the options to memoize, call or no.
+      attr_reader :options
 
+      # @api abstract
       def initialize(item, options = {})
         @item = item
         @options = {
           call: item.is_a?(::Proc) && item.parameters.empty?
         }.merge(options)
-
-        if options[:memoize] == true
-          raise(
-            ::Dry::Container::Error,
-            'Memoize only supported for a block or a proc'
-          ) unless item.is_a?(::Proc)
-          @memoize = true
-          @memoize_mutex = ::Mutex.new
-        end
       end
 
+      # @api abstract
       def call
-        return memoized_item if memoize
+        raise NotImplementedError
+      end
 
-        if options[:call] == true
-          item.call
-        else
-          item
-        end
+      # @private
+      def value?
+        !callable?
       end
 
-      private
+      # @private
+      def callable?
+        options[:call]
+      end
 
-      def memoized_item
-        memoize_mutex.synchronize do
-          @memoized_item ||= item.call
+      # Build a new item with transformation applied
+      #
+      # @private
+      def map(func)
+        if callable?
+          self.class.new(-> { func.(item.call) }, options)
+        else
+          self.class.new(func.(item), options)
         end
       end
     end