dep-inject 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 714cfbce718d38561a3cd9977c26a88a51235795f6b50a81c1673fb2e1be21d6
+  data.tar.gz: 5454342a77296850b4dd9a0590f0349ce729f99076cf691f6641c16a9c25530e
+SHA512:
+  metadata.gz: 5bfb65dcba2603139df734646ba31a1df627071c2bf176a7906fceac88d1514e10896cb1189a7867d6f50344fc69a1f011b38b2608ec2b9661ce06a61585179e
+  data.tar.gz: '09d03a5158cadadd67feadc2d99ae19a5278e532aba65ad0a854e12b01a0916b2b3400608684741b003113a108a2000ceb0b4ec17badb1307cb271854908ce18'

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-18
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 chris-nonato
+
+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,68 @@
+# Dep-inject
+
+Dep-inject is a simple Ruby gem that allows for clean and flexible dependency injection in Ruby classes. It provides a constructor method (`build`) and enforces a single public method (`execute`) to encourage well-structured use cases and services. The gem raises errors if other public methods are defined, ensuring that classes stay focused on a single responsibility.
+
+## Features
+
+- **Dependency Injection**: Easily inject dependencies such as repositories, service objects, etc.
+- **Enforced Interface**: Ensures that only the `execute` method is public.
+- **Error Handling**: Raises specific errors when expected conventions are not followed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dep-inject'
+```
+
+Then bundle install
+
+## Usage
+
+To use DepInject, include the module in your class, specify your dependencies, and define the execute method. DepInject will handle the injection of the specified dependencies and enforce that only execute is exposed as a public method.
+
+Dependencies can be any class or object. DepInject will initialize and inject them into your use case at runtime. The dependencies are injected as instance variables with the same name as the keys passed in provide.
+
+### Basic Example
+
+```ruby
+class MockLogger
+  def log(message)
+    "Logged: #{message}"
+  end
+end
+
+class MockTaskManager
+  def create_task(name)
+    "Task #{name} created"
+  end
+end
+
+class TaskUseCase
+  include DepInject
+
+  provide(
+    logger: MockLogger,
+    task_manager: MockTaskManager
+  )
+
+  def execute(task_name)
+    task = @task_manager.create_task(task_name)
+    @logger.log("Executing #{task}")
+  end
+end
+
+# Instantiate using constructor method and execute
+usecase = TaskUseCase.build
+usecase.execute("Test Task")
+```
+
+## Contributing
+
+This project is intended to be a welcoming space for contribution. Pull requests are welcome.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/dep_inject/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DepInject
+  VERSION = "0.1.0"
+end

data/lib/dep_inject.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "dep_inject/version"
+
+module DepInject
+  class PublicMethodError < StandardError; end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def provide(dependencies={})
+      define_singleton_method :build do
+        new(**prepare_dependencies(dependencies))
+      end
+
+      define_method :initialize do |**injected|
+        injected.each do |name, dependency|
+          instance_variable_set("@#{name}", dependency)
+        end
+
+        unless self.class.instance_methods.include?(:execute)
+          raise NotImplementedError, "Class #{self.class} must define an `execute` method"
+        end
+
+        public_methods_except_execute = self.class.public_instance_methods(false) - [:execute]
+        unless public_methods_except_execute.empty?
+          raise PublicMethodError, "Class #{self.class} should only define `execute` as a public method. Additional public methods: #{public_methods_except_execute.join(', ')}"
+        end
+
+      end
+    end
+
+    private
+
+    def prepare_dependencies(dependencies)
+      dependencies.transform_values do |dependency|
+        instantiate_dependency(dependency)
+      end
+    end
+
+    def instantiate_dependency(dependency)
+      if dependency.respond_to?(:build)
+        dependency.build
+      elsif dependency.respond_to?(:new)
+        dependency.new
+      else
+        dependency
+      end
+    end
+
+  end
+end

data/sig/dinject.rbs

@@ -0,0 +1,4 @@
+module DepInject
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: dep-inject
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- christophenonato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-10-18 00:00:00.000000000 Z
+dependencies: []
+description: DepInject helps to inject dependencies into your classes, enforcing public
+  method restrictions.
+email:
+- chr.nonato@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dep_inject.rb
+- lib/dep_inject/version.rb
+- sig/dinject.rbs
+homepage: https://github.com/christophenonato/dep-inject
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/christophenonato/dep-inject
+  source_code_uri: https://github.com/christophenonato/dep-inject
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key: 
+specification_version: 4
+summary: A lightweight dependency injection gem
+test_files: []