gutentag 2.6.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a57320061f9e3181385744a38c797564a7ce45c2fceb6e51ba3bc7a5e7a4d68
-  data.tar.gz: 86d6f5d761a18434e20919b1996234896f33f5764ed2f6032cca5dbe82164e2a
+  metadata.gz: 98f15b646e502b6b79038023b1e36b4b1d148cb99744134254165ad0997733ff
+  data.tar.gz: d5f73cf67e7c0992a01730506a63567ecb62bf27bd934036c04c2fa80383eff6
 SHA512:
-  metadata.gz: 45e211fdef9849824571e960dfe21d68eaa77ca2244375952e823e031bc112d797f55513aa7adf25c6469d399ba9f7e045c7714cf875c13a754823e91cea3f17
-  data.tar.gz: 86f48f5be03702882c074ff36d055ca735ca97ef0ae9befa1fd95e750cbcea7c44b0f00e52a4df19f8007fb361816661e7415035a083ed288fd01e4f003884b8
+  metadata.gz: 3fcff8de1bf31f8c7c31183c868445e68e4ea22b836c55512b8b423efeaee1cc72f2b6b40cf5e7d3749371a87a3e8627318aa831ceb8b6a2aaeb6b30f30237fb
+  data.tar.gz: 538d5d06ce5ddad20ea227cc6ea090d6b2cead6afe97259fa7d01f6c7f80863c86ca13a66e9c8ab39f56d22ea6f34106e3cc1f32a5ce2a92d15021d3a055a0ef

data/.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0' ]
+        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.1' ]
         bundler: [ '1.17.3', '2.1.4' ]
         database: [ 'mysql', 'postgresql', 'sqlite' ]
         exclude:
@@ -23,14 +23,16 @@ jobs:
             bundler: '1.17.3'
           - ruby: '3.0'
             bundler: '1.17.3'
+          - ruby: '3.1'
+            bundler: '1.17.3'
 
     services:
       postgres:
-        image: postgres:10
+        image: postgres:13.5
         env:
           POSTGRES_USER: root
           POSTGRES_PASSWORD: gutentag
-          POSTGRES_DB: test
+          POSTGRES_DB: gutentag
         ports: ['5432:5432']
         # needed because the postgres container does not provide a healthcheck
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
@@ -39,7 +41,7 @@ jobs:
         image: mysql:5.7
         env:
           MYSQL_ROOT_PASSWORD: gutentag
-          MYSQL_DATABASE: test
+          MYSQL_DATABASE: gutentag
         ports: ['3306:3306']
         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
 

data/.gitignore

@@ -1,6 +1,10 @@
 *.lock
+data
 gemfiles
 pkg/*
 spec/internal/db/*.sqlite
 spec/internal/db/migrate/
+.overmind.env
+.rspec
 .rubocop-*-yml
+.tool-versions

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   TargetRubyVersion: 2.3
   Exclude:
     - gemfiles/*.gemfile
+    - spec/internal/db/migrate/*
     - vendor/**/*
 
 Bundler/DuplicatedGem:

data/Appraisals

@@ -35,16 +35,25 @@ appraise "rails_5_2" do
   gem "mysql2", "~> 0.5.0", :platform => :ruby
 end if RUBY_VERSION.to_f >= 2.2 && RUBY_VERSION.to_f <= 2.7
 
-appraise "rails_6_0" do
-  gem "rails",   "~> 6.0.0"
-  gem "pg",      "~> 1.0",   :platform => :ruby
-  gem "mysql2",  "~> 0.5.0", :platform => :ruby
-  gem "sqlite3", "~> 1.4",   :platform => :ruby
-end if RUBY_VERSION.to_f >= 2.5 && RUBY_PLATFORM != "java"
-
-appraise "rails_6_1" do
-  gem "rails",   "~> 6.1.0"
-  gem "pg",      "~> 1.0",   :platform => :ruby
-  gem "mysql2",  "~> 0.5.0", :platform => :ruby
-  gem "sqlite3", "~> 1.4",   :platform => :ruby
-end if RUBY_VERSION.to_f >= 2.5 && RUBY_PLATFORM != "java"
+if RUBY_PLATFORM != "java"
+  appraise "rails_6_0" do
+    gem "rails",   "~> 6.0.0"
+    gem "pg",      "~> 1.0",   :platform => :ruby
+    gem "mysql2",  "~> 0.5.0", :platform => :ruby
+    gem "sqlite3", "~> 1.4",   :platform => :ruby
+  end if RUBY_VERSION.to_f >= 2.5 && RUBY_VERSION.to_f <= 3.0
+
+  appraise "rails_6_1" do
+    gem "rails",   "~> 6.1.0"
+    gem "pg",      "~> 1.0",   :platform => :ruby
+    gem "mysql2",  "~> 0.5.0", :platform => :ruby
+    gem "sqlite3", "~> 1.4",   :platform => :ruby
+  end if RUBY_VERSION.to_f >= 2.5
+
+  appraise "rails_7_0" do
+    gem "rails",   "~> 7.0.1"
+    gem "pg",      "~> 1.0",   :platform => :ruby
+    gem "mysql2",  "~> 0.5.0", :platform => :ruby
+    gem "sqlite3", "~> 1.4",   :platform => :ruby
+  end if RUBY_VERSION.to_f >= 2.7
+end

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project (at least, from v0.5.0 onwards) will be documented in this file.
 
+## 2.6.2 - 2022-11-05
+
+### Fixed
+
+* Documenting the `Gutentag::Tag.names_for_scope` method. ([Ryan Romanchuk](https://github.com/rromanchuk) in [#83](https://github.com/pat/gutentag/pull/83)).
+* Avoid double-querying of tag_names from the database. See discussion in [#84](https://github.com/pat/gutentag/issues/84).
+
+### Changed
+
+* Added Ruby 3.1 to the test matrix.
+
 ## 2.6.1 - 2021-09-18
 
 ### Fixed

data/Gemfile

@@ -20,3 +20,6 @@ gem "activerecord-jdbcpostgresql-adapter", ">= 1.3.23", :platform => :jruby
 gem "activerecord-jdbcsqlite3-adapter",    ">= 1.3.23", :platform => :jruby
 
 gem "activerecord", [">= 3.2.22"] if RUBY_PLATFORM == "java"
+
+# Required for testing Rails 6.1 on MRI 3.1+
+gem "net-smtp" if RUBY_VERSION.to_f > 3.0

data/Procfile.support

@@ -0,0 +1,2 @@
+postgres: postgres -D data/postgres -p ${POSTGRES_PORT:-5432}
+mysql: $(brew --prefix mysql@5.7)/bin/mysqld --datadir=$(PWD)/data/mysql --port ${MYSQL_PORT:-3306} --socket=mysql.sock

data/README.md

@@ -1,7 +1,7 @@
 # Gutentag
 
 [![Gem Version](https://badge.fury.io/rb/gutentag.svg)](http://badge.fury.io/rb/gutentag)
-[![Build Status](https://travis-ci.org/pat/gutentag.svg?branch=master)](https://travis-ci.org/pat/gutentag)
+[![Build Status](https://github.com/pat/gutentag/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/pat/gutentag/actions/)
 [![Code Climate](https://codeclimate.com/github/pat/gutentag.svg)](https://codeclimate.com/github/pat/gutentag)
 
 A good, simple, solid tagging extension for ActiveRecord.
@@ -74,14 +74,29 @@ To return records that have _none_ of the specified tags, use `:match => :none`:
 Article.tagged_with(:ids => [tag_a.id, tag_b.id], :match => :none)
 ```
 
+To return all tag names used by an instance of a model or relation
+
+```ruby
+# Returns array of tag names
+Gutentag::Tag.names_for_scope(Article)
+# => ['tag1', 'tag2', 'tag3']
+
+Gutentag::Tag.names_for_scope(Article.where(:created_at => 1.week.ago..1.second.ago))
+# => ['tag3']
+
+# Return array of the tag names used from the two most recent articles
+Gutentag::Tag.names_for_scope(Article.order(created_at: :desc).limit(2))
+# => []
+```
+
 <h2 id="installation">Installation</h2>
 
 ### Dependencies
 
 These are the versions the test suite runs against. It's possible it may work on older versions of Ruby, but it definitely won't work on older versions of Rails.
 
-* Ruby: MRI v2.3-v2.6, JRuby v9.2.5
-* Rails/ActiveRecord: v4.0-v6.1
+* Ruby: MRI v2.3-v3.1, JRuby v9.2.5
+* Rails/ActiveRecord: v4.0-v7.0
 
 If you're using MRI v2.2 and/or ActiveRecord v3.2, the last version of Gutentag that fully supported those versions is v2.4.1.
 
@@ -179,4 +194,4 @@ Please note that this project now has a [Contributor Code of Conduct](http://con
 
 <h2 id="licence">Licence</h2>
 
-Copyright (c) 2013-2021, Gutentag is developed and maintained by Pat Allan, and is released under the open MIT Licence.
+Copyright (c) 2013-2022, Gutentag is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/bin/test

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -o allexport
+source .overmind.env
+set +o allexport
+
+DATABASE=postgresql DB_HOST=127.0.0.1 DB_PORT=${POSTGRES_PORT} bundle exec appraisal rspec
+DATABASE=mysql DB_USERNAME=${MYSQL_USERNAME} DB_PASSWORD=${MYSQL_PASSWORD} DB_HOST=127.0.0.1 DB_PORT=${MYSQL_PORT} bundle exec appraisal rspec
+DATABASE=sqlite bundle exec appraisal rspec

data/gutentag.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "gutentag"
-  s.version     = "2.6.1"
+  s.version     = "2.6.2"
   s.authors     = ["Pat Allan"]
   s.email       = ["pat@freelancing-gods.com"]
   s.homepage    = "https://github.com/pat/gutentag"

data/lib/gutentag/active_record/instance_methods.rb

@@ -20,13 +20,20 @@ module Gutentag::ActiveRecord::InstanceMethods
 
     # Update the underlying value rather than going through the setter, to
     # ensure this update doesn't get marked as a 'change'.
-    @attributes.write_from_database "tag_names", nil
+    @attributes.write_from_database "tag_names", []
+    @prepared_tag_names = false
   end
 
   def tag_names
-    # If the underlying value is nil, we've not requested this from the
-    # database yet.
-    self.tag_names = tags.pluck(:name) if super.nil?
+    if super.nil? || !prepared_tag_names?
+      # If the underlying value is nil, we've not requested this from the
+      # database yet. But we also don't want to make the query twice. So, grab
+      # the names, prepare as needed, and make sure we also invoke the setter.
+      names = tags.pluck(:name)
+
+      prepare_tag_names(names)
+      self.tag_names = names
+    end
 
     # Use ActiveRecord's underlying implementation with change tracking.
     super
@@ -35,7 +42,7 @@ module Gutentag::ActiveRecord::InstanceMethods
   def tag_names=(names)
     # This value is about to be overwritten, but we want to make sure the change
     # tracking doesn't think the original value was nil.
-    @attributes.write_from_database "tag_names", tags.pluck(:name)
+    prepare_tag_names
 
     super Gutentag::TagNames.call(names)
   end
@@ -45,4 +52,17 @@ module Gutentag::ActiveRecord::InstanceMethods
   def persist_tags
     Gutentag::Persistence.new(Gutentag::ChangeState.new(self)).persist
   end
+
+  def prepare_tag_names(names = nil)
+    return if prepared_tag_names?
+
+    names ||= tags.pluck(:name)
+    @attributes.write_from_database("tag_names", names)
+
+    @prepared_tag_names = true
+  end
+
+  def prepared_tag_names?
+    @prepared_tag_names ||= false
+  end
 end

data/spec/internal/config/database.yml

@@ -9,6 +9,9 @@ test:
   <% if ENV["DB_PASSWORD"] %>
   password: <%= ENV["DB_PASSWORD"] %>
   <% end %>
+  <% if ENV["DB_PORT"] %>
+  port: <%= ENV["DB_PORT"] %>
+  <% end %>
 <% elsif ENV["DATABASE"] == "postgres" %>
 test:
   adapter: postgresql
@@ -22,6 +25,9 @@ test:
   <% if ENV["DB_PASSWORD"] %>
   password: <%= ENV["DB_PASSWORD"] %>
   <% end %>
+  <% if ENV["DB_PORT"] %>
+  port: <%= ENV["DB_PORT"] %>
+  <% end %>
 <% else %>
 test:
   adapter: sqlite3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gutentag
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - Pat Allan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-18 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -150,10 +150,12 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENCE
+- Procfile.support
 - README.md
 - Rakefile
 - app/models/gutentag/tag.rb
 - app/models/gutentag/tagging.rb
+- bin/test
 - db/migrate/1_gutentag_tables.rb
 - db/migrate/2_gutentag_cache_counter.rb
 - db/migrate/3_no_null_counters.rb
@@ -198,7 +200,7 @@ homepage: https://github.com/pat/gutentag
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,8 +215,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Good Tags
 test_files: []