simple_injector 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75751a79a8d5e62050da1e4e8dcf3b9f29d8fc04ce239aeb1dbb0072a99b669c
+  data.tar.gz: 5de5aed7094301ef9aa3285fb31250d642033cb98e90a5dca030d87ca20fbb98
+SHA512:
+  metadata.gz: d3800a3cc0334ce69431956b6dd9a697917d0fc4c385724a9bd07ab6d301d81a13ff2d29c7ecbd63f69f4dc115e527c16022116a1bd6eac600a9948d71f5bbfa
+  data.tar.gz: 9399abafbfa86185477c85117da7d43e85856c97598b2d4400a9053b0100b07e03db978a0a02ba01e58109a34efedb7625870edb3564e32776b8f4ca2b26debe

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-rake
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7.6
+
+  Exclude:
+    - 'bin/*'
+    - 'tmp/*'
+    - 'spec/spec_helper.rb'
+
+  NewCops: enable
+
+Metrics:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.rubycritic.yml

@@ -0,0 +1,7 @@
+path: 'rubycritic'
+no_browser: true
+minimum_score: 95
+
+paths:
+  - 'lib/'
+  - 'spec/lib/'

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.6

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in injector.gemspec
+gemspec
+
+gem 'byebug'
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+
+gem 'rubocop-performance'
+
+gem 'rubocop-rake'
+
+gem 'rubocop-rspec'
+
+gem 'rubycritic'
+
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    simple_injector (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.3)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (11.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    equalizer (0.0.11)
+    erubi (1.12.0)
+    flay (2.13.0)
+      erubi (~> 1.10)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.6)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    ice_nine (0.11.2)
+    json (2.6.3)
+    kwalify (0.7.2)
+    launchy (2.5.2)
+      addressable (~> 2.8)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    path_expander (1.1.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    reek (6.1.4)
+      kwalify (~> 0.7.0)
+      parser (~> 3.2.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.49.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    ruby_parser (3.20.0)
+      sexp_processor (~> 4.16)
+    rubycritic (4.7.0)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (>= 2.0.0)
+      parser (>= 2.6.0)
+      rainbow (~> 3.0)
+      reek (~> 6.0, < 7.0)
+      ruby_parser (~> 3.8)
+      simplecov (>= 0.17.0)
+      tty-which (~> 0.4.0)
+      virtus (~> 1.0)
+    sexp_processor (4.16.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    thread_safe (0.3.6)
+    tty-which (0.4.2)
+    unicode-display_width (2.4.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  rubycritic
+  simple_injector!
+  simplecov
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

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

@@ -0,0 +1,84 @@
+[![Rubocop](https://github.com/leoncruz/injector/actions/workflows/rubocop.workflow.yml/badge.svg)](https://github.com/leoncruz/injector/actions/workflows/rubocop.workflow.yml)
+[![Rubycritic](https://github.com/leoncruz/injector/actions/workflows/rubycritic.workflow.yml/badge.svg)](https://github.com/leoncruz/injector/actions/workflows/rubycritic.workflow.yml)
+[![Tests](https://github.com/leoncruz/injector/actions/workflows/test.workflow.yml/badge.svg)](https://github.com/leoncruz/injector/actions/workflows/test.workflow.yml)
+# SimpleInjector
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add simple_injector
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install simple_injector
+
+## Usage
+
+First, declare your contract to your class
+
+```ruby
+class CreateUserContract < SimpleInjector::Contract
+  register :api_client, -> { ApiClient.new }
+end
+```
+
+The `register` method receive a key, as a identifier of that instance and a proc that returns the object to be injectable into class
+
+```ruby
+class CreateUser
+  include SimpleInjector
+
+  contract CreateUserContract
+
+  attr_injector :api_client
+
+  def initialize(user_params)
+    @user_params = user_params
+  end
+
+  def create
+    api_client.post @user_params
+  end
+end
+```
+In your service class, include the `SimpleInjector` module. This will be add the `contract` and `attr_injector` methods
+
+The `contract` method receives a class, your contract defined previously
+
+The `attr_injector` receives the key, has to be the same key defined in the contract and add a method in service class to retrieve the instance.
+If you define more than one instance on contract class, you could add an `attr_injector` for each instance. Ex:
+
+```ruby
+class CreateUserContract < SimpleInjector::Contract
+  register :api_client, -> { ApiClient.new }
+  register :notify_user, ->  { NotifyUser.new }
+  register :user_model, ->  { User }
+end
+
+class CreateUser
+  include SimpleInjector
+
+  contract CreateUserContract
+
+  attr_injector :api_client
+  attr_injector :notify_user
+  attr_injector :user_model
+
+  def initialize(user_params)
+    @user_params = user_params
+  end
+
+  def create
+    user = user_model.save @user_params
+
+    api_client.post '/users/create/token', { id: user.id }
+
+    notify_user.notify(user)
+  end
+end
+```
+
+## License
+
+The code is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simple_injector"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/lib/simple_injector/contract.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SimpleInjector
+  # Module to handle instance registrations
+  class Contract
+    class << self
+      def register(name, callback)
+        class_name = to_s
+
+        Inject.register(class_name, name, callback)
+      end
+
+      def find(name)
+        class_name = to_s
+
+        Inject.find(class_name, name).callback.call
+      end
+    end
+  end
+end

data/lib/simple_injector/inject.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SimpleInjector
+  class InjectableNotFound < StandardError; end
+
+  # Singleton class to save instances and retrieve
+  class Inject
+    @injectables = {}
+
+    class << self
+      attr_accessor :injectables
+
+      def register(contract_name, name, callback)
+        (@injectables[contract_name] ||= []) << Injectable.new(name, callback)
+      end
+
+      def find(contract_name, name)
+        injectable = (@injectables[contract_name] ||= []).find { |i| i.name == name }
+
+        raise InjectableNotFound, "An instance with name '#{name}' was not registered" unless injectable
+
+        injectable
+      end
+    end
+  end
+end

data/lib/simple_injector/injectable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SimpleInjector
+  # Class to handle instances to are injectable
+  class Injectable
+    attr_accessor :name, :callback
+
+    def initialize(name, callback)
+      @name = name
+      @callback = callback
+    end
+  end
+end

data/lib/simple_injector/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleInjector
+  VERSION = '0.0.2'
+end

data/lib/simple_injector.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'simple_injector/version'
+require_relative 'simple_injector/contract'
+require_relative 'simple_injector/injectable'
+require_relative 'simple_injector/inject'
+
+# Entrypoint module
+module SimpleInjector
+  def self.included(target)
+    target.extend(ClassMethods)
+  end
+
+  # methods to add on included class
+  module ClassMethods
+    @contractor_class = nil
+
+    def attr_injector(name)
+      injectable = Inject.find(@contractor_class, name)
+
+      define_method name do
+        instance_variable_set(:"@#{name}", injectable.callback.call) unless instance_variable_defined?(:"@#{name}")
+
+        instance_variable_get(:"@#{name}")
+      end
+    end
+
+    def contract(klass)
+      @contractor_class = klass.to_s
+    end
+  end
+end

data/simple_injector.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simple_injector/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'simple_injector'
+  spec.version = SimpleInjector::VERSION
+  spec.authors = ['Leon Cruz']
+  spec.email = ['leon.cruz.teixeira@gmail.com']
+
+  spec.summary = 'A gem to handle dependency injection on ruby applications'
+  spec.description = 'A gem to handle dependency injection on ruby applications'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: simple_injector
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Leon Cruz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-24 00:00:00.000000000 Z
+dependencies: []
+description: A gem to handle dependency injection on ruby applications
+email:
+- leon.cruz.teixeira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubycritic.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_injector.rb
+- lib/simple_injector/contract.rb
+- lib/simple_injector/inject.rb
+- lib/simple_injector/injectable.rb
+- lib/simple_injector/version.rb
+- simple_injector.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A gem to handle dependency injection on ruby applications
+test_files: []