Merge pull request #634 from rikettsie/master

#623: solve matching of binary-encoded strings with MySql (via rake rule or initializer setting)

Author: seuros

CHANGELOG.md

@@ -4,13 +4,10 @@ Each change should fall into categories that would affect whether the release is
 
 As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch.  And _misc_ is either minor or patch, the difference being kind of fuzzy for the purposes of history.  Adding tests would be patch level.
 
-### Master [changes](https://github.com/mbleigh/acts-as-taggable-on/compare/v3.4.4...master)
+### Master [fixes](https://github.com/mbleigh/acts-as-taggable-on/compare/v3.4.4...master)
 
-  * Breaking Changes
-  * Features
   * Fixes
-  * Performance
-  * Misc
+   * [@rikettsie Fixed collation for MySql via rake rule or config parameter](https://github.com/mbleigh/acts-as-taggable-on/pull/634)
 
 ### [3.4.4 / 2015-02-11](https://github.com/mbleigh/acts-as-taggable-on/compare/v3.4.3...v3.4.4)
 

Gemfile

@@ -8,4 +8,4 @@ group :local_development do
   gem 'appraisal'
   gem 'rake'
   gem 'byebug' , platform: :mri_21
-end
+end

README.md

@@ -57,20 +57,22 @@ Review the generated migrations then migrate :
 rake db:migrate
 ```
 
-MySql users should also run the following rake task to get special characters
-work correctly for tag names, see [issue #623](https://github.com/mbleigh/acts-as-taggable-on/issues/623):
+#### 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:
 
-```shell
-rake acts_as_taggable_on_engine:tag_names:collate
+```ruby
+ActsAsTaggableOn.force_binary_collation = true
 ```
 
-or, alternatively, execute the following command in the MySql console:
+Or by running this rake task:
 
 ```shell
-USE my_wonderful_app_db;
-ALTER TABLE tags MODIFY name VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_bin;
+rake acts_as_taggable_on_engine:tag_names:collate_bin
 ```
 
+See the Configuration section for more details, and a general note valid for older
+version of the gem.
+
 #### Upgrading
 
 see [UPGRADING](UPGRADING.md)
@@ -421,13 +423,28 @@ If you would like tags to be case-sensitive and not use LIKE queries for creatio
 ActsAsTaggableOn.strict_case_match = true
 ```
 
+If you would like to have an exact match covering special characters with MySql:
+
+```ruby
+ActsAsTaggableOn.force_binary_collation = true
+```
+
 If you want to change the default delimiter (it defaults to ','). You can also pass in an array of delimiters such as ([',', '|']):
 
 ```ruby
 ActsAsTaggableOn.delimiter = ','
 ```
 
-*NOTE: SQLite by default can't upcase or downcase multibyte characters, resulting in unwanted behavior. Load the SQLite ICU extension for proper handle of such characters. [See docs](http://www.sqlite.org/src/artifact?ci=trunk&filename=ext/icu/README.txt)*
+*NOTE 1: SQLite by default can't upcase or downcase multibyte characters, resulting in unwanted behavior. Load the SQLite ICU extension for proper handle of such characters. [See docs](http://www.sqlite.org/src/artifact?ci=trunk&filename=ext/icu/README.txt)*
+
+*NOTE 2: the option `force_binary_collation` is strongest than `strict_case_match` and when
+set to true, the `strict_case_match` is ignored.
+To roughly apply the `force_binary_collation` behaviour with a version of the gem <= 3.4.4, execute the following commands in the MySql console:*
+
+```shell
+USE my_wonderful_app_db;
+ALTER TABLE tags MODIFY name VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_bin;
+```
 
 ## Contributors
 

db/migrate/5_change_collation_for_tag_names.rb

@@ -69,6 +69,13 @@ def initialize
       @remove_unused_tags = false
       @tags_counter = true
       @default_parser = DefaultParser
+      @force_binary_collation = false
+    end
+
+    def strict_case_match=(force_cs)
+      if @force_binary_collation == false
+        @strict_case_match = force_cs
+      end
     end
 
     def delimiter=(string)
@@ -79,6 +86,30 @@ def delimiter=(string)
 WARNING
       @delimiter = string
     end
+
+    def force_binary_collation=(force_bin)
+      if Utils.using_mysql?
+        if force_bin == true
+          Configuration.apply_binary_collation(true)
+          @force_binary_collation = true
+          @strict_case_match = true
+        else
+          Configuration.apply_binary_collation(false)
+          @force_binary_collation = false
+        end
+      end
+    end
+
+    def self.apply_binary_collation(bincoll)
+      if Utils.using_mysql?
+        coll = 'utf8_general_ci'
+        if bincoll == true
+          coll = 'utf8_bin'
+        end
+        ActiveRecord::Migration.execute("ALTER TABLE tags MODIFY name varchar(255) CHARACTER SET utf8 COLLATE #{coll};")
+      end
+    end
+
   end
 
   setup

lib/acts-as-taggable-on.rb

@@ -1,15 +1,19 @@
-# This rake task is to be run by MySql users only, and fixes the management of 
-# binary-encoded strings for tag 'names'. Issues: 
+# These rake tasks are to be run by MySql users only, they fix the management of
+# binary-encoded strings for tag 'names'. Issues:
 # https://github.com/mbleigh/acts-as-taggable-on/issues/623
 
 namespace :acts_as_taggable_on_engine do
 
   namespace :tag_names do
 
     desc "Forcing collate of tag names to utf8_bin"
-    task :collate => [:environment] do |t, args|
-      puts "Changing collate for column 'name' of table 'tags'"
-      ActiveRecord::Migration.execute("ALTER TABLE tags MODIFY name varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
+    task :collate_bin => [:environment] do |t, args|
+      ActsAsTaggableOn::Configuration.apply_binary_collation(true)
+    end
+
+    desc "Forcing collate of tag names to utf8_general_ci"
+    task :collate_ci => [:environment] do |t, args|
+      ActsAsTaggableOn::Configuration.apply_binary_collation(false)
     end
 
   end

lib/tasks/tags_collate_utf8.rake

@@ -2,6 +2,7 @@
 require 'spec_helper'
 require 'db/migrate/2_add_missing_unique_indices.rb'
 
+
 shared_examples_for 'without unique index' do
   prepend_before(:all) { AddMissingUniqueIndices.down }
   append_after(:all) do
@@ -309,7 +310,7 @@
         tag.save!
       end
     end
-    
+
     it 'should find the most popular tags' do
       expect(ActsAsTaggableOn::Tag.most_used(3).first.name).to eq("golden_syrup")
       expect(ActsAsTaggableOn::Tag.most_used(3).length).to eq(3)
@@ -320,4 +321,5 @@
       expect(ActsAsTaggableOn::Tag.least_used(3).length).to eq(3)
     end
   end
+
 end