Skip to content

Raise exception when injecting into modules - #62

Open
janko wants to merge 1 commit into
dry-rb:mainfrom
janko:raise-for-modules
Open

Raise exception when injecting into modules#62
janko wants to merge 1 commit into
dry-rb:mainfrom
janko:raise-for-modules

Conversation

@janko

@janko janko commented Oct 1, 2019

Copy link
Copy Markdown

To me it happened that I accidentally injected my dependencies into a namespace module instead of into a class, like this:

module Operations
  module Articles
    include Import["repositories.articles"]

    class Create
      # ...
    end
  end
end

When I did that, I got an error originating from that line, but happening somewhere in dry-auto_inject's internals (a NoMethodError for NilClass). This led me to believe that I've somehow incorrectly passed parameters to Import[], and it took me a while to realize what was the error.

The error occurred because the downstream code assumes the #initialize method will be defined, which is not the case for modules. To improve the developer experience, we detect that we're attempting to inject into a module and raise an explicit exception.

To me it happened that I accidentally injected my dependencies into a
namespace module instead of into a class, like this:

  module Operations
    module Articles
      include Import["repositories.articles"]

      class Create
        # ...
      end
    end
  end

When I did that, I got a NoMethodError for NilClass somewhere down the
line. This led me to believe that I've somehow incorrectly passed
parameters to `Import[]`, and it took me a while to realize what was the
error.

The error occurred because the downstream code assumes the #initialize
method will be defined, which is not the case for modules. To improve
the developer experience, we detect that we're attempting to inject into
a module and raise an explicit exception.
@janko
janko force-pushed the raise-for-modules branch from 29229f4 to 733d017 Compare October 1, 2019 19:23
@flash-gordon

Copy link
Copy Markdown
Member

I won't go into details right now, but I want to note that this is strategy-dependent. For example, effect-based DI works with modules or whatever. And I believe we can make built-in strategies to work with modules too. However, this would require some hacking.

@janko

janko commented Oct 1, 2019

Copy link
Copy Markdown
Author

Hmm, you're right, I haven't considered that. I've also often seen people using modules instead of classes for stateless operations, in which case they might want to use auto-inject.

I'll keep this open in case you still want to merge it until support for modules is added.

@solnic

solnic commented Jan 4, 2020

Copy link
Copy Markdown
Member

Codacy Here is an overview of what got changed by this pull request:

Issues
======
- Added 3
           

Complexity increasing per file
==============================
- lib/dry/auto_inject/strategies/constructor.rb  2
         

Clones added
============
- spec/dry/auto_inject_spec.rb  3
         

See the complete overview on Codacy


# @api private
def included(klass)
fail Error, "cannot inject dependencies into a module" unless klass.respond_to?(:new)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


context 'autoinject in a module' do
it 'raises exception' do
expect {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


# @api private
def included(klass)
fail Error, "cannot inject dependencies into a module" unless klass.respond_to?(:new)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants