redmine_plugins_helper 0.12.2 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b11be7658944fad863cbae11f781f91add85990656cf9a6b02a269cd2edf75e
-  data.tar.gz: 4ff94b0da6a7ca8cdb7f25b37da49c5229b853bd0a221ac7315a276404bfac2e
+  metadata.gz: aaaaeded613ef8e1008c1132a077516083ccb224dd6c3e14762ec6b9ce57cd4f
+  data.tar.gz: d554fd7dd558929f38e0c8c57b5bdfdcbc2e12dc903610b2477e30fe6e6b9e62
 SHA512:
-  metadata.gz: 53951f0c50e341532893f0162bdb4ae885501be99cc7b9684ace05d9e1e4c0a084fd0ef53cca676528b8ba35d94d905db8f6c42b4f67f202c272be1980573073
-  data.tar.gz: 9e5acf5b10a84f02dab26de5e417c57b1773ed63fc3eaeb8b82ab946884f9ce43c492102a3cebd3e20148ddea2cd157281f1d78ae20122506859a059b3932594
+  metadata.gz: dbed1ae45933b914612c964b232e8bd3ad15a5514b60fca9e2030ba9531e11fa9fa0dbe53acadaa7f8a3c005d1c723bf401f5167227da0af4e979c89379418ec
+  data.tar.gz: 41b1c4b5899809adb2c2270ec6ff2f1c147197b9d3e278d9745997cfc837aed2b116765b2395229ffa615ed66f23751aae8d8e956cd417d660099042be286943

data/init.rb

@@ -14,6 +14,6 @@ end
 Rails.configuration.to_prepare do
   require_dependency 'redmine_plugins_helper/patches/redmine/plugin_patch'
   require_dependency 'redmine_plugins_helper/patches/redmine/plugin_migration_context'
-  ::Redmine::Plugin.registered_plugins.values.each(&:add_assets_paths)
-  ::Redmine::Plugin.registered_plugins.values.each(&:load_initializers)
+  ::Redmine::Plugin.all.each(&:add_assets_paths)
+  ::Redmine::Plugin.all.each(&:load_initializers)
 end

data/lib/redmine_plugins_helper/migrate.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
+require 'eac_ruby_utils/core_ext'
+
 module RedminePluginsHelper
   class Migrate
-    attr_reader :plugin_name, :migration_version
-
-    def initialize(plugin_name, migration_version)
-      @plugin_name = plugin_name
-      @migration_version = migration_version
+    common_constructor :plugin_name, :migration_version do
       run
     end
 
@@ -21,41 +19,21 @@ module RedminePluginsHelper
     end
 
     def run_all
-      versions_sorted.each do |v|
-        migrate_plugin_version(v)
-      end
+      versions_sorted.each(&:apply)
     end
 
     def run_version
       ::Redmine::Plugin.migrate(plugin_name, migration_version)
     end
 
-    def migrate_plugin_version(version)
-      return if migrated?(version)
-
-      ::Redmine::Plugin.registered_plugins[version[:plugin]].migrate(version[:timestamp])
-    end
-
+    # @return [Enumerable<RedminePluginsHelper::Migration>]
     def versions_sorted
-      versions.sort_by { |e| [e[:timestamp]] }
+      versions.sort
     end
 
+    # @return [Enumerable<RedminePluginsHelper::Migration>]
     def versions
-      r = []
-      ::RedminePluginsHelper::Migrations.local_versions.each do |plugin, ts|
-        ts.each { |t| r << { plugin: plugin, timestamp: t } }
-      end
-      r
-    end
-
-    def migrated?(version)
-      return false unless db_versions.key?(version[:plugin])
-
-      db_versions[version[:plugin]].include?(version[:timestamp])
-    end
-
-    def db_versions
-      @db_versions ||= ::RedminePluginsHelper::Migrations.db_versions
+      ::RedminePluginsHelper::Migration.from_code.select(&:plugin?)
     end
   end
 end

data/lib/redmine_plugins_helper/migration.rb

@@ -10,6 +10,19 @@ module RedminePluginsHelper
       self.plugin_id = plugin_id.to_sym
       self.version = version.to_i
     end
+    compare_by :version, :plugin_id
+
+    # @return [void]
+    def apply
+      return if applied?
+
+      nyi unless plugin?
+
+      ::Redmine::Plugin::Migrator.current_plugin = plugin
+      ::Redmine::Plugin::MigrationContext.new(plugin.migration_directory).up do |m|
+        m.version == version
+      end
+    end
 
     # @return [Boolean]
     def applied?
@@ -27,6 +40,11 @@ module RedminePluginsHelper
       plugin_id == PLUGIN_ID_CORE_VALUE
     end
 
+    # @return [Redmine::Plugin]
+    def plugin
+      plugin? ? ::Redmine::Plugin.find(plugin_id) : nil
+    end
+
     # @return [Boolean]
     def plugin?
       !core?

data/lib/redmine_plugins_helper/patches/redmine/plugin_patch/assets.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module RedminePluginsHelper
+  module Patches
+    module Redmine
+      module PluginPatch
+        module Assets
+          common_concern
+
+          ASSETS_SUBDIRS = %w[stylesheets javascripts images].freeze
+
+          ASSETS_SUBDIRS.each do |assert_subdir|
+            class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+            def #{assert_subdir}_directory
+              ::File.join(directory, 'app', 'assets', '#{assert_subdir}')
+            end
+            RUBY_EVAL
+          end
+
+          def add_assets_paths
+            ASSETS_SUBDIRS.each do |assert_subdir|
+              assets_directory = send("#{assert_subdir}_directory")
+              next unless ::File.directory?(assets_directory)
+
+              Rails.application.config.assets.paths << assets_directory
+            end
+          end
+
+          def main_javascript_asset_path
+            find_asset(javascripts_directory, %w[js coffee js.coffee])
+          end
+
+          def main_stylesheet_asset_path
+            find_asset(stylesheets_directory, %w[css scss])
+          end
+
+          private
+
+          def find_asset(assets_directory, extensions)
+            extensions.each do |extension|
+              ['', '.erb'].each do |erb_extension|
+                path = ::File.join(assets_directory, "#{id}.#{extension}#{erb_extension}")
+                return id if ::File.exist?(path)
+              end
+            end
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redmine_plugins_helper/patches/redmine/plugin_patch/dependencies.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module RedminePluginsHelper
+  module Patches
+    module Redmine
+      module PluginPatch
+        module Dependencies
+          common_concern
+
+          DEPENDENCIES_FILE_BASENAMES = %w[yml yaml].map { |e| "dependencies.#{e}" }
+
+          # @param other [Redmine::Plugin]
+          # @return [Integer]
+          def <=>(other)
+            so = dependency?(other)
+            os = other.dependency?(self)
+
+            return 1 if so && !os
+            return -1 if !so && os
+
+            super
+          end
+
+          # @return [Array<Symbol>]
+          def dependencies_ids
+            load_dependencies_from_file
+            dependencies_hash.keys
+          end
+
+          # @param other [Redmine::Plugin]
+          # @return [Boolean]
+          def dependency?(other)
+            load_dependencies_from_file
+            recursive_dependencies_ids.include?(other.id)
+          end
+
+          # @param plugin_name [Symbol]
+          # @param arg [Hash, String]
+          # @return [Boolean]
+          def requires_redmine_plugin(plugin_name, arg)
+            r = super
+            dependencies_hash[plugin_name.to_sym] = arg
+            r
+          end
+
+          private
+
+          # @return [Hash<Symbol, Object>]
+          def dependencies_hash
+            @dependencies_hash ||= {}
+          end
+
+          # @return [Hash<Symbol, Object>]
+          def dependencies_from_file
+            r = dependencies_file.if_present({}) { |path| ::EacRubyUtils::Yaml.load_file(path) }
+            r = r.map do |plugin_name, arg|
+              [plugin_name.to_sym, (arg.is_a?(::Hash) ? arg.symbolize_keys : arg)]
+            end
+            r.to_h
+          end
+
+          # @return [Pathname, nil]
+          def dependencies_file
+            DEPENDENCIES_FILE_BASENAMES
+              .lazy
+              .map { |b| directory.to_pathname.join(b) }.select(&:file?).first
+          end
+
+          # @return [void]
+          def load_dependencies_from_file
+            return if @dependencies_from_file_loaded
+
+            dependencies_from_file
+              .each { |plugin_name, arg| requires_redmine_plugin(plugin_name, arg) }
+            @dependencies_from_file_loaded = true
+          end
+
+          # @return [Set<Symbol>]
+          def recursive_dependencies_ids
+            ::EacRubyUtils::RecursiveBuilder
+              .new(id) { |plugin_id| ::Redmine::Plugin.find(plugin_id).dependencies_ids }.result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redmine_plugins_helper/patches/redmine/plugin_patch/initializers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module RedminePluginsHelper
+  module Patches
+    module Redmine
+      module PluginPatch
+        module Initializers
+          def load_initializers
+            Dir["#{initializers_directory}/*.rb"].sort.each { |f| require f }
+          end
+
+          private
+
+          def initializers_directory
+            File.join(directory, 'config', 'initializers')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redmine_plugins_helper/patches/redmine/plugin_patch.rb

@@ -11,10 +11,11 @@ module RedminePluginsHelper
         included do
           extend ClassMethods
           include InstanceMethods
+          include ::RedminePluginsHelper::Patches::Redmine::PluginPatch::Assets
+          prepend ::RedminePluginsHelper::Patches::Redmine::PluginPatch::Dependencies
+          include ::RedminePluginsHelper::Patches::Redmine::PluginPatch::Initializers
         end
 
-        ASSETS_SUBDIRS = %w[stylesheets javascripts images].freeze
-
         module ClassMethods
           def by_path(path)
             plugin_id_from_path(path).if_present do |v|
@@ -39,53 +40,6 @@ module RedminePluginsHelper
             plugin.instance_eval(&block)
           end
         end
-
-        module InstanceMethods
-          def load_initializers
-            Dir["#{initializers_directory}/*.rb"].sort.each { |f| require f }
-          end
-
-          ASSETS_SUBDIRS.each do |assert_subdir|
-            class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-            def #{assert_subdir}_directory
-              ::File.join(directory, 'app', 'assets', '#{assert_subdir}')
-            end
-            RUBY_EVAL
-          end
-
-          def add_assets_paths
-            ASSETS_SUBDIRS.each do |assert_subdir|
-              assets_directory = send("#{assert_subdir}_directory")
-              next unless ::File.directory?(assets_directory)
-
-              Rails.application.config.assets.paths << assets_directory
-            end
-          end
-
-          def main_javascript_asset_path
-            find_asset(javascripts_directory, %w[js coffee js.coffee])
-          end
-
-          def main_stylesheet_asset_path
-            find_asset(stylesheets_directory, %w[css scss])
-          end
-
-          private
-
-          def initializers_directory
-            File.join(directory, 'config', 'initializers')
-          end
-
-          def find_asset(assets_directory, extensions)
-            extensions.each do |extension|
-              ['', '.erb'].each do |erb_extension|
-                path = ::File.join(assets_directory, "#{id}.#{extension}#{erb_extension}")
-                return id if ::File.exist?(path)
-              end
-            end
-            nil
-          end
-        end
       end
     end
   end

data/lib/redmine_plugins_helper/test_tasks/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module RedminePluginsHelper
+  module TestTasks
+    class Base
+      acts_as_abstract :register
+      DEFAULT_TASK_NAME_LAST_PART = 'test'
+      PREPARE_TASK_NAME = 'db:test:prepare'
+
+      class << self
+        def register(plugin_id, task_name_last_part = DEFAULT_TASK_NAME_LAST_PART)
+          new(plugin_id, task_name_last_part).register
+        end
+      end
+
+      common_constructor :plugin_id, :task_name_last_part
+
+      # @return [Pathname]
+      def plugin_root
+        ::Rails.root.join('plugins', plugin_id.to_s)
+      end
+
+      # @return [String]
+      def prepare_task_name
+        PREPARE_TASK_NAME
+      end
+
+      # @return [String]
+      def task_full_name
+        "#{plugin_id}:#{task_name_last_part}"
+      end
+    end
+  end
+end

data/lib/redmine_plugins_helper/test_tasks/minitest.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'redmine_plugins_helper/test_tasks/base'
+require 'rake/testtask'
+
+module RedminePluginsHelper
+  module TestTasks
+    class Minitest < ::RedminePluginsHelper::TestTasks::Base
+      def register
+        ::Rake::TestTask.new(task_full_name => 'db:test:prepare') do |t|
+          t.description = "Run plugin #{plugin_id}\'s tests."
+          t.libs << 'test'
+          t.test_files = ::FileList["#{plugin_root}/test/**/*_test.rb"]
+          t.verbose = false
+          t.warning = false
+        end
+      end
+    end
+  end
+end

data/lib/redmine_plugins_helper/test_tasks/rspec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'redmine_plugins_helper/test_tasks/base'
+require 'rspec/core/rake_task'
+
+module RedminePluginsHelper
+  module TestTasks
+    class Rspec < ::RedminePluginsHelper::TestTasks::Base
+      def register
+        ::RSpec::Core::RakeTask.new(task_full_name) do |t|
+          t.rspec_opts = ::Shellwords.join(rspec_opts)
+        end
+        ::Rake::Task[task_full_name].enhance [prepare_task_name]
+      end
+
+      def rspec_opts
+        ['--pattern', plugin_root.join('spec/**/*_spec.rb'),
+         '--default-path', 'plugins/redmine_plugins_helper/spec',
+         '--require', 'spec_helper']
+      end
+    end
+  end
+end

data/lib/redmine_plugins_helper/version.rb

@@ -3,5 +3,5 @@
 module RedminePluginsHelper
   AUTHOR = 'Eduardo Henrique Bogoni'
   SUMMARY = 'Helper for Redmine plugins'
-  VERSION = '0.12.2'
+  VERSION = '0.13.1'
 end

data/lib/tasks/redmine_plugins_helper.rake

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require 'redmine_plugins_helper/plugin_rake_task'
-::RedminePluginsHelper::PluginRakeTask.register(:redmine_plugins_helper, :test)
+require 'redmine_plugins_helper/test_tasks/rspec'
+::RedminePluginsHelper::TestTasks::Rspec.register(:redmine_plugins_helper, :test)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_plugins_helper
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.1
 platform: ruby
 authors:
-- 0.12.2
+- 0.13.1
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.95'
+        version: '0.119'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.95.1
+        version: 0.119.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.95'
+        version: '0.119'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.95.1
+        version: 0.119.2
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -124,12 +124,17 @@ files:
 - lib/redmine_plugins_helper/migrations.rb
 - lib/redmine_plugins_helper/patches/redmine/plugin_migration_context.rb
 - lib/redmine_plugins_helper/patches/redmine/plugin_patch.rb
+- lib/redmine_plugins_helper/patches/redmine/plugin_patch/assets.rb
+- lib/redmine_plugins_helper/patches/redmine/plugin_patch/dependencies.rb
+- lib/redmine_plugins_helper/patches/redmine/plugin_patch/initializers.rb
 - lib/redmine_plugins_helper/patches/test_case_patch.rb
-- lib/redmine_plugins_helper/plugin_rake_task.rb
 - lib/redmine_plugins_helper/settings.rb
 - lib/redmine_plugins_helper/status_migrations.rb
 - lib/redmine_plugins_helper/test_config.rb
 - lib/redmine_plugins_helper/test_helper.rb
+- lib/redmine_plugins_helper/test_tasks/base.rb
+- lib/redmine_plugins_helper/test_tasks/minitest.rb
+- lib/redmine_plugins_helper/test_tasks/rspec.rb
 - lib/redmine_plugins_helper/version.rb
 - lib/tasks/redmine.rake
 - lib/tasks/redmine_plugins_helper.rake

data/lib/redmine_plugins_helper/plugin_rake_task.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-require 'rspec/core/rake_task'
-require 'shellwords'
-
-module RedminePluginsHelper
-  class PluginRakeTask
-    DEFAULT_TASK_NAME_LAST_PART = 'rspec'
-
-    class << self
-      def register(plugin_id, task_name_last_part = DEFAULT_TASK_NAME_LAST_PART)
-        new(plugin_id, task_name_last_part).register
-      end
-    end
-
-    common_constructor :plugin_id, :task_name_last_part
-
-    def register
-      ::RSpec::Core::RakeTask.new(task_full_name) do |t|
-        t.rspec_opts = ::Shellwords.join(rspec_opts)
-      end
-      Rake::Task[task_full_name].enhance ['db:test:prepare']
-    end
-
-    def task_full_name
-      "#{plugin_id}:#{task_name_last_part}"
-    end
-
-    def rspec_opts
-      ['--pattern', "plugins/#{plugin_id}/spec/**/*_spec.rb",
-       '--default-path', 'plugins/redmine_plugins_helper/spec',
-       '--require', 'spec_helper']
-    end
-  end
-end