additional_tags 1.0.2 → 1.0.3

data/config/locales/ru.yml

@@ -1,33 +1,38 @@
 ru:
-  field_tag_list: Tags
-  field_tags: Tags
-  field_issue_tags: Issue tags
-  label_active_issue_tags: "Активировать теги проблем"
-  label_active_wiki_tags: "Активировать вики-теги"
-  label_add_tags: "Добавить теги"
+  field_tag_list: Теги
+  field_tags: Теги
+  field_issue_tags: Теги задач
+  label_active_issue_tags: "Активировать теги задач"
+  label_active_wiki_tags: "Активировать теги вики"
+  label_add_tags: "Добавьте теги"
   label_edit_tags: "Редактировать теги"
-  label_manage_tags: "Управляющие метки"
+  label_manage_tags: "Управление тегами"
   label_merge_selected_tags: "Объединить выбранные теги"
-  label_open_issues_only: "Отображать только открытые вопросы"
-  label_show_with_count: "Отображаемое количество на теге"
-  label_tags_tag: "Tag"
+  label_open_issues_only: "Отображать только открытые задачи"
+  label_show_with_count: "Отображать количество на теге"
+  label_tags_tag: "Тег"
   label_use_colors: "Использовать цвета"
   label_wiki_index_for_tag_html: "Вики-страницы с тегом <em>%{tag}</em>"
   notice_failed_to_add_tags: "Не удалось добавить теги"
   notice_tags_added: "Теги добавлены"
-  permission_add_wiki_tags: "Добавить вики-теги"
-  permission_create_issue_tags: "Добавить теги проблемы"
-  permission_edit_issue_tags: "Редактирование тематических тегов"
-  permission_view_issue_tags: "Отображать проблемные теги"
-  tags_order_by_last_created: "Последний созданный"
-  tags_order_by_count: "Наиболее часто используемый"
+  permission_add_wiki_tags: "Добавление тегов вики"
+  permission_create_issue_tags: "Добавление тегов задач"
+  permission_edit_issue_tags: "Редактирование тегов задач"
+  permission_view_issue_tags: "Просмотр тегов задач"
+  tags_order_by_last_created: "Недавно созданные"
+  tags_order_by_count: "Наиболее часто используемые"
   tags_order_by_name: "Имя"
-  tags_sidebar_cloud: "Cloud"
+  tags_sidebar_cloud: "Облако"
   tags_sidebar_list: "Список"
   tags_sidebar_none: "Нет"
-  tags_sidebar_simple_cloud: "Simple cloud"
-  label_tags_sidebar: "DОтображать теги на боковой панели как"
-  tags_sort_by_count: "Посчитать"
-  tags_sort_by_name: "Имя"
-  label_tags_sort_by: "Сортировать метки по"
-  label_tags_suggestion_order: "Порядок предложения"
+  tags_sidebar_simple_cloud: "Простое облако"
+  label_tags_sidebar: "Способ отображения тегов на боковой панели"
+  tags_sort_by_count: "Количеству"
+  tags_sort_by_name: "Имени"
+  label_tags_sort_by: "Сортировать теги по"
+  label_tags_suggestion_order: "Порядок предложения при вводе"
+  label_with_table_of_values: "С таблицей значений"
+  label_with_chart: "С графиком"
+  label_amount_tags: "Теги Сумма"
+  label_amount_entities_with_tags: "Сумма %{name} с тегами"
+  label_quantity: "Количество"

data/init.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
+require 'additional_tags/plugin_version'
+
+loader = RedminePluginKit::Loader.new plugin_id: 'additional_tags'
+
 Redmine::Plugin.register :additional_tags do
   name        'Additional Tags'
   author      'AlphaNodes GmbH'
   description 'Redmine tagging support'
-  version     AdditionalTags::VERSION
+  version     AdditionalTags::PluginVersion::VERSION
   url         'https://github.com/alphanodes/additional_tags/'
-  author_url 'https://alphanodes.com/'
+  author_url  'https://alphanodes.com/'
   directory __dir__
 
   requires_redmine version_or_higher: '4.1'
 
-  settings default: Additionals.load_settings('additional_tags'),
+  settings default: loader.default_settings,
            partial: 'additional_tags/settings/settings'
 
   project_module :issue_tracking do
@@ -30,6 +34,5 @@ Redmine::Plugin.register :additional_tags do
        caption: :field_tags
 end
 
-Rails.configuration.to_prepare do
-  AdditionalTags.setup
-end
+RedminePluginKit::Loader.persisting { loader.load_model_hooks! }
+RedminePluginKit::Loader.to_prepare { AdditionalTags.setup!(loader) } if Rails.version < '6.0'

data/lib/additional_tags/hooks/model_hook.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module AdditionalTags
+  module Hooks
+    class ModelHook < Redmine::Hook::Listener
+      def after_plugins_loaded(_context = {})
+        return if Rails.version < '6.0'
+
+        AdditionalTags.setup!
+      end
+    end
+  end
+end

data/lib/additional_tags/hooks/view_hook.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module AdditionalTags
+  module Hooks
+    class ViewHook < Redmine::Hook::ViewListener
+      render_on :view_issues_bulk_edit_details_bottom,
+                partial: 'issues/tags_form_details',
+                locals: { tags_form: 'issues/tags_bulk_edit' }
+      render_on :view_issues_context_menu_end, partial: 'context_menus/issues_tags'
+      render_on :view_issues_form_details_bottom,
+                partial: 'issues/tags_form_details',
+                locals: { tags_form: 'issues/tags_form' }
+      render_on :view_issues_show_details_bottom, partial: 'issues/tags'
+      render_on :view_issues_sidebar_planning_bottom, partial: 'issues/tags_sidebar'
+      render_on :view_layouts_base_html_head, partial: 'additional_tags/html_head'
+      render_on :view_wiki_form_bottom, partial: 'tags_form_bottom'
+      render_on :view_wiki_show_bottom, partial: 'tags_show'
+      render_on :view_wiki_show_sidebar_bottom, partial: 'wiki/tags_sidebar'
+
+      def controller_issues_edit_before_save(context = {})
+        tags_journal context[:issue], context[:params]
+      end
+
+      def controller_issues_bulk_edit_before_save(context = {})
+        issue = context[:issue]
+        params = context[:params]
+
+        issues_bulk_tags_fix issue, params
+        tags_journal issue, params
+      end
+
+      # this hook is missing in redmine core at the moment
+      def view_issue_pdf_fields(context = {})
+        issue = context[:issue]
+        right = context[:right]
+
+        if AdditionalTags.setting?(:active_issue_tags) &&
+           User.current.allowed_to?(:view_issue_tags, issue.project)
+          right << [l(:field_tag_list), issue.tag_list]
+        end
+      end
+
+      # this hook is missing in redmine core at the moment
+      def view_wiki_pdf_buttom(context = {})
+        page = context[:page]
+        pdf = context[:pdf]
+
+        return if page.tag_list.blank?
+
+        pdf.ln 5
+        pdf.SetFontStyle 'B', 9
+        pdf.RDMCell 190, 5, l(:field_tag_list), 'B'
+
+        pdf.ln
+        pdf.SetFontStyle '', 8
+        pdf.RDMCell 190, 5, page.tag_list.join(', ')
+        pdf.ln
+      end
+
+      private
+
+      def issues_bulk_tags_fix(issue, params)
+        old_tags = issue.tags.map(&:name)
+        new_tags = Array(params[:issue][:tag_list]).reject(&:empty?)
+        issue.tag_list = (old_tags + new_tags).uniq
+      end
+
+      def tags_journal(issue, params)
+        return unless params && params[:issue] && params[:issue][:tag_list]
+
+        issue.tags_to_journal Issue.find_by(id: issue.id)&.tag_list&.to_s,
+                              issue.tag_list.to_s
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/dashboard_content_patch.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module AdditionalTags
+  module Patches
+    module DashboardContentPatch
+      extend ActiveSupport::Concern
+
+      included do
+        prepend InstanceOverwriteMethods
+      end
+
+      module InstanceOverwriteMethods
+        def block_definitions
+          blocks = super
+
+          blocks['issue_tags'] = {
+            label: l(:field_issue_tags),
+            permission: :view_issue_tags,
+            if: proc { AdditionalTags.setting?(:active_issue_tags) },
+            async: { partial: 'dashboards/blocks/issue_tags' }
+          }
+
+          blocks
+        end
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/issue_patch.rb

@@ -25,8 +25,12 @@ module AdditionalTags
           tags.all? { |tag| allowed_tags.include? tag }
         end
 
-        def by_tags(project, with_subprojects: false)
-          count_and_group_by project: project, association: :tags, with_subprojects: with_subprojects
+        def group_by_status_with_tags(project = nil)
+          Issue.visible(User.current, project: project)
+               .joins(:status)
+               .joins(:tags)
+               .group(:is_closed, 'tag_id')
+               .count
         end
 
         def available_tags(**options)
@@ -67,12 +71,15 @@ module AdditionalTags
           send 'safe_attributes_without_tags=', attrs, user
         end
 
-        def copy_from_with_tags(arg, **options)
-          copy_from_without_tags(arg, **options)
+        # copy_from requires hash for Redmine - works with Ruby 3
+        # rubocop: disable Style/OptionHash
+        def copy_from_with_tags(arg, options = {})
+          copy_from_without_tags arg, options
           issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
           self.tag_list = issue.tag_list
           self
         end
+        # rubocop: enable Style/OptionHash
 
         def tags_to_journal(old_tags, new_tags)
           return if current_journal.blank? || old_tags == new_tags

data/lib/additional_tags/patches/wiki_controller_patch.rb

@@ -31,7 +31,7 @@ module AdditionalTags
           @tag = params[:tag]
           return super unless AdditionalTags.setting?(:active_wiki_tags) && @tag.present?
 
-          @pages = wiki_pages_with_tag @tag, @project
+          @pages = WikiPage.with_tags @tag, project: @project
 
           respond_to do |format|
             format.html do

data/lib/additional_tags/patches/wiki_page_patch.rb

@@ -27,6 +27,49 @@ module AdditionalTags
           options[:permission] = :view_wiki_pages
           AdditionalTags::Tags.available_tags self, **options
         end
+
+        def with_tags(tag, project: nil, order: 'title_asc', max_entries: nil)
+          wiki = project&.wiki
+
+          scope = if wiki
+                    wiki.pages
+                  else
+                    WikiPage.joins wiki: :project
+                  end
+
+          scope = scope.visible User.current, project: project if scope.respond_to? :visible
+          scope = scope.limit max_entries if max_entries
+
+          tags = Array tag
+          tags.map!(&:strip)
+          tags.reject!(&:blank?)
+          return [] if tags.count.zero?
+
+          tags.map!(&:downcase)
+
+          scope = scope.where(id: tagged_with(tags, any: true).ids)
+                       .with_updated_on
+                       .joins(wiki: :project)
+
+          return scope if order.nil?
+
+          sorted = order.split '_'
+          raise 'unsupported sort order' if sorted != 2 && %w[title date].exclude?(sorted.first)
+
+          order_dir = sorted.second == 'desc' ? 'DESC' : 'ASC'
+
+          case sorted.first
+          when 'date'
+            scope.joins(:content)
+                 .reorder("#{WikiContent.table_name}.updated_on #{order_dir}")
+          else
+            if wiki.nil?
+              scope.order "#{Project.table_name}.name, #{WikiPage.table_name}.title #{order_dir}"
+            else
+              scope.includes(:parent).order "#{WikiPage.table_name}.title #{order_dir}"
+            end
+          end
+        end
       end
 
       module InstanceMethods

data/lib/additional_tags/plugin_version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AdditionalTags
+  module PluginVersion
+    VERSION = '1.0.3' unless defined? VERSION
+  end
+end

data/lib/additional_tags.rb

@@ -1,94 +1,84 @@
 # frozen_string_literal: true
 
-require 'additional_tags/version'
-require 'additional_tags/tags'
+require 'redmine_plugin_kit'
+require 'acts-as-taggable-on'
 
 module AdditionalTags
   TAG_TABLE_NAME = 'additional_tags'
   TAGGING_TABLE_NAME = 'additional_taggings'
 
+  include RedminePluginKit::PluginBase
+
   class << self
+    def show_sidebar_tags?
+      setting(:tags_sidebar).present? && setting(:tags_sidebar) != 'none'
+    end
+
+    private
+
     def setup
-      raise 'Please install additionals plugin (https://github.com/alphanodes/additionals)' unless Redmine::Plugin.installed? 'additionals'
+      # TODO: this check does not work with Rails 6 at the moment
+      # reason: ActiveSupport.on_load(:active_record) is used for setup
+      # as temp solution
+      if Rails.version < '6.0' && !Redmine::Plugin.installed?('additionals')
+        raise 'Please install additionals plugin (https://github.com/alphanodes/additionals)'
+      end
 
-      Additionals.incompatible_plugins(%w[redmine_tags
-                                          redmine_tagging
-                                          redmineup_tags], 'additional_tags')
+      loader.incompatible? %w[redmine_tags
+                              redmine_tagging
+                              redmineup_tags]
 
       # Patches
-      AutoCompletesController.include AdditionalTags::Patches::AutoCompletesControllerPatch
-      CalendarsController.include AdditionalTags::Patches::CalendarsControllerPatch
-      DashboardsController.include AdditionalTags::Patches::DashboardsControllerPatch
-      DashboardAsyncBlocksController.include AdditionalTags::Patches::DashboardAsyncBlocksControllerPatch
-      GanttsController.include AdditionalTags::Patches::GanttsControllerPatch
-      MyController.include AdditionalTags::Patches::MyControllerPatch
-      Issue.include AdditionalTags::Patches::IssuePatch
-      Journal.include AdditionalTags::Patches::JournalPatch
-      Query.include AdditionalTags::Patches::QueryPatch
-      IssuesController.include AdditionalTags::Patches::IssuesControllerPatch
-      ImportsController.include AdditionalTags::Patches::ImportsControllerPatch
-      QueriesHelper.include AdditionalTags::Patches::QueriesHelperPatch
-      ReportsController.include AdditionalTags::Patches::ReportsControllerPatch
-      SettingsController.include AdditionalTags::Patches::SettingsControllerPatch
-      Redmine::Helpers::TimeReport.include AdditionalTags::Patches::TimeReportPatch
-      TimeEntry.include AdditionalTags::Patches::TimeEntryPatch
-      TimelogController.include AdditionalTags::Patches::TimelogControllerPatch
-      WikiController.include AdditionalTags::Patches::WikiControllerPatch
-      WikiPage.include AdditionalTags::Patches::WikiPagePatch
+      loader.add_patch %w[AutoCompletesController
+                          CalendarsController
+                          DashboardsController
+                          DashboardAsyncBlocksController
+                          GanttsController
+                          MyController
+                          Issue
+                          DashboardContent
+                          Journal
+                          Query
+                          IssuesController
+                          ImportsController
+                          QueriesHelper
+                          SettingsController
+                          TimeEntry
+                          TimelogController
+                          WikiController
+                          WikiPage]
+
+      loader.add_patch({ target: Redmine::Helpers::TimeReport,
+                         patch: 'TimeReport' })
 
       # because of this bug: https://www.redmine.org/issues/33290
-      if Additionals.redmine_database_ready? TAG_TABLE_NAME
-        IssueQuery.include AdditionalTags::Patches::IssueQueryPatch
-        TimeEntryQuery.include AdditionalTags::Patches::TimeEntryQueryPatch
+      if RedminePluginKit::Loader.redmine_database_ready? TAG_TABLE_NAME
+        loader.add_patch %w[IssueQuery TimeEntryQuery]
 
         if Redmine::Plugin.installed? 'redmine_agile'
-          AgileQuery.include AdditionalTags::Patches::AgileQueryPatch
-          AgileBoardsController.include AdditionalTags::Patches::AgileBoardsControllerPatch
-          if AGILE_VERSION_TYPE == 'PRO version'
-            AgileVersionsController.include AdditionalTags::Patches::AgileVersionsControllerPatch
-            AgileVersionsQuery.include AdditionalTags::Patches::AgileVersionsQueryPatch
-          end
+          loader.add_patch %w[AgileQuery AgileBoardsController]
+          loader.add_patch %w[AgileVersionsController AgileVersionsQuery] if AGILE_VERSION_TYPE == 'PRO version'
         end
       end
 
-      # Hooks
-      require_dependency 'additional_tags/hooks'
-    end
-
-    # support with default setting as fall back
-    def setting(value)
-      if settings.key? value
-        settings[value]
-      else
-        Additionals.load_settings('additional_tags')[value]
-      end
-    end
-
-    def setting?(value)
-      Additionals.true? settings[value]
-    end
-
-    def show_sidebar_tags?
-      setting(:tags_sidebar).present? && setting(:tags_sidebar) != 'none'
-    end
-
-    private
+      # Apply patches and helper
+      loader.apply!
 
-    def settings
-      Setting[:plugin_additional_tags]
+      # Load view hooks
+      loader.load_view_hooks!
     end
   end
 
   # Run the classic redmine plugin initializer after rails boot
   class Plugin < ::Rails::Engine
-    require 'acts-as-taggable-on'
+    require 'additional_tags/tags'
 
     ActsAsTaggableOn.tags_table = TAG_TABLE_NAME
     ActsAsTaggableOn.taggings_table = TAGGING_TABLE_NAME
 
     config.after_initialize do
       # engine_name could be used (additional_tags_plugin), but can
-      # create some side effencts
+      # create some side effects
       plugin_id = 'additional_tags'
 
       # if plugin is already in plugins directory, use this and leave here
@@ -96,7 +86,7 @@ module AdditionalTags
 
       # gem is used as redmine plugin
       require File.expand_path '../init', __dir__
-      AdditionalTags.setup
+      AdditionalTags.setup!
       Additionals::Gemify.install_assets plugin_id
       Additionals::Gemify.create_plugin_hint plugin_id
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: additional_tags
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - AlphaNodes
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-22 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts-as-taggable-on
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: redmine_plugin_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,8 @@ files:
 - app/views/additional_tags/settings/_settings.html.slim
 - app/views/auto_completes/_additional_tag_list.slim
 - app/views/context_menus/_issues_tags.html.slim
+- app/views/dashboards/blocks/_issue_tags.html.slim
+- app/views/dashboards/blocks/_issue_tags_settings.html.slim
 - app/views/issue_tags/_edit_modal.html.slim
 - app/views/issue_tags/edit.js.erb
 - app/views/issues/_tags.html.slim
@@ -98,7 +114,6 @@ files:
 - app/views/issues/_tags_form.html.slim
 - app/views/issues/_tags_form_details.html.slim
 - app/views/issues/_tags_sidebar.html.slim
-- app/views/reports/_tags_simple.html.slim
 - app/views/wiki/_tags_form.html.slim
 - app/views/wiki/_tags_form_bottom.html.slim
 - app/views/wiki/_tags_show.html.slim
@@ -106,6 +121,7 @@ files:
 - app/views/wiki/tag_index.html.slim
 - assets/javascripts/tags.js
 - assets/stylesheets/tags.css
+- config/initializers/zeitwerk.rb
 - config/locales/bg.yml
 - config/locales/cs.yml
 - config/locales/de.yml
@@ -126,7 +142,8 @@ files:
 - doc/images/additional-tags.gif
 - init.rb
 - lib/additional_tags.rb
-- lib/additional_tags/hooks.rb
+- lib/additional_tags/hooks/model_hook.rb
+- lib/additional_tags/hooks/view_hook.rb
 - lib/additional_tags/patches/agile_boards_controller_patch.rb
 - lib/additional_tags/patches/agile_query_patch.rb
 - lib/additional_tags/patches/agile_versions_controller_patch.rb
@@ -134,6 +151,7 @@ files:
 - lib/additional_tags/patches/auto_completes_controller_patch.rb
 - lib/additional_tags/patches/calendars_controller_patch.rb
 - lib/additional_tags/patches/dashboard_async_blocks_controller_patch.rb
+- lib/additional_tags/patches/dashboard_content_patch.rb
 - lib/additional_tags/patches/dashboards_controller_patch.rb
 - lib/additional_tags/patches/gantts_controller_patch.rb
 - lib/additional_tags/patches/imports_controller_patch.rb
@@ -144,7 +162,6 @@ files:
 - lib/additional_tags/patches/my_controller_patch.rb
 - lib/additional_tags/patches/queries_helper_patch.rb
 - lib/additional_tags/patches/query_patch.rb
-- lib/additional_tags/patches/reports_controller_patch.rb
 - lib/additional_tags/patches/settings_controller_patch.rb
 - lib/additional_tags/patches/time_entry_patch.rb
 - lib/additional_tags/patches/time_entry_query_patch.rb
@@ -152,12 +169,13 @@ files:
 - lib/additional_tags/patches/timelog_controller_patch.rb
 - lib/additional_tags/patches/wiki_controller_patch.rb
 - lib/additional_tags/patches/wiki_page_patch.rb
+- lib/additional_tags/plugin_version.rb
 - lib/additional_tags/tags.rb
-- lib/additional_tags/version.rb
 homepage: https://github.com/alphanodes/additional_tags
 licenses:
 - GPL-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -166,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/app/views/reports/_tags_simple.html.slim

@@ -1,11 +0,0 @@
-- if AdditionalTags.setting?(:active_issue_tags) && User.current.allowed_to?(:view_issue_tags, @project)
-  h3
-    = l :field_tags
-    |  
-    = link_to l(:label_details),
-              project_issues_report_details_path(@project, detail: 'tag'),
-              class: 'icon-only icon-zoom-in',
-              title: l(:label_details)
-
-  = render partial: 'simple',
-           locals: { data: @issues_by_tags, field_name: 'tag_id', rows: @tags }