dry-system 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a18b1a854bc129ce0971540b70db051a98d7af4f
-  data.tar.gz: 3028860d178d68633123d23fd3900508cd6defb2
+SHA256:
+  metadata.gz: c694492a1df5aacafb821e345e815e27510e7a83b348cbe5a88d0bfdda7403e8
+  data.tar.gz: 00f59ee5248183a9d3f05de29ecee93f43ca728bea4208508249a3f6a577ff3e
 SHA512:
-  metadata.gz: ccc8a1a34791ffaa7d4e345d7ca734f48a017d3ea85e7ccda787ea6ffecc2cf71542c84aaf697bbf66447e964a8a598f8e1ad766c4ea4750c1340edd18c8ac8c
-  data.tar.gz: 6a8566bac53d9feab8655d04022150c70a8d263e294ce4df82a8023430bd975cae426b74c444c442076961f7804f977bdfec2a3512834c9180b37aa4cf253728
+  metadata.gz: c0c4feafffa05af7d60c5b8bad601337622e8deb3b7387d08f54343c95092718c3a3222d190c26d6bc1909613938317ec6a7fab4366095ef0f7cbf945f3752da
+  data.tar.gz: 4acaf75291aa2f229ad8fc14d617cef887e60b1a2178861445f6cd25dff23a9d7ace71f6a3ce20467f27656189723f10041bd7587420236c3421577c203cd618

data/CHANGELOG.md

@@ -1,4 +1,26 @@
-# 0.8.0 - 2017-10-17
+# 0.9.0 - 2018-01-02
+
+### Added
+
+* Plugin API (solnic)
+* `:env` plugin which adds support for setting `env` config value (solnic)
+* `:logging` plugin which adds a default logger (solnic)
+* `:decorate` plugin for decorating registered objects (solnic)
+* `:notifications` plugin adding pub/sub bus to containers (solnic)
+* `:monitoring` plugin which adds `monitor` method for monitoring object method calls (solnic)
+* `:bootsnap` plugin which adds support for bootsnap (solnic)
+
+### Changed
+
+* [BREAKING] renamed `Container.{require=>require_from_root}` (GustavoCaso)
+
+### Internal
+
+* `#bootable?` and `#boot_file` methods were moved from `Component` to `Booter` (GustavoCaso)
+
+[Compare v0.8.1...v0.9.0](https://github.com/dry-rb/dry-system/compare/v0.8.1...v0.9.0)
+
+# 0.8.1 - 2017-10-17
 
 ### Fixed
 

data/lib/dry/system/auto_registrar.rb

@@ -52,7 +52,7 @@ module Dry
 
       # @api private
       def files(dir)
-        Dir["#{root}/#{dir}/**/*.rb"]
+        Dir["#{root}/#{dir}/**/#{RB_GLOB}"]
       end
 
       # @api private

data/lib/dry/system/booter.rb

@@ -1,5 +1,6 @@
 require 'dry/system/components/bootable'
 require 'dry/system/errors'
+require 'dry/system/constants'
 require 'dry/system/lifecycle'
 require 'dry/system/booter/component_registry'
 
@@ -26,6 +27,18 @@ module Dry
         @components = ComponentRegistry.new
       end
 
+      # @api private
+      def bootable?(component)
+        boot_file(component).exist?
+      end
+
+      # @api private
+      def boot_file(name)
+        name = name.respond_to?(:root_key) ? name.root_key.to_s : name
+
+        path.join("#{name}#{RB_EXT}")
+      end
+
       # @api private
       def register_component(component)
         components.register(component)
@@ -34,7 +47,7 @@ module Dry
 
       # @api private
       def load_component(path)
-        identifier = Pathname(path).basename('.rb').to_s.to_sym
+        identifier = Pathname(path).basename(RB_EXT).to_s.to_sym
 
         unless components.exists?(identifier)
           require path
@@ -119,18 +132,18 @@ module Dry
 
       # @api private
       def require_boot_file(identifier)
-        boot_file = boot_files.detect { |path| Pathname(path).basename('.rb').to_s == identifier.to_s }
+        boot_file = boot_files.detect { |path| Pathname(path).basename(RB_EXT).to_s == identifier.to_s }
         require boot_file if boot_file
       end
 
       # @api private
       def boot_files
-        Dir["#{path}/**/*.rb"]
+        Dir["#{path}/**/#{RB_GLOB}"]
       end
 
       # @api private
       def boot_dependency(component)
-        boot_file = component.boot_file(path)
+        boot_file = boot_file(component)
         start(boot_file.basename('.*').to_s.to_sym) if boot_file.exist?
       end
     end

data/lib/dry/system/component.rb

@@ -80,7 +80,7 @@ module Dry
       def initialize(identifier, path, options)
         @identifier, @path = identifier, path
         @options = options
-        @file = "#{path}.rb".freeze
+        @file = "#{path}#{RB_EXT}".freeze
         @loader = options.fetch(:loader)
         freeze
       end
@@ -113,16 +113,6 @@ module Dry
         false
       end
 
-      # @api private
-      def bootable?(path)
-        boot_file(path).exist?
-      end
-
-      # @api private
-      def boot_file(path)
-        path.join("#{root_key}.rb")
-      end
-
       # @api private
       def file_exists?(paths)
         paths.any? { |path| path.join(file).exist? }

data/lib/dry/system/components/bootable.rb

@@ -1,6 +1,7 @@
 require 'dry/system/lifecycle'
 require 'dry/system/settings'
 require 'dry/system/components/config'
+require 'dry/system/constants'
 
 module Dry
   module System
@@ -241,7 +242,7 @@ module Dry
         # @api private
         def boot_file
           container_boot_files.
-            detect { |path| Pathname(path).basename('.rb').to_s == identifier.to_s }
+            detect { |path| Pathname(path).basename(RB_EXT).to_s == identifier.to_s }
         end
 
         # Return path to boot dir
@@ -259,7 +260,7 @@ module Dry
         #
         # @api private
         def container_boot_files
-          Dir[container.boot_path.join('**/*.rb')]
+          Dir[container.boot_path.join("**/#{RB_GLOB}")]
         end
 
         private

data/lib/dry/system/constants.rb

@@ -1,8 +1,11 @@
+require 'dry/core/constants'
+
 module Dry
   module System
+    include Dry::Core::Constants
+
     RB_EXT = '.rb'.freeze
     RB_GLOB = '*.rb'.freeze
-    EMPTY_STRING = ''.freeze
     PATH_SEPARATOR = '/'.freeze
     DEFAULT_SEPARATOR = '.'.freeze
     WORD_REGEX = /\w+/.freeze

data/lib/dry/system/container.rb

@@ -15,6 +15,7 @@ require 'dry/system/manual_registrar'
 require 'dry/system/importer'
 require 'dry/system/component'
 require 'dry/system/constants'
+require 'dry/system/plugins'
 
 module Dry
   module System
@@ -66,6 +67,7 @@ module Dry
     class Container
       extend Dry::Configurable
       extend Dry::Container::Mixin
+      extend Dry::System::Plugins
 
       setting :name
       setting :default_namespace
@@ -100,6 +102,7 @@ module Dry
         def configure(&block)
           super(&block)
           load_paths!(config.system_dir)
+          hooks[:configure].each { |hook| instance_eval(&hook) }
           self
         end
 
@@ -441,19 +444,19 @@ module Dry
         #
         # @example
         #   # sinle file
-        #   MyApp.require('lib/core')
+        #   MyApp.require_from_root('lib/core')
         #
         #   # glob
-        #   MyApp.require('lib/**/*')
+        #   MyApp.require_from_root('lib/**/*')
         #
         # @param *paths [Array<String>] one or more paths, supports globs too
         #
         # @api public
-        def require(*paths)
+        def require_from_root(*paths)
           paths.flat_map { |path|
             path.to_s.include?('*') ? Dir[root.join(path)] : root.join(path)
           }.each { |path|
-            Kernel.require path.to_s
+            require path.to_s
           }
         end
 
@@ -535,7 +538,7 @@ module Dry
             raise FileNotFoundError, component
           end
 
-          Kernel.require(component.path)
+          require component.path
 
           yield
         end
@@ -563,11 +566,34 @@ module Dry
           self
         end
 
+        # @api private
+        def after(event, &block)
+          hooks[event] << block
+        end
+
+        # @api private
+        def hooks
+          @__hooks__ ||= Hash.new { |h, k| h[k] = [] }
+        end
+
+        # @api private
+        def inherited(klass)
+          new_hooks = Container.hooks.dup
+
+          hooks.each do |event, blocks|
+            new_hooks[event].concat(blocks)
+            new_hooks[event].concat(klass.hooks[event])
+          end
+
+          klass.instance_variable_set(:@__hooks__, new_hooks)
+          super
+        end
+
         private
 
         # @api private
         def load_local_component(component, default_namespace_fallback = false)
-          if component.bootable?(booter.path) || component.file_exists?(load_paths)
+          if booter.bootable?(component) || component.file_exists?(load_paths)
             booter.boot_dependency(component) unless finalized?
 
             require_component(component) do

data/lib/dry/system/loader.rb

@@ -1,4 +1,4 @@
-require 'inflecto'
+require 'dry/inflector'
 
 module Dry
   module System
@@ -27,9 +27,14 @@ module Dry
       #   @return [String] Path to component's file
       attr_reader :path
 
+      # @!attribute [r] inflector
+      #   @return [Object] Inflector backend
+      attr_reader :inflector
+
       # @api private
-      def initialize(path)
+      def initialize(path, inflector = Dry::Inflector.new)
         @path = path
+        @inflector = inflector
       end
 
       # Returns component's instance
@@ -55,7 +60,7 @@ module Dry
       #
       # @api public
       def constant
-        Inflecto.constantize(Inflecto.camelize(path))
+        inflector.constantize(inflector.camelize(path))
       end
 
       private

data/lib/dry/system/plugins.rb

@@ -0,0 +1,97 @@
+module Dry
+  module System
+    module Plugins
+      # @api private
+      class Plugin
+        attr_reader :name
+
+        attr_reader :mod
+
+        attr_reader :block
+
+        # @api private
+        def initialize(name, mod, &block)
+          @name = name
+          @mod = mod
+          @block = block
+        end
+
+        # @api private
+        def apply_to(system, options)
+          system.extend(stateful? ? mod.new(options) : mod)
+          system.instance_eval(&block) if block
+          system
+        end
+
+        # @api private
+        def stateful?
+          mod < Module
+        end
+      end
+
+      # Register a plugin
+      #
+      # @param [Symbol] name The name of a plugin
+      # @param [Class] plugin Plugin module
+      #
+      # @return [Plugins]
+      #
+      # @api public
+      def self.register(name, plugin, &block)
+        registry[name] = Plugin.new(name, plugin, &block)
+      end
+
+      # @api private
+      def self.registry
+        @__registry__ ||= {}
+      end
+
+      # Enable a plugin
+      #
+      # Plugin identifier
+      #
+      # @param [Symbol] name The plugin identifier
+      # @param [Hash] options Plugin options
+      #
+      # @return [self]
+      #
+      # @api public
+      def use(name, options = {})
+        unless enabled_plugins.include?(name)
+          Plugins.registry[name].apply_to(self, options)
+          enabled_plugins << name
+        end
+        self
+      end
+
+      # @api private
+      def inherited(klass)
+        klass.instance_variable_set(:@__enabled_plugins__, enabled_plugins.dup)
+        super
+      end
+
+      # @api private
+      def enabled_plugins
+        @__enabled_plugins__ ||= []
+      end
+
+      require 'dry/system/plugins/bootsnap'
+      register(:bootsnap, Plugins::Bootsnap)
+
+      require 'dry/system/plugins/logging'
+      register(:logging, Plugins::Logging)
+
+      require 'dry/system/plugins/env'
+      register(:env, Plugins::Env)
+
+      require 'dry/system/plugins/decorate'
+      register(:decorate, Plugins::Decorate)
+
+      require 'dry/system/plugins/notifications'
+      register(:notifications, Plugins::Notifications)
+
+      require 'dry/system/plugins/monitoring'
+      register(:monitoring, Plugins::Monitoring)
+    end
+  end
+end

data/lib/dry/system/plugins/bootsnap.rb

@@ -0,0 +1,37 @@
+module Dry
+  module System
+    module Plugins
+      module Bootsnap
+        DEFAULT_OPTIONS = {
+          load_path_cache: true,
+          disable_trace: true,
+          compile_cache_iseq: true,
+          compile_cache_yaml: true,
+          autoload_paths_cache: false
+        }.freeze
+
+        # @api private
+        def self.extended(system)
+          super
+          system.use(:env)
+          system.setting :bootsnap, DEFAULT_OPTIONS
+          system.after(:configure, &:setup_bootsnap)
+        end
+
+        # Set up bootsnap for faster booting
+        #
+        # @api public
+        def setup_bootsnap
+          return unless bootsnap_available?
+          require 'bootsnap' unless Object.const_defined?(:Bootsnap)
+          ::Bootsnap.setup(config.bootsnap.merge(cache_dir: root.join('tmp/cache').to_s))
+        end
+
+        # @api private
+        def bootsnap_available?
+          RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.3.0" && RUBY_VERSION < "2.5.0"
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/plugins/decorate.rb

@@ -0,0 +1,22 @@
+module Dry
+  module System
+    module Plugins
+      # @api public
+      module Decorate
+        # @api public
+        def decorate(key, decorator:)
+          original = _container.delete(key.to_s)
+
+          if original.is_a?(Dry::Container::Item) && original.options[:call] && decorator.is_a?(Class)
+            register(key) do
+              decorator.new(original.call)
+            end
+          else
+            decorated = decorator.is_a?(Class) ? decorator.new(original) : decorator
+            register(key, decorated)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/plugins/env.rb

@@ -0,0 +1,27 @@
+module Dry
+  module System
+    module Plugins
+      # @api public
+      class Env < Module
+        DEFAULT_INFERRER = -> { :development }
+
+        attr_reader :options
+
+        # @api private
+        def initialize(options)
+          @options = options
+        end
+
+        def inferrer
+          options.fetch(:inferrer, DEFAULT_INFERRER)
+        end
+
+        # @api private
+        def extended(system)
+          system.setting :env, inferrer.(), reader: true
+          super
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/plugins/logging.rb

@@ -0,0 +1,69 @@
+require 'logger'
+
+module Dry
+  module System
+    module Plugins
+      module Logging
+        # @api private
+        def self.extended(system)
+          system.setting :logger, reader: true
+
+          system.setting :log_dir, 'log'.freeze
+
+          system.setting :log_levels, {
+                           development: Logger::DEBUG,
+                           test: Logger::DEBUG,
+                           production: Logger::ERROR
+                         }
+
+          system.setting :logger_class, ::Logger, reader: true
+
+          system.after(:configure, &:register_logger)
+
+          super
+        end
+
+        # Set a logger
+        #
+        # This is invoked automatically when a container is being configured
+        #
+        # @return [self]
+        #
+        # @api private
+        def register_logger
+          if key?(:logger)
+            self
+          elsif config.logger
+            register(:logger, config.logger)
+          else
+            config.logger = logger = config.logger_class.new(log_file_path)
+            config.logger.level = log_level
+
+            register(:logger, config.logger)
+            self
+          end
+        end
+
+        # @api private
+        def log_level
+          config.log_levels.fetch(config.env, Logger::ERROR)
+        end
+
+        # @api private
+        def log_dir_path
+          root.join(config.log_dir).realpath
+        end
+
+        # @api private
+        def log_file_path
+          log_dir_path.join(log_file_name)
+        end
+
+        # @api private
+        def log_file_name
+          "#{config.env}.log"
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/plugins/monitoring.rb

@@ -0,0 +1,80 @@
+require 'delegate'
+require 'dry/system/constants'
+require 'dry/events/publisher'
+
+module Dry
+  module System
+    module Plugins
+      # @api public
+      module Monitoring
+        class Proxy < SimpleDelegator
+          # @api private
+          def self.for(target, key:, methods: [], &block)
+            monitored_methods =
+              if methods.empty?
+                target.public_methods - Object.public_instance_methods
+              else
+                methods
+              end
+
+            Class.new(self) do
+              extend Dry::Core::ClassAttributes
+              include Dry::Events::Publisher[target.class.name]
+
+              defines :monitored_methods
+
+              attr_reader :__notifications__
+
+              monitored_methods(methods.empty? ? target.public_methods - Object.public_instance_methods : methods)
+
+              monitored_methods.each do |meth|
+                define_method(meth) do |*args, &block|
+                  object = __getobj__
+                  opts = { target: key, object: object, method: meth, args: args }
+
+                  __notifications__.instrument(:monitoring, opts) do
+                    object.public_send(meth, *args, &block)
+                  end
+                end
+              end
+            end
+          end
+
+          def initialize(target, notifications)
+            super(target)
+            @__notifications__ = notifications
+          end
+        end
+
+        # @api private
+        def self.extended(system)
+          super
+
+          system.use(:decorate)
+          system.use(:notifications)
+
+          system.after(:configure) do
+            self[:notifications].register_event(:monitoring)
+          end
+        end
+
+        # @api private
+        def monitor(key, options = EMPTY_HASH, &block)
+          notifications = self[:notifications]
+
+          resolve(key).tap do |target|
+            proxy = Proxy.for(target, options.merge(key: key))
+
+            if block
+              proxy.monitored_methods.each do |meth|
+                notifications.subscribe(:monitoring, target: key, method: meth, &block)
+              end
+            end
+
+            decorate(key, decorator: proxy.new(target, notifications))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/plugins/notifications.rb

@@ -0,0 +1,20 @@
+module Dry
+  module System
+    module Plugins
+      # @api public
+      module Notifications
+        # @api private
+        def self.extended(system)
+          system.after(:configure, &:register_notifications)
+        end
+
+        # @api private
+        def register_notifications
+          return self if key?(:notifications)
+          require 'dry/monitor/notifications' unless Object.const_defined?('Dry::Monitor::Notifications')
+          register(:notifications, Monitor::Notifications.new(config.name))
+        end
+      end
+    end
+  end
+end

data/lib/dry/system/provider.rb

@@ -1,4 +1,5 @@
 require 'concurrent/map'
+require 'dry/system/constants'
 require 'dry/system/components/bootable'
 
 module Dry
@@ -21,7 +22,7 @@ module Dry
       end
 
       def boot_files
-        Dir[boot_path.join('**/*.rb')]
+        Dir[boot_path.join("**/#{RB_GLOB}")]
       end
 
       def register_component(name, fn)
@@ -29,7 +30,7 @@ module Dry
       end
 
       def boot_file(name)
-        boot_files.detect { |path| Pathname(path).basename('.rb').to_s == name.to_s }
+        boot_files.detect { |path| Pathname(path).basename(RB_EXT).to_s == name.to_s }
       end
 
       def component(name, options = {})

data/lib/dry/system/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module System
-    VERSION = '0.8.1'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

metadata

@@ -1,71 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: dry-system
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: inflecto
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
-  name: dry-core
+  name: dry-auto_inject
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: dry-equalizer
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: dry-container
   requirement: !ruby/object:Gem::Requirement
@@ -81,39 +87,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: dry-auto_inject
+  name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +198,13 @@ files:
 - lib/dry/system/loader.rb
 - lib/dry/system/magic_comments_parser.rb
 - lib/dry/system/manual_registrar.rb
+- lib/dry/system/plugins.rb
+- lib/dry/system/plugins/bootsnap.rb
+- lib/dry/system/plugins/decorate.rb
+- lib/dry/system/plugins/env.rb
+- lib/dry/system/plugins/logging.rb
+- lib/dry/system/plugins/monitoring.rb
+- lib/dry/system/plugins/notifications.rb
 - lib/dry/system/provider.rb
 - lib/dry/system/provider_registry.rb
 - lib/dry/system/settings.rb
@@ -226,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Organize your code into reusable components