acts-as-taggable-on 6.0.0 → 6.5.0

data/README.md

@@ -57,7 +57,7 @@ was used.
 To use it, add it to your Gemfile:
 
 ```ruby
-gem 'acts-as-taggable-on', '~> 5.0'
+gem 'acts-as-taggable-on', '~> 6.0'
 ```
 
 and bundle:
@@ -121,6 +121,7 @@ Add and remove a single tag
 ```ruby
 @user.tag_list.add("awesome")   # add a single tag. alias for <<
 @user.tag_list.remove("awesome") # remove a single tag
+@user.save # save to persist tag_list
 ```
 
 Add and remove multiple tags in an array
@@ -128,6 +129,7 @@ Add and remove multiple tags in an array
 ```ruby
 @user.tag_list.add("awesome", "slick")
 @user.tag_list.remove("awesome", "slick")
+@user.save
 ```
 
 You can also add and remove tags in format of String. This would
@@ -486,6 +488,13 @@ If you would like to have an exact match covering special characters with MySql:
 ActsAsTaggableOn.force_binary_collation = true
 ```
 
+If you would like to specify table names:
+
+```ruby
+ActsAsTaggableOn.tags_table = 'aato_tags'
+ActsAsTaggableOn.taggings_table = 'aato_taggings'
+```
+
 If you want to change the default delimiter (it defaults to ','). You can also pass in an array of delimiters such as ([',', '|']):
 
 ```ruby

data/acts-as-taggable-on.gemspec

@@ -16,13 +16,13 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
-  gem.required_ruby_version     = '>= 2.2.7'
+  gem.required_ruby_version     = '>= 2.3.7'
 
   if File.exist?('UPGRADING.md')
     gem.post_install_message = File.read('UPGRADING.md')
   end
 
-  gem.add_runtime_dependency 'activerecord', ['~> 5.0']
+  gem.add_runtime_dependency 'activerecord', '>= 5.0', '< 6.1'
 
   gem.add_development_dependency 'rspec-rails'
   gem.add_development_dependency 'rspec-its'

data/db/migrate/1_acts_as_taggable_on_migration.rb

@@ -5,12 +5,13 @@ else
 end
 ActsAsTaggableOnMigration.class_eval do
   def self.up
-    create_table :tags do |t|
+    create_table ActsAsTaggableOn.tags_table do |t|
       t.string :name
+      t.timestamps
     end
 
-    create_table :taggings do |t|
-      t.references :tag
+    create_table ActsAsTaggableOn.taggings_table do |t|
+      t.references :tag, foreign_key: { to_table: ActsAsTaggableOn.tags_table }
 
       # You should make sure that the column created is
       # long enough to store the required class names.
@@ -24,12 +25,12 @@ ActsAsTaggableOnMigration.class_eval do
       t.datetime :created_at
     end
 
-    add_index :taggings, :tag_id
-    add_index :taggings, [:taggable_id, :taggable_type, :context]
+    add_index ActsAsTaggableOn.taggings_table, :tag_id
+    add_index ActsAsTaggableOn.taggings_table, [:taggable_id, :taggable_type, :context], name: 'taggings_taggable_context_idx'
   end
 
   def self.down
-    drop_table :taggings
-    drop_table :tags
+    drop_table ActsAsTaggableOn.taggings_table
+    drop_table ActsAsTaggableOn.tags_table
   end
 end

data/db/migrate/2_add_missing_unique_indices.rb

@@ -5,21 +5,21 @@ else
 end
 AddMissingUniqueIndices.class_eval do
   def self.up
-    add_index :tags, :name, unique: true
+    add_index ActsAsTaggableOn.tags_table, :name, unique: true
 
-    remove_index :taggings, :tag_id if index_exists?(:taggings, :tag_id)
-    remove_index :taggings, [:taggable_id, :taggable_type, :context]
-    add_index :taggings,
+    remove_index ActsAsTaggableOn.taggings_table, :tag_id if index_exists?(ActsAsTaggableOn.taggings_table, :tag_id)
+    remove_index ActsAsTaggableOn.taggings_table, name: 'taggings_taggable_context_idx'
+    add_index ActsAsTaggableOn.taggings_table,
               [:tag_id, :taggable_id, :taggable_type, :context, :tagger_id, :tagger_type],
               unique: true, name: 'taggings_idx'
   end
 
   def self.down
-    remove_index :tags, :name
+    remove_index ActsAsTaggableOn.tags_table, :name
 
-    remove_index :taggings, name: 'taggings_idx'
+    remove_index ActsAsTaggableOn.taggings_table, name: 'taggings_idx'
 
-    add_index :taggings, :tag_id unless index_exists?(:taggings, :tag_id)
-    add_index :taggings, [:taggable_id, :taggable_type, :context]
+    add_index ActsAsTaggableOn.taggings_table, :tag_id unless index_exists?(ActsAsTaggableOn.taggings_table, :tag_id)
+    add_index ActsAsTaggableOn.taggings_table, [:taggable_id, :taggable_type, :context], name: 'taggings_taggable_context_idx'
   end
 end

data/db/migrate/3_add_taggings_counter_cache_to_tags.rb

@@ -5,15 +5,15 @@ else
 end
 AddTaggingsCounterCacheToTags.class_eval do
   def self.up
-    add_column :tags, :taggings_count, :integer, default: 0
+    add_column ActsAsTaggableOn.tags_table, :taggings_count, :integer, default: 0
 
     ActsAsTaggableOn::Tag.reset_column_information
     ActsAsTaggableOn::Tag.find_each do |tag|
-      ActsAsTaggableOn::Tag.reset_counters(tag.id, :taggings)
+      ActsAsTaggableOn::Tag.reset_counters(tag.id, ActsAsTaggableOn.taggings_table)
     end
   end
 
   def self.down
-    remove_column :tags, :taggings_count
+    remove_column ActsAsTaggableOn.tags_table, :taggings_count
   end
 end

data/db/migrate/4_add_missing_taggable_index.rb

@@ -5,10 +5,10 @@ else
 end
 AddMissingTaggableIndex.class_eval do
   def self.up
-    add_index :taggings, [:taggable_id, :taggable_type, :context]
+    add_index ActsAsTaggableOn.taggings_table, [:taggable_id, :taggable_type, :context], name: 'taggings_taggable_context_idx'
   end
 
   def self.down
-    remove_index :taggings, [:taggable_id, :taggable_type, :context]
+    remove_index ActsAsTaggableOn.taggings_table, name: 'taggings_taggable_context_idx'
   end
 end

data/db/migrate/5_change_collation_for_tag_names.rb

@@ -8,7 +8,7 @@ end
 ChangeCollationForTagNames.class_eval do
   def up
     if ActsAsTaggableOn::Utils.using_mysql?
-      execute("ALTER TABLE tags MODIFY name varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
+      execute("ALTER TABLE #{ActsAsTaggableOn.tags_table} MODIFY name varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
     end
   end
 end

data/db/migrate/6_add_missing_indexes_on_taggings.rb

@@ -5,18 +5,18 @@ else
 end
 AddMissingIndexesOnTaggings.class_eval do
   def change
-    add_index :taggings, :tag_id unless index_exists? :taggings, :tag_id
-    add_index :taggings, :taggable_id unless index_exists? :taggings, :taggable_id
-    add_index :taggings, :taggable_type unless index_exists? :taggings, :taggable_type
-    add_index :taggings, :tagger_id unless index_exists? :taggings, :tagger_id
-    add_index :taggings, :context unless index_exists? :taggings, :context
+    add_index ActsAsTaggableOn.taggings_table, :tag_id unless index_exists? ActsAsTaggableOn.taggings_table, :tag_id
+    add_index ActsAsTaggableOn.taggings_table, :taggable_id unless index_exists? ActsAsTaggableOn.taggings_table, :taggable_id
+    add_index ActsAsTaggableOn.taggings_table, :taggable_type unless index_exists? ActsAsTaggableOn.taggings_table, :taggable_type
+    add_index ActsAsTaggableOn.taggings_table, :tagger_id unless index_exists? ActsAsTaggableOn.taggings_table, :tagger_id
+    add_index ActsAsTaggableOn.taggings_table, :context unless index_exists? ActsAsTaggableOn.taggings_table, :context
 
-    unless index_exists? :taggings, [:tagger_id, :tagger_type]
-      add_index :taggings, [:tagger_id, :tagger_type]
+    unless index_exists? ActsAsTaggableOn.taggings_table, [:tagger_id, :tagger_type]
+      add_index ActsAsTaggableOn.taggings_table, [:tagger_id, :tagger_type]
     end
 
-    unless index_exists? :taggings, [:taggable_id, :taggable_type, :tagger_id, :context], name: 'taggings_idy'
-      add_index :taggings, [:taggable_id, :taggable_type, :tagger_id, :context], name: 'taggings_idy'
+    unless index_exists? ActsAsTaggableOn.taggings_table, [:taggable_id, :taggable_type, :tagger_id, :context], name: 'taggings_idy'
+      add_index ActsAsTaggableOn.taggings_table, [:taggable_id, :taggable_type, :tagger_id, :context], name: 'taggings_idy'
     end
   end
 end

data/gemfiles/activerecord_5.0.gemfile

@@ -1,5 +1,3 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
 gem "activerecord", "~> 5.0.3"
@@ -9,7 +7,7 @@ when "postgresql"
 when "mysql"
   gem 'mysql2', '~> 0.3'
 else
-  gem 'sqlite3'
+  gem "sqlite3", "~> 1.3", "< 1.4"
 end
 
 group :local_development do
@@ -17,7 +15,7 @@ group :local_development do
   gem "guard-rspec"
   gem "appraisal"
   gem "rake"
-  gem "byebug", platforms: [:mri_21, :mri_22, :mri_23]
+  gem "byebug", platforms: [:mri]
 end
 
 gemspec path: "../"

data/gemfiles/activerecord_5.1.gemfile

@@ -1,5 +1,3 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
 gem "activerecord", "~> 5.1.1"
@@ -9,7 +7,7 @@ when "postgresql"
 when "mysql"
   gem 'mysql2', '~> 0.3'
 else
-  gem 'sqlite3'
+  gem "sqlite3", "~> 1.3", "< 1.4"
 end
 
 group :local_development do
@@ -17,7 +15,7 @@ group :local_development do
   gem "guard-rspec"
   gem "appraisal"
   gem "rake"
-  gem "byebug", platforms: [:mri_21, :mri_22, :mri_23]
+  gem "byebug", platforms: [:mri]
 end
 
 gemspec path: "../"

data/gemfiles/activerecord_5.2.gemfile

@@ -1,5 +1,3 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
 gem "activerecord", "~> 5.2.0"
@@ -9,7 +7,7 @@ when "postgresql"
 when "mysql"
   gem 'mysql2', '~> 0.3'
 else
-  gem 'sqlite3'
+  gem "sqlite3", "~> 1.3", "< 1.4"
 end
 
 group :local_development do
@@ -17,7 +15,7 @@ group :local_development do
   gem "guard-rspec"
   gem "appraisal"
   gem "rake"
-  gem "byebug", platforms: [:mri_21, :mri_22, :mri_23]
+  gem "byebug", platforms: [:mri]
 end
 
 gemspec path: "../"

data/gemfiles/activerecord_6.0.gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+case ENV["DB"]
+when "postgresql"
+  gem 'pg'
+when "mysql"
+  gem 'mysql2', '~> 0.3'
+else
+  gem 'sqlite3'
+end
+
+group :local_development do
+  gem "guard"
+  gem "guard-rspec"
+  gem "appraisal"
+  gem "rake"
+  gem "byebug", platforms: [:mri]
+end
+
+gemspec path: "../"

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

@@ -31,6 +31,7 @@ module ActsAsTaggableOn
     autoload :Dirty
     autoload :Ownership
     autoload :Related
+    autoload :TagListType
   end
 
   autoload :Utils
@@ -63,7 +64,8 @@ module ActsAsTaggableOn
   class Configuration
     attr_accessor :force_lowercase, :force_parameterize,
                   :remove_unused_tags, :default_parser,
-                  :tags_counter
+                  :tags_counter, :tags_table,
+                  :taggings_table
     attr_reader :delimiter, :strict_case_match
 
     def initialize
@@ -75,6 +77,8 @@ module ActsAsTaggableOn
       @tags_counter = true
       @default_parser = DefaultParser
       @force_binary_collation = false
+      @tags_table = :tags
+      @taggings_table = :taggings
     end
 
     def strict_case_match=(force_cs)

data/lib/acts_as_taggable_on/tag.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 module ActsAsTaggableOn
   class Tag < ::ActiveRecord::Base
+    self.table_name = ActsAsTaggableOn.tags_table
 
     ### ASSOCIATIONS:
 
@@ -50,8 +51,8 @@ module ActsAsTaggableOn
 
     def self.for_context(context)
       joins(:taggings).
-        where(["taggings.context = ?", context]).
-        select("DISTINCT tags.*")
+        where(["#{ActsAsTaggableOn.taggings_table}.context = ?", context]).
+        select("DISTINCT #{ActsAsTaggableOn.tags_table}.*")
     end
 
     ### CLASS METHODS:
@@ -69,17 +70,17 @@ module ActsAsTaggableOn
 
       return [] if list.empty?
 
+      existing_tags = named_any(list)
       list.map do |tag_name|
         begin
           tries ||= 3
-
-          existing_tags = named_any(list)
           comparable_tag_name = comparable_name(tag_name)
           existing_tag = existing_tags.find { |tag| comparable_name(tag.name) == comparable_tag_name }
           existing_tag || create(name: tag_name)
         rescue ActiveRecord::RecordNotUnique
           if (tries -= 1).positive?
             ActiveRecord::Base.connection.execute 'ROLLBACK'
+            existing_tags = named_any(list)
             retry
           end
 
@@ -104,8 +105,6 @@ module ActsAsTaggableOn
 
     class << self
 
-
-
       private
 
       def comparable_name(str)
@@ -120,20 +119,12 @@ module ActsAsTaggableOn
         ActsAsTaggableOn::Utils.using_mysql? ? 'BINARY ' : nil
       end
 
-      def unicode_downcase(string)
-        if ActiveSupport::Multibyte::Unicode.respond_to?(:downcase)
-          ActiveSupport::Multibyte::Unicode.downcase(string)
-        else
-          ActiveSupport::Multibyte::Chars.new(string).downcase.to_s
-        end
+      def as_8bit_ascii(string)
+        string.to_s.mb_chars
       end
 
-      def as_8bit_ascii(string)
-        if defined?(Encoding)
-          string.to_s.dup.force_encoding('BINARY')
-        else
-          string.to_s.mb_chars
-        end
+      def unicode_downcase(string)
+        as_8bit_ascii(string).downcase
       end
 
       def sanitize_sql_for_named_any(tag)

data/lib/acts_as_taggable_on/taggable/cache.rb

@@ -3,47 +3,51 @@ module ActsAsTaggableOn::Taggable
     def self.included(base)
       # When included, conditionally adds tag caching methods when the model
       #   has any "cached_#{tag_type}_list" column
-      base.instance_eval do
-        # @private
-        def _has_tags_cache_columns?(db_columns)
-          db_column_names = db_columns.map(&:name)
-          tag_types.any? do |context|
-            db_column_names.include?("cached_#{context.to_s.singularize}_list")
-          end
+      base.extend Columns
+    end
+
+    module Columns
+      # ActiveRecord::Base.columns makes a database connection and caches the
+      #   calculated columns hash for the record as @columns.  Since we don't
+      #   want to add caching methods until we confirm the presence of a
+      #   caching column, and we don't want to force opening a database
+      #   connection when the class is loaded, here we intercept and cache
+      #   the call to :columns as @acts_as_taggable_on_cache_columns
+      #   to mimic the underlying behavior.  While processing this first
+      #   call to columns, we do the caching column check and dynamically add
+      #   the class and instance methods
+      #   FIXME: this method cannot compile in rubinius
+      def columns
+        @acts_as_taggable_on_cache_columns ||= begin
+          db_columns = super
+          _add_tags_caching_methods if _has_tags_cache_columns?(db_columns)
+          db_columns
         end
+      end
 
-        # @private
-        def _add_tags_caching_methods
-          send :include, ActsAsTaggableOn::Taggable::Cache::InstanceMethods
-          extend ActsAsTaggableOn::Taggable::Cache::ClassMethods
+      def reset_column_information
+        super
+        @acts_as_taggable_on_cache_columns = nil
+      end
 
-          before_save :save_cached_tag_list
+      private
 
-          initialize_tags_cache
+      # @private
+      def _has_tags_cache_columns?(db_columns)
+        db_column_names = db_columns.map(&:name)
+        tag_types.any? do |context|
+          db_column_names.include?("cached_#{context.to_s.singularize}_list")
         end
+      end
 
-        # ActiveRecord::Base.columns makes a database connection and caches the
-        #   calculated columns hash for the record as @columns.  Since we don't
-        #   want to add caching methods until we confirm the presence of a
-        #   caching column, and we don't want to force opening a database
-        #   connection when the class is loaded, here we intercept and cache
-        #   the call to :columns as @acts_as_taggable_on_cache_columns
-        #   to mimic the underlying behavior.  While processing this first
-        #   call to columns, we do the caching column check and dynamically add
-        #   the class and instance methods
-        #   FIXME: this method cannot compile in rubinius
-        def columns
-          @acts_as_taggable_on_cache_columns ||= begin
-            db_columns = super
-            _add_tags_caching_methods if _has_tags_cache_columns?(db_columns)
-            db_columns
-          end
-        end
+      # @private
+      def _add_tags_caching_methods
+        send :include, ActsAsTaggableOn::Taggable::Cache::InstanceMethods
+        extend ActsAsTaggableOn::Taggable::Cache::ClassMethods
 
-        def reset_column_information
-          super
-          @acts_as_taggable_on_cache_columns = nil
-        end
+        before_save :save_cached_tag_list
+
+        initialize_tags_cache
       end
     end