gutentag 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6935bb3c51e7b225573d2330a1f95b858bed7cd130f0825177aef98c9f0d175
-  data.tar.gz: 52201a047a523da00bd33cee60fe72ac1901c1273eb8296b4cfa637349991cf2
+  metadata.gz: 506e53c384365bbd56d66a31a5a6956955d4098c31dd9bda30c5fe4d9f6822f7
+  data.tar.gz: e905db1b576c5ee5cd52a834b776232b7f3339d62f8517d9d9262f7c840151c1
 SHA512:
-  metadata.gz: 75251e4214a914b48256c60a97241f0db275fd06441e4eb3def15a8ada9fdebf6150208237b81d6715d63c87eae15d2bbcca208c61cc767961f451be60c8737f
-  data.tar.gz: 2b8f4b94045a63adfae0bb8e762922f788e49d3b0f37e44d5f54f8a2cd5fb0390f453a532106cc6b4da38b4f9c5cd8bf51211f2ba64713b0fb649a35b5b71e5d
+  metadata.gz: a0039255e81ca547cfe1fa5ea9591b4edaedff4982835dbe4faf1788e5661b61d2ed25622242f641b3226b8d494a7c3ff54ca34e21859418b319a7aa701c8d78
+  data.tar.gz: 38d36b39b9d935cc32f1e0cdc80267d0d7e347d3c747b02f6270000beae2fe4bb60206f8ef5ccab8f3179c6cdeb6983fc3c3079f3b8452b843373c98b24b704c

data/Appraisals

@@ -17,7 +17,7 @@ end if RUBY_VERSION.to_f < 2.4
 
 appraise "rails_4_2" do
   gem "rails",    "~> 4.2.8"
-end if RUBY_VERSION.to_f < 2.4
+end
 
 appraise "rails_5_0" do
   gem "rails", "~> 5.0.3"

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project (at least, from v0.5.0 onwards) will be documented in this file.
 
+## 2.2.1 - 2018-03-06
+
+### Fixed
+
+* Fix `tag_names` to return persisted values on a fresh load of a tagged object (which involved distinguishing Rails 4.2 behaviour from more recent approaches).
+
 ## 2.2.0 - 2018-03-04
 
 ### Added

data/README.md

@@ -80,7 +80,7 @@ These are the versions the test suite runs against. It's possible it may work on
 Get it into your Gemfile - and don't forget the version constraint!
 
 ```Ruby
-gem 'gutentag', '~> 2.2.0'
+gem 'gutentag', '~> 2.2.1'
 ```
 
 Next: your tags get persisted to your database, so let's import and run the migrations to get the tables set up:

data/gutentag.gemspec

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

data/lib/gutentag/active_record.rb

@@ -34,7 +34,8 @@ class Gutentag::ActiveRecord
     if legacy?
       model.define_attribute_method "tag_names"
     else
-      model.attribute "tag_names", ActiveRecord::Type::Value.new, :default => []
+      model.attribute "tag_names", ActiveRecord::Type::Value.new,
+        :default => default_tag_names
     end
   end
 
@@ -49,13 +50,21 @@ class Gutentag::ActiveRecord
   end
 
   def add_methods
-    model.send :extend, Gutentag::ActiveRecord::ClassMethods
-
-    if legacy?
-      model.send :include, Gutentag::ActiveRecord::LegacyInstanceMethods
+    case ActiveRecord::VERSION::STRING.to_f
+    when 3.2..4.1
+      require "gutentag/active_record/instance_methods_3_2"
+    when 4.2
+      require "gutentag/active_record/instance_methods_4_2"
     else
-      model.send :include, Gutentag::ActiveRecord::ModernInstanceMethods
+      require "gutentag/active_record/instance_methods"
     end
+
+    model.send :extend, Gutentag::ActiveRecord::ClassMethods
+    model.send :include, Gutentag::ActiveRecord::InstanceMethods
+  end
+
+  def default_tag_names
+    ActiveRecord::VERSION::STRING.to_f <= 4.2 ? [] : nil
   end
 
   def legacy?
@@ -64,5 +73,3 @@ class Gutentag::ActiveRecord
 end
 
 require "gutentag/active_record/class_methods"
-require "gutentag/active_record/legacy_instance_methods"
-require "gutentag/active_record/modern_instance_methods"

data/lib/gutentag/active_record/instance_methods.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# For Rails 5.0+
+module Gutentag::ActiveRecord::InstanceMethods
+  # If the tag_names attribute was one of the modified values, then let's just
+  # use the modifications, rather than overwriting the stored value.
+  #
+  # The reason we overwrite the stored value is because new tags may be added to
+  # the instance directly (e.g. article.tags << tag), which invokes the save
+  # callbacks, but the old tag_names value is stored but not updated.
+  def reset_tag_names
+    return if tag_names_previously_changed?
+
+    # 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
+  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?
+
+    # Use ActiveRecord's underlying implementation with change tracking.
+    super
+  end
+
+  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", []
+
+    super
+  end
+
+  private
+
+  def persist_tags
+    Gutentag::Persistence.new(Gutentag::ChangeState.new(self)).persist
+  end
+end

data/lib/gutentag/active_record/{legacy_instance_methods.rb → instance_methods_3_2.rb}

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 # For Rails <= 4.1
-module Gutentag::ActiveRecord::LegacyInstanceMethods
+module Gutentag::ActiveRecord::InstanceMethods
+  # The reason we overwrite the stored value is because new tags may be added to
+  # the instance directly (e.g. article.tags << tag), which invokes the save
+  # callbacks, but the old tag_names value is stored but not updated.
   def reset_tag_names
     @tag_names = nil
   end

data/lib/gutentag/active_record/instance_methods_4_2.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# For Rails 4.2 only.
+module Gutentag::ActiveRecord::InstanceMethods
+  # The reason we overwrite the stored value is because new tags may be added to
+  # the instance directly (e.g. article.tags << tag), which invokes the save
+  # callbacks, but the old tag_names value is stored but not updated.
+  def reset_tag_names
+    # Update the underlying value rather than going through the setter, to
+    # ensure this update doesn't get marked as a 'change'.
+    self.tag_names = nil
+  end
+
+  def tag_names
+    # If the underlying value is nil, we've not requested this from the
+    # database yet.
+    if read_attribute("tag_names") { nil }.nil?
+      self.tag_names = tags.pluck(:name)
+    end
+
+    # Use ActiveRecord's underlying implementation with change tracking.
+    super
+  end
+
+  private
+
+  def persist_tags
+    Gutentag::Persistence.new(Gutentag::ChangeState.new(self)).persist
+  end
+end

data/spec/acceptance/tag_names_spec.rb

@@ -109,4 +109,11 @@ describe "Managing tags via names" do
   it "allows overriding of tag_names=" do
     expect(Article.instance_methods(false)).to_not include(:tag_names=)
   end
+
+  it "returns known tag names from a freshly loaded object" do
+    article.tag_names << "melbourne"
+    article.save!
+
+    expect(Article.find(article.id).tag_names).to eq(["melbourne"])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gutentag
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-04 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,8 +147,9 @@ files:
 - lib/gutentag.rb
 - lib/gutentag/active_record.rb
 - lib/gutentag/active_record/class_methods.rb
-- lib/gutentag/active_record/legacy_instance_methods.rb
-- lib/gutentag/active_record/modern_instance_methods.rb
+- lib/gutentag/active_record/instance_methods.rb
+- lib/gutentag/active_record/instance_methods_3_2.rb
+- lib/gutentag/active_record/instance_methods_4_2.rb
 - lib/gutentag/change_state.rb
 - lib/gutentag/dirty.rb
 - lib/gutentag/engine.rb

data/lib/gutentag/active_record/modern_instance_methods.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# For Rails 4.2+
-module Gutentag::ActiveRecord::ModernInstanceMethods
-  def reset_tag_names
-    self.tag_names = nil
-  end
-
-  def tag_names
-    self.tag_names = tags.pluck(:name) if super.nil?
-
-    super
-  end
-
-  def tag_names=(names)
-    Gutentag.dirtier.call self, names if Gutentag.dirtier
-
-    super
-  end
-
-  private
-
-  def persist_tags
-    Gutentag::Persistence.new(Gutentag::ChangeState.new(self)).persist
-  end
-end