make_taggable 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9313e4b6fc5d1b81f44b56665f2dbf6c6a8c8a8213f492b00e17e1e20c0a27bb
-  data.tar.gz: ef32dbb42368817bea0791803f1013f1481d58ca50992551131483b7fac416ab
+  metadata.gz: 7d3a7c89a48d79f6d985b8290d88007368ecdf983789a7e4881662724a1060a9
+  data.tar.gz: dda60e219b50e10b8948b6b9b260e703d8815f43bd200b1c434875144ae68071
 SHA512:
-  metadata.gz: 750c882a7d5836848cfd7d536896403cb619868121a817d9aa89ac2aed7e36d6f3d9cf70be5be04e1dd428e35484957b1f49ba17a2e7ef50f2a67adc271d7510
-  data.tar.gz: d14dba688a46a5e48507a082d7b65071aa8e0197df657156c3859652fcabd8eca5e0c5256033f7a9c4665d197c87177f0d9107c010e811d671fc1de2011b4d1f
+  metadata.gz: 7aa7e8b6c7190cbc8fbdcaf54fd5f49bf8f877c3161c7466e7df98eefd8f14eaa208391b47fa5a328db563d489d5e9a6f82b3bfd4b0ce770cdedbf3423f958bc
+  data.tar.gz: 0e868727368e57e72fe627cbbc4b7a4dc2077e459d6ac9131732788fec26a88037bd7ed12cb86a35f3b8308b3df7fa238319c24628f39e698c073e7d0dd8fa68

data/CHANGELOG.md

@@ -5,6 +5,21 @@ 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.1.1] - 2026-08-22
+
+### Fixed
+
+- Documentation examples used `params.expect` and `ActiveRecord::Migration[8.0]`, neither of which
+  exists on Active Record 7.2 -- the version the gem promises to support. Both are corrected, and
+  `spec/docs_spec.rb` now fails the build if either creeps back.
+
+### Internal
+
+- Added documentation checks to the suite: every Ruby block in the README and `docs/` must parse,
+  example migrations must declare a version the floor accepts, version-sensitive calls must be
+  shown alongside an alternative, and relative links must resolve. They run on every Rails version
+  in the matrix.
+
 ## [1.1.0] - 2026-08-22
 
 ### Added

data/CONTRIBUTING.md

@@ -64,6 +64,12 @@ Prose documentation lives in [docs/](docs). API documentation is YARD comments i
 the style already there: a `##` opening line, a description, a blank line, then tags with real Ruby
 types.
 
+`spec/docs_spec.rb` holds the prose to the versions the gemspec promises. It checks that every Ruby
+block parses, that no example declares a migration version newer than the supported floor, that
+calls the floor does not have are shown alongside an alternative, and that every relative link
+resolves. It runs with the rest of the suite, so it runs on every Rails version in the matrix --
+including the oldest, which is where documentation written on the newest tends to break.
+
 Build it locally with `bundle exec yard doc`.
 
 ## Releasing

data/README.md

@@ -1,7 +1,8 @@
 # MakeTaggable
 
-[![Gem Version](https://badge.fury.io/rb/make_taggable.svg)](https://badge.fury.io/rb/make_taggable)
-![CI](https://github.com/MatthewKennedy/make_taggable/workflows/CI/badge.svg)
+[![Gem Version](https://img.shields.io/gem/v/make_taggable)](https://rubygems.org/gems/make_taggable)
+[![Downloads](https://img.shields.io/gem/dt/make_taggable)](https://rubygems.org/gems/make_taggable)
+[![CI](https://github.com/MatthewKennedy/make_taggable/actions/workflows/ci.yml/badge.svg)](https://github.com/MatthewKennedy/make_taggable/actions/workflows/ci.yml)
 [![Standard Rb](https://github.com/MatthewKennedy/make_taggable/actions/workflows/standard-ci.yml/badge.svg)](https://github.com/MatthewKennedy/make_taggable/actions/workflows/standard-ci.yml)
 
 Tagging for Active Record models, across any number of named contexts.
@@ -12,7 +13,7 @@ order they were added in, and be cached on the record for display.
 
 ## Requirements
 
-| | |
+| Component | Supported |
 |---|---|
 | Ruby | 3.2 or newer |
 | Active Record | 7.2 or newer |
@@ -35,44 +36,73 @@ rails db:migrate
 
 ```ruby
 class Book < ApplicationRecord
-  make_taggable            # the :tags context
-  make_taggable :genres    # and one of your own
+  make_taggable            # the :tags context, for free-form tags
+  make_taggable :genres    # a context of your own, for a curated set
 end
 ```
 
+Each context is a separate set of tags, with its own list:
+
 ```ruby
-book = Book.create!(title: "Dune", tag_list: "sci-fi, classic")
+book = Book.create!(title: "Dune", genre_list: "sci-fi, classic")
+
+book.genre_list                  # => ["sci-fi", "classic"]
+```
 
-book.tag_list                    # => ["sci-fi", "classic"]
-book.tag_list.add("desert")
-book.tag_list.remove("classic")
+Add and remove individual tags. Nothing is written until you save:
+
+```ruby
+book.genre_list.add("space opera")
+book.genre_list.remove("classic")
 book.save
 
-book.genre_list = "science fiction"
+book.genre_list                  # => ["sci-fi", "space opera"]
+book.genres                      # => [#<MakeTaggable::Tag name: "sci-fi">, #<MakeTaggable::Tag name: "space opera">]
+```
+
+Assigning replaces the whole list, and the two contexts never touch each other:
+
+```ruby
+book.tag_list = "desert, chosen-one, re-read"
 book.save
+
+book.tag_list                    # => ["desert", "chosen-one", "re-read"]
+book.genre_list                  # => ["sci-fi", "space opera"]
 ```
 
 Find them again:
 
 ```ruby
 Book.tagged_with("sci-fi")                             # carries this tag
-Book.tagged_with(["sci-fi", "desert"])                 # carries both
+Book.tagged_with(["sci-fi", "space opera"])            # carries both
 Book.tagged_with(["sci-fi", "fantasy"], any: true)     # carries either
-Book.tagged_with(["sci-fi"], exclude: true)            # carries neither
+Book.tagged_with(["fantasy"], exclude: true)           # carries neither
+```
+
+Scope a query to one context, and tags in the others stop counting:
+
+```ruby
+Book.tagged_with("sci-fi", on: :genres)                # => [#<Book title: "Dune">]
+Book.tagged_with("sci-fi", on: :tags)                  # => []
+```
 
-Book.tag_counts_on(:genres)                            # tags with usage counts
+Counts, for tag clouds and "most used" lists:
+
+```ruby
+Book.tag_counts_on(:genres)                            # tags carrying a `count`
 Book.top_genres(10)
 ```
 
 Tags are ordinary attributes as far as your controller is concerned:
 
 ```ruby
-params.expect(book: [:title, :tag_list])
+params.expect(book: [:title, :tag_list])            # Rails 8
+params.require(:book).permit(:title, :tag_list)     # Rails 7.2
 ```
 
 ## Documentation
 
-| | |
+| Guide | Covers |
 |---|---|
 | [Getting started](docs/getting-started.md) | Install, first tagged model, reading and writing |
 | [Tag contexts](docs/contexts.md) | Multiple contexts, ordered tags, contexts created at runtime |

data/docs/caching.md

@@ -10,7 +10,7 @@ There is no setting. Add a column named `cached_<singular context>_list` and cac
 itself on for that context:
 
 ```ruby
-class AddCachedTagListToBooks < ActiveRecord::Migration[8.0]
+class AddCachedTagListToBooks < ActiveRecord::Migration[7.2]
   def change
     add_column :books, :cached_tag_list, :string
     add_column :books, :cached_genre_list, :string

data/docs/contexts.md

@@ -46,10 +46,15 @@ Calling `make_taggable` again adds contexts rather than replacing them, which is
 subclass extend its parent:
 
 ```ruby
+class Book < ApplicationRecord
+  make_taggable
+end
+
 class Manual < Book
   make_taggable :audiences
 end
 
+Book.tag_types   # => [:tags]
 Manual.tag_types # => [:tags, :audiences]
 ```
 
@@ -134,7 +139,7 @@ tags, `Market.count` returns every tag in the table, and reloading a record give
 `MakeTaggable::Tag` back. Add the column to get real separation:
 
 ```ruby
-class AddTypeToTags < ActiveRecord::Migration[8.0]
+class AddTypeToTags < ActiveRecord::Migration[7.2]
   def change
     add_column MakeTaggable.tags_table, :type, :string
     add_index MakeTaggable.tags_table, :type

data/docs/getting-started.md

@@ -83,15 +83,19 @@ class BooksController < ApplicationController
   private
 
   def book_params
-    params.expect(book: [:title, :tag_list])
+    params.expect(book: [:title, :tag_list])       # Rails 8
+    # params.require(:book).permit(:title, :tag_list)   # Rails 7.2
   end
 end
 ```
 
+`params.expect` arrived in Rails 8. On Rails 7.2 use `require` and `permit`, as commented above.
+
 To accept an array of tags from a multi-select, permit it as one:
 
 ```ruby
-params.expect(book: [:title, {tag_list: []}])
+params.expect(book: [:title, {tag_list: []}])      # Rails 8
+params.require(:book).permit(:title, tag_list: []) # Rails 7.2
 ```
 
 ## Find tagged records

data/docs/querying.md

@@ -6,18 +6,18 @@
 pagination.
 
 ```ruby
-User.tagged_with("awesome").by_join_date.limit(20)
+Book.tagged_with("sci-fi").order(published_at: :desc).limit(20)
 ```
 
 By default every tag given must be present:
 
 ```ruby
-User.tagged_with(["awesome", "cool"])              # carries awesome AND cool
-User.tagged_with(["awesome", "cool"], any: true)   # carries awesome OR cool
-User.tagged_with(["awesome", "cool"], exclude: true) # carries NEITHER
+Book.tagged_with(["sci-fi", "classic"])                # carries sci-fi AND classic
+Book.tagged_with(["sci-fi", "classic"], any: true)     # carries sci-fi OR classic
+Book.tagged_with(["sci-fi", "classic"], exclude: true) # carries NEITHER
 ```
 
-Passing nothing matches nothing. `User.tagged_with([])` and `User.tagged_with("")` both return an
+Passing nothing matches nothing. `Book.tagged_with([])` and `Book.tagged_with("")` both return an
 empty relation rather than every record — worth knowing when the tags come from user input.
 
 ### Options
@@ -27,7 +27,7 @@ empty relation rather than every record — worth knowing when the tags come fro
 | `:any` | Match records carrying at least one of the tags |
 | `:exclude` | Match records carrying none of the tags |
 | `:match_all` | Match records carrying only these tags and no others |
-| `:wild` | Match tags *containing* the given text, i.e. `%awesome%` |
+| `:wild` | Match tags *containing* the given text, i.e. `%sci%` |
 | `:on` | Restrict to one context |
 | `:owned_by` | Restrict to tags applied by one tagger |
 | `:order_by_matching_tag_count` | With `:any`, order by how many tags matched, most first |
@@ -37,15 +37,15 @@ empty relation rather than every record — worth knowing when the tags come fro
 `:wild` combines with `:any` or `:exclude`:
 
 ```ruby
-User.tagged_with(["awe", "co"], any: true, wild: true)
+Book.tagged_with(["sci", "clas"], any: true, wild: true)
 ```
 
 Contexts are matched one call at a time, so chain to combine them:
 
 ```ruby
-User
-  .tagged_with(["awesome", "cool"], on: :tags, any: true)
-  .tagged_with(["smart", "shy"], on: :skills, any: true)
+Book
+  .tagged_with(["sci-fi", "fantasy"], on: :genres, any: true)
+  .tagged_with(["desert", "space"], on: :tags, any: true)
 ```
 
 ### Case sensitivity
@@ -105,6 +105,9 @@ noticeably cheaper on a large table.
 
 ## Related records
 
+These examples switch to a `User` model tagged on `:skills` — sharing tags is easiest to picture
+with people.
+
 Records sharing tags with this one, ordered by how many tags matched:
 
 ```ruby

data/lib/make_taggable/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: make_taggable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthew Kennedy