acts-as-taggable-on 4.0.0 → 8.0.0

data/CONTRIBUTING.md

@@ -1,3 +1,16 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [How to contribute:](#how-to-contribute)
+  - [Bug reports / Issues](#bug-reports--issues)
+  - [Code](#code)
+    - [Commit Messages](#commit-messages)
+    - [About Pull Requests (PR's)](#about-pull-requests-prs)
+  - [Documentation](#documentation)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # How to contribute:
 
 ## Bug reports / Issues

data/Gemfile

@@ -7,5 +7,5 @@ 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

data/README.md

@@ -1,10 +1,41 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [ActsAsTaggableOn](#actsastaggableon)
+  - [Installation](#installation)
+      - [Post Installation](#post-installation)
+      - [For MySql users](#for-mysql-users)
+  - [Usage](#usage)
+    - [Finding most or least used tags](#finding-most-or-least-used-tags)
+    - [Finding Tagged Objects](#finding-tagged-objects)
+    - [Relationships](#relationships)
+    - [Dynamic Tag Contexts](#dynamic-tag-contexts)
+    - [Tag Parsers](#tag-parsers)
+    - [Tag Ownership](#tag-ownership)
+      - [Working with Owned Tags](#working-with-owned-tags)
+        - [Adding owned tags](#adding-owned-tags)
+        - [Removing owned tags](#removing-owned-tags)
+    - [Dirty objects](#dirty-objects)
+    - [Tag cloud calculations](#tag-cloud-calculations)
+  - [Configuration](#configuration)
+      - [Upgrading](#upgrading)
+  - [Contributors](#contributors)
+  - [Compatibility](#compatibility)
+  - [TODO](#todo)
+  - [Testing](#testing)
+  - [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # ActsAsTaggableOn
 
 [![Join the chat at https://gitter.im/mbleigh/acts-as-taggable-on](https://badges.gitter.im/mbleigh/acts-as-taggable-on.svg)](https://gitter.im/mbleigh/acts-as-taggable-on?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Gem Version](https://badge.fury.io/rb/acts-as-taggable-on.svg)](http://badge.fury.io/rb/acts-as-taggable-on)
-[![Build Status](https://secure.travis-ci.org/mbleigh/acts-as-taggable-on.png)](http://travis-ci.org/mbleigh/acts-as-taggable-on)
-[![Code Climate](https://codeclimate.com/github/mbleigh/acts-as-taggable-on.png)](https://codeclimate.com/github/mbleigh/acts-as-taggable-on)
-[![Inline docs](http://inch-ci.org/github/mbleigh/acts-as-taggable-on.png)](http://inch-ci.org/github/mbleigh/acts-as-taggable-on)
+[![Build Status](https://github.com/mbleigh/acts-as-taggable-on/workflows/spec/badge.svg)](https://github.com/mbleigh/acts-as-taggable-on/actions)
+[![Code Climate](https://codeclimate.com/github/mbleigh/acts-as-taggable-on.svg)](https://codeclimate.com/github/mbleigh/acts-as-taggable-on)
+[![Inline docs](http://inch-ci.org/github/mbleigh/acts-as-taggable-on.svg)](http://inch-ci.org/github/mbleigh/acts-as-taggable-on)
+[![Security](https://hakiri.io/github/mbleigh/acts-as-taggable-on/master.svg)](https://hakiri.io/github/mbleigh/acts-as-taggable-on/master)
 
 This plugin was originally based on Acts as Taggable on Steroids by Jonathan Viney.
 It has evolved substantially since that point, but all credit goes to him for the
@@ -26,7 +57,7 @@ was used.
 To use it, add it to your Gemfile:
 
 ```ruby
-gem 'acts-as-taggable-on', '~> 4.0'
+gem 'acts-as-taggable-on', '~> 7.0'
 ```
 
 and bundle:
@@ -49,6 +80,8 @@ Review the generated migrations then migrate :
 rake db:migrate
 ```
 
+If you do not wish or need to support multi-tenancy, the migration for `add_tenant_to_taggings` is optional and can be discarded safely.
+
 #### 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:
 
@@ -72,8 +105,8 @@ Setup
 
 ```ruby
 class User < ActiveRecord::Base
-  acts_as_taggable # Alias for acts_as_taggable_on :tags
-  acts_as_taggable_on :skills, :interests
+  acts_as_taggable_on :tags
+  acts_as_taggable_on :skills, :interests #You can also configure multiple tag types per model
 end
 
 class UsersController < ApplicationController
@@ -90,6 +123,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
@@ -97,6 +131,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
@@ -207,12 +242,13 @@ User.tagged_with("awesome").by_join_date
 User.tagged_with("awesome").by_join_date.paginate(:page => params[:page], :per_page => 20)
 
 # Find users that matches all given tags:
+# NOTE: This only matches users that have the exact set of specified tags. If a user has additional tags, they are not returned.
 User.tagged_with(["awesome", "cool"], :match_all => true)
 
 # Find users with any of the specified tags:
 User.tagged_with(["awesome", "cool"], :any => true)
 
-# Find users that has not been tagged with awesome or cool:
+# Find users that have not been tagged with awesome or cool:
 User.tagged_with(["awesome", "cool"], :exclude => true)
 
 # Find users with any of the tags based on context:
@@ -332,12 +368,12 @@ Note that **owned tags** are added all at once, in the form of ***comma seperate
 Also, when you try to add **owned tags** again, it simply overwrites the previous set of **owned tags**.
 So to append tags in previously existing **owned tags** list, go as follows:
 ```ruby
-def add_owned_tag 
+def add_owned_tag
     @some_item = Item.find(params[:id])
-    owned_tag_list = @some_item.all_tag_list - @some_item.tag_list
+    owned_tag_list = @some_item.all_tags_list - @some_item.tag_list
     owned_tag_list += [(params[:tag])]
     @tag_owner.tag(@some_item, :with => stringify(owned_tag_list), :on => :tags)
-    @some_item.save   
+    @some_item.save
 end
 
 def stringify(tag_list)
@@ -347,15 +383,36 @@ end
 ##### Removing owned tags
 Similarly as above, removing will be as follows:
 ```ruby
-def remove_owned_tag 
+def remove_owned_tag
     @some_item = Item.find(params[:id])
-    owned_tag_list = @some_item.all_tag_list - @some_item.tag_list
+    owned_tag_list = @some_item.all_tags_list - @some_item.tag_list
     owned_tag_list -= [(params[:tag])]
     @tag_owner.tag(@some_item, :with => stringify(owned_tag_list), :on => :tags)
-    @some_item.save   
+    @some_item.save
 end
 ```
 
+### Tag Tenancy
+
+Tags support multi-tenancy. This is useful for applications where a Tag belongs to a scoped set of models:
+
+```ruby
+class Account < ActiveRecord::Base
+  has_many :photos
+end
+
+class User < ActiveRecord::Base
+  belongs_to :account
+  acts_as_taggable_on :tags
+  acts_as_taggable_tenant :account_id
+end
+
+@user1.tag_list = ["foo", "bar"] # these taggings will automatically have the tenant saved
+@user2.tag_list = ["bar", "baz"]
+
+ActsAsTaggableOn::Tag.for_tenant(@user1.account.id) # returns Tag models for "foo" and "bar", but not "baz"
+```
+
 ### Dirty objects
 
 ```ruby
@@ -454,6 +511,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
@@ -489,6 +553,8 @@ Versions >= 3.x are compatible with Ruby 1.9.3+ and Rails 3 and 4.
 
 Versions >= 4.x are compatible with Ruby 2.0.0+ and Rails 4 and 5.
 
+Versions >= 7.x are compatible with Ruby 2.3.7+ and Rails 5 and 6.
+
 For an up-to-date roadmap, see https://github.com/mbleigh/acts-as-taggable-on/milestones
 
 ## TODO

data/acts-as-taggable-on.gemspec

@@ -16,17 +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.0.0'
+  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', ['>= 4.0']
-
-  gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'mysql2', '~> 0.3'
-  gem.add_development_dependency 'pg'
+  gem.add_runtime_dependency 'activerecord', '>= 5.0', '< 6.2'
 
   gem.add_development_dependency 'rspec-rails'
   gem.add_development_dependency 'rspec-its'

data/db/migrate/1_acts_as_taggable_on_migration.rb

@@ -1,11 +1,17 @@
-class ActsAsTaggableOnMigration < ActiveRecord::Migration
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class ActsAsTaggableOnMigration < ActiveRecord::Migration[4.2]; end
+else
+  class ActsAsTaggableOnMigration < ActiveRecord::Migration; end
+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.
@@ -19,12 +25,12 @@ class ActsAsTaggableOnMigration < ActiveRecord::Migration
       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

@@ -1,20 +1,25 @@
-class AddMissingUniqueIndices < ActiveRecord::Migration
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class AddMissingUniqueIndices < ActiveRecord::Migration[4.2]; end
+else
+  class AddMissingUniqueIndices < ActiveRecord::Migration; end
+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

@@ -1,14 +1,19 @@
-class AddTaggingsCounterCacheToTags < ActiveRecord::Migration
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class AddTaggingsCounterCacheToTags < ActiveRecord::Migration[4.2]; end
+else
+  class AddTaggingsCounterCacheToTags < ActiveRecord::Migration; end
+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

@@ -1,9 +1,14 @@
-class AddMissingTaggableIndex < ActiveRecord::Migration
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class AddMissingTaggableIndex < ActiveRecord::Migration[4.2]; end
+else
+  class AddMissingTaggableIndex < ActiveRecord::Migration; end
+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

@@ -1,9 +1,14 @@
 # This migration is added to circumvent issue #623 and have special characters
 # work properly
-class ChangeCollationForTagNames < ActiveRecord::Migration
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class ChangeCollationForTagNames < ActiveRecord::Migration[4.2]; end
+else
+  class ChangeCollationForTagNames < ActiveRecord::Migration; end
+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

@@ -0,0 +1,22 @@
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class AddMissingIndexesOnTaggings < ActiveRecord::Migration[4.2]; end
+else
+  class AddMissingIndexesOnTaggings < ActiveRecord::Migration; end
+end
+AddMissingIndexesOnTaggings.class_eval do
+  def change
+    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? ActsAsTaggableOn.taggings_table, [:tagger_id, :tagger_type]
+      add_index ActsAsTaggableOn.taggings_table, [:tagger_id, :tagger_type]
+    end
+
+    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/db/migrate/7_add_tenant_to_taggings.rb

@@ -0,0 +1,16 @@
+if ActiveRecord.gem_version >= Gem::Version.new('5.0')
+  class AddTenantToTaggings < ActiveRecord::Migration[4.2]; end
+else
+  class AddTenantToTaggings < ActiveRecord::Migration; end
+end
+AddTenantToTaggings.class_eval do
+  def self.up
+    add_column :taggings, :tenant, :string, limit: 128
+    add_index :taggings, :tenant unless index_exists? :taggings, :tenant
+  end
+
+  def self.down
+    remove_column :taggings, :tenant
+    remove_index :taggings, :tenant
+  end
+end

data/gemfiles/activerecord_5.0.gemfile

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

data/gemfiles/activerecord_5.1.gemfile

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