acts-as-taggable-on 3.4.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3150df9e4bb27c039d1bf451b14848f05867cd1
-  data.tar.gz: 9451664d7c39a2bae61c254f8852b7c65101658c
+  metadata.gz: 92222646174fc38e87d9972cea2022c78e9ba337
+  data.tar.gz: 62d819d54ea8d538ce67d1f30c4c640e63333328
 SHA512:
-  metadata.gz: 33408ad30bec8845467d740606689fff474a35ff5440ed15a5320ff2b3a56f2076d557f111409c788c2431f6dfb732a2713b0847880895ed6d5abf7aa86d4bc9
-  data.tar.gz: 402c76125e5b27adbf531c9aeccf971af256b2b4545d92daa31b98a25beb3381820055075b6ae73e03efb7dd1c22495ae737655623b536c4703e7929002b624b
+  metadata.gz: 6a17ce74f9d91e98037faa3348449813632f2f1ba2a4ca92a297beaafa8e544b650c2e12586c03a9aab8c2c6b0b5c1c1de21571d860be49aed971b0d20b8338e
+  data.tar.gz: d50ea8e8200c3eaef6f1d80b53412637604e74de62dd3a2e6385e22d1fbf579bbb372f2bbd9b6c026f3f062e4959a288a5a890360d5f98cde6df222ebc72947f

data/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)
+### [3.5.0 / 2015-02-11](https://github.com/mbleigh/acts-as-taggable-on/compare/v3.4.4...v3.5.0)
 
-  * 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)
 

data/Gemfile

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

data/README.md

@@ -57,6 +57,22 @@ Review the generated migrations then migrate :
 rake db:migrate
 ```
 
+#### 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
+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)
@@ -407,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
 

data/Rakefile

@@ -1,6 +1,8 @@
 require 'rubygems'
 require 'bundler/setup'
 
+import "./lib/tasks/tags_collate_utf8.rake"
+
 desc 'Default: run specs'
 task default: :spec
 

data/UPGRADING.md

@@ -4,4 +4,5 @@ Re-run the migrations generator
 
     rake acts_as_taggable_on_engine:install:migrations
 
-It will create any new migrations and skip existing ones
+This will create any new migrations and skip existing ones
+Version 3.5.0 has a migration for mysql adapter

data/db/migrate/5_change_collation_for_tag_names.rb

@@ -0,0 +1,9 @@
+# This migration is added to circumvent issue #623 and have special characters
+# work properly
+class ChangeCollationForTagNames < ActiveRecord::Migration
+  def up
+    if ActsAsTaggableOn::Utils.using_mysql?
+      execute("ALTER TABLE tags MODIFY name varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
+    end
+  end
+end

data/lib/acts-as-taggable-on.rb

@@ -69,6 +69,13 @@ module ActsAsTaggableOn
       @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 @@ a ActsAsTaggableOn.default_parser instead
 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

data/lib/acts_as_taggable_on/tag.rb

@@ -6,7 +6,7 @@ module ActsAsTaggableOn
 
     ### ASSOCIATIONS:
 
-    has_many :taggings, dependent: :destroy, class_name: 'ActsAsTaggableOn::Tagging'
+    has_many :taggings, dependent: :destroy, class_name: '::ActsAsTaggableOn::Tagging'
 
     ### VALIDATIONS:
 

data/lib/acts_as_taggable_on/taggable.rb

@@ -80,8 +80,8 @@ module ActsAsTaggableOn
         self.preserve_tag_order = preserve_tag_order
 
         class_eval do
-          has_many :taggings, as: :taggable, dependent: :destroy, class_name: 'ActsAsTaggableOn::Tagging'
-          has_many :base_tags, through: :taggings, source: :tag, class_name: 'ActsAsTaggableOn::Tag'
+          has_many :taggings, as: :taggable, dependent: :destroy, class_name: '::ActsAsTaggableOn::Tagging'
+          has_many :base_tags, through: :taggings, source: :tag, class_name: '::ActsAsTaggableOn::Tag'
 
           def self.taggable?
             true

data/lib/acts_as_taggable_on/tagger.rb

@@ -19,13 +19,13 @@ module ActsAsTaggableOn
                                                opts.merge(
                                                    as: :tagger,
                                                    dependent: :destroy,
-                                                   class_name: 'ActsAsTaggableOn::Tagging'
+                                                   class_name: '::ActsAsTaggableOn::Tagging'
                                                )
 
           has_many_with_taggable_compatibility :owned_tags,
                                                through: :owned_taggings,
                                                source: :tag,
-                                               class_name: 'ActsAsTaggableOn::Tag',
+                                               class_name: '::ActsAsTaggableOn::Tag',
                                                uniq: true
         end
 

data/lib/acts_as_taggable_on/tagging.rb

@@ -11,7 +11,7 @@ module ActsAsTaggableOn
                     :tagger_type,
                     :tagger_id if defined?(ActiveModel::MassAssignmentSecurity)
 
-    belongs_to :tag, class_name: 'ActsAsTaggableOn::Tag', counter_cache: ActsAsTaggableOn.tags_counter
+    belongs_to :tag, class_name: '::ActsAsTaggableOn::Tag', counter_cache: ActsAsTaggableOn.tags_counter
     belongs_to :taggable, polymorphic: true
     belongs_to :tagger,   polymorphic: true
 

data/lib/acts_as_taggable_on/version.rb

@@ -1,4 +1,4 @@
 module ActsAsTaggableOn
-  VERSION = '3.4.4'
+  VERSION = '3.5.0'
 end
 

data/lib/tasks/tags_collate_utf8.rake

@@ -0,0 +1,21 @@
+# 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_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
+
+end

data/spec/acts_as_taggable_on/tag_spec.rb

@@ -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 @@ describe ActsAsTaggableOn::Tag do
         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 @@ describe ActsAsTaggableOn::Tag do
       expect(ActsAsTaggableOn::Tag.least_used(3).length).to eq(3)
     end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts-as-taggable-on
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.5.0
 platform: ruby
 authors:
 - Michael Bleigh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -169,6 +169,7 @@ files:
 - db/migrate/2_add_missing_unique_indices.rb
 - db/migrate/3_add_taggings_counter_cache_to_tags.rb
 - db/migrate/4_add_missing_taggable_index.rb
+- db/migrate/5_change_collation_for_tag_names.rb
 - gemfiles/activerecord_3.2.gemfile
 - gemfiles/activerecord_4.0.gemfile
 - gemfiles/activerecord_4.1.gemfile
@@ -194,6 +195,7 @@ files:
 - lib/acts_as_taggable_on/tags_helper.rb
 - lib/acts_as_taggable_on/utils.rb
 - lib/acts_as_taggable_on/version.rb
+- lib/tasks/tags_collate_utf8.rake
 - spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb
 - spec/acts_as_taggable_on/acts_as_tagger_spec.rb
 - spec/acts_as_taggable_on/caching_spec.rb
@@ -243,7 +245,8 @@ post_install_message: |-
 
       rake acts_as_taggable_on_engine:install:migrations
 
-  It will create any new migrations and skip existing ones
+  This will create any new migrations and skip existing ones
+  Version 3.5.0 has a migration for mysql adapter
 rdoc_options: []
 require_paths:
 - lib