make_taggable 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0899d63ba230419961175b79e863fe890723fd2a58bf26a53c9fd5c75c8ce382'
-  data.tar.gz: 7cd1bd0136a30e8c9a2c0136ce064b6d334f2e4a29e9c5bd357988b07f6091e3
+  metadata.gz: d9c3e4304ca2823d876d4ca13908a567b0d5be1521a2c413b39a98d8adbe976f
+  data.tar.gz: df708319ca01f12577082ada78b8a9093508aabd8013aeb5f02354c92ba29be7
 SHA512:
-  metadata.gz: d64862b76207d13c1411825adf40705ec70ec78f23ac11faf58ddcbc35e76f2c698910b7a5828f1ee831ba344210bd637bf84bf44dafc4c4ced3fbc84b051ec6
-  data.tar.gz: f6a75d3805a9afa297753266351286a14d390fe5c96d8074234ded4ea6678c3e67f77b821eabb5c9db6e3775da9b02f9ac912de953b2c31bfe00819c6b91bdc0
+  metadata.gz: f5e8acad4d9852e5ce2c7d44135126d2a1b70cff524c69d3d93531f271a4eb454608f2ca172945393cc4779e824201500b05dba24979854826725e146691bd4f
+  data.tar.gz: 044af9b759de0558e7adf4617ecfac8264421f7effc04db64556233215aa93357aaac951754378fdab996f1e3522a43eb3d363c9a66e978132a82886140fed84

data/CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project are documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.7.1] - 2026-08-23
+
+### Fixed
+
+- `tagged_with(..., exclude: true, match_all: true)` raised `HAVING clause on a non-aggregate query`.
+  The combination is now refused with an `ArgumentError`: `:match_all` selects records carrying only
+  the given tags, `:exclude` selects records carrying none of them, and no set of records satisfies
+  both.
+
+- Tag creation retries on a deadlock as well as on a duplicate key. Under concurrent writes MySQL
+  reports one or the other depending on how two inserts of the same name interleave on the unique
+  index, and only the second was being retried -- so a busy application could see
+  `ActiveRecord::Deadlocked` escape from what is meant to be a transparent retry.
+
+### Internal
+
+- Coverage is measured (`COVERAGE=1 bundle exec rspec`) with a floor enforced in CI. It found the
+  `:exclude` combination above on its first run.
+- The concurrency example runs. It had been skipped since the fork and referenced a `Barrier` class
+  that did not exist, so concurrent tag creation was untested outright.
+- `UPGRADING.md`, which ships as the gem's post-install message, covers the whole 1.x line rather
+  than stopping at 1.0.
+- The 1.7.0 changelog entry was split in two by a stray `Unreleased` heading, so the per-context
+  vocabulary changes that shipped in it were filed as unreleased. Folded back into 1.7.0.
+
 ## [1.7.0] - 2026-08-23
 
 ### Added
@@ -23,20 +48,6 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   This is a global setting. Giving different contexts different vocabularies is a separate thing and
   needs a `type` column -- see [docs/contexts.md](docs/contexts.md).
 
-### Fixed
-
-- A tag list came back in whatever order the database chose. An `ORDER BY` was applied only under
-  `make_ordered_taggable`, so `record.tag_list` could return the same tags in different orders on
-  different calls or adapters, and `tag_list_was` could report an original the list had never been
-  in. Lists are now always ordered by when each tag was applied; `preserve_tag_order` keeps its
-  existing meaning for writes and for change detection.
-
-- The documentation for `find_or_create_tags_from_list_with_context` claimed overriding it keeps a
-  separate vocabulary for one context. It does not: it routes creation only, and without a `type`
-  column on the tags table nothing distinguishes a subclass's rows.
-
-## [Unreleased]
-
 ### Changed
 
 - The tag name uniqueness validation scopes itself by `type` when the tags table has that column, so
@@ -50,6 +61,16 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Fixed
 
+- A tag list came back in whatever order the database chose. An `ORDER BY` was applied only under
+  `make_ordered_taggable`, so `record.tag_list` could return the same tags in different orders on
+  different calls or adapters, and `tag_list_was` could report an original the list had never been
+  in. Lists are now always ordered by when each tag was applied; `preserve_tag_order` keeps its
+  existing meaning for writes and for change detection.
+
+- The documentation for `find_or_create_tags_from_list_with_context` claimed overriding it keeps a
+  separate vocabulary for one context. It does not: it routes creation only, and without a `type`
+  column on the tags table nothing distinguishes a subclass's rows.
+
 - The recipe in `docs/contexts.md` for giving a context its own vocabulary did not work. It had you
   add a `type` column and widen the unique index, then failed on the model validation with `Name has
   already been taken` -- after a column had been added and a unique index rewritten on a production

data/CONTRIBUTING.md

@@ -17,7 +17,9 @@ smallest model and code that reproduce the problem.
 5. Format: `bundle exec standardrb --fix`.
 6. Document any public API you added: `bundle exec yard stats --list-undoc` should report 100%.
 7. Add an entry to [CHANGELOG.md](CHANGELOG.md) under "unreleased".
-8. Open a pull request explaining what changed and why.
+8. If it changes something an application would have to react to, add it to
+   [UPGRADING.md](UPGRADING.md) — that file is the gem's post-install message.
+9. Open a pull request explaining what changed and why.
 
 Keep commits small and well described, and link any relevant issues. Don't bump the version — that
 happens at release.
@@ -38,6 +40,26 @@ DATABASE_ADAPTER=postgresql DATABASE_URL=postgres://localhost/make_taggable_test
 DATABASE_ADAPTER=mysql2 DATABASE_URL=mysql2://root@127.0.0.1/make_taggable_test bundle exec rake
 ```
 
+Worth doing before opening a pull request if you touched anything that generates SQL. Several bugs
+in this gem only appeared on one adapter — SQLite in particular is forgiving enough to hide them,
+and one of them passed on SQLite only because it treats an unresolvable double-quoted identifier as
+a string literal.
+
+The concurrency example does not run on SQLite. It needs an adapter that supports real concurrent
+writes, so it is skipped there and runs on MySQL and PostgreSQL.
+
+## Coverage
+
+```shell
+COVERAGE=1 bundle exec rspec
+```
+
+The run fails if coverage drops below the floor set in `spec/spec_helper.rb`, and CI runs it on
+every pull request. Raise the floor when coverage improves; never lower it to make a run pass.
+
+Coverage is a way of finding untested paths, not a target. The last time it was measured it pointed
+straight at an untested option combination that turned out to be broken.
+
 Across every supported Rails version:
 
 ```shell

data/UPGRADING.md

@@ -1,35 +1,116 @@
-Upgrading to MakeTaggable 1.0
+Upgrading MakeTaggable
 
-This release renames the declaration methods and changes how delimiters are escaped.
+Only the changes that can ask something of you are listed. Everything else is
+in CHANGELOG.md.
 
-1. Rename the declarations in your models:
+--------------------------------------------------------------------------
+1.7.0
 
-     acts_as_taggable                    ->  make_taggable
-     acts_as_taggable_on :skills         ->  make_taggable :skills
-     acts_as_ordered_taggable            ->  make_ordered_taggable
-     acts_as_ordered_taggable_on :skills ->  make_ordered_taggable :skills
-     acts_as_tagger                      ->  make_tagger
+  Tag lists come back in a stable order
 
-   Everything generated per context keeps its name: skill_list, skills,
-   skill_counts, top_skills, skills_from, find_related_skills.
+    A list is now ordered by when each tag was applied. Before, an order was
+    only applied under make_ordered_taggable, so the database chose -- and on
+    PostgreSQL that could differ between calls.
 
-2. If you configure a delimiter containing a regular expression
-   metacharacter, unescape it. Delimiters are now literal strings:
+    Nothing to change. If you were sorting a list defensively, you no longer
+    need to.
 
-     MakeTaggable.delimiter = ['\|']  ->  MakeTaggable.delimiter = ["|"]
+  New: a Tag class of your own
 
-3. If you rely on `make_taggable` with no arguments adding no contexts,
-   note that it now tags on :tags.
+    MakeTaggable.setup { |config| config.tag_class = "MyApp::Tag" }
 
-4. Requirements are now Ruby 3.2 and Active Record 7.2 or newer.
+    Name the class as a String, in an initializer. See docs/configuration.md.
 
-Note for anyone upgrading past 1.0: a later migration adds a unique index
-preventing duplicate unowned taggings. If it fails, your taggings table
-already holds duplicates -- docs/database.md has a snippet to clear them.
+--------------------------------------------------------------------------
+1.6.0
 
-Install any new migrations:
+  Eager loading tag lists actually works
 
-    rails make_taggable_engine:install:migrations
-    rails db:migrate
+    Book.includes(:tags).each { |book| book.tag_list }
 
-Full notes: https://github.com/MatthewKennedy/make_taggable/blob/master/CHANGELOG.md
+    used to cost a query per record on top of the preload. It no longer does.
+    Nothing to change.
+
+--------------------------------------------------------------------------
+1.4.0                                                          ACTION NEEDED
+
+  Tag lists are no longer in as_json
+
+    A tag list is not an Active Record attribute any more, so it is not in
+    attributes and not in as_json. This is what stops serialising a
+    collection querying once per record.
+
+    If an API response included a tag list, it will stop:
+
+      book.as_json                          # no "tag_list" key
+      book.as_json(methods: :tag_list)      # ask for it
+
+    attributes["tag_list"] is gone too -- it always returned nil, while
+    tag_list returned the tags. Use tag_list.
+
+    Dirty tracking is unchanged: tag_list_changed?, _was, _change,
+    saved_change_to_tag_list? and changes all still work.
+
+    MakeTaggable::Taggable::TagListType is removed. It backed the attribute.
+
+--------------------------------------------------------------------------
+1.3.0                                                          ACTION NEEDED
+
+  tagged_with no longer joins the taggings table
+
+    It tests for each tag with an EXISTS subquery instead. That is what stops
+    a record being returned once per matching tagging -- a tag applied in two
+    contexts used to return the record twice, and .count disagreed with the
+    number of records.
+
+    A taggings column is no longer in scope on the relation:
+
+      Book.tagged_with("sci-fi").order("taggings.created_at")            # was fine
+      Book.tagged_with("sci-fi").joins(:taggings).order("taggings.created_at")
+
+    Joining brings back one row per tagging, so add .distinct if you want
+    records rather than matches.
+
+  Five indexes dropped from taggings
+
+    Migration 7 removes single-column indexes on tag_id, taggable_id,
+    taggable_type and tagger_id, plus a duplicate of the tagger pair. Each is
+    a leading column of an index that remains, so no query plan changes --
+    but every index was maintained on insert.
+
+    It is not applied automatically:
+
+      rails make_taggable_engine:install:migrations
+
+--------------------------------------------------------------------------
+1.2.0
+
+  A migration you may want
+
+    Migration 6 adds a partial unique index stopping duplicate unowned
+    taggings, which the existing index could not do because it spans the
+    nullable tagger columns. Install it the same way. MySQL has no partial
+    indexes, so it is a no-op there.
+
+--------------------------------------------------------------------------
+1.0.0                                                          ACTION NEEDED
+
+  The declaration methods were renamed
+
+    acts_as_taggable                    ->  make_taggable
+    acts_as_taggable_on :skills         ->  make_taggable :skills
+    acts_as_ordered_taggable            ->  make_ordered_taggable
+    acts_as_ordered_taggable_on :skills ->  make_ordered_taggable :skills
+
+  Delimiters are literal strings
+
+    A delimiter is no longer interpolated into a pattern unescaped, so it no
+    longer needs escaping by hand:
+
+      MakeTaggable.delimiter = '\|'   ->   MakeTaggable.delimiter = "|"
+
+  make_taggable with no arguments tags on :tags
+
+    It previously added no contexts at all, despite the documentation.
+
+  Minimum versions are Ruby 3.2 and Active Record 7.2

data/lib/make_taggable/tag.rb

@@ -197,7 +197,11 @@ module MakeTaggable
         # unwinds only the failed insert. Without one the caller's transaction
         # is left in an aborted state and everything it had done is lost.
         transaction(requires_new: true) { create(name: tag_name) }.tap { |tag| existing_tags << tag }
-      rescue ActiveRecord::RecordNotUnique
+        # A deadlock counts as losing the race, the same as a duplicate key.
+        # MySQL reports one or the other depending on how two inserts of the
+        # same name interleave on the unique index, and both mean the work
+        # should be re-read and retried rather than abandoned.
+      rescue ActiveRecord::RecordNotUnique, ActiveRecord::Deadlocked
         if (tries -= 1).positive?
           existing_tags = named_any(list).to_a
           retry

data/lib/make_taggable/taggable/tagged_with_query/exclude_tags_query.rb

@@ -13,7 +13,6 @@ module MakeTaggable::Taggable::TaggedWithQuery
     def build
       taggable_model.joins(owning_to_tagger)
         .where(tags_not_in_list)
-        .having(tags_that_matches_count)
         .readonly(false)
     end
 
@@ -61,44 +60,7 @@ module MakeTaggable::Taggable::TaggedWithQuery
           .and(tagging_arel_table[:taggable_type].eq(taggable_model.base_class.name))
         )
 
-      if options[:match_all].present?
-        arel_join = arel_join
-          .join(tagging_arel_table, Arel::Nodes::OuterJoin)
-          .on(
-            match_all_on_conditions
-          )
-      end
-
       arel_join.join_sources
     end
-
-    def match_all_on_conditions
-      on_condition = tagging_arel_table[:taggable_id].eq(taggable_arel_table[taggable_model.primary_key])
-        .and(tagging_arel_table[:taggable_type].eq(taggable_model.base_class.name))
-
-      if options[:start_at].present?
-        on_condition = on_condition.and(tagging_arel_table[:created_at].gteq(options[:start_at]))
-      end
-
-      if options[:end_at].present?
-        on_condition = on_condition.and(tagging_arel_table[:created_at].lteq(options[:end_at]))
-      end
-
-      if options[:on].present?
-        on_condition = on_condition.and(context_predicate)
-      end
-
-      on_condition
-    end
-
-    def tags_that_matches_count
-      return [] unless options[:match_all].present?
-
-      taggable_model.find_by_sql(tag_arel_table.project(Arel.star.count).where(tags_match_type).to_sql)
-
-      tagging_arel_table[:taggable_id].count.eq(
-        tag_arel_table.project(Arel.star.count).where(tags_match_type)
-      )
-    end
   end
 end

data/lib/make_taggable/taggable/tagged_with_query.rb

@@ -22,6 +22,13 @@ module MakeTaggable::Taggable::TaggedWithQuery
   # @return [ActiveRecord::Relation]
   #
   def self.build(taggable_model, tag_model, tagging_model, tag_list, options)
+    if options[:exclude].present? && options[:match_all].present?
+      raise ArgumentError,
+        ":match_all and :exclude cannot be combined. :match_all selects records carrying only the " \
+        "given tags and nothing else, :exclude selects records carrying none of them, and there is " \
+        "no set of records that satisfies both."
+    end
+
     if options[:exclude].present?
       ExcludeTagsQuery.new(taggable_model, tag_model, tagging_model, tag_list, options).build
     elsif options[:any].present?

data/lib/make_taggable/version.rb

@@ -6,5 +6,5 @@ module MakeTaggable
   #
   # @return [String]
   #
-  VERSION = "1.7.0"
+  VERSION = "1.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: make_taggable
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Matthew Kennedy
@@ -92,41 +92,122 @@ metadata:
   documentation_uri: https://github.com/MatthewKennedy/make_taggable/blob/master/docs
   rubygems_mfa_required: 'true'
 post_install_message: |
-  Upgrading to MakeTaggable 1.0
+  Upgrading MakeTaggable
 
-  This release renames the declaration methods and changes how delimiters are escaped.
+  Only the changes that can ask something of you are listed. Everything else is
+  in CHANGELOG.md.
 
-  1. Rename the declarations in your models:
+  --------------------------------------------------------------------------
+  1.7.0
 
-       acts_as_taggable                    ->  make_taggable
-       acts_as_taggable_on :skills         ->  make_taggable :skills
-       acts_as_ordered_taggable            ->  make_ordered_taggable
-       acts_as_ordered_taggable_on :skills ->  make_ordered_taggable :skills
-       acts_as_tagger                      ->  make_tagger
+    Tag lists come back in a stable order
 
-     Everything generated per context keeps its name: skill_list, skills,
-     skill_counts, top_skills, skills_from, find_related_skills.
+      A list is now ordered by when each tag was applied. Before, an order was
+      only applied under make_ordered_taggable, so the database chose -- and on
+      PostgreSQL that could differ between calls.
 
-  2. If you configure a delimiter containing a regular expression
-     metacharacter, unescape it. Delimiters are now literal strings:
+      Nothing to change. If you were sorting a list defensively, you no longer
+      need to.
 
-       MakeTaggable.delimiter = ['\|']  ->  MakeTaggable.delimiter = ["|"]
+    New: a Tag class of your own
 
-  3. If you rely on `make_taggable` with no arguments adding no contexts,
-     note that it now tags on :tags.
+      MakeTaggable.setup { |config| config.tag_class = "MyApp::Tag" }
 
-  4. Requirements are now Ruby 3.2 and Active Record 7.2 or newer.
+      Name the class as a String, in an initializer. See docs/configuration.md.
 
-  Note for anyone upgrading past 1.0: a later migration adds a unique index
-  preventing duplicate unowned taggings. If it fails, your taggings table
-  already holds duplicates -- docs/database.md has a snippet to clear them.
+  --------------------------------------------------------------------------
+  1.6.0
 
-  Install any new migrations:
+    Eager loading tag lists actually works
 
-      rails make_taggable_engine:install:migrations
-      rails db:migrate
+      Book.includes(:tags).each { |book| book.tag_list }
 
-  Full notes: https://github.com/MatthewKennedy/make_taggable/blob/master/CHANGELOG.md
+      used to cost a query per record on top of the preload. It no longer does.
+      Nothing to change.
+
+  --------------------------------------------------------------------------
+  1.4.0                                                          ACTION NEEDED
+
+    Tag lists are no longer in as_json
+
+      A tag list is not an Active Record attribute any more, so it is not in
+      attributes and not in as_json. This is what stops serialising a
+      collection querying once per record.
+
+      If an API response included a tag list, it will stop:
+
+        book.as_json                          # no "tag_list" key
+        book.as_json(methods: :tag_list)      # ask for it
+
+      attributes["tag_list"] is gone too -- it always returned nil, while
+      tag_list returned the tags. Use tag_list.
+
+      Dirty tracking is unchanged: tag_list_changed?, _was, _change,
+      saved_change_to_tag_list? and changes all still work.
+
+      MakeTaggable::Taggable::TagListType is removed. It backed the attribute.
+
+  --------------------------------------------------------------------------
+  1.3.0                                                          ACTION NEEDED
+
+    tagged_with no longer joins the taggings table
+
+      It tests for each tag with an EXISTS subquery instead. That is what stops
+      a record being returned once per matching tagging -- a tag applied in two
+      contexts used to return the record twice, and .count disagreed with the
+      number of records.
+
+      A taggings column is no longer in scope on the relation:
+
+        Book.tagged_with("sci-fi").order("taggings.created_at")            # was fine
+        Book.tagged_with("sci-fi").joins(:taggings).order("taggings.created_at")
+
+      Joining brings back one row per tagging, so add .distinct if you want
+      records rather than matches.
+
+    Five indexes dropped from taggings
+
+      Migration 7 removes single-column indexes on tag_id, taggable_id,
+      taggable_type and tagger_id, plus a duplicate of the tagger pair. Each is
+      a leading column of an index that remains, so no query plan changes --
+      but every index was maintained on insert.
+
+      It is not applied automatically:
+
+        rails make_taggable_engine:install:migrations
+
+  --------------------------------------------------------------------------
+  1.2.0
+
+    A migration you may want
+
+      Migration 6 adds a partial unique index stopping duplicate unowned
+      taggings, which the existing index could not do because it spans the
+      nullable tagger columns. Install it the same way. MySQL has no partial
+      indexes, so it is a no-op there.
+
+  --------------------------------------------------------------------------
+  1.0.0                                                          ACTION NEEDED
+
+    The declaration methods were renamed
+
+      acts_as_taggable                    ->  make_taggable
+      acts_as_taggable_on :skills         ->  make_taggable :skills
+      acts_as_ordered_taggable            ->  make_ordered_taggable
+      acts_as_ordered_taggable_on :skills ->  make_ordered_taggable :skills
+
+    Delimiters are literal strings
+
+      A delimiter is no longer interpolated into a pattern unescaped, so it no
+      longer needs escaping by hand:
+
+        MakeTaggable.delimiter = '\|'   ->   MakeTaggable.delimiter = "|"
+
+    make_taggable with no arguments tags on :tags
+
+      It previously added no contexts at all, despite the documentation.
+
+    Minimum versions are Ruby 3.2 and Active Record 7.2
 rdoc_options: []
 require_paths:
 - lib