ekylibre-plugin_system 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31fa595ea20dee0bbf28b84fb549a4728e9c5420585d1414ab88378eceee9d0d
+  data.tar.gz: c53e1a49c95655a86ea85b44cee8f276ff1d229fc9ed6055c96662043d22168c
+SHA512:
+  metadata.gz: '0078f0864c44175b792d194f89db19ccf28473f6881a0447cd762c3b43ce1934898f8f1fa8f3da091b1f76f7c3d32064cbfe37d39218314f9fb50ab96653be16'
+  data.tar.gz: ef004b7fa8ee0ca120acd0f263a7851f551a63a8ec06630d7b22bd82d6a97a6b96e1c07c9513794f774e1206da4168fd4d9e76ef2d687388e550dc980e65f546

data/ekylibre-plugin_system.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ekylibre/plugin_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ekylibre-plugin_system'
+  spec.version = Ekylibre::PluginSystem::VERSION
+  spec.authors = ['Ekylibre developers']
+  spec.email = ['dev@ekylibre.com']
+
+  spec.summary = 'Plugin system for Rails built around a Dependency Injection Container'
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.homepage = 'https://www.ekylibre.com'
+  spec.license = 'AGPL-3.0-only'
+
+  # 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.glob(%w[lib/**/*.rb *.gemspec])
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'corindon', '~> 0.7.0'
+  spec.add_dependency 'railties', '> 4'
+  spec.add_dependency 'request_store', '~> 1.5.0'
+  spec.add_dependency 'request_store-sidekiq', '~> 0.1.0'
+  spec.add_dependency 'zeitwerk', '~> 2.4'
+
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.3.0'
+end

data/lib/ekylibre-plugin_system.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'corindon'
+require 'request_store'
+require 'request_store/sidekiq'
+require 'zeitwerk'
+
+module Ekylibre # :nodoc:
+
+end
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore(__FILE__)
+loader.ignore("#{__dir__}/plugin_system/rails/**/*.rb")
+loader.ignore("#{__dir__}/plugin_system/multi_tenancy/railtie.rb")
+loader.setup
+
+require_relative 'ekylibre/plugin_system/rails/railtie' if defined?(::Rails)

data/lib/ekylibre/plugin_system/console_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    # Helper methods to access the container from the Rails console
+    module ConsoleHelper
+      extend ActiveSupport::Concern
+
+      # @return [Corindon::DependencyInjection::Container]
+      def container
+        ::Rails.application.system.container
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/controller_mixin.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    # Helper module to access the container from a Rails controller
+    module ControllerMixin
+      # @return [Corindon::DependencyInjection::Container]
+      def container
+        request.env['container']
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/middleware/rack_middleware.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Middleware
+      # Rack middleware adding the provided container to the request context
+      class RackMiddleware
+        # @param [#call] app
+        # @param [Corindon::DependencyInjection::Container] container
+        def initialize(app, container)
+          @app = app
+          @container = container
+        end
+
+        def call(env)
+          # request_container = enter_tenant(container, ::Ekylibre::Tenant.current)
+          RequestStore['container'] = container
+
+          # We HAVE to mutate the environment because Devise (and maybe other) needs to pass information up the middleware stack
+          # from the Rails application to the Auth middleware through the environment
+          env['container'] = container
+
+          @app.call(env)
+        end
+
+        private
+
+          # @return [Corindon::DependencyInjection::Container]
+          attr_reader :container
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/middleware/sidekiq_middleware.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Middleware
+      # Sidekiq server middleware adding the provided container to the job context
+      class SidekiqMiddleware
+        def initialize(container)
+          @container = container
+        end
+
+        def call(_worker_class, item, _queue)
+          RequestStore['container'] = container
+          item['container'] = container
+
+          yield
+        end
+
+        private
+          # @return [Corindon::DependencyInjection::Container]
+          attr_reader :container
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/parameters.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+using Corindon::DependencyInjection::Injectable
+
+module Ekylibre
+  module PluginSystem
+    # Utility class defining some InjectionTokens for the plugin system
+    class Parameters
+      CURRENT_TENANT = make_parameter('current_tenant')
+      RAILS_APPLICATION = make_parameter('rails_application')
+    end
+  end
+end

data/lib/ekylibre/plugin_system/plugin.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    # Base class for a Plugin
+    class Plugin
+      # @return [Rails::Engine]
+      attr_reader :engine
+
+      # @param [Rails::Engine] engine
+      def initialize(engine: nil)
+        @engine = engine
+      end
+
+      # @return [String]
+      def name
+        self.class.name
+      end
+
+      def version
+        'unknown'
+      end
+
+      # @param [Container] container
+      def boot(container) end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/plugin_registration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    # Utility module to facilitate Plugin and Engine registration into the plugin system
+    module PluginRegistration
+      class << self
+        def extended(base)
+          base.initializer(:register_railtie) do |app|
+            container = app.system.container
+
+            container.set_parameter(self.class, self)
+          end
+        end
+      end
+
+      def register_plugin(plugin_class)
+        initializer(:register_plugin, after: :register_railtie) do |app|
+          container = app.system.container
+
+          container.add_definition(plugin_class)
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/rails/railtie.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Rails
+      # Railtie to integrate the PluginSystem into a Rails application
+      class Railtie < ::Rails::Railtie
+        extend PluginRegistration
+
+        initializer(:register_application) do |app|
+          container = app.system.container
+
+          container.set_parameter(Ekylibre::PluginSystem::Parameters::RAILS_APPLICATION.key, app)
+        end
+
+        initializer(:register_middleware, after: :engines_blank_point) do |app|
+          # app.config.middleware.insert_after(apartment_middleware, Ekylibre::PluginSystem::Middleware::RackMiddleware, app.system.container)
+          app.config.middleware.use(Middleware::RackMiddleware, app.system.container)
+        end
+
+        initializer(:register_sidekiq_middleware, after: :engines_blank_point) do |app|
+          ::Sidekiq.configure_server do |config|
+            config.server_middleware do |chain|
+              if defined?(::Sidekiq::Batch::Server)
+                chain.insert_before ::Sidekiq::Batch::Server, Middleware::SidekiqMiddleware, app.system.container
+              else
+                chain.add Middleware::SidekiqMiddleware, app.system.container
+              end
+            end
+          end
+        end
+
+        # rubocop:disable Lint/Debugger
+        console do
+          ::Rails::ConsoleMethods.send :include, ConsoleHelper
+        end
+        # rubocop:enable Lint/Debugger
+
+        # Reboot system between requests if reloading is enabled.
+        # Application configuration cannot be changed but this allow us to use rails reloading system in development.
+        config.to_prepare do
+          app = Ekylibre::Application.instance
+
+          app.system.reset
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/sugar/procedo.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Sugar
+      # Syntactic sugar to ease the registration of Procedo procedures into the container
+      module Procedo
+        refine Plugin do
+          using Corindon::DependencyInjection::Injectable
+
+          # @param [Corindon::DependencyInjection::Container] container
+          def register_procedures(container:)
+            container.add_definition(
+              self.class.make_definition('procedure_loader', ::Procedo::ProcedureLoader) { tag 'procedo.loader' },
+              context: { root: engine.root }
+            ) do |ctx|
+              args root: value(ctx.root)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/sugar/rights.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Sugar
+      # Syntactic sugar to ease the registration of Ekylibre Rights into the container
+      module Rights
+        refine Plugin do
+          using Corindon::DependencyInjection::Injectable
+
+          # @param [Corindon::DependencyInjection::Container] container
+          def register_rights(container:)
+            container.add_definition(
+              self.class.make_definition('rights_loader', Ekylibre::Access::RightsLoader, context: engine.root.join('config', 'rights.yml')) do |path|
+                args path, origin: value(:hajimari)
+                tag 'ekylibre.access.rights_loader'
+              end
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/sugar/scripts.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Sugar
+      # Syntactic sugar to ease the registration of ScriptAddon into the container
+      module Scripts
+        refine Plugin do
+          using Corindon::DependencyInjection::Injectable
+
+          # @param [Array<String>] addons
+          # @param [Corindon::DependencyInjection::Container] container
+          def register_script_addons(addons, container:)
+            addons.each do |relative_path|
+              container.add_definition(
+                self.class.make_definition(relative_path, Ekylibre::View::Scripts::ScriptAddon) { tag 'ekylibre.view.script_addon' },
+                context: { path: relative_path, origin: self.name }
+              ) do |ctx|
+                args relative_path: value(ctx.path), origin: value(ctx.name)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/sugar/themes.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    module Sugar
+      # Syntactic sugar to ease the registration of Themes and ThemeAddon into the container
+      module Themes
+        refine Plugin do
+          using Corindon::DependencyInjection::Injectable
+
+          # @param [Array<String>] addons
+          # @param [Corindon::DependencyInjection::Container] container
+          def register_theme_addons(addons, container:)
+            addons.each do |relative_path|
+              container.add_definition(
+                self.class.make_definition(relative_path, Ekylibre::View::Themes::ThemeAddon) { tag 'ekylibre.view.theme_addon' },
+                context: { path: relative_path, origin: self.name }
+              ) do |ctx|
+                args for_theme: value('tekyla'), relative_path: value(ctx.path), origin: value(ctx.name)
+              end
+            end
+          end
+
+          def register_themes(themes, container:)
+            themes.each { |theme| register_theme(theme, container: container) }
+          end
+
+          def register_theme(theme, container:)
+            container.add_definition(
+              self.class.make_definition("themes.#{theme}", Ekylibre::View::Themes::Theme) { tag 'ekylibre.view.theme' },
+              context: { theme: theme }
+            ) do |ctx|
+              args value(ctx.theme)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/system.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    # This class in the interface between the Rails application and the core plugin system that is basically just the container
+    class System
+      # @return [Corindon::DependencyInjection::Container]
+      attr_reader :container
+
+      def initialize
+        @started = false
+        @container = Corindon::DependencyInjection::Container.new
+      end
+
+      def start
+        if !started?
+          @started = true
+          boot_plugins
+        end
+      end
+
+      # @return [Boolean]
+      def started?
+        @started
+      end
+
+      def reset
+        if !started?
+          start
+        else
+          container.clear
+        end
+      end
+
+      def plugins
+        @container.tagged('ekylibre.system.plugin').map { |key| @container.get(key) }
+      end
+
+      private
+
+        def boot_plugins
+          plugins.each { |p| p.boot(container) }
+        end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    VERSION = '0.4.0'
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: ekylibre-plugin_system
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Ekylibre developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: corindon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.7.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: request_store-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: 
+email:
+- dev@ekylibre.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ekylibre-plugin_system.gemspec
+- lib/ekylibre-plugin_system.rb
+- lib/ekylibre/plugin_system/console_helper.rb
+- lib/ekylibre/plugin_system/controller_mixin.rb
+- lib/ekylibre/plugin_system/middleware/rack_middleware.rb
+- lib/ekylibre/plugin_system/middleware/sidekiq_middleware.rb
+- lib/ekylibre/plugin_system/parameters.rb
+- lib/ekylibre/plugin_system/plugin.rb
+- lib/ekylibre/plugin_system/plugin_registration.rb
+- lib/ekylibre/plugin_system/rails/railtie.rb
+- lib/ekylibre/plugin_system/sugar/procedo.rb
+- lib/ekylibre/plugin_system/sugar/rights.rb
+- lib/ekylibre/plugin_system/sugar/scripts.rb
+- lib/ekylibre/plugin_system/sugar/themes.rb
+- lib/ekylibre/plugin_system/system.rb
+- lib/ekylibre/plugin_system/version.rb
+homepage: https://www.ekylibre.com
+licenses:
+- AGPL-3.0-only
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Plugin system for Rails built around a Dependency Injection Container
+test_files: []