dry-system 0.5.0

data/lib/dry/system/errors.rb

@@ -0,0 +1,62 @@
+module Dry
+  module System
+    # Error raised when the container tries to load a component with missing
+    # file
+    #
+    # @api public
+    FileNotFoundError = Class.new(StandardError) do
+      def initialize(component)
+        super("could not resolve require file for #{component.identifier}")
+      end
+    end
+
+    # Error raised when a resolved component couldn't be found
+    #
+    # @api public
+    ComponentLoadError = Class.new(StandardError) do
+      def initialize(component)
+        super("could not load component #{component.inspect}")
+      end
+    end
+
+    # Error raised when invalid namespace name was provided
+    #
+    # @api public
+    InvalidNamespaceError = Class.new(StandardError) do
+      def initialize(ns)
+        super("Namespace #{ns} cannot include a separator")
+      end
+    end
+
+    # Error raised when resolved component couldn't be loaded
+    #
+    # @api public
+    InvalidComponentError = Class.new(ArgumentError) do
+      def initialize(name, reason = nil)
+        super(
+          "Tried to create an invalid #{name.inspect} component - #{reason}"
+        )
+      end
+    end
+
+    # Error raised when component's identifier is not valid
+    #
+    # @api public
+    InvalidComponentIdentifierError = Class.new(ArgumentError) do
+      def initialize(name)
+        super(
+          "component identifier +#{name}+ is invalid or boot file is missing"
+        )
+      end
+    end
+
+    # Error raised when component's identifier for booting is not a symbol
+    #
+    # @api public
+    InvalidComponentIdentifierTypeError = Class.new(ArgumentError) do
+      def initialize(name)
+        super("component identifier #{name.inspect} must be a symbol")
+      end
+    end
+  end
+end

data/lib/dry/system/importer.rb

@@ -0,0 +1,53 @@
+module Dry
+  module System
+    # Default importer implementation
+    #
+    # This is currently configured by default for every System::Container.
+    # Importer objects are responsible for importing components from one
+    # container to another. This is used in cases where an application is split
+    # into multiple sub-systems.
+    #
+    # @api private
+    class Importer
+      attr_reader :container
+
+      attr_reader :separator
+
+      attr_reader :registry
+
+      # @api private
+      def initialize(container)
+        @container = container
+        @separator = container.config.namespace_separator
+        @registry = {}
+      end
+
+      # @api private
+      def finalize!
+        registry.each do |name, container|
+          call(name, container.finalize!)
+        end
+      end
+
+      # @api private
+      def [](name)
+        registry.fetch(name)
+      end
+
+      # @api private
+      def key?(name)
+        registry.key?(name)
+      end
+
+      # @api private
+      def call(ns, other)
+        container.merge(other, namespace: ns)
+      end
+
+      # @api private
+      def register(other)
+        registry.update(other)
+      end
+    end
+  end
+end

data/lib/dry/system/injector.rb

@@ -0,0 +1,68 @@
+require "dry-auto_inject"
+
+module Dry
+  module System
+    # Injection mixin builder
+    #
+    # Injector objects are created by containers and can be used to automatically
+    # define object constructors where depedencies will be injected in.
+    #
+    # Main purpose of this object is to provide injection along with lazy-loading
+    # of components on demand. This gives us a way to load components in
+    # isolation from the rest of the system.
+    #
+    # @see [Container.injector]
+    #
+    # @api public
+    class Injector < BasicObject
+      # @api private
+      attr_reader :container
+
+      # @api private
+      attr_reader :options
+
+      # @api private
+      attr_reader :injector
+
+      # @api private
+      def initialize(container, options: {}, strategy: :default)
+        @container = container
+        @options = options
+        @injector = ::Dry::AutoInject(container, options).__send__(strategy)
+      end
+
+      # Create injection mixin for specified dependencies
+      #
+      # @example
+      #   require 'system/import'
+      #
+      #   class UserRepo
+      #     include Import['persistence.db']
+      #   end
+      #
+      # @param [Array<String>] *deps Keys under which dependencies are registered
+      #
+      # @return [Dry::AutoInject::Injector]
+      #
+      # @api public
+      def [](*deps)
+        load_components(*deps)
+        injector[*deps]
+      end
+
+      private
+
+      # @api private
+      def method_missing(name, *args, &block)
+        ::Dry::System::Injector.new(container, options: options, strategy: name)
+      end
+
+      # @api private
+      def load_components(*keys, **aliases)
+        (keys + aliases.values).each do |key|
+          container.load_component(key)
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/lifecycle.rb

@@ -0,0 +1,104 @@
+require 'concurrent/map'
+
+module Dry
+  module System
+    # Lifecycle booting DSL
+    #
+    # Lifecycle objects are used in the boot files where you can register custom
+    # init/start/stop triggers
+    #
+    # @see [Container.finalize]
+    #
+    # @api private
+    class Lifecycle < BasicObject
+      attr_reader :container
+
+      attr_reader :init
+
+      attr_reader :start
+
+      attr_reader :stop
+
+      attr_reader :statuses
+
+      attr_reader :triggers
+
+      # @api private
+      def self.new(container, &block)
+        cache.fetch_or_store([container, block].hash) do
+          super
+        end
+      end
+
+      # @api private
+      def self.cache
+        @cache ||= ::Concurrent::Map.new
+      end
+
+      # @api private
+      def initialize(container, &block)
+        @container = container
+        @statuses = []
+        @triggers = {}
+        instance_exec(container, &block)
+      end
+
+      # @api private
+      def call(*triggers)
+        triggers.each do |trigger|
+          unless statuses.include?(trigger)
+            __send__(trigger)
+            statuses << trigger
+          end
+        end
+      end
+
+      # @api private
+      def init(&block)
+        trigger!(:init, &block)
+      end
+
+      # @api private
+      def start(&block)
+        trigger!(:start, &block)
+      end
+
+      # @api private
+      def stop(&block)
+        trigger!(:stop, &block)
+      end
+
+      # @api private
+      def use(*names)
+        names.each do |name|
+          container.boot!(name)
+        end
+      end
+
+      # @api private
+      def register(*args, &block)
+        container.register(*args, &block)
+      end
+
+      private
+
+      # @api private
+      def trigger!(name, &block)
+        if triggers.key?(name)
+          triggers[name].()
+        elsif block
+          triggers[name] = block
+        end
+      end
+
+      # @api private
+      def method_missing(meth, *args, &block)
+        if container.key?(meth)
+          container[meth]
+        elsif ::Kernel.respond_to?(meth)
+          ::Kernel.public_send(meth, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/loader.rb

@@ -0,0 +1,69 @@
+require 'inflecto'
+
+module Dry
+  module System
+    # Default component loader implementation
+    #
+    # This class is configured by default for every System::Container. You can
+    # provide your own and use it in your containers too.
+    #
+    # @example
+    #   class MyLoader < Dry::System::Loader
+    #     def call(*args)
+    #       constant.build(*args)
+    #     end
+    #   end
+    #
+    #   class MyApp < Dry::System::Container
+    #     configure do |config|
+    #       # ...
+    #       config.loader MyLoader
+    #     end
+    #   end
+    #
+    # @api public
+    class Loader
+      # @!attribute [r] path
+      #   @return [String] Path to component's file
+      attr_reader :path
+
+      # @api private
+      def initialize(path)
+        @path = path
+      end
+
+      # Returns component's instance
+      #
+      # Provided optional args are passed to object's constructor
+      #
+      # @param [Array] *args Optional constructor args
+      #
+      # @return [Object]
+      #
+      # @api public
+      def call(*args)
+        if singleton?(constant)
+          constant.instance(*args)
+        else
+          constant.new(*args)
+        end
+      end
+
+      # Return component's class constant
+      #
+      # @return [Class]
+      #
+      # @api public
+      def constant
+        Inflecto.constantize(Inflecto.camelize(path))
+      end
+
+      private
+
+      # @api private
+      def singleton?(constant)
+        constant.respond_to?(:instance) && !constant.respond_to?(:new)
+      end
+    end
+  end
+end

data/lib/dry/system/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module System
+    VERSION = '0.5.0'.freeze
+  end
+end

data/spec/fixtures/components/bar.rb

@@ -0,0 +1,5 @@
+class Bar
+  def self.call
+    "Welcome to my Moe's Tavern!"
+  end
+end

data/spec/fixtures/components/bar/baz.rb

@@ -0,0 +1,4 @@
+class Bar
+  class Baz
+  end
+end

data/spec/fixtures/components/foo.rb

@@ -0,0 +1,2 @@
+class Foo
+end

data/spec/fixtures/import_test/config/application.yml

@@ -0,0 +1,2 @@
+test:
+  foo: 'bar'

data/spec/fixtures/import_test/lib/test/bar.rb

@@ -0,0 +1,4 @@
+module Test
+  class Bar
+  end
+end

data/spec/fixtures/import_test/lib/test/foo.rb

@@ -0,0 +1,5 @@
+module Test
+  class Foo
+    include Import['test.bar']
+  end
+end

data/spec/fixtures/import_test/system/boot/bar.rb

@@ -0,0 +1,11 @@
+Test::Container.namespace(:test) do |container|
+  module Test
+    module Bar
+      # I shall be booted
+    end
+  end
+
+  container.finalize(:bar) do
+    container.register(:bar, 'I was finalized')
+  end
+end

data/spec/fixtures/lazytest/config/application.yml

@@ -0,0 +1,2 @@
+test:
+  foo: 'bar'

data/spec/fixtures/lazytest/lib/test/dep.rb

@@ -0,0 +1,4 @@
+module Test
+  class Dep
+  end
+end

data/spec/fixtures/lazytest/lib/test/foo.rb

@@ -0,0 +1,5 @@
+module Test
+  class Foo
+    include Import['test.dep']
+  end
+end

data/spec/fixtures/lazytest/lib/test/models.rb

@@ -0,0 +1,4 @@
+module Test
+  module Models
+  end
+end

data/spec/fixtures/lazytest/lib/test/models/book.rb

@@ -0,0 +1,6 @@
+module Test
+  module Models
+    class Book
+    end
+  end
+end

data/spec/fixtures/lazytest/lib/test/models/user.rb

@@ -0,0 +1,6 @@
+module Test
+  module Models
+    class User
+    end
+  end
+end