additional_tags 1.0.1 → 1.0.4

data/lib/additional_tags.rb

@@ -1,104 +1,83 @@
-require 'additional_tags/version'
-require 'additional_tags/tags'
+# frozen_string_literal: true
+
+require 'redmine_plugin_kit'
+require 'acts-as-taggable-on'
 
 module AdditionalTags
-  TAG_TABLE_NAME = 'additional_tags'.freeze
-  TAGGING_TABLE_NAME = 'additional_taggings'.freeze
+  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'
 
-      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
-      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
-
-    def sql_for_tags_field(klass, operator, values)
-      compare = ['=', '*'].include?(operator) ? 'IN' : 'NOT IN'
-
-      case operator
-      when '=', '!'
-        ids_list = klass.tagged_with(values, any: true).pluck :id
-        "(#{klass.table_name}.id #{compare} (#{ids_list.join ','}))" if ids_list.present?
-      else
-        entries = ActsAsTaggableOn::Tagging.where taggable_type: klass.name
-        "(#{klass.table_name}.id #{compare} (#{entries.select(:taggable_id).to_sql}))"
-      end
-    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
+    # NOTE: remove_unused_tags cannot be used, because tag is deleted before assign for tagging
+    # @see https://github.com/mbleigh/acts-as-taggable-on/issues/946
+    # NOTE2: merging tags is not compatible, too.
+    ActsAsTaggableOn.remove_unused_tags = false
 
     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
@@ -106,7 +85,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

data/lib/tasks/additional_tags.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+namespace :redmine do
+  namespace :additional_tags do
+    desc <<-DESCRIPTION
+    Remove unused tags.
+
+    Example:
+      bundle exec rake redmine:additional_tags:remove_unused_tags RAILS_ENV=production
+    DESCRIPTION
+    task remove_unused_tags: :environment do
+      AdditionalTags::Tags.remove_unused_tags
+
+      puts 'Unused tags has been removed.'
+      exit 0
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: additional_tags
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - AlphaNodes
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-10 00:00:00.000000000 Z
+date: 2022-03-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
@@ -60,7 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".eslintrc.yml"
-- ".github/workflows/brakeman.yml"
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/linters.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
@@ -80,6 +94,8 @@ files:
 - app/jobs/additional_tags_remove_unused_tag_job.rb
 - app/models/migrate_tag.rb
 - app/models/migrate_tagging.rb
+- app/models/query_tags_column.rb
+- app/views/additional_tags/_body_bottom.html.slim
 - app/views/additional_tags/_html_head.html.slim
 - app/views/additional_tags/_tag_list.html.slim
 - app/views/additional_tags/context_menu.html.slim
@@ -89,7 +105,10 @@ files:
 - app/views/additional_tags/settings/_manage_tags.html.slim
 - app/views/additional_tags/settings/_settings.html.slim
 - app/views/auto_completes/_additional_tag_list.slim
+- app/views/common/_tag_summary_block.html.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
@@ -97,7 +116,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
@@ -105,6 +123,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
@@ -125,7 +144,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
@@ -133,6 +153,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
@@ -142,7 +163,7 @@ files:
 - lib/additional_tags/patches/journal_patch.rb
 - lib/additional_tags/patches/my_controller_patch.rb
 - lib/additional_tags/patches/queries_helper_patch.rb
-- lib/additional_tags/patches/reports_controller_patch.rb
+- lib/additional_tags/patches/query_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
@@ -150,12 +171,14 @@ 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
+- lib/tasks/additional_tags.rake
 homepage: https://github.com/alphanodes/additional_tags
 licenses:
 - GPL-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -164,7 +187,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/.github/workflows/brakeman.yml

@@ -1,33 +0,0 @@
-name: Run Brakeman
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Install package dependencies
-      run: >
-        sudo apt-get install --yes --quiet pandoc
-
-    - name: Setup Gemfile
-      run: |
-        cp test/support/gemfile.rb Gemfile
-
-    - name: Setup Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.6
-        bundler-cache: true
-
-    - name: Setup gems
-      run: |
-        bundle install --jobs 4 --retry 3
-
-    - name: Run Brakeman
-      run: |
-        bundle exec brakeman -5

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 }

data/lib/additional_tags/hooks.rb

@@ -1,73 +0,0 @@
-module AdditionalTags
-  class AdditionalTagsHookListener < 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_reports_issue_report_split_content_right, partial: 'tags_simple'
-    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

data/lib/additional_tags/patches/reports_controller_patch.rb

@@ -1,32 +0,0 @@
-module AdditionalTags
-  module Patches
-    module ReportsControllerPatch
-      extend ActiveSupport::Concern
-
-      included do
-        prepend InstanceOverwriteMethods
-      end
-
-      module InstanceOverwriteMethods
-        def issue_report
-          @tags = AdditionalTags::Tags.sort_tag_list Issue.available_tags(project_id: @project.id)
-          @issues_by_tags = Issue.by_tags @project, with_subprojects: Setting.display_subprojects_issues?
-          super
-        end
-
-        def issue_report_details
-          if params[:detail] == 'tag' &&
-             AdditionalTags.setting?(:active_issue_tags) &&
-             User.current.allowed_to?(:view_issue_tags, @project)
-            @field = 'tag_id'
-            @rows = AdditionalTags::Tags.sort_tag_list Issue.available_tags(project_id: @project.id)
-            @data = Issue.by_tags @project, with_subprojects: Setting.display_subprojects_issues?
-            @report_title = l :field_tags
-          else
-            super
-          end
-        end
-      end
-    end
-  end
-end

data/lib/additional_tags/version.rb

@@ -1,3 +0,0 @@
-module AdditionalTags
-  VERSION = '1.0.1'.freeze unless defined? VERSION
-end