additional_tags 1.0.0

data/db/migrate/20201116145429_acts_as_taggable_migration.rb

@@ -0,0 +1,40 @@
+class ActsAsTaggableMigration < ActiveRecord::Migration[5.2]
+  def up
+    create_table ActsAsTaggableOn.tags_table do |t|
+      t.string :name, index: { unique: true }
+      t.integer :taggings_count, default: 0
+      t.timestamps
+    end
+
+    create_table ActsAsTaggableOn.taggings_table do |t|
+      t.references :tag, foreign_key: { to_table: ActsAsTaggableOn.tags_table }, index: false
+
+      # You should make sure that the column created is
+      # long enough to store the required class names.
+      t.references :taggable, polymorphic: true
+      t.references :tagger, polymorphic: true
+
+      # Limit is created to prevent MySQL error on index
+      # length for MyISAM table type: http://bit.ly/vgW2Ql
+      t.string :context, limit: 128
+
+      t.datetime :created_at
+
+      t.index %i[tag_id taggable_id taggable_type context tagger_id tagger_type], unique: true, name: 'ataggings_idx'
+      t.index %i[taggable_id taggable_type context], name: 'ataggings_taggable_context_idx'
+      t.index :taggable_type
+      t.index :context
+      t.index %i[tagger_id tagger_type]
+      t.index %i[taggable_id taggable_type tagger_id context], name: 'ataggings_idy'
+    end
+
+    return unless ActsAsTaggableOn::Utils.using_mysql?
+
+    execute("ALTER TABLE #{ActsAsTaggableOn.tags_table} MODIFY name varchar(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;")
+  end
+
+  def down
+    drop_table ActsAsTaggableOn.taggings_table
+    drop_table ActsAsTaggableOn.tags_table
+  end
+end

data/db/migrate/20201123093214_migrate_existing_tags.rb

@@ -0,0 +1,39 @@
+class MigrateExistingTags < ActiveRecord::Migration[5.2]
+  def up
+    return unless table_exists?(MigrateTag.table_name) && table_exists?(MigrateTagging.table_name)
+
+    excluded_taggable_types = %w[Question Contact DriveEntry]
+
+    MigrateTag.all.each do |old_tag|
+      ActsAsTaggableOn::Tagging.transaction do
+        tag = ActsAsTaggableOn::Tag.find_by name: old_tag.name
+        cnt = 0
+        old_tag.migrate_taggings.each do |tagging|
+          next if excluded_taggable_types.include? tagging.taggable_type
+
+          tag = ActsAsTaggableOn::Tag.create!(name: old_tag.name) if cnt.zero? && tag.nil?
+          context = tagging.respond_to?('context') && tagging.context.present? ? tagging.context : 'tags'
+
+          # old data can include dups
+          next if ActsAsTaggableOn::Tagging.exists? tag_id: tag.id,
+                                                    taggable_id: tagging.taggable_id,
+                                                    taggable_type: tagging.taggable_type,
+                                                    context: context
+
+          ActsAsTaggableOn::Tagging.create! tag_id: tag.id,
+                                            taggable_id: tagging.taggable_id,
+                                            taggable_type: tagging.taggable_type,
+                                            context: context,
+                                            created_at: tagging.created_at
+          cnt += 1
+        end
+
+        ActsAsTaggableOn::Tag.reset_counters(tag.id, :taggings) unless tag.nil?
+      end
+    end
+  end
+
+  def down
+    # to nothing
+  end
+end

data/init.rb

@@ -0,0 +1,31 @@
+Redmine::Plugin.register :additional_tags do
+  name        'Additional Tags'
+  author      'AlphaNodes GmbH'
+  description 'Redmine tagging support'
+  version     AdditionalTags::VERSION
+  url         'https://github.com/alphanodes/additional_tags/'
+  author_url 'https://alphanodes.com/'
+  directory __dir__
+
+  requires_redmine version_or_higher: '4.1'
+
+  settings default: Additionals.load_settings('additional_tags'),
+           partial: 'additional_tags/settings/settings'
+
+  project_module :issue_tracking do
+    permission :create_issue_tags, {}
+    permission :edit_issue_tags, {}
+    permission :view_issue_tags, {}, read: true
+  end
+
+  project_module :wiki do
+    permission :add_wiki_tags, wiki: %i[update_tags]
+  end
+
+  menu :admin_menu,
+       :tags, { controller: 'settings', action: 'plugin', id: 'additional_tags' }, caption: :field_tags
+end
+
+Rails.configuration.to_prepare do
+  AdditionalTags.setup
+end

data/lib/additional_tags.rb

@@ -0,0 +1,107 @@
+require 'additional_tags/version'
+require 'additional_tags/tags'
+
+module AdditionalTags
+  TAG_TABLE_NAME = 'additional_tags'.freeze
+  TAGGING_TABLE_NAME = 'additional_taggings'.freeze
+
+  class << self
+    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')
+
+      # 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
+
+      # 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 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
+        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, value)
+      compare   = operator.eql?('=') ? 'IN' : 'NOT IN'
+      ids_list  = klass.tagged_with(value).map(&:id).push(0).join(',')
+      "(#{klass.table_name}.id #{compare} (#{ids_list})) "
+    end
+
+    private
+
+    def settings
+      Setting[:plugin_additional_tags]
+    end
+  end
+
+  # Run the classic redmine plugin initializer after rails boot
+  class Plugin < ::Rails::Engine
+    require 'acts-as-taggable-on'
+
+    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
+      plugin_id = 'additional_tags'
+
+      # if plugin is already in plugins directory, use this and leave here
+      next if Redmine::Plugin.installed? plugin_id
+
+      # gem is used as redmine plugin
+      require File.expand_path '../init', __dir__
+      AdditionalTags.setup
+      Additionals::Gemify.install_assets plugin_id
+      Additionals::Gemify.create_plugin_hint plugin_id
+    end
+  end
+end

data/lib/additional_tags/hooks.rb

@@ -0,0 +1,63 @@
+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: 'tags_sidebar'
+
+    def controller_issues_edit_before_save(context = {})
+      tags_journal context[:issue], context[:params]
+    end
+
+    def controller_issues_bulk_edit_before_save(context = {})
+      tags_journal context[:issue], context[: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 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/agile_boards_controller_patch.rb

@@ -0,0 +1,14 @@
+module AdditionalTags
+  module Patches
+    module AgileBoardsControllerPatch
+      extend ActiveSupport::Concern
+
+      included do
+        helper :additional_tags
+        helper :additional_tags_issues
+
+        include AdditionalTagsHelper
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/agile_query_patch.rb

@@ -0,0 +1,41 @@
+module AdditionalTags
+  module Patches
+    module AgileQueryPatch
+      extend ActiveSupport::Concern
+
+      included do
+        include AdditionalsQuery
+        include InstanceMethods
+
+        alias_method :initialize_available_filters_without_tags, :initialize_available_filters
+        alias_method :initialize_available_filters, :initialize_available_filters_with_tags
+
+        add_available_column QueryColumn.new(:tags)
+      end
+
+      module InstanceMethods
+        def sql_for_tags_field(_field, operator, value)
+          case operator
+          when '=', '!'
+            issues = Issue.tagged_with(value.clone)
+          when '!*'
+            issues = Issue.joins(:tags).uniq
+          else
+            issues = Issue.tagged_with(ActsAsTaggableOn::Tag.all.map(&:to_s), any: true)
+          end
+
+          compare   = operator.include?('!') ? 'NOT IN' : 'IN'
+          ids_list  = issues.collect(&:id).push(0).join(',')
+          "( #{Issue.table_name}.id #{compare} (#{ids_list}) ) "
+        end
+
+        def initialize_available_filters_with_tags
+          initialize_available_filters_without_tags
+
+          initialize_tags_filter if !available_filters.key?('tags') &&
+                                    User.current.allowed_to?(:view_issue_tags, project, global: true)
+        end
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/agile_versions_controller_patch.rb

@@ -0,0 +1,14 @@
+module AdditionalTags
+  module Patches
+    module AgileVersionsControllerPatch
+      extend ActiveSupport::Concern
+
+      included do
+        helper :additional_tags
+        helper :additional_tags_issues
+
+        include AdditionalTagsHelper
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/agile_versions_query_patch.rb

@@ -0,0 +1,11 @@
+module AdditionalTags
+  module Patches
+    module AgileVersionsQueryPatch
+      extend ActiveSupport::Concern
+
+      included do
+        add_available_column QueryColumn.new(:tags)
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/auto_completes_controller_patch.rb

@@ -0,0 +1,42 @@
+module AdditionalTags
+  module Patches
+    module AutoCompletesControllerPatch
+      extend ActiveSupport::Concern
+
+      included do
+        include InstanceMethods
+      end
+
+      module InstanceMethods
+        def issue_tags
+          suggestion_order = AdditionalTags.setting(:tags_suggestion_order) || 'name'
+          @name = (params[:q] || params[:term]).to_s.strip
+          @tags = Issue.available_tags name_like: @name,
+                                       sort_by: suggestion_order,
+                                       order: (suggestion_order == 'name' ? 'ASC' : 'DESC')
+
+          @tags = AdditionalTags::Tags.sort_tag_list @tags if suggestion_order == 'name'
+
+          render layout: false, partial: 'additional_tag_list', locals: { unsorted: true }
+        end
+
+        def wiki_tags
+          @name = params[:q].to_s
+          @tags = WikiPage.available_tags project: @project, name_like: @name
+          render layout: false, partial: 'additional_tag_list', locals: { unsorted: true }
+        end
+
+        def all_tags
+          return render_403 unless User.current.admin?
+
+          @name = params[:q].to_s
+          sql_for_where = "LOWER(#{ActiveRecord::Base.connection.quote_table_name(ActsAsTaggableOn.tags_table)}.name) LIKE ?"
+          @tags = ActsAsTaggableOn::Tag.where(sql_for_where, "%#{@name.downcase}%")
+                                       .order(name: :asc)
+
+          render layout: false, partial: 'additional_tag_list', locals: { unsorted: true }
+        end
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/calendars_controller_patch.rb

@@ -0,0 +1,14 @@
+module AdditionalTags
+  module Patches
+    module CalendarsControllerPatch
+      extend ActiveSupport::Concern
+
+      included do
+        helper :additional_tags
+        helper :additional_tags_issues
+
+        include AdditionalTagsHelper
+      end
+    end
+  end
+end

data/lib/additional_tags/patches/dashboard_async_blocks_controller_patch.rb

@@ -0,0 +1,11 @@
+module AdditionalTags
+  module Patches
+    module DashboardAsyncBlocksControllerPatch
+      extend ActiveSupport::Concern
+
+      included do
+        helper :additional_tags
+      end
+    end
+  end
+end