dinja 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1122813235a4bb4cf99eb67e396cd70e0d58d995228d5d98095159b2bffc1e6b
+  data.tar.gz: f0a6c651e57ea285eb6ccd842d1e0445861ad02f5be3fb4a4e29a539446427c8
+SHA512:
+  metadata.gz: 11a9f8ea23f8ea1b9adf65841eede3baac1073fad9e092ebbccf13925afbbdc34e7b99061d25d23a7f440c69751c843e4b7e056e3d16f18463cad9e55edf6f77
+  data.tar.gz: 5668ecbbee6758bc7fe4ee9c139fd69ef28d98a8eb4cf99cb44b54668c8272fbae93ad0b27022c50aaa013d4255f4af8fb45cb1f9b22ad97868572ded5e43340

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dinja.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Florian Dejonckheere
+
+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,127 @@
+# Dinja
+
+![Continuous Integration](https://github.com/floriandejonckheere/dinja/workflows/Continuous%20Integration/badge.svg)
+![Release](https://img.shields.io/github/v/release/floriandejonckheere/dinja?label=Latest%20release)
+
+Dinja, Dependency Injection Ninja
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "dinja"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dinja
+
+## Usage
+
+### Standalone
+
+```ruby
+# Instantiate a dependency injection container
+container = Dinja::Container.new
+
+# Register a dependency
+container.register("my_dependency") { |name| OpenStruct.new(name: name) }
+
+# Resolve a dependency
+my_dependency = container.resolve("my_dependency", "foobar")
+
+puts my_dependency.name
+# => "foobar"
+
+# container.resolve will raise when trying to resolve unregistered dependencies
+# Use container.resolve! to resolve unregistered dependencies without raising (dangerous)
+container.resolve("another_dependency")
+# => DependencyNotRegistered
+
+# container.register will raise when trying to overwrite registered dependencies
+# Use container.register! to overwrite dependencies (dangerous)
+container.register("my_dependency") { |name| OpenStruct.new(name: name) }
+```
+
+### Rails
+
+In a Rails application, add the following line to your `config/application.rb`:
+
+```ruby
+require "dinja/railtie"
+```
+
+Create `config/dependencies.rb` and register some dependencies:
+
+```ruby
+register("my_dependency") do |name|
+  OpenStruct.new(name: name)
+end
+```
+
+A dependency injection container is now available throughout your application on `Rails.application.config.container`:
+
+```ruby
+my_dependency = Rails.application.config.container.resolve("my_dependency", "foobar")
+
+my_dependency.name
+# => "foobar"
+```
+
+### Gem
+
+In a gem, add the following lines to your `lib/my_gem.rb`:
+
+```ruby
+require "dinja"
+
+module MyGem
+  def container
+    @container ||= Dinja::Container.new 
+  end
+  
+  def setup
+    # ...other stuff here
+
+    # Register dependencies
+    container.instance_eval(File.read("config/dependencies.rb"))
+  end
+end
+
+MyGem.setup
+```
+
+Create `config/dependencies.rb` and register some dependencies:
+
+```ruby
+register("my_dependency") do |name|
+  OpenStruct.new(name: name)
+end
+```
+
+A dependency injection container is now available throughout your application on `MyGem.container`:
+
+```ruby
+my_dependency = MyGem.container.resolve("my_dependency", "foobar")
+
+my_dependency.name
+# => "foobar"
+```
+
+## Development
+
+To release a new version, update the version number in `lib/dinja/version.rb`, update the changelog, commit the files and create a git tag starting with `v`, and push it to the repository.
+Github Actions will automatically run the test suite, build the `.gem` file and push it to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/floriandejonckheere/dinja](https://github.com/floriandejonckheere/dinja). 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/dinja.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+# Simple dependency injection
+module Dinja
+  class << self
+    # Code loader instance
+    attr_reader :loader
+
+    def root
+      @root ||= Pathname.new(File.expand_path(File.join("..", ".."), __FILE__))
+    end
+
+    def setup
+      @loader = Zeitwerk::Loader.for_gem
+
+      # Do not eager load Railtie
+      loader.do_not_eager_load(root.join("lib/dinja/railtie.rb"))
+
+      loader.setup
+      loader.eager_load
+    end
+  end
+end
+
+Dinja.setup

data/lib/dinja/container.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Dinja
+  # Dependency injection container
+  class Container
+    attr_reader :dependencies
+
+    def initialize
+      @dependencies = {}
+    end
+
+    # Register a dependency
+    #
+    # @param [String] key The unique key under which the dependency will be registered
+    # @param [Proc] &block The proc to be called when resolving the dependency
+    #
+    # @raise [DependencyAlreadyRegistered] If the dependency was already registered before
+    #
+    def register(key, &block)
+      raise DependencyAlreadyRegistered, "Dependency already registered: #{key}" if dependencies.key?(key)
+
+      register!(key, &block)
+    end
+
+    # Register or overwrite an existing dependency
+    #
+    # @param [String] key The unique key under which the dependency will be registered
+    # @param [Proc] &block The proc to be called when resolving the dependency
+    #
+    def register!(key, &block)
+      dependencies[key] = block
+    end
+
+    # Resolve a dependency
+    #
+    # @param [String] key The unique key under which the dependency was registered
+    # @param [Object] *args The arguments to pass when resolving the dependency
+    # @param [Proc] &block The block to pass when resolving the dependency
+    #
+    # @raise [DependencyNotRegistered] If the dependency was not registered
+    #
+    def resolve(key, *args, &block)
+      return dependencies[key].call(*args, &block) if dependencies.key?(key)
+
+      raise DependencyNotRegistered, "Dependency not registered: #{key}"
+    end
+
+    # Resolve a dependency
+    #
+    # @param [String] key The unique key under which the dependency was registered
+    # @param [Object] *args The arguments to pass when resolving the dependency
+    # @param [Proc] &block The block to pass when resolving the dependency
+    #
+    def resolve!(key, *args, &block)
+      dependencies[key]&.call(*args, &block)
+    end
+
+    # Raised when trying to overwrite a dependency that was already registered
+    class DependencyAlreadyRegistered < StandardError; end
+
+    # Raised when trying to resolve a dependency that was not registered
+    class DependencyNotRegistered < StandardError; end
+  end
+end

data/lib/dinja/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails"
+
+require_relative "../dinja"
+
+module Dinja
+  # Dinja Railtie
+  class Railtie < Rails::Railtie
+    config.container = Dinja::Container.new
+
+    config.container.instance_eval(File.read(File.join("config/dependencies.rb")))
+  end
+end

data/lib/dinja/version.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dinja
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    PRE   = nil
+
+    VERSION = [MAJOR, MINOR, PATCH].compact.join(".")
+
+    STRING = [VERSION, PRE].compact.join("-")
+  end
+
+  VERSION = Version::STRING
+end

metadata

@@ -0,0 +1,248 @@
+--- !ruby/object:Gem::Specification
+name: dinja
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Florian Dejonckheere
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: debase
+  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: factory_bot
+  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: fasterer
+  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: flay
+  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: overcommit
+  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: pronto
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: rspec
+  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: rubocop
+  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: rubocop-performance
+  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: rubocop-rspec
+  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: Dinja, Dependency Injection Ninja allows you to decouple abstractions
+  from implementations
+email:
+- florian@floriandejonckheere.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/dinja.rb
+- lib/dinja/container.rb
+- lib/dinja/railtie.rb
+- lib/dinja/version.rb
+homepage: https://github.com/floriandejonckheere/dinja
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/floriandejonckheere/dinja.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Simple Dependency Injection container
+test_files: []