dry-plugins 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c3f397db9409161943cf1beb2b08991137bea56
+  data.tar.gz: 421e745136b991141b11b2254a9d6d5a4d545ace
+SHA512:
+  metadata.gz: 1aafce2b121f32b1c726cf7948dbb9517ec6830e487acdad85c96bccea58e89248a96d47795129968ac34c0d7df05acd1e4fa925eef561d4e869352f030fc387
+  data.tar.gz: e3d80259a5e6700e7eb1009726365e319430e164b5c291237cd12e22a88ed6172b7853561298d455bc79c4ccf284119004d9f2405a9e2a2df863221b2fd21631

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle
+.rspec_status
+.yardoc
+_yardoc
+coverage
+doc
+Gemfile.lock
+pkg
+spec/examples.txt
+spec/reports
+tmp
+vendor/bundle

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DefaultFormatter: fuubar
+  DisplayCopNames: true
+  ExtraDetails: true
+  Exclude:
+  - vendor/**/*.rb
+
+inherit_from: .rubocop_todo.yml
+
+Metrics/BlockLength:
+  Exclude:
+  - rakelib/**/*.rb
+  - spec/**/*.rb
+  - vendor/**/*.rb
+
+# It is 2017, UTF time!
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+  # Specification is doc itself
+  - spec/**/*
+  # Tests are docs itself
+  - test/**/*
+
+Style/FileName:
+  Exclude:
+  # cozy name for gem requirement
+  - 'lib/dry-plugins.rb'
+  - 'lib/rspec/dry-plugins.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,35 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-06-15 22:45:51 +0300 using RuboCop version 0.49.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/rspec/dry-plugins.rb'
+
+# Offense count: 1
+# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/dry/plugins/registry/builder.rb'
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 14
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 120
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14

data/.simplecov

@@ -0,0 +1,6 @@
+SimpleCov.start do
+  add_filter '/bin/'
+  add_filter '/spec/'
+  add_group('Missing') { |src| src.covered_percent < 100 }
+  add_group('Covered') { |src| src.covered_percent == 100 }
+end

data/.yardopts

@@ -0,0 +1,7 @@
+--title 'dry-plugins'
+--plugin yard-commonmarker
+--markup-provider commonmarker
+--markup markdown
+--readme README.md
+--tag "default:Default values"
+lib/**/*.rb

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec name: 'dry-plugins'

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    dry-plugins (0.1.0)
+      dry-auto_inject
+      dry-configurable
+      dry-container (~> 0.6.0)
+      dry-core
+      dry-equalizer
+      inflecto
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    bundler-audit (0.5.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    commonmarker (0.16.0)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.0.5)
+    development-toolbox (0.7.0)
+      bundler (~> 1.13)
+      bundler-audit (~> 0.5)
+      rake (~> 12.0)
+      rspec (~> 3.5)
+      rspec-its (~> 1.2)
+      rubocop (~> 0.48)
+      yard-commonmarker (~> 0.3)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dry-auto_inject (0.4.3)
+      dry-container (>= 0.3.4)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.3.1)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.0)
+    i18n (0.8.1)
+    inflecto (0.0.2)
+    json (2.1.0)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-enum (0.7.1)
+      i18n
+    ruby-progressbar (1.8.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    thor (0.19.4)
+    unicode-display_width (1.2.1)
+    yard (0.9.9)
+    yard-commonmarker (0.3.0)
+      commonmarker (~> 0.16)
+      yard (~> 0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  development-toolbox (~> 0.6)
+  dry-plugins!
+  simplecov
+
+BUNDLED WITH
+   1.15.1

data/LICENSE.md

@@ -0,0 +1,28 @@
+# @title dry-plugins: The MIT License (MIT)
+
+# The MIT License (MIT)
+
+## Copyright 
+
+* [Alex Semyonov] <[alex@semyonov.us]>, 2017
+
+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.
+
+[Alex Semyonov]: https://alex.semyonov.us/ "Alex Semyonov"
+[alex@semyonov.us]: mailto:alex@semyonov.us?subject=dry-plugins "Email Alex about dry-plugins"

data/README.md

@@ -0,0 +1,32 @@
+# @title dry-plugins: DSL for plugins
+# @author Alex Semyonov <alex@semyonov.us>
+
+# dry-plugins: DSL for plugins
+
+Abstract DSL for providing plug-in interface for PORO and complex structures.
+
+Wikipedia says following:
+ 
+> The host application {Dry::Plugins::Host::DSL provides services} which the plug-in can use, including {Dry::Plugins::Registry#register a way for plug-ins to register themselves} with the host application and a protocol for the exchange of data with plug-ins. Plug-ins depend on the services provided by the host application and do not usually work by themselves. Conversely, the host application operates independently of the plug-ins, making it possible for end-users to add and update plug-ins dynamically without needing to make changes to the host application.
+> 
+> Programmers typically implement plug-in functionality using shared libraries installed in a place prescribed by the host application. HyperCard supported a similar facility, but more commonly included the plug-in code in the HyperCard documents (called stacks) themselves. Thus the HyperCard stack became a self-contained application in its own right, distributable as a single entity that end-users could run without the need for additional installation-steps. Programs may also implement plugins by loading a directory of simple script files written in a scripting language like Python or Lua.
+
+## TL;DR
+
+dry-plugins is a utility to provide plug-ins interface for your Ruby class (called *host* in documentation).
+
+See {Dry::Plugins}.
+
+Configuration: see {Dry::Plugins::Config}.
+
+## 
+
+Documentation:
+
+* {Dry::Plugins::Registry} - a plug-ins registry;
+    * {Dry::Plugins::Registry::Resolver} - a plug-in resolver;
+* {Dry::Plugins::Plugin} — a proxy for a plug-in;
+
+## Copyright and License
+
+© [Alex Semyonov](https://alex.semyonov.us/) <[alex@semyonov.us](mailto:alex@semyonov.us?subject=dry-plugins)>, 2017, [MIT license](LICENSE.md)

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'development/tasks'
+Development::Tasks.install

data/bin/rake

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/yard

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/dry-plugins.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/plugins/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'dry-plugins'
+  spec.version = Dry::Plugins::VERSION
+  spec.authors = ['Alex Semyonov']
+  spec.email = ['alex@semyonov.us']
+
+  spec.summary = 'Dry way to add plugins to your framework'
+  spec.description = 'Generic plugin interface.'
+  spec.homepage = 'http://alsemyonov.gitlab.com/dry-plugins/'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dry-configurable'
+  spec.add_runtime_dependency 'dry-container', '~> 0.6.0'
+  spec.add_runtime_dependency 'dry-auto_inject'
+  spec.add_runtime_dependency 'dry-equalizer'
+  spec.add_runtime_dependency 'dry-core'
+  spec.add_runtime_dependency 'inflecto'
+
+  spec.add_development_dependency 'development-toolbox', '~> 0.6'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/dry/plugins/builder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'dry/plugins/config'
+require 'dry/plugins/host/dsl'
+
+module Dry
+  module Plugins
+    # Plug-ins builder
+    # @see Builder#call
+    class Builder
+      # @!method module_builder
+      #   @return [ModuleBuilder]
+      #
+      # @!method registry_builder
+      #   @return [Registry::Builder]
+      #
+      # @!method host_builder
+      #   @return [Host::Builder]
+      include Import[:module_builder, :registry_builder, :host_builder]
+
+      # Build a plug-in registry for given `host`
+      #
+      # 1. Extend `host` with a {Host::DSL plug-ins host DSL}
+      # 2. Create a {Registry plug-ins registry} for `host`,
+      #    Find or create a `Module` containing plug-ins for `host`,
+      #    and extend it with {DSL plug-ins registry DSL}
+      #
+      # @param host [Module]
+      # @return [Registry]
+      def call(host, registry: registry_builder.call(host))
+        host_builder.call(host, registry)
+      end
+    end
+  end
+end

data/lib/dry/plugins/config.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# noinspection RubyConstantNamingConvention
+
+require 'dry-auto_inject'
+require 'dry-container'
+require 'dry-configurable'
+
+# rubocop:disable Style/Documentation
+
+module Dry
+  module Plugins
+    extend Dry::Container::Mixin
+
+    Import = Dry.AutoInject(self)
+
+    # @!parse
+    #   # Global configuration of {Dry::Plugins}
+    #   #
+    #   # @!group Method names
+    #   #
+    #   # @!attribute [rw] configure_method
+    #   #   Name of the method that will be used for configuration when
+    #   #   {Dry::Plugins::Host::DSL#use} called with block
+    #   #   @return [Symbol]
+    #   #   @default `:configure`
+    #   #
+    #   # @!attribute [rw] load_dependencies_method
+    #   #   Name of the method that will be used for loading dependencies when
+    #   #   {Dry::Plugins::Host::DSL#use} called
+    #   #   @return [Symbol]
+    #   #   @default `:load_dependencies`
+    #   #
+    #   # @!attribute [rw] registry_method
+    #   #   @return [Symbol]
+    #   #   @default `:plugins_registry`
+    #   #
+    #   # @!group Constant names
+    #   #
+    #   # @!attribute [rw] class_interface_name
+    #   #   Name of the module that will be used as a class extension
+    #   #   when plug-in is included
+    #   #   @return [Symbol]
+    #   #   @default `:ClassInterface`
+    #   #
+    #   # @!attribute [rw] plugins_module_name
+    #   #   Name of the module that will be used for plug-ins
+    #   #   @return [Symbol]
+    #   #   @default `:Plugins`
+    #   #
+    #   # @!attribute [rw] registry_class_name
+    #   #   Name of the class that will be used for plug-ins registry
+    #   #   @return [Symbol]
+    #   #   @default `:Registry`
+    #   #
+    #   class Config < Dry::Configurable::Config
+    #   end
+    #
+    # @!method self.config
+    #   @return [Config]
+    #
+    # @!method self.configure
+    #   @yieldparam config [Config]
+    #
+    #   @return [Config]
+    #
+    #   @see Config#configure_method config.configure_method
+    #   @see Config#load_dependencies_method config.load_dependencies_method
+    #   @see Config#registry_method config.registry_method
+    #   @see Config#class_interface_name config.class_interface_name
+    #   @see Config#plugins_module_name config.plugins_module_name
+    #   @see Config#registry_class_name config.registry_class_name
+    #
+    #   @example dry-plugins default configuration
+    #     Dry::Plugins.configure do |config|
+    #       config.configure_method = :configure
+    #       config.load_dependencies_method = :load_dependencies
+    #       config.class_interface_name = :ClassInterface
+    #       config.plugins_module_name = :Plugins
+    #       config.registry_class_name = :Registry
+    #     end
+    setting :container, Dry::Plugins
+    setting :configure_method, :configure
+    setting :load_dependencies_method, :load_dependencies
+    setting :registry_method, :plugins_registry
+    setting :class_interface_name, :ClassInterface
+    setting :plugins_module_name, :Plugins
+    setting :registry_class_name, :Registry
+
+    register :host_builder do
+      require 'dry/plugins/host/builder'
+      Host::Builder.new
+    end
+
+    register :module_builder do
+      require 'dry/plugins/module_builder'
+      ModuleBuilder.new
+    end
+
+    register :builder do
+      require 'dry/plugins/builder'
+      Builder.new
+    end
+
+    register :registry_builder do
+      require 'dry/plugins/registry/builder'
+      Registry::Builder.new
+    end
+
+    register :registry_class_builder do
+      require 'dry/plugins/registry/class_builder'
+      Registry::ClassBuilder.new
+    end
+  end
+end

data/lib/dry/plugins/dsl.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Dry
+  module Plugins
+    # Plug-ins DSL
+    module DSL
+      # @api private
+      def self.extended(plugins)
+        super(plugins)
+        plugins.extend SingleForwardable
+        plugins.def_single_delegators Plugins.config.registry_method,
+                                      :register,
+                                      :resolve,
+                                      :[]
+      end
+
+      # @return [Module, Host::DSL]
+      def host
+        @host ||= Inflecto.constantize(name.gsub(/::[^:]+$/, ''))
+      end
+
+      # @!method register(name, plugin)
+      #   @param name [#to_sym]
+      #   @param plugin [Module, Plugin]
+      #
+      #   @return [Plugin]
+      #
+      #   @see Dry::Plugins::Registry#register
+
+      # @!method resolve(name)
+      #   @param name [#to_sym]
+      #
+      #   @return [Plugin]
+      #
+      #   @see Dry::Plugins::Registry#resolve
+    end
+  end
+end

data/lib/dry/plugins/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Dry
+  module Plugins
+    # Plug-ins error
+    class Error < StandardError
+    end
+  end
+end

data/lib/dry/plugins/host/builder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'dry/plugins/config'
+require 'dry/plugins/host/dsl'
+
+module Dry
+  module Plugins
+    module Host
+      # Extends a host with plug-ins interfaces
+      class Builder
+        def initialize(registry_method: Plugins.config.registry_method)
+          @registry_method = registry_method
+        end
+
+        # @return [Symbol]
+        attr_reader :registry_method
+
+        # @param host [Module]
+        #
+        # @return [Module]
+        #
+        # @example
+        #   require 'dry/plugins/module_builder'
+        #
+        #   class Host
+        #   end
+        #
+        #   module_builder = Dry::Plugins::HostExtender.new
+        #   module_builder.call(Host) #=> Host::Plugins
+        def call(host, registry)
+          unless host.respond_to? registry_method
+            host.define_singleton_method registry_method do
+              registry
+            end
+          end
+
+          unless host.singleton_class.included_modules.include? Host::DSL
+            host.extend Host::DSL
+          end
+
+          host
+        end
+      end
+    end
+  end
+end