service_orchestrator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03353d6cb24dcfa291140362f9f2d892cd4de3a0c93325ff5890d63e0b8c756f
+  data.tar.gz: 17a6aa66407e74a57bb24761ca72445acc254adabfe36dcdb648f257cc9979fe
+SHA512:
+  metadata.gz: eebfd03ac0cacdf4c3deca6d8adf0e194cb74cffcad34fba4afe98b91b2c0df622ccbcb335caa3507d661b3e003b19f885dd3843b1dcc1209685395b691fdd66
+  data.tar.gz: 622e9b3aca930bde206e0b5da7c7cc45f9680aa082ed19fa43b7e123a9a0f05f27302c2e1ee2fdb73d0fb0d2121d7e8379e7269c91855abdce05f3c9e7b7f338

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    service_orchestrator (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    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.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  service_orchestrator!
+
+BUNDLED WITH
+   2.3.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Didier Lafforgue
+
+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,90 @@
+# ServiceOrchestrator
+
+ServiceOrchestrator is a lightweight dependency injection framework, greatly inspired by the awesome [Morphine](https://github.com/bkeepers/morphine) gem.
+
+Compared to Morphine, it automatically wires dependencies between services thanks to some simple conventions.
+
+If you wonder if you need this library, please check out [our article]() about Services in Rails.
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+    $ bundle add service_orchestrator
+
+## Usage
+
+The framework is composed of 2 main Ruby classes:
+
+- `ServiceOrchestrator::Container` which registers all the services and wires the dependencies.
+- `ServiceOrchestrator::Service` that any service with dependencies inherits from.
+
+**Conventions**
+
+- a service has a single public method named **call**.
+- the **call** method of a service takes N named arguments.
+- don't use instance variables inside the Service Ruby class.
+
+## Example
+
+First, declare a container in order to register all your services.
+
+```ruby
+class ApplicationContainer < ServiceOrchestrator::Container
+  
+  register :onboarding, 'OnBoardingService'
+
+  register :analytics_tracker, 'AmplitudeAnalyticsTrackerService'
+
+  private
+
+  register :amplitude_sdk do
+    AmplitudeSDK.new(api_key: Rails.application.credentials.amplitude.api_key)
+  end
+end
+```
+
+Then, declare your services.
+
+```ruby
+class AmplitudeAnalyticsTrackerService < ServiceOrchestrator::Service
+  dependency :amplitude_sdk
+
+  def call(event_name:, properties: {})
+    amplitude_sdk.send_event(event_name, properties)
+  end
+```
+
+```ruby
+class OnboardingService < ServiceOrchestrator::Service
+  dependency :analytics_tracker
+  
+  def call(attributes:)
+    User.create(attributes).tap do |user|
+      analytics_tracker.call(:new_user, { email: user.email })
+    end
+  end
+end
+```
+
+Create an instance of a container to get access to your services.
+
+```ruby
+container = ApplicationContainer.new
+
+container.onboarding.call({ email: 'john@doe.net', name: 'John' })
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/nocoffeehq/service_orchestrator.
+
+## License
+
+The gem 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[spec rubocop]

data/lib/service_orchestrator/container.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ServiceOrchestrator
+  # Strongly inspired by https://github.com/bkeepers/morphine (MIT).
+  # Copying/pasting/modifying the code from Morphine seemed the cleaner solution.
+  class Container
+    def dependencies
+      @dependencies ||= {}
+    end
+
+    def klasses
+      @klasses ||= {}
+    end
+
+    def self.register(name, class_name = nil, &block)
+      define_method name do |*args|
+        dependencies[name] ||= class_name ? service_class(class_name).wire(self) : instance_exec(*args, &block)
+      end
+
+      define_method "#{name}=" do |service|
+        dependencies[name] = service
+      end
+    end
+
+    private
+
+    def service_class(class_name)
+      return klasses[class_name] if klasses[class_name]
+
+      klass = ActiveSupport::Inflector.constantize(class_name)
+
+      unless klass.respond_to?(:wire)
+        raise ServiceOrchestrator::Error, "#{class_name} should implement the wire class method"
+      end
+
+      klasses[class_name] ||= klass
+    end
+  end
+end

data/lib/service_orchestrator/service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ServiceOrchestrator
+  # In order to wire automatically dependencies in the services
+  # registered within a Container, the services has to inherit
+  # from this class.
+  class Service
+    class_attribute :registered_deps
+
+    def self.dependencies(*names)
+      names.each do |name|
+        dependency(name)
+      end
+    end
+
+    def self.dependency(name)
+      self.registered_deps ||= []
+      self.registered_deps += [name]
+      attr_accessor name
+    end
+
+    def self.wire(container)
+      args = {}
+      (self.registered_deps || []).each do |name|
+        args[name] = container.send(name)
+      end
+      new(args)
+    end
+
+    def initialize(args)
+      args.each do |name, value|
+        instance_variable_set(:"@#{name}", value)
+      end
+    end
+  end
+end

data/lib/service_orchestrator/version.rb

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

data/lib/service_orchestrator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/class/attribute'
+require 'active_support/inflector'
+
+require_relative 'service_orchestrator/version'
+require_relative 'service_orchestrator/container'
+require_relative 'service_orchestrator/service'
+
+module ServiceOrchestrator
+  class Error < StandardError; end
+end

data/service_orchestrator.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/service_orchestrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'service_orchestrator'
+  spec.version = ServiceOrchestrator::VERSION
+  spec.authors = ['Didier Lafforgue']
+  spec.email = ['didier.lafforgue@gmail.com']
+
+  spec.summary = 'A small library to help you manage services with dependency injection.'
+  spec.homepage = 'https://github.com/nocoffeehq/service_orchestrator'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'activesupport'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: service_orchestrator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Didier Lafforgue
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+description: 
+email:
+- didier.lafforgue@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/service_orchestrator.rb
+- lib/service_orchestrator/container.rb
+- lib/service_orchestrator/service.rb
+- lib/service_orchestrator/version.rb
+- service_orchestrator.gemspec
+homepage: https://github.com/nocoffeehq/service_orchestrator
+licenses:
+- MIT
+metadata: {}
+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.2.32
+signing_key: 
+specification_version: 4
+summary: A small library to help you manage services with dependency injection.
+test_files: []