gutentag 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22821eb031cd1b00ea0f167035e557971b5c3c073ce56964394b96f05b364d5b
-  data.tar.gz: d523b07744aa3159028c765284b91e4d83bfebff3ad5fdaab27383bfee76e1d7
+  metadata.gz: e6935bb3c51e7b225573d2330a1f95b858bed7cd130f0825177aef98c9f0d175
+  data.tar.gz: 52201a047a523da00bd33cee60fe72ac1901c1273eb8296b4cfa637349991cf2
 SHA512:
-  metadata.gz: 04f2eb02cfd53bac7b394f07e0c2d035b79978b96388f7ea8c083adfb2bc5cbe59a2ae4a4535863455d3cdc62260c8927879ef987cd1596567c3402006b954e8
-  data.tar.gz: fc75caec7d7a1b03f42136087c78f8cd5c0319595afca6e76b2977b8c7f11b2b75a456434342040f2c8b78a4e9f9091181a327785eae551a52adcbc2ebb3f496
+  metadata.gz: 75251e4214a914b48256c60a97241f0db275fd06441e4eb3def15a8ada9fdebf6150208237b81d6715d63c87eae15d2bbcca208c61cc767961f451be60c8737f
+  data.tar.gz: 2b8f4b94045a63adfae0bb8e762922f788e49d3b0f37e44d5f54f8a2cd5fb0390f453a532106cc6b4da38b4f9c5cd8bf51211f2ba64713b0fb649a35b5b71e5d

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project (at least, from v0.5.0 onwards) will be documented in this file.
 
+## 2.2.0 - 2018-03-04
+
+### Added
+
+* Dirty state support for `tag_names` is now available for Rails 4.2 onwards, and is more reliable for Rails 3.2-4.1 (supporting all known methods, such as `tag_names_changed?`, `previous_changes`, etc.)
+
+### Changed
+
+* Switch normalising of tag names from a callback within `Gutentag::Tag` to `#name=` ([Tomasz Ras](https://github.com/RasMachineMan) in [#47](https://github.com/pat/gutentag/pull/47)).
+
 ## 2.1.0 - 2018-02-01
 
 ### 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.1.0'
+gem 'gutentag', '~> 2.2.0'
 ```
 
 Next: your tags get persisted to your database, so let's import and run the migrations to get the tables set up:

data/app/models/gutentag/tag.rb

@@ -11,8 +11,6 @@ class Gutentag::Tag < ActiveRecord::Base
 
   scope :by_weight, lambda { order("gutentag_tags.taggings_count DESC") }
 
-  before_validation :normalise_name
-
   def self.find_by_name(name)
     where(:name => Gutentag.normaliser.call(name)).first
   end
@@ -21,9 +19,7 @@ class Gutentag::Tag < ActiveRecord::Base
     find_by_name(name) || create(:name => name)
   end
 
-  private
-
-  def normalise_name
-    self.name = Gutentag.normaliser.call name
+  def name=(value)
+    super(Gutentag.normaliser.call(value))
   end
 end

data/gutentag.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "gutentag"
-  s.version     = "2.1.0"
+  s.version     = "2.2.0"
   s.authors     = ["Pat Allan"]
   s.email       = ["pat@freelancing-gods.com"]
   s.homepage    = "https://github.com/pat/gutentag"
@@ -17,10 +17,11 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency     "activerecord", ">= 3.2.0"
 
-  s.add_development_dependency "appraisal",    "~> 2.1.0"
-  s.add_development_dependency "bundler",      ">= 1.7.12"
-  s.add_development_dependency "combustion",   "0.8.0"
+  s.add_development_dependency "appraisal",        "~> 2.1.0"
+  s.add_development_dependency "bundler",          ">= 1.7.12"
+  s.add_development_dependency "combustion",       "0.8.0"
+  s.add_development_dependency "database_cleaner", "~> 1.6"
   s.add_development_dependency "rails"
-  s.add_development_dependency "rspec-rails",  "~> 3.1"
-  s.add_development_dependency "rubocop",      "~> 0.52.1"
+  s.add_development_dependency "rspec-rails",      "~> 3.1"
+  s.add_development_dependency "rubocop",          "~> 0.52.1"
 end

data/lib/gutentag.rb

@@ -36,11 +36,7 @@ require "gutentag/remove_unused"
 require "gutentag/tag_validations"
 require "gutentag/tagged_with"
 
-if ActiveRecord::VERSION::MAJOR == 3
-  Gutentag.dirtier = Gutentag::Dirty
-elsif ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR < 2
-  Gutentag.dirtier = Gutentag::Dirty
-end
+Gutentag.dirtier = Gutentag::Dirty if ActiveRecord::VERSION::STRING.to_f < 4.2
 
 require "active_support/lazy_load_hooks"
 ActiveSupport.on_load(:gutentag) do

data/lib/gutentag/active_record.rb

@@ -2,6 +2,25 @@
 
 class Gutentag::ActiveRecord
   def self.call(model)
+    new(model).call
+  end
+
+  def initialize(model)
+    @model = model
+  end
+
+  def call
+    add_associations
+    add_callbacks
+    add_methods
+    add_attribute
+  end
+
+  private
+
+  attr_reader :model
+
+  def add_associations
     model.has_many :taggings,
       :class_name => "Gutentag::Tagging",
       :as         => :taggable,
@@ -9,13 +28,41 @@ class Gutentag::ActiveRecord
     model.has_many :tags,
       :class_name => "Gutentag::Tag",
       :through    => :taggings
+  end
+
+  def add_attribute
+    if legacy?
+      model.define_attribute_method "tag_names"
+    else
+      model.attribute "tag_names", ActiveRecord::Type::Value.new, :default => []
+    end
+  end
 
+  def add_callbacks
     model.after_save :persist_tags
 
-    model.send :extend,  Gutentag::ActiveRecord::ClassMethods
-    model.send :include, Gutentag::ActiveRecord::InstanceMethods
+    if legacy?
+      model.after_save :reset_tag_names
+    else
+      model.after_commit :reset_tag_names, :on => %i[ create update ]
+    end
+  end
+
+  def add_methods
+    model.send :extend, Gutentag::ActiveRecord::ClassMethods
+
+    if legacy?
+      model.send :include, Gutentag::ActiveRecord::LegacyInstanceMethods
+    else
+      model.send :include, Gutentag::ActiveRecord::ModernInstanceMethods
+    end
+  end
+
+  def legacy?
+    ActiveRecord::VERSION::STRING.to_f < 4.2
   end
 end
 
 require "gutentag/active_record/class_methods"
-require "gutentag/active_record/instance_methods"
+require "gutentag/active_record/legacy_instance_methods"
+require "gutentag/active_record/modern_instance_methods"

data/lib/gutentag/active_record/class_methods.rb

@@ -4,4 +4,20 @@ module Gutentag::ActiveRecord::ClassMethods
   def tagged_with(options)
     Gutentag::TaggedWith.call self, options
   end
+
+  if ActiveRecord::VERSION::STRING.to_f < 4.2
+    def skip_time_zone_conversion_for_attributes
+      super + [:tag_names]
+    end
+  end
+
+  if ActiveRecord::VERSION::STRING.to_f < 4.0
+    def create_time_zone_conversion_attribute?(attr_name, column)
+      attr_name != "tag_names" && super
+    end
+
+    def attribute_cast_code(attr_name)
+      attr_name == "tag_names" ? "v" : super
+    end
+  end
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-module Gutentag::ActiveRecord::InstanceMethods
+# For Rails <= 4.1
+module Gutentag::ActiveRecord::LegacyInstanceMethods
   def reset_tag_names
     @tag_names = nil
   end

data/lib/gutentag/active_record/modern_instance_methods.rb

@@ -0,0 +1,26 @@
+# 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

data/lib/gutentag/dirty.rb

@@ -11,7 +11,10 @@ class Gutentag::Dirty
   end
 
   def call
-    instance.changed_attributes[:tag_names] = existing if changes.present?
+    return unless changes.present?
+
+    instance.tag_names_will_change!
+    instance.changed_attributes[:tag_names] = existing
   end
 
   private

data/lib/gutentag/persistence.rb

@@ -14,8 +14,6 @@ class Gutentag::Persistence
   def persist
     remove_old
     add_new
-
-    taggable.reset_tag_names
   end
 
   private

data/spec/acceptance/dirty_state_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "Dirty state of tag names" do
+  let(:article) { Article.create! }
+
+  it "knows what tag names will change" do
+    article.tag_names = ["pancakes"]
+
+    expect(article).to be_changed
+    expect(article.tag_names_changed?).to eq(true)
+    expect(article.tag_names_was).to eq([])
+    expect(article.tag_names_change).to eq([[], ["pancakes"]])
+
+    if ActiveRecord::VERSION::STRING.to_f > 4.0
+      expect(article.tag_names_changed?(:from => [], :to => ["pancakes"])).
+        to eq(true)
+    end
+
+    if ActiveRecord::VERSION::STRING.to_f > 5.0
+      expect(article.will_save_change_to_tag_names?).to eq(true)
+      expect(article.tag_names_change_to_be_saved).to eq([[], ["pancakes"]])
+      expect(article.tag_names_in_database).to eq([])
+    end
+  end
+
+  it "knows what tag names have changed" do
+    article.tag_names = ["pancakes"]
+    article.save
+
+    expect(article.tag_names).to eq(["pancakes"])
+
+    expect(article).to_not be_changed
+    expect(article.tag_names_changed?).to eq(false)
+    expect(article.previous_changes["tag_names"]).to eq([[], ["pancakes"]])
+
+    if ActiveRecord::VERSION::STRING.to_f >= 5.0
+      expect(article.tag_names_previously_changed?).to eq(true)
+      expect(article.tag_names_previous_change).to eq([[], ["pancakes"]])
+    end
+
+    if ActiveRecord::VERSION::STRING.to_f > 5.0
+      expect(article.saved_change_to_tag_names?).to eq(true)
+      expect(article.saved_change_to_tag_names).to eq([[], ["pancakes"]])
+      expect(article.saved_changes["tag_names"]).to eq([[], ["pancakes"]])
+      expect(article.tag_names_before_last_save).to eq([])
+      expect(article.tag_names_change_to_be_saved).to eq(nil)
+      expect(article.tag_names_in_database).to eq(["pancakes"])
+    end
+  end
+end

data/spec/acceptance/tag_names_spec.rb

@@ -3,7 +3,7 @@
 require "spec_helper"
 
 describe "Managing tags via names" do
-  let(:article)   { Article.create }
+  let(:article) { Article.create }
 
   it "returns tag names" do
     melbourne = Gutentag::Tag.create :name => "melbourne"
@@ -20,25 +20,6 @@ describe "Managing tags via names" do
     expect(article.tags.collect(&:name)).to eq(["melbourne"])
   end
 
-  it "makes model dirty when changing through tag_names" do
-    article.tag_names << "melbourne"
-    article.save!
-
-    article.tag_names = ["sydney"]
-
-    expect(article.changed_attributes.stringify_keys).
-      to eq("tag_names" => ["melbourne"])
-  end if Gutentag.dirtier
-
-  it "does not make model dirty when changing through tag_names" do
-    article.tag_names << "melbourne"
-    article.save!
-
-    article.tag_names = ["melbourne"]
-
-    expect(article.changed_attributes).to eq({})
-  end
-
   it "allows for different tag normalisation" do
     Gutentag.normaliser = lambda { |name| name.upcase }
 

data/spec/spec_helper.rb

@@ -11,8 +11,19 @@ require "rspec/rails"
 
 RSpec.configure do |config|
   if config.respond_to?(:use_transactional_tests)
-    config.use_transactional_tests = true
+    config.use_transactional_tests = false
   else
-    config.use_transactional_fixtures = true
+    config.use_transactional_fixtures = false
+  end
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gutentag
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +147,8 @@ files:
 - lib/gutentag.rb
 - lib/gutentag/active_record.rb
 - lib/gutentag/active_record/class_methods.rb
-- lib/gutentag/active_record/instance_methods.rb
+- lib/gutentag/active_record/legacy_instance_methods.rb
+- lib/gutentag/active_record/modern_instance_methods.rb
 - lib/gutentag/change_state.rb
 - lib/gutentag/dirty.rb
 - lib/gutentag/engine.rb
@@ -144,6 +159,7 @@ files:
 - lib/gutentag/tagged_with/id_query.rb
 - lib/gutentag/tagged_with/name_query.rb
 - lib/gutentag/tagged_with/query.rb
+- spec/acceptance/dirty_state_spec.rb
 - spec/acceptance/removing_unused_spec.rb
 - spec/acceptance/tag_names_spec.rb
 - spec/acceptance/tags_spec.rb
@@ -176,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Good Tags