koine-di 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ef78903580aadd9cdc99368872217d256ffece8a19f7104af9d20e2ba630ffb
+  data.tar.gz: b0ebaaa7a05693689e8fc6e9ef1f93296da9a97a74be4f75745b97f0564f674e
+SHA512:
+  metadata.gz: e52aa1ebc41a064dc1770e6f54a0aba97dd19c2212a5211c208f8056c4c136c581c401f0518d4992cfc08da0aaadb5fa9a95efb5ad522511545e47923a08b4c7
+  data.tar.gz: e02b730b3b2fa823ddeeae232e3d1b372450c4e09c2ee6506fc988ed4eedcaf6050bd65874cea1a537958c270fe72562f98952e8307cbe1275d5f58b75cbfce8

data/.github/workflows/unit-tests.yml

@@ -0,0 +1,24 @@
+name: Unit tests
+on:
+  push:
+    branches: 
+      - master
+  pull_request:
+    branches:
+      - '*'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+    - name: Build and test with Rake
+      run: |
+        sudo apt-get -yqq install libpq-dev
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test:coverage 
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/.scrutinizer.yml

@@ -0,0 +1,15 @@
+checks:
+  ruby:
+    code_rating: true
+    duplicate_code: true
+
+build:
+  tests:
+    override:
+      -
+        command: 'bundle exec rake test:scrutinizer'
+        environment:
+          'SCRUTINIZER_CC_FILE': 'my-coverage'
+        coverage:
+          file: 'my-coverage'
+          format: 'rb-cc'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+cache: bundle
+rvm:
+  # - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - 2.4.0
+  - 2.4.3
+  - 2.5.0
+script: rake test:coveralls
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# 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, ethnicity, 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.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2017 Marcelo Jacobus
+
+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,108 @@
+# Koine::Di
+
+Koine::Di, for your dependency injection
+A fork of [Nurse](https://github.com/mjacobus/nurse-rb) under a safer namespace.
+
+Code quality
+
+[![Coverage Status](https://coveralls.io/repos/github/mjacobus/koine-di/badge.svg?branch=master)](https://coveralls.io/github/mjacobus/koine-di?branch=master)
+[![Code Climate](https://codeclimate.com/github/mjacobus/koine-di/badges/gpa.svg)](https://codeclimate.com/github/mjacobus/koine-di)
+
+Package information
+
+[![Gem Version](https://badge.fury.io/rb/koine-di.svg)](https://badge.fury.io/rb/koine-di)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'koine-di'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koine-di
+
+## Usage
+
+### Defining dependencies
+
+```ruby
+dependency_manager = Koine::Di::DependencyContainer.new
+
+dependency_manager.share(:connection) do |dependency_manager|
+  MyConnection.new("mysql://root@localhost/my_db")
+end
+
+dependency_manager.share(:user_repository) do |dependency_manager|
+  connection = dependency_manager.get(:connection)
+  UserRepository.new(connection)
+end
+```
+
+Also, you can use the singleton instance. Use singleton if you do not have
+control over how classes, such as controllers, are created.
+
+```ruby
+dependency_manager = Koine::Di.instance
+```
+
+### Fetching dependencies
+```ruby
+class UsersController < SomeBaseController
+  def index
+    @users = repository.find_all
+  end
+
+  private
+
+  def repository
+    dependency_manager.get(:user_repository)
+  end
+end
+```
+
+### Using factories
+
+```ruby
+class DatabaseConnectionFactory < Koine::Di::ServiceFactory
+  share true
+  key :db_connection
+
+  def create_service(dependencies)
+    DatabaseConnection.new(dependencies.get(:db_config))
+  end
+end
+
+class UserRepositoryFactory < Koine::Di::ServiceFactory
+  key :user_repository
+
+  def create_service(dependencies)
+    UserRepository.new(dependencies.get(:db_connection))
+  end
+end
+
+dependency_manager.add_factory(DatabaseConnectionFactory.new)
+dependency_manager.add_factory(UserRepositoryFactory.new)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/mjacobus/koine-di. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+namespace :test do
+  task :coveralls do
+    ENV['COVERALLS'] = 'true'
+    Rake::Task['test:coverage'].invoke
+  end
+
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+
+  task :scrutinizer do
+    ENV['SCRUTINIZER'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nurse'
+
+# 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

data/bin/setup

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

data/koine-di.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koine/di/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'koine-di'
+  spec.version       = Koine::Di::VERSION
+  spec.authors       = ['Marcelo Jacobus']
+  spec.email         = ['marcelo.jacobus@gmail.com']
+
+  spec.summary       = 'Koine DI, for your dependency injection'
+  spec.description   = 'Koine DI, for your dependency injection. Dependency injection container'
+  spec.homepage      = 'https://github.com/mjacobus/koine-di'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'scrutinizer-ocular'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'simplecov-lcov'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/koine/di/dependency_container.rb

@@ -0,0 +1,73 @@
+module Koine
+  module Di
+    # The dependency container class
+    class DependencyContainer
+      class UndefinedDependency < RuntimeError; end
+      class DependencyAlreadyDefined < RuntimeError; end
+
+      def initialize
+        @factories = {}
+        @shared_factories = {}
+        @instances = {}
+      end
+
+      def share(dependency, &block)
+        ensure_undefined(dependency)
+        shared_factories[to_key(dependency)] = block
+        self
+      end
+
+      def set(dependency, &block)
+        ensure_undefined(dependency)
+        factories[to_key(dependency)] = block
+        self
+      end
+
+      def defined?(dependency)
+        key = to_key(dependency)
+        shared_factories.key?(key) || factories.key?(key)
+      end
+
+      def get(dependency, &_block)
+        key = to_key(dependency)
+
+        if self.defined?(key)
+          return from_shared_factories(key) || from_factories(key)
+        end
+
+        return yield if block_given?
+
+        fail UndefinedDependency, "'#{dependency}' was not defined"
+      end
+
+      def add_factory(factory)
+        factory.attach_to(self)
+      end
+
+      protected
+
+      attr_reader :factories
+      attr_reader :instances
+      attr_reader :shared_factories
+
+      def from_shared_factories(key)
+        return unless shared_factories.key?(key)
+        instances[key] ||= shared_factories[key].call(self)
+      end
+
+      def from_factories(key)
+        factories[key].call(self) if factories.key?(key)
+      end
+
+      def ensure_undefined(dependency)
+        return unless self.defined?(dependency)
+        fail DependencyAlreadyDefined,
+          "Dependency '#{dependency}' was already defined"
+      end
+
+      def to_key(object)
+        object.to_s
+      end
+    end
+  end
+end

data/lib/koine/di/service_factory.rb

@@ -0,0 +1,51 @@
+module Koine
+  module Di
+    class ServiceFactory
+      def attach_to(dependency_manager)
+        if shared?
+          dependency_manager.share(dependency_key) do |di|
+            create_service(di)
+          end
+
+          return
+        end
+
+        dependency_manager.set(dependency_key) do |di|
+          create_service(di)
+        end
+      end
+
+      def create_service(_dependency_manager)
+        raise 'create_service must be implemented'
+      end
+
+      def dependency_key
+        raise 'dependency_key must be implemented'
+      end
+
+      def shared?
+        false
+      end
+
+      class << self
+        private
+
+        def share(boolean)
+          instance_eval do
+            define_method :shared? do
+              boolean
+            end
+          end
+        end
+
+        def key(dependency_key)
+          instance_eval do
+            define_method :dependency_key do
+              dependency_key
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/koine/di/shared_service_factory.rb

@@ -0,0 +1,17 @@
+module Koine
+  module Di
+    class SharedServiceFactory < ServiceFactory
+      def shared?
+        true
+      end
+
+      class << self
+        private
+
+        def share(_shared)
+          raise 'You cannot change the shared state of a shared service factory. Extend Nurse::ServiceFactory instead'
+        end
+      end
+    end
+  end
+end

data/lib/koine/di/version.rb

@@ -0,0 +1,5 @@
+module Koine
+  module Di
+    VERSION = '1.0.0'
+  end
+end

data/lib/koine/di.rb

@@ -0,0 +1,12 @@
+require 'koine/di/version'
+require 'koine/di/dependency_container'
+require 'koine/di/service_factory'
+require 'koine/di/shared_service_factory'
+
+module Koine
+  module Di
+    def self.instance
+      @instance ||= Koine::Di::DependencyContainer.new
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: koine-di
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: scrutinizer-ocular
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Koine DI, for your dependency injection. Dependency injection container
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/unit-tests.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".scrutinizer.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- koine-di.gemspec
+- lib/koine/di.rb
+- lib/koine/di/dependency_container.rb
+- lib/koine/di/service_factory.rb
+- lib/koine/di/shared_service_factory.rb
+- lib/koine/di/version.rb
+homepage: https://github.com/mjacobus/koine-di
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Koine DI, for your dependency injection
+test_files: []