acts-as-taggable-on 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a719de5e742725a409d676059cc39e90875c07e1684f56fc6a00d970d4e1ffd
-  data.tar.gz: 8ae1467d822b80e8cd37a4e3e584d5e5467161625ab7b95ae4cc2db0de3cf6fb
+  metadata.gz: 9a4ab64bc795a1e9596de357c7dad4cc014e4049f6990b478cbfd5423aeea166
+  data.tar.gz: b5efae9e459d67584920ad0cf8aa4dac8e8889ea70897941ad580fa4cfe58508
 SHA512:
-  metadata.gz: 67cb7da1b6efea8ce6652c60475b8977605577dd91efe4f7a07757a1a98c46ad024c57f47657a240690301927fe85f5dfb380411b20ddfa7860ef148536abe97
-  data.tar.gz: ffffd0d8a13f94fa8880914d20a165855dd9f019ea6c64d94439c44262b29a94381eb879c8e1273552b8856a7457a818364768c4a82740a6ff1dd7486eb67dc0
+  metadata.gz: f3456a0521ea9e853afdb316792fdbbdef01c6cbc354b34b46b7916e9ce5111c9a85085c029deb0191f93f32993cebeb3b565ed865090633892584c67e017db5
+  data.tar.gz: b392a57b1f80e17e88766db866bb9e802dfd8924ae175c31032e98414aef48f213f007f0b93c7ca3d272540ea40579a26b8aa8e42a6d0874cc502dea7448b1fe

data/.github/workflows/spec.yml

@@ -0,0 +1,95 @@
+name: spec
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.ruby == 'head' }}
+    env:
+      DB: ${{ matrix.db }}
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    strategy:
+      matrix:
+        ruby:
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+          - head
+        gemfile:
+          - gemfiles/activerecord_5.0.gemfile
+          - gemfiles/activerecord_5.2.gemfile
+          - gemfiles/activerecord_5.1.gemfile
+          - gemfiles/activerecord_6.0.gemfile
+          - gemfiles/activerecord_6.1.gemfile
+        db:
+          - mysql
+          - postgresql
+          - sqlite3
+        exclude:
+          # Unfortunately, the mysql2 gem encounters a segfault in the ruby 2.3 environment:
+          - ruby: 2.3
+            db: mysql
+          # Exclude ActiveRecord 6.x for Ruby < 2.5
+          - ruby: 2.3
+            gemfile: gemfiles/activerecord_6.0.gemfile
+          - ruby: 2.3
+            gemfile: gemfiles/activerecord_6.1.gemfile
+          - ruby: 2.4
+            gemfile: gemfiles/activerecord_6.0.gemfile
+          - ruby: 2.4
+            gemfile: gemfiles/activerecord_6.1.gemfile
+          # Exclude ActiveRecord 5.x for Ruby >= 3.0
+          - ruby: 3.0
+            gemfile: gemfiles/activerecord_5.0.gemfile
+          - ruby: 3.0
+            gemfile: gemfiles/activerecord_5.1.gemfile
+          - ruby: 3.0
+            gemfile: gemfiles/activerecord_5.2.gemfile
+          - ruby: head
+            gemfile: gemfiles/activerecord_5.0.gemfile
+          - ruby: head
+            gemfile: gemfiles/activerecord_5.1.gemfile
+          - ruby: head
+            gemfile: gemfiles/activerecord_5.2.gemfile
+
+    services:
+      postgres:
+        image: postgres:10
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: acts_as_taggable_on
+          POSTGRES_PASSWORD: postgres
+        ports: ['5432:5432']
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      mysql:
+        image: mysql:8
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: true
+        ports: ['3306:3306']
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Create MySQL test database with utf8mb4 charset
+      if: ${{ matrix.db == 'mysql' }}
+      run: |
+        mysql -uroot --host=127.0.0.1 -e "CREATE DATABASE acts_as_taggable_on CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci"
+    - name: Build and test with Rake
+      run: |
+        bundle exec rake

data/CHANGELOG.md

@@ -10,6 +10,12 @@ Each change should fall into categories that would affect whether the release is
 
 As such, _Breaking Changes_ are major. _Features_ would map to either major or minor. _Fixes_, _Performance_, and _Misc_ are either minor or patch, the difference being kind of fuzzy for the purposes of history. Adding _Documentation_ (including tests) would be patch level.
 
+### [v8.0.0) / 2021-06-07](https://github.com/mbleigh/acts-as-taggable-on/compare/v7.0.0...v8.0.0)
+* Features
+  * [@lunaru Support tenants for taggings](https://github.com/mbleigh/acts-as-taggable-on/pull/1000)
+* Fixes
+  * [@gr-eg Use none? instead of count.zero?](https://github.com/mbleigh/acts-as-taggable-on/pull/1030)
+  
 ### [v7.0.0) / 2020-12-31](https://github.com/mbleigh/acts-as-taggable-on/compare/v6.5.0...v7.0.0)
 * Features
   * [@kvokka Rails 6.1 support](https://github.com/mbleigh/acts-as-taggable-on/pull/1013)

data/README.md

@@ -32,7 +32,7 @@
 
 [![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.svg)](http://travis-ci.org/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)
@@ -57,7 +57,7 @@ was used.
 To use it, add it to your Gemfile:
 
 ```ruby
-gem 'acts-as-taggable-on', '~> 6.0'
+gem 'acts-as-taggable-on', '~> 7.0'
 ```
 
 and bundle:
@@ -80,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:
 
@@ -390,6 +392,27 @@ def remove_owned_tag
 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
@@ -530,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/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/lib/acts_as_taggable_on/tag.rb

@@ -55,6 +55,12 @@ module ActsAsTaggableOn
         select("DISTINCT #{ActsAsTaggableOn.tags_table}.*")
     end
 
+    def self.for_tenant(tenant)
+      joins(:taggings).
+        where("#{ActsAsTaggableOn.taggings_table}.tenant = ?", tenant.to_s).
+        select("DISTINCT #{ActsAsTaggableOn.tags_table}.*")
+    end
+
     ### CLASS METHODS:
 
     def self.find_or_create_with_like_by_name(name)

data/lib/acts_as_taggable_on/taggable.rb

@@ -54,6 +54,23 @@ module ActsAsTaggableOn
       taggable_on(true, tag_types)
     end
 
+    def acts_as_taggable_tenant(tenant)
+      if taggable?
+        self.tenant_column = tenant
+      else
+        class_attribute :tenant_column
+        self.tenant_column = tenant
+      end
+
+      # each of these add context-specific methods and must be
+      # called on each call of taggable_on
+      include Core
+      include Collection
+      include Cache
+      include Ownership
+      include Related
+    end
+
     private
 
       # Make a model taggable on specified contexts
@@ -78,6 +95,7 @@ module ActsAsTaggableOn
         self.tag_types = tag_types
         class_attribute :preserve_tag_order
         self.preserve_tag_order = preserve_tag_order
+        class_attribute :tenant_column
 
         class_eval do
           has_many :taggings, as: :taggable, dependent: :destroy, class_name: '::ActsAsTaggableOn::Tagging'

data/lib/acts_as_taggable_on/taggable/core.rb

@@ -214,6 +214,12 @@ module ActsAsTaggableOn::Taggable
       self.class.tag_types.map(&:to_s) + custom_contexts
     end
 
+    def tenant
+      if self.class.tenant_column
+        read_attribute(self.class.tenant_column)
+      end
+    end
+
     def reload(*args)
       self.class.tag_types.each do |context|
         instance_variable_set("@#{context.to_s.singularize}_list", nil)
@@ -272,7 +278,11 @@ module ActsAsTaggableOn::Taggable
 
         # Create new taggings:
         new_tags.each do |tag|
-          taggings.create!(tag_id: tag.id, context: context.to_s, taggable: self)
+          if tenant
+            taggings.create!(tag_id: tag.id, context: context.to_s, taggable: self, tenant: tenant)
+          else
+            taggings.create!(tag_id: tag.id, context: context.to_s, taggable: self)
+          end
         end
       end
 

data/lib/acts_as_taggable_on/tagging.rb

@@ -14,6 +14,8 @@ module ActsAsTaggableOn
     scope :by_contexts, ->(contexts) { where(context: (contexts || DEFAULT_CONTEXT)) }
     scope :by_context, ->(context = DEFAULT_CONTEXT) { by_contexts(context.to_s) }
 
+    scope :by_tenant, ->(tenant) { where(tenant: tenant) }
+
     validates_presence_of :context
     validates_presence_of :tag_id
 
@@ -28,7 +30,7 @@ module ActsAsTaggableOn
         if ActsAsTaggableOn.tags_counter
           tag.destroy if tag.reload.taggings_count.zero?
         else
-          tag.destroy if tag.reload.taggings.count.zero?
+          tag.destroy if tag.reload.taggings.none?
         end
       end
     end

data/lib/acts_as_taggable_on/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTaggableOn
-  VERSION = '7.0.0'
+  VERSION = '8.0.0'
 end

data/spec/acts_as_taggable_on/tag_spec.rb

@@ -14,7 +14,7 @@ end
 describe ActsAsTaggableOn::Tag do
   before(:each) do
     @tag = ActsAsTaggableOn::Tag.new
-    @user = TaggableModel.create(name: 'Pablo')
+    @user = TaggableModel.create(name: 'Pablo', tenant_id: 100)
   end
 
 
@@ -70,6 +70,21 @@ describe ActsAsTaggableOn::Tag do
     end
   end
 
+  describe 'for tenant' do
+    before(:each) do
+      @user.skill_list.add('ruby')
+      @user.save
+    end
+
+    it 'should return tags for the tenant' do
+      expect(ActsAsTaggableOn::Tag.for_tenant('100').pluck(:name)).to include('ruby')
+    end
+
+    it 'should not return tags for other tenants' do
+      expect(ActsAsTaggableOn::Tag.for_tenant('200').pluck(:name)).to_not include('ruby')
+    end
+  end
+
   describe 'find or create by name' do
     before(:each) do
       @tag.name = 'awesome'

data/spec/acts_as_taggable_on/taggable_spec.rb

@@ -109,6 +109,10 @@ describe 'Taggable' do
     expect(@taggable.tag_types).to eq(TaggableModel.tag_types)
   end
 
+  it 'should have tenant column' do
+    expect(TaggableModel.tenant_column).to eq(:tenant_id)
+  end
+
   it 'should have tag_counts_on' do
     expect(TaggableModel.tag_counts_on(:tags)).to be_empty
 
@@ -676,11 +680,11 @@ describe 'Taggable' do
     end
 
     it 'should return all column names joined for TaggableModel GROUP clause' do
-      expect(@taggable.grouped_column_names_for(TaggableModel)).to eq('taggable_models.id, taggable_models.name, taggable_models.type')
+      expect(@taggable.grouped_column_names_for(TaggableModel)).to eq('taggable_models.id, taggable_models.name, taggable_models.type, taggable_models.tenant_id')
     end
 
     it 'should return all column names joined for NonStandardIdTaggableModel GROUP clause' do
-      expect(@taggable.grouped_column_names_for(TaggableModel)).to eq("taggable_models.#{TaggableModel.primary_key}, taggable_models.name, taggable_models.type")
+      expect(@taggable.grouped_column_names_for(TaggableModel)).to eq("taggable_models.#{TaggableModel.primary_key}, taggable_models.name, taggable_models.type, taggable_models.tenant_id")
     end
   end
 

data/spec/acts_as_taggable_on/tagging_spec.rb

@@ -49,6 +49,22 @@ describe ActsAsTaggableOn::Tagging do
     ActsAsTaggableOn.remove_unused_tags = previous_setting
   end
 
+  it 'should destroy unused tags after tagging destroyed when not using tags_counter' do
+    remove_unused_tags_previous_setting = ActsAsTaggableOn.remove_unused_tags
+    tags_counter_previous_setting = ActsAsTaggableOn.tags_counter
+    ActsAsTaggableOn.remove_unused_tags = true
+    ActsAsTaggableOn.tags_counter = false
+
+    ActsAsTaggableOn::Tag.destroy_all
+    @taggable = TaggableModel.create(name: 'Bob Jones')
+    @taggable.update_attribute :tag_list, 'aaa,bbb,ccc'
+    @taggable.update_attribute :tag_list, ''
+    expect(ActsAsTaggableOn::Tag.count).to eql(0)
+
+    ActsAsTaggableOn.remove_unused_tags = remove_unused_tags_previous_setting
+    ActsAsTaggableOn.tags_counter = tags_counter_previous_setting
+  end
+
   describe 'context scopes' do
     before do
       @tagging_2 = ActsAsTaggableOn::Tagging.new
@@ -61,12 +77,14 @@ describe ActsAsTaggableOn::Tagging do
       @tagging.tag = ActsAsTaggableOn::Tag.create(name: "Physics")
       @tagging.tagger = @tagger
       @tagging.context = 'Science'
+      @tagging.tenant = 'account1'
       @tagging.save
 
       @tagging_2.taggable = TaggableModel.create(name: "Satellites")
       @tagging_2.tag = ActsAsTaggableOn::Tag.create(name: "Technology")
       @tagging_2.tagger = @tagger_2
       @tagging_2.context = 'Science'
+      @tagging_2.tenant = 'account1'
       @tagging_2.save
 
       @tagging_3.taggable = TaggableModel.create(name: "Satellites")
@@ -98,6 +116,14 @@ describe ActsAsTaggableOn::Tagging do
       end
     end
 
+    describe '.by_tenant' do
+      it "should find taggings by tenant" do
+        expect(ActsAsTaggableOn::Tagging.by_tenant('account1').length).to eq(2);
+        expect(ActsAsTaggableOn::Tagging.by_tenant('account1').first).to eq(@tagging);
+        expect(ActsAsTaggableOn::Tagging.by_tenant('account1').second).to eq(@tagging_2);
+      end
+    end
+
     describe '.not_owned' do
       before do
         @tagging_4 = ActsAsTaggableOn::Tagging.new

data/spec/internal/app/models/taggable_model.rb

@@ -3,6 +3,8 @@ class TaggableModel < ActiveRecord::Base
   acts_as_taggable_on :languages
   acts_as_taggable_on :skills
   acts_as_taggable_on :needs, :offerings
+  acts_as_taggable_tenant :tenant_id
+
   has_many :untaggable_models
 
   attr_reader :tag_list_submethod_called

data/spec/internal/config/database.yml.sample

@@ -4,16 +4,12 @@ sqlite3:
 
 mysql:
   adapter: mysql2
-  host: localhost
+  host: 127.0.0.1
   username: root
   password:
   database: acts_as_taggable_on
-  charset: utf8
+  encoding: utf8
   
 postgresql:
-  adapter: postgresql
-  hostname: localhost
-  username: postgres
-  password:
-  database: acts_as_taggable_on
-  encoding: utf8
+  # Needs to be given as a URL to force connection via TCP
+  url: postgresql://postgres:postgres@127.0.0.1:5432/acts_as_taggable_on?encoding=utf8

data/spec/internal/db/schema.rb

@@ -21,6 +21,8 @@ ActiveRecord::Schema.define version: 0 do
     # length for MyISAM table type: http://bit.ly/vgW2Ql
     t.string :context, limit: 128
 
+    t.string :tenant , limit: 128
+
     t.datetime :created_at
   end
   add_index ActsAsTaggableOn.taggings_table,
@@ -34,6 +36,7 @@ ActiveRecord::Schema.define version: 0 do
   create_table :taggable_models, force: true do |t|
     t.column :name, :string
     t.column :type, :string
+    t.column :tenant_id, :integer
   end
 
   create_table :columns_override_models, force: true do |t|

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: acts-as-taggable-on
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Michael Bleigh
 - Joost Baaij
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-31 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -110,9 +110,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/spec.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -121,7 +121,6 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- UPGRADING.md
 - acts-as-taggable-on.gemspec
 - db/migrate/1_acts_as_taggable_on_migration.rb
 - db/migrate/2_add_missing_unique_indices.rb
@@ -129,6 +128,7 @@ files:
 - db/migrate/4_add_missing_taggable_index.rb
 - db/migrate/5_change_collation_for_tag_names.rb
 - db/migrate/6_add_missing_indexes_on_taggings.rb
+- db/migrate/7_add_tenant_to_taggings.rb
 - gemfiles/activerecord_5.0.gemfile
 - gemfiles/activerecord_5.1.gemfile
 - gemfiles/activerecord_5.2.gemfile
@@ -200,15 +200,7 @@ homepage: https://github.com/mbleigh/acts-as-taggable-on
 licenses:
 - MIT
 metadata: {}
-post_install_message: |-
-  When upgrading
-
-  Re-run the migrations generator
-
-      rake acts_as_taggable_on_engine:install:migrations
-
-  This will create any new migrations and skip existing ones
-  Version 3.5.0 has a migration for mysql adapter
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -224,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Advanced tagging for Rails.
 test_files:

data/.travis.yml

@@ -1,49 +0,0 @@
-language: ruby
-cache: bundler
-
-addons:
-  postgresql: '10'
-
-services:
-  - mysql
-  - postgresql
-
-rvm:
-  - 2.7.0
-  - 2.6.5
-  - 2.5.5
-  - 2.4.6
-  - 2.3.7
-
-env:
-  - DB=sqlite3
-  - DB=mysql
-  - DB=postgresql
-
-gemfile:
-  - gemfiles/activerecord_5.2.gemfile
-  - gemfiles/activerecord_5.1.gemfile
-  - gemfiles/activerecord_5.0.gemfile
-  - gemfiles/activerecord_6.0.gemfile
-  - gemfiles/activerecord_6.1.gemfile
-
-bundler_args: '--without local_development --jobs 3 --retry 3'
-
-before_install:
-    - gem install bundler
-
-script: bundle exec rake
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
-  exclude:
-    - rvm: 2.3.7
-      gemfile: gemfiles/activerecord_6.0.gemfile
-    - rvm: 2.4.6
-      gemfile: gemfiles/activerecord_6.0.gemfile
-    - rvm: 2.3.7
-      gemfile: gemfiles/activerecord_6.1.gemfile
-    - rvm: 2.4.6
-      gemfile: gemfiles/activerecord_6.1.gemfile

data/UPGRADING.md

@@ -1,8 +0,0 @@
-When upgrading
-
-Re-run the migrations generator
-
-    rake acts_as_taggable_on_engine:install:migrations
-
-This will create any new migrations and skip existing ones
-Version 3.5.0 has a migration for mysql adapter