make_taggable 0.7.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 418910d2f9e9a651f3101d4e9d1688d970e1fa5aa4bd4036ba7bcf8e0efff02b
-  data.tar.gz: 6aeadae682477523982efee1f9a4903613c5a23e3512580d32f7c8e319516a16
+  metadata.gz: be8e033e4d750a0bc75a77f652351843c096f38d8f8332f56e9d642e2085f12b
+  data.tar.gz: 698531499c7e7636b241b854cf60e2e2aee3799af3dba3d2d8a5f1ae2ff954f1
 SHA512:
-  metadata.gz: e63d4adb3aff65c339dc11359b908b93afd8f3cf142862b27868238af14f7e885a0b9076ca7ac4915090caa4dad591b7ad809d9177c1d4433a2b9f35d526808c
-  data.tar.gz: '097d51f1401b7112455748cdd3be4e6024c87f6ffef95005c74dc384d67726b0451de624053e8d7d4e19dfe03b59c7387df4ab16e24643fe63ab0b91e4f0487c'
+  metadata.gz: c2f772cac980b2bab6c101c087916f3083f519aaec61c8c45ad4cd8750ab95dc6f9534d4ac2a511a6411872590dcfb4a58c3af7f68611458365ff8e5ce024866
+  data.tar.gz: 50aae450f2dfd5923ecf8c18a348b6e7e27b761d71d7fd59b61498c338341f607b735194b2a56da154624ad71e84a748f3a3aebec84beb0a6a21b3a7d0f244b0

data/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+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.0.0] - unreleased
+
+### Breaking
+
+- **Removed the `acts_as_*` method names.** Use `make_taggable`, `make_ordered_taggable` and
+  `make_tagger` in place of `acts_as_taggable`, `acts_as_taggable_on`, `acts_as_ordered_taggable`,
+  `acts_as_ordered_taggable_on` and `acts_as_tagger`.
+- **Delimiters are literal strings.** They were previously interpolated into a pattern unescaped,
+  so a delimiter containing a regular expression metacharacter had to be escaped by hand. Pass
+  `"|"` where you previously passed `'\|'`.
+- **`make_taggable` with no arguments now tags on `:tags`.** It previously added no contexts at
+  all, despite the README documenting otherwise.
+- **Raised the minimum versions** to Ruby 3.2 and Active Record 7.2, and removed the Active Record
+  upper bound.
+
+See [UPGRADING.md](UPGRADING.md).
+
+### Fixed
+
+- Tags containing non-ASCII characters no longer raise
+  `Encoding::UndefinedConversionError`. `Tag.named_any` was forcing sanitised SQL to `BINARY`.
+- A delimiter containing a regular expression metacharacter no longer corrupts parsing. A `"."`
+  delimiter previously discarded every tag.
+- `MakeTaggable::Dirty` and `MakeTaggable::Compatibility` no longer raise `LoadError`. Both were
+  declared as autoloads pointing at files that do not exist.
+- `MakeTaggable.delimiter=` no longer raises `NoMethodError` when Active Record has no logger,
+  which is the case in a plain Active Record process or an initializer that runs early.
+- Class names are parameterised through `sanitize_sql` rather than interpolated into SQL.
+- `Tag.find_or_create_with_like_by_name` matches the whole name rather than a substring of it.
+  Asking for `"ruby"` while a tag named `"ruby on rails"` existed returned that tag instead of
+  creating the one requested. It is also no longer at the mercy of the column's collation, which
+  the MySQL migration sets to `utf8mb4_bin` -- on MySQL the method created a duplicate row for a
+  name differing only in case, despite `strict_case_match` being off.
+- `Tag.find_or_create_all_with_like_by_name` no longer creates two rows for a list holding two
+  spellings of one name, such as `["Ruby", "ruby"]`. Tags created during the call were invisible to
+  the names that followed. Tagging through a tag list was never affected, since the list dedupes
+  before the lookup.
+
+### Changed
+
+- Replaced `String#mb_chars` and `ActiveSupport::Multibyte::Chars`, both removed in Rails 8.2, with
+  plain String methods.
+- Removed the Active Record 5 compatibility branches and the Rails 5 `count` workaround's dead
+  argument.
+- Added `frozen_string_literal` to every file in `lib`.
+- The deprecation warning on `MakeTaggable.delimiter=` no longer refers to a "v4.0" that does not
+  exist in this gem's history.
+
+### Documentation
+
+- Public API documentation coverage raised from 38.65% to 100%, with no YARD warnings.
+- Rewrote the README against the actual API, and added a `docs/` directory covering contexts,
+  querying, ownership, parsers, caching, tag clouds, configuration, the database schema, and
+  migrating from acts-as-taggable-on.
+
+### Internal
+
+- Replaced the test harness. The suite runs against bare Active Record instead of a generated dummy
+  application, dropping the `rails-dummy` dependency and the `create_test_app` step, and builds its
+  schema from the gem's own migrations.
+- Replaced `spec/make_taggable/tag_spec.rb`. The file of that name contained no tests: it was a
+  stale copy of `lib/make_taggable/tag.rb` that RSpec loaded, silently redefining
+  `MakeTaggable::Tag` and reverting it part way through the suite. `MakeTaggable::Tag` now has 45
+  unit specs, covering validations, every lookup and creation method, comparison, the scopes, and
+  the taggings association.
+- CI covers Rails 7.2, 8.0, 8.1 and main on Ruby 3.2 through 4.0.
+
+## [0.7.5] - 2021-03-17
+
+Earlier releases predate this changelog. See the
+[commit history](https://github.com/MatthewKennedy/make_taggable/commits/master) for 0.7.x and
+below.

data/CONTRIBUTING.md

@@ -1,31 +1,74 @@
-# How to contribute:
+# Contributing
 
-## Bug reports / Issues
+## Bug reports
 
-  * Is something broken or not working as expected? Check for an existing issue or [create a new one](https://github.com/MatthewKennedy/make_taggable/issues/new)
-  * IMPORTANT: Include the version of the gem, if you've install from git, what Ruby and Rails you are running, etc.
+Check for an [existing issue](https://github.com/MatthewKennedy/make_taggable/issues) first, then
+[open a new one](https://github.com/MatthewKennedy/make_taggable/issues/new).
 
-## Code
+Please include the version of the gem, your Ruby and Rails versions, your database adapter, and the
+smallest model and code that reproduce the problem.
 
-1. [Fork and clone the repo](https://help.github.com/articles/fork-a-repo)
-2. Install the gem dependencies: `bundle install`
-3. Make the changes you want and back them up with tests.
-4. Run the tests](https://github.com/MatthewKennedy/make_taggable#testing)
-5. Update the CHANGELOG.md file with your changes and give yourself credit
-6. Commit and create a pull request with details as to what has been changed and why
-  * Use well-described, small (atomic) commits.
-  * Include links to any relevant github issues.
-  * *Don't* change the VERSION file.
+## Making a change
 
-## How I handle pull requests:
+1. [Fork and clone the repo](https://help.github.com/articles/fork-a-repo).
+2. `bundle install`.
+3. Write a failing test first, then make it pass.
+4. Run the suite: `bundle exec rake`.
+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.
 
-* If the tests pass and the pull request looks good, I will merge it.
-* If the pull request needs to be changed,
-  * you can change it by updating the branch you generated the pull request from
-    * either by adding more commits, or
-    * by force pushing to it
-  * I can make any changes myself and manually merge the code in.
+Keep commits small and well described, and link any relevant issues. Don't bump the version — that
+happens at release.
+
+## Running the tests
+
+The suite runs against bare Active Record, using in-memory SQLite by default. There is no dummy
+application to generate.
+
+```shell
+bundle exec rake
+```
+
+Against another adapter:
+
+```shell
+DATABASE_ADAPTER=postgresql DATABASE_URL=postgres://localhost/make_taggable_test bundle exec rake
+DATABASE_ADAPTER=mysql2 DATABASE_URL=mysql2://root@127.0.0.1/make_taggable_test bundle exec rake
+```
+
+Across every supported Rails version:
+
+```shell
+bundle exec appraisal install
+bundle exec appraisal rake
+```
+
+### A note on test ordering
+
+The suite runs in defined order. Several examples mutate shared model classes — adding a context to
+`TaggableModel`, flipping `preserve_tag_order` — and rely on siblings having run first. Randomising
+the order exposes this. Making those examples self-contained is welcome work; until then, please
+don't add new examples that depend on a sibling's side effects.
 
 ## Documentation
 
-* Update the wiki
+Prose documentation lives in [docs/](docs). API documentation is YARD comments in `lib`, following
+the style already there: a `##` opening line, a description, a blank line, then tags with real Ruby
+types.
+
+Build it locally with `bundle exec yard doc`.
+
+## Releasing
+
+Maintainers only. Bump `lib/make_taggable/version.rb`, move the "unreleased" changelog heading to
+the new version, then tag:
+
+```shell
+git tag v1.0.0
+git push origin v1.0.0
+```
+
+The release workflow runs the suite, checks formatting and documentation coverage, and publishes to
+RubyGems via trusted publishing.

data/LICENSE.md

@@ -1,20 +1,21 @@
-__Copyright (c) 2020 Matthew Kennedy.__
+The MIT License (MIT)
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2021 Matthew Kennedy
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.