Preserve original search scopes; fixes #71, #72

Author: nodecarter

.travis.yml

@@ -13,14 +13,14 @@ gemfile:
 env:
   - REDMINE_VER=2.3.4 DB=mysql
   - REDMINE_VER=2.6.9 DB=mysql
-  - REDMINE_VER=3.1.6 DB=mysql
-  - REDMINE_VER=3.2.3 DB=mysql
-  - REDMINE_VER=3.3.0 DB=mysql
+  - REDMINE_VER=3.1.7 DB=mysql
+  - REDMINE_VER=3.2.4 DB=mysql
+  - REDMINE_VER=3.3.1 DB=mysql
   - REDMINE_VER=2.3.4 DB=postgresql
   - REDMINE_VER=2.6.9 DB=postgresql
-  - REDMINE_VER=3.1.6 DB=postgresql
-  - REDMINE_VER=3.2.3 DB=postgresql
-  - REDMINE_VER=3.3.0 DB=postgresql
+  - REDMINE_VER=3.1.7 DB=postgresql
+  - REDMINE_VER=3.2.4 DB=postgresql
+  - REDMINE_VER=3.3.1 DB=postgresql
 
 before_install:
   - export PLUGIN_NAME=redmine_tagging
@@ -29,6 +29,7 @@ before_install:
   - ln -s $TRAVIS_BUILD_DIR $REDMINE_PATH/plugins/$PLUGIN_NAME
   - cp config/database-$DB-travis.yml $REDMINE_PATH/config/database.yml
   - cp config/configuration-travis.yml $REDMINE_PATH/config/configuration.yml
+  - echo "config.active_record.schema_format = :sql" > $REDMINE_PATH/config/additional_environment.rb
   - cd $REDMINE_PATH
 
 before_script:
@@ -40,5 +41,5 @@ before_script:
   - bundle exec rake redmine:plugins:migrate
 
 script:
-  - bundle exec rake redmine_tagging:test
+  - bundle exec rake redmine:plugins:test
 

Gemfile

@@ -1,2 +1 @@
-gem 'acts-as-taggable-on', '~> 3.4.1'
-gem 'rails_sql_views', git: 'git://github.com/Undev/rails_sql_views.git'
+gem 'acts-as-taggable-on', '~> 4.0'

README.md

@@ -33,8 +33,7 @@ The initial authors of the plugin are [Emiliano Heyns](mailto:emiliano.heyns@gma
 
 2. Update the Gemfile.lock file by running the following commands:  
 
-         rm Gemfile.lock  
-         bundle install
+        bundle install
             
 3. Run the migrations generator to create tables for tags and associations:
 
@@ -49,6 +48,21 @@ The initial authors of the plugin are [Emiliano Heyns](mailto:emiliano.heyns@gma
 
 Now you should be able to see the plugin in **Administration > Plugins**.
 
+### For MySql users
+You can circumvent at any time the problem of special characters [issue 623](https://github.com/mbleigh/acts-as-taggable-on/issues/623) by setting in an initializer file:
+
+```ruby
+ActsAsTaggableOn.force_binary_collation = true
+```
+
+Or by running this rake task:
+
+```shell
+bundle exec rake acts_as_taggable_on_engine:tag_names:collate_bin
+```
+
+See the [configuration](https://github.com/mbleigh/acts-as-taggable-on#configuration) section in acts-as-taggable-on gem for more details.
+
 ## Usage
 
 The plugin enables you to add tags to wiki and issue pages using either the **Tags** field or inline tags. To switch between these two modes, you should enable or disable the corresponding check boxes in the plugin settings. 
@@ -93,4 +107,8 @@ Tags can be used to search for issues and create issue filters:
 
 ## Maintainers
 
-Danil Tashkinov, [github.com/nodecarter](https://github.com/nodecarter)
+Danil Tashkinov, [github.com/nodecarter](https://github.com/nodecarter)
+
+## Thanks to
+
+* https://github.com/jkraemer

init.rb

@@ -4,7 +4,7 @@
   name 'Redmine Tagging Plugin'
   author 'Restream'
   description 'This plugin adds tagging features to Redmine.'
-  version '0.1.4'
+  version '0.1.5'
 
   settings default: {
       dynamic_font_size: '1',
@@ -98,28 +98,6 @@
   require 'redmine_tagging'
   require File.expand_path('../app/helpers/tagging_helper', __FILE__)
   ActionView::Base.send :include, TaggingHelper
-
-  unless Issue.searchable_options[:include] && Issue.searchable_options[:include].include?(:issue_tags)
-    Issue.searchable_options[:columns] << "#{IssueTag.table_name}.tag"
-
-    # For redmine < 3
-    Issue.searchable_options[:include] ||= []
-    Issue.searchable_options[:include] << :issue_tags
-
-    # For redmine > 3
-    Issue.searchable_options[:scope] = proc { Issue.includes(:issue_tags) }
-  end
-
-  unless WikiPage.searchable_options[:include] && WikiPage.searchable_options[:include].include?(:wiki_page_tags)
-    WikiPage.searchable_options[:columns] << "#{WikiPageTag.table_name}.tag"
-
-    # For redmine < 3
-    WikiPage.searchable_options[:include] ||= []
-    WikiPage.searchable_options[:include] << :wiki_page_tags
-
-    # For redmine > 3
-    WikiPage.searchable_options[:scope] = proc { WikiPage.includes(:wiki_page_tags) }
-  end
 end
 
 require_dependency 'tagging_plugin/tagging_hooks'

lib/redmine_tagging.rb

@@ -4,5 +4,6 @@ module RedmineTagging
 require 'redmine_tagging/patches/issue_patch'
 require 'redmine_tagging/patches/project_patch'
 require 'redmine_tagging/patches/query_patch'
+require 'redmine_tagging/patches/wiki_page_patch'
 require 'redmine_tagging/patches/queries_helper_patch'
 require 'redmine_tagging/patches/application_controller_patch'

lib/redmine_tagging/patches/issue_patch.rb

@@ -18,13 +18,30 @@ module RedmineTagging::Patches::IssuePatch
     alias_method_chain :create_journal, :tags
     alias_method_chain :init_journal, :tags
     alias_method_chain :copy_from, :tags
+
+    if Redmine::VERSION::MAJOR < 3
+      searchable_options[:columns] << "#{IssueTag.table_name}.tag"
+      searchable_options[:include] ||= []
+      searchable_options[:include] << :issue_tags
+    else
+      searchable_options[:columns] << "#{IssueTag.table_name}.tag"
+
+      original_scope = searchable_options[:scope] || self
+
+      searchable_options[:scope] = ->(*args) {
+        (original_scope.respond_to?(:call) ?
+          original_scope.call(*args) :
+          original_scope
+        ).includes :issue_tags
+      }
+    end
   end
 
   def create_journal_with_tags
     if @current_journal
       tag_context = TaggingPlugin::ContextHelper.context_for(project)
-      before = @issue_tags_before_change
-      after = TaggingPlugin::TagsHelper.to_string(tag_list_on(tag_context))
+      before      = @issue_tags_before_change
+      after       = TaggingPlugin::TagsHelper.to_string(tag_list_on(tag_context))
       unless before == after
         @current_journal.details << JournalDetail.new(
           property:  'attr',
@@ -38,7 +55,7 @@ def create_journal_with_tags
 
   def init_journal_with_tags(user, notes = "")
     unless project.nil?
-      tag_context = TaggingPlugin::ContextHelper.context_for(project)
+      tag_context               = TaggingPlugin::ContextHelper.context_for(project)
       @issue_tags_before_change = TaggingPlugin::TagsHelper.to_string(tag_list_on(tag_context))
     end
     init_journal_without_tags(user, notes)
@@ -50,7 +67,7 @@ def tags
 
   def copy_from_with_tags(arg, options = {})
     copy_from_without_tags(arg, options)
-    issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
+    issue             = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
     self.tag_list_ctx = issue.tag_list_ctx
     self
   end
@@ -88,7 +105,7 @@ def cleanup_tags
     if @new_project_id
       context = TaggingPlugin::ContextHelper.context_for(project)
       ActsAsTaggableOn::Tagging.where(
-          'context != ? AND taggable_id = ? AND taggable_type = ?', context, id, 'Issue'
+        'context != ? AND taggable_id = ? AND taggable_type = ?', context, id, 'Issue'
       ).delete_all
     end
     true

lib/redmine_tagging/patches/wiki_page_patch.rb

@@ -0,0 +1,50 @@
+require_dependency 'wiki_page'
+
+module RedmineTagging::Patches::WikiPagePatch
+  extend ActiveSupport::Concern
+
+  included do
+    unloadable
+
+    attr_writer :tags_to_update
+
+    has_many :wiki_page_tags
+
+    acts_as_taggable
+
+    before_save :update_tags
+
+    if Redmine::VERSION::MAJOR < 3
+      searchable_options[:columns] << "#{WikiPageTag.table_name}.tag"
+      searchable_options[:include] ||= []
+      searchable_options[:include] << :wiki_page_tags
+    else
+      searchable_options[:columns] << "#{WikiPageTag.table_name}.tag"
+
+      original_scope = searchable_options[:scope] || self
+
+      searchable_options[:scope] = ->(*args) {
+        (original_scope.respond_to?(:call) ?
+          original_scope.call(*args) :
+          original_scope
+        ).includes :wiki_page_tags
+      }
+    end
+  end
+
+  private
+
+  def update_tags
+    if @tags_to_update
+      project_context = TaggingPlugin::ContextHelper.context_for(project)
+      set_tag_list_on(project_context, @tags_to_update)
+    end
+
+    true
+  end
+
+end
+
+unless WikiPage.included_modules.include? RedmineTagging::Patches::WikiPagePatch
+  WikiPage.send :include, RedmineTagging::Patches::WikiPagePatch
+end

lib/tagging_plugin/tagging_patches.rb

@@ -1,6 +1,3 @@
-require_dependency 'issue'
-require_dependency 'wiki_page'
-
 module TaggingPlugin
 
   module ProjectsHelperPatch
@@ -21,35 +18,6 @@ def project_settings_tabs_with_tags_tab
     end
   end
 
-  module WikiPagePatch
-    def self.included(base) # :nodoc:
-      base.send(:include, InstanceMethods)
-
-      base.class_eval do
-        unloadable
-
-        attr_writer :tags_to_update
-
-        before_save :update_tags
-        acts_as_taggable
-
-        has_many :wiki_page_tags
-      end
-    end
-
-    module InstanceMethods
-      private
-        def update_tags
-          if @tags_to_update
-            project_context = ContextHelper.context_for(project)
-            set_tag_list_on(project_context, @tags_to_update)
-          end
-
-          true
-        end
-    end
-  end
-
   module WikiControllerPatch
     def self.included(base) # :nodoc:
       base.send(:include, InstanceMethods)
@@ -75,8 +43,5 @@ def update_with_tags
   end
 end
 
-WikiPage.send(:include, TaggingPlugin::WikiPagePatch) unless WikiPage.included_modules.include? TaggingPlugin::WikiPagePatch
-
 WikiController.send(:include, TaggingPlugin::WikiControllerPatch) unless WikiController.included_modules.include? TaggingPlugin::WikiControllerPatch
-
 ProjectsHelper.send(:include, TaggingPlugin::ProjectsHelperPatch) unless ProjectsHelper.included_modules.include? TaggingPlugin::ProjectsHelperPatch