ekylibre-plugin_system 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e67301a6ea670850bd6794f51d287fabb277f209fbbf5983d3e29540de7fefb4
-  data.tar.gz: 5fe4b34bdad1085b5484ba7ebf809466005ca01343634aa5942596e9bf7d0d18
+  metadata.gz: c18835a3f0df42efc51f7255499700f5daf5c58995acd0391d01bd4c5eb96b34
+  data.tar.gz: fd48bb8dd840471bd7e746be73f520e62cd7c690ff3aed0c725eb39dab7c15fb
 SHA512:
-  metadata.gz: 81ff8b3f60e94fca1a5ecf30ad0ebdd39c946af640ec6ab15e578a72fc881d2096bdcc7f96d2dc531111e5f83e57a04abdd0c9cfef61753e9fd1a63b512631b9
-  data.tar.gz: 38521c74d7ef72588fe61d8b0e7d27f04260c2d964e2b36c5715052e2c8ebf8f7d741608f44376ecfa2b0c5ea832391982b14f9197cd2791c7063319497901fc
+  metadata.gz: 06e0dc832b6d3d8d362752aa71c018e2880cfdec5981324e5502e6b1ca7e529e75b6ee9754b4e87e74a11a17b08cd094c09d9bbf6d99de1adc372dabafa26592
+  data.tar.gz: ca4a600d5192155300d387050c6e631bb2e0eb2b6198c675165121e21a3cb709d387a4fe7b587b14d1e09cc5432485e7ac265ce615f080839c7aa2a642bbff38

data/ekylibre-plugin_system.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.4'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 1.3.0'
 end

data/lib/ekylibre-plugin_system.rb

@@ -11,6 +11,7 @@ end
 loader = Zeitwerk::Loader.for_gem
 loader.ignore(__FILE__)
 loader.ignore("#{__dir__}/plugin_system/rails/**/*.rb")
+loader.ignore("#{__dir__}/plugin_system/testing/**/*.rb")
 loader.setup
 
 require_relative 'ekylibre/plugin_system/rails/railtie' if defined?(::Rails)

data/lib/ekylibre/plugin_system/console_helper.rb

@@ -4,14 +4,10 @@ module Ekylibre
   module PluginSystem
     # Helper methods to access the container from the Rails console
     module ConsoleHelper
-      extend ActiveSupport::Concern
-
+      # Provides an easy access to the container from the console context.
       # @return [Corindon::DependencyInjection::Container]
       def container
-        instance = ::Rails.application.system.container
-        RequestStore['container'] = instance
-
-        instance
+        GlobalContainer.get
       end
     end
   end

data/lib/ekylibre/plugin_system/global_container.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Ekylibre
+  module PluginSystem
+    # This class is a wrapper around RequestStore that, in addition to provide a concise way to access the container globally,
+    # ensures that a container is present if the application ask for one (nil is not a valid value)
+    class GlobalContainer
+      class << self
+        private :new
+
+        # @param [Corindon::DependencyInjection::Container] container
+        def set(container)
+          RequestStore['container'] = container
+        end
+
+        def unset
+          RequestStore.delete('container')
+        end
+
+        # @param [Corindon::DependencyInjection::Container] container
+        def replace_with(container, &block)
+          prev = if has?
+                   get
+                 else
+                   nil
+                 end
+
+          set(container)
+
+          block.call
+        ensure
+          if prev.nil?
+            unset
+          else
+            set(prev)
+          end
+        end
+
+        def has?
+          RequestStore.exist?('container')
+        end
+
+        # @return [Corindon::DependencyInjection::Container]
+        def get
+          container = RequestStore['container']
+
+          if container.nil?
+            raise StandardError.new(
+              'The application requires the container to be loaded to work. Please load it before calling GlobalContainer.get'
+            )
+          else
+            container
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,13 +14,14 @@ module Ekylibre
 
         def call(env)
           # request_container = enter_tenant(container, ::Ekylibre::Tenant.current)
-          RequestStore['container'] = container
+          GlobalContainer.replace_with(container) do
 
-          # 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
+            # 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)
+            @app.call(env)
+          end
         end
 
         private

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

@@ -12,10 +12,11 @@ module Ekylibre
           end
 
           def call(_worker_class, item, _queue)
-            RequestStore['container'] = container
-            item['container'] = container
+            GlobalContainer.replace_with(container) do
+              item['container'] = container
 
-            yield
+              yield
+            end
           ensure
             # We want to have the same behavior as the request_store-sidekiq gem.
             # However, we want to insert our middleware BEFORE the Batch middleware.

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

@@ -22,7 +22,10 @@ module Ekylibre
         end
 
         # rubocop:disable Lint/Debugger
-        console do
+        console do |app|
+          # Make the app container accessible in the RequestStore when in rails console
+          GlobalContainer.set(app.system.container)
+
           ::Rails::ConsoleMethods.send :include, ConsoleHelper
         end
         # rubocop:enable Lint/Debugger

data/lib/ekylibre/plugin_system/testing/spec_reporter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'io/console'
+require 'minitest/reporters'
+
+module Ekylibre
+  module PluginSystem
+    module Testing
+      class SpecReporter < Minitest::Reporters::SpecReporter
+        def record_print_status(test)
+          test_name = test.name.gsub(/^test_: /, 'test:')
+          print_colored_status(test)
+          print pad_test(test_name)
+          print(format(' (%.2fs)', test.time)) unless test.time.nil?
+          puts
+        end
+
+        private def pad_test(str)
+          if ENV.key?('CI')
+            super
+          else
+            pad(format("%-#{[TEST_SIZE, IO.console.winsize[1] - 15].max}s", str), TEST_PADDING)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ekylibre/plugin_system/version.rb

@@ -2,6 +2,6 @@
 
 module Ekylibre
   module PluginSystem
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ekylibre-plugin_system
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ekylibre developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: corindon
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +147,7 @@ files:
 - lib/ekylibre-plugin_system.rb
 - lib/ekylibre/plugin_system/console_helper.rb
 - lib/ekylibre/plugin_system/controller_mixin.rb
+- lib/ekylibre/plugin_system/global_container.rb
 - lib/ekylibre/plugin_system/middleware/rack_middleware.rb
 - lib/ekylibre/plugin_system/middleware/sidekiq_middleware.rb
 - lib/ekylibre/plugin_system/middleware/sidekiq_middleware/client_middleware.rb
@@ -146,6 +161,7 @@ files:
 - lib/ekylibre/plugin_system/sugar/scripts.rb
 - lib/ekylibre/plugin_system/sugar/themes.rb
 - lib/ekylibre/plugin_system/system.rb
+- lib/ekylibre/plugin_system/testing/spec_reporter.rb
 - lib/ekylibre/plugin_system/version.rb
 homepage: https://www.ekylibre.com
 licenses: