redmine_plugin_kit 1.0.8 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b950fef55b36b8c083f86f9763d9528a259c42b85da7f238ac94ba9dd85ca40
-  data.tar.gz: b425a3447f2b07ded747e329d6b482010e8404a36d9842f3415aa06c5232b959
+  metadata.gz: 742a6b7ef926f76e6c7615961748e673590423a410041567a15743692337e753
+  data.tar.gz: 2a63b5273c96b44f8c42f7f473a462acf2352979137331e61b3baca6fd835e1f
 SHA512:
-  metadata.gz: 516210aeab2395b927086b354b913eeca88e7aed1de3f7674aad6d6efb0bcd602897eefd28f108c00d13519f9cb27df51167638937516ec3d9793577ad52d3c9
-  data.tar.gz: 4579bbdaed1f2dec0bce766f18bd3344398f303c5417b8944312945a63894a750cad7f4fce3d41bb2ebd5082e06ccc5f3aa4f6ae26ff8e56d042b27cce205f0d
+  metadata.gz: 3b339aad3aa4192aecc5b385678b656a93e1b3e820f0d7f20500f89c8bd35f81be1c2dd49c66e860721b75d4b856bd4058a7eced562941ee802df0738c48f967
+  data.tar.gz: 4d11d3f39bcc013d6addd4cbc03ada64a13f51b0be1e5ca446f693f4a6e88e0c7431a67415078ee88df07d49336395a7986e04778ef513061f9da5e96355357c

data/lib/redmine_plugin_kit/loader.rb

@@ -89,11 +89,34 @@ module RedminePluginKit
 
       files.reverse! if reverse
       files.each do |f|
-        Rails.autoloaders.main.ignore << f if Rails.version > '6.0' && ignore_autoload
+        if Rails.version > '6.0' && ignore_autoload
+          Rails.autoloaders.main.ignore << f
+          # Such a file registers itself in a registry that lives on a module
+          # Zeitwerk rebuilds on every reload (Redmine::FieldFormat). The
+          # registration is lost with the old module, and require would be a
+          # no-op the second time round - the custom field then falls back to a
+          # plain text field showing the raw id. Reloading the file restores it.
+          #
+          # NOTE: the require below stays as it is, so booting behaves exactly as
+          # before and does not depend on when to_prepare runs. Loading the file
+          # again in the first prepare run is harmless: these files only define a
+          # class and register it under a fixed name.
+          reload_on_prepare f
+        end
+
         require f
       end
     end
 
+    # Load the file again after every code reload.
+    #
+    # The block keeps the order of the surrounding loop, which matters because
+    # formats may inherit from each other (CompanyFormat < ContactFormat) - a
+    # subclass loaded before its parent raises NameError.
+    def reload_on_prepare(file)
+      ActiveSupport::Reloader.to_prepare { load file }
+    end
+
     def incompatible?(plugins = [])
       plugins.each do |plugin|
         raise "\n\033[31m#{plugin_id} plugin cannot be used with #{plugin} plugin.\033[0m" if Redmine::Plugin.installed? plugin

data/lib/redmine_plugin_kit/plugin_base.rb

@@ -38,6 +38,19 @@ module RedminePluginKit
 
       private
 
+      # Enforce a plugin's REQUIRED_ALPHANODES_PLUGINS (an array of plugin ids it
+      # hard-depends on). Called from setup! which runs via the
+      # after_plugins_loaded hook, i.e. AFTER every plugin is registered - so the
+      # alphabetical plugin load order is irrelevant here.
+      #
+      # This is why AlphaNodes plugins declare dependencies on other redmine_*
+      # plugins via REQUIRED_ALPHANODES_PLUGINS instead of requires_redmine_plugin:
+      # requires_redmine_plugin runs while init.rb is loaded (during alphabetical
+      # registration) and therefore only works for dependencies that load earlier,
+      # such as additionals / additional_tags. A dependency that loads later (e.g.
+      # redmine_automation depending on redmine_reporting) would raise
+      # PluginNotFound even though it is installed. To see a plugin's hard
+      # AlphaNodes dependencies, look at its REQUIRED_ALPHANODES_PLUGINS constant.
       # rubocop: disable Style/RaiseArgs
       def setup_required_plugins
         return unless defined? self::REQUIRED_ALPHANODES_PLUGINS

data/lib/redmine_plugin_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedminePluginKit
-  VERSION = '1.0.8'
+  VERSION = '1.0.10'
 end

data/lib/redmine_plugin_kit.rb

@@ -26,6 +26,17 @@ module RedminePluginKit
       !true?(value)
     end
 
+    # Returns plugin settings with indifferent access and the given setting applied.
+    # Redmine stores plugin settings from the settings form this way, too. Without it,
+    # a string key from the command line would be added next to an existing symbol key,
+    # and plugins reading the symbol key would never see the new value.
+    def plugin_settings_with(settings, setting, value)
+      settings = {} unless settings.is_a? Hash
+      settings = settings.with_indifferent_access
+      settings[setting] = value
+      settings
+    end
+
     def textarea_cols(text, min: 8, max: 20)
       [[min, text.to_s.length / 50].max, max].min # rubocop: disable Style/ComparableClamp
     end

data/lib/tasks/redmine_plugin_kit.rake

@@ -46,9 +46,7 @@ namespace :redmine_plugin_kit do
       Setting[setting.to_sym] = value
     else
       plugin_name = :"plugin_#{name}"
-      plugin_settings = Setting[plugin_name]
-      plugin_settings[setting] = value
-      Setting[plugin_name] = plugin_settings
+      Setting[plugin_name] = RedminePluginKit.plugin_settings_with Setting[plugin_name], setting, value
     end
   end
 
@@ -76,7 +74,7 @@ namespace :redmine_plugin_kit do
     else
       plugin_name = :"plugin_#{name}"
       plugin_settings = Setting[plugin_name]
-      puts plugin_settings[setting]
+      puts plugin_settings.with_indifferent_access[setting] if plugin_settings.is_a? Hash
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redmine_plugin_kit
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.10
 platform: ruby
 authors:
 - AlphaNodes
@@ -55,6 +55,7 @@ files:
 - lib/redmine_plugin_kit/plugin_base.rb
 - lib/redmine_plugin_kit/version.rb
 - lib/tasks/redmine_plugin_kit.rake
+- redmine_plugin_kit-1.0.9.gem
 homepage: https://github.com/alphanodes/redmine_plugin_kit
 licenses:
 - GPL-2.0