gutentag 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6dfcf9cc249f5d24513e805b16a351641f06520
-  data.tar.gz: 819247c5802512d2de7cccaea882f6faa8caa3cb
+  metadata.gz: e38980a4454dabe309f3c203ddd7b918f82c5193
+  data.tar.gz: 8b50af89daa6b099ae1cca584478758d11ab6b0c
 SHA512:
-  metadata.gz: dd5025ccfab3083978980ea492d725235f550cec508d9a955c36ca8bb8337f44027aff7b56fc7d165b96d3fea0fb944369c54917d44ea050dcf243004748d84c
-  data.tar.gz: '0191ae96a804109c49e990f2bde2e6192d2f0ae37f8f8bea68a12a1294e3e0ce717a179162793982a889332ef80c125bfb9955c004cc9979fc86ca4787dd578a'
+  metadata.gz: 31686ed82181198d188ea9e6f323b3e47e9dbb69e53d9458a2d1adbcbd75d17cc2baf6a563428caabe9dcca0552c22b1efb785e5834312baadefa59f2eeb9a4c
+  data.tar.gz: d9c469b2df3bc48d991700f0e062aa626efeca3c2d15fd813f0f108705ad471d4d833814fbf61af29d577a276e1936cc418746c8e37ce19e448bbfd12a51978c

data/.gitignore

@@ -1,3 +1,5 @@
 *.lock
+gemfiles
 pkg/*
 spec/internal/db/*.sqlite
+.rubocop-*-yml

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from:
+  - https://gist.githubusercontent.com/pat/ba3b8ffb1901bfe5439b460943b6b019/raw/.rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/MethodLength:
+  Exclude:
+    - db/migrate/1_gutentag_tables.rb
+
+Style/MultilineIfModifier:
+  Exclude:
+    - Appraisals
+    - spec/acceptance/tag_names_spec.rb
+
+Style/MultilineTernaryOperator:
+  Exclude:
+    - db/migrate/*.rb
+
+Style/SafeNavigation:
+  Enabled: false

data/.travis.yml

@@ -1,14 +1,15 @@
 language: ruby
-script: bundle exec appraisal rspec
+script: bundle exec appraisal rake
 rvm:
-  - 2.0.0
-  - 2.2.2
-  - 2.3.3
-  - 2.4.0
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+  - jruby-9.1.13.0
 before_install:
   - gem install bundler
 before_script:
   - bundle exec appraisal install
+  - ./bin/literals
 env:
   - DATABASE=postgres
   - DATABASE=mysql

data/Appraisals

@@ -1,34 +1,28 @@
-appraise 'rails_3_2' do
-  gem 'rails',    '~> 3.2.22.5'
-  gem 'rack',     '~> 1.0',   :platforms => [:ruby_20, :ruby_21]
-  gem 'nokogiri', '~> 1.6.0', :platforms => [:ruby_20]
-  gem 'mysql2',   '~> 0.3.10'
-end if RUBY_VERSION.to_f < 2.2
+# frozen_string_literal: true
 
-appraise 'rails_4_0' do
-  gem 'rails',    '~> 4.0.13'
-  gem 'rack',     '~> 1.0', :platforms => [:ruby_20, :ruby_21]
-  gem 'nokogiri', '~> 1.6.0', :platforms => [:ruby_20]
-  gem 'mysql2',   '~> 0.3.10'
+appraise "rails_3_2" do
+  gem "rails",    "~> 3.2.22.5"
+  gem "mysql2",   "~> 0.3.10", :platform => :ruby
+end if RUBY_VERSION.to_f <= 2.2
+
+appraise "rails_4_0" do
+  gem "rails",    "~> 4.0.13"
+  gem "mysql2",   "~> 0.3.10", :platform => :ruby
 end if RUBY_VERSION.to_f < 2.4
 
-appraise 'rails_4_1' do
-  gem 'rails',    '~> 4.1.16'
-  gem 'rack',     '~> 1.0', :platforms => [:ruby_20, :ruby_21]
-  gem 'nokogiri', '~> 1.6.0', :platforms => [:ruby_20]
-  gem 'mysql2',   '~> 0.3.13'
+appraise "rails_4_1" do
+  gem "rails",    "~> 4.1.16"
+  gem "mysql2",   "~> 0.3.13", :platform => :ruby
 end if RUBY_VERSION.to_f < 2.4
 
-appraise 'rails_4_2' do
-  gem 'rails',    '~> 4.2.7'
-  gem 'rack',     '~> 1.0',   :platforms => [:ruby_20, :ruby_21]
-  gem 'nokogiri', '~> 1.6.0', :platforms => [:ruby_20]
+appraise "rails_4_2" do
+  gem "rails",    "~> 4.2.8"
 end if RUBY_VERSION.to_f < 2.4
 
-appraise 'rails_5_0' do
-  gem 'rails', '~> 5.0.1'
-end if RUBY_VERSION.to_f >= 2.2
+appraise "rails_5_0" do
+  gem "rails", "~> 5.0.3"
+end if RUBY_VERSION.to_f >= 2.2 && RUBY_PLATFORM != "java"
 
-appraise 'rails_5_1' do
-  gem 'rails', '~> 5.1.0'
-end if RUBY_VERSION.to_f >= 2.2
+appraise "rails_5_1" do
+  gem "rails", "~> 5.1.1"
+end if RUBY_VERSION.to_f >= 2.2 && RUBY_PLATFORM != "java"

data/Gemfile

@@ -1,12 +1,17 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 gemspec
 
-gem 'test-unit', :platform => :ruby_22
-gem 'rack',       '~> 1.0'   if RUBY_VERSION.to_f <= 2.1
-gem 'nokogiri',   '~> 1.6.0' if RUBY_VERSION.to_f <= 2.0
+gem "test-unit", :platform => :ruby_22
+
+gem "mysql2",  "~> 0.3",  :platform => :ruby
+gem "pg",      "~> 0.18", :platform => :ruby
+gem "sqlite3", "~> 1.3",  :platform => :ruby
+
+gem "activerecord-jdbcmysql-adapter",      "~> 1.3.23", :platform => :jruby
+gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.23", :platform => :jruby
+gem "activerecord-jdbcsqlite3-adapter",    "~> 1.3.23", :platform => :jruby
 
-gem 'combustion', '~> 0.6',
-  :git    => 'https://github.com/pat/combustion.git',
-  :branch => 'master',
-  :ref    => 'ef434634d7'
+gem "activerecord", [">= 3.2.22", "< 5"] if RUBY_PLATFORM == "java"

data/README.md

@@ -68,7 +68,7 @@ Article.tagged_with(:ids => [tag_a.id, tag_b.id], :match => :all)
 Get it into your Gemfile - and don't forget the version constraint!
 
 ```Ruby
-gem 'gutentag', '~> 0.9.0'
+gem 'gutentag', '~> 1.0.0'
 ```
 
 Next: your tags get persisted to your database, so let's import and run the migrations to get the tables set up:
@@ -105,6 +105,10 @@ add_index :gutentag_tags, :taggings_count
 
 <h2 id="upgrading">Upgrading</h2>
 
+### 1.0.0
+
+Behaviour that was deprecated in 0.9.0 (`has_many_tags`, `tagged_with` arguments) have now been removed.
+
 ### 0.9.0
 
 * In your models with tags, change `has_many_tags` to `Gutentag::ActiveRecord.call self`.

data/Rakefile

@@ -1,8 +1,12 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task :default => [:test]
-task :test    => [:spec]
+task :default => %i[ test ]
+task :test    => %i[ rubocop spec ]

data/app/models/gutentag/tag.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 class Gutentag::Tag < ActiveRecord::Base
-  self.table_name = 'gutentag_tags'
+  self.table_name = "gutentag_tags"
 
-  has_many :taggings, :class_name => 'Gutentag::Tagging',
-    :dependent => :destroy
+  has_many :taggings,
+    :class_name => "Gutentag::Tagging",
+    :dependent  => :destroy
 
   attr_accessible :name if ActiveRecord::VERSION::MAJOR == 3
 
-  scope :by_weight, ->{ order('gutentag_tags.taggings_count DESC') }
+  scope :by_weight, lambda { order("gutentag_tags.taggings_count DESC") }
 
   Gutentag.tag_validations.call self
 

data/app/models/gutentag/tagging.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 class Gutentag::Tagging < ActiveRecord::Base
-  self.table_name = 'gutentag_taggings'
+  self.table_name = "gutentag_taggings"
 
   belongs_to :taggable, :polymorphic => true
-  belongs_to :tag, :class_name => 'Gutentag::Tag', :counter_cache => true
+  belongs_to :tag, :class_name => "Gutentag::Tag", :counter_cache => true
 
   validates :taggable, :presence => true
   validates :tag,      :presence => true
   validates :tag_id,   :uniqueness => {
-    :scope => [:taggable_id, :taggable_type]
+    :scope => %i[ taggable_id taggable_type ]
   }
 end

data/bin/literals

@@ -0,0 +1,9 @@
+if (ruby -e "exit RUBY_VERSION.to_f >= 2.4")
+then
+  echo "Automatic frozen string literals are supported"
+  gem install pragmater -v 4.0.0
+  pragmater --add lib --comments "# frozen_string_literal: true" --whitelist "**/*.rb"
+  pragmater --add spec --comments "# frozen_string_literal: true" --whitelist "**/*.rb"
+else
+  echo "Automatic frozen string literals are not supported."
+fi

data/db/migrate/1_gutentag_tables.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 superclass = ActiveRecord::VERSION::MAJOR < 5 ?
   ActiveRecord::Migration : ActiveRecord::Migration[4.2]
 class GutentagTables < superclass
@@ -10,9 +12,9 @@ class GutentagTables < superclass
     end
 
     add_index :gutentag_taggings, :tag_id
-    add_index :gutentag_taggings, [:taggable_type, :taggable_id]
-    add_index :gutentag_taggings, [:taggable_type, :taggable_id, :tag_id],
-      :unique => true, :name => 'unique_taggings'
+    add_index :gutentag_taggings, %i[ taggable_type taggable_id ]
+    add_index :gutentag_taggings, %i[ taggable_type taggable_id tag_id ],
+      :unique => true, :name => "unique_taggings"
 
     create_table :gutentag_tags do |t|
       t.string :name, :null => false

data/db/migrate/2_gutentag_cache_counter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 superclass = ActiveRecord::VERSION::MAJOR < 5 ?
   ActiveRecord::Migration : ActiveRecord::Migration[4.2]
 class GutentagCacheCounter < superclass

data/db/migrate/3_no_null_counters.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 superclass = ActiveRecord::VERSION::MAJOR < 5 ?
   ActiveRecord::Migration : ActiveRecord::Migration[4.2]
 class NoNullCounters < superclass
   def up
-    change_column :gutentag_tags, :taggings_count, :integer, :default => 0,
-      :null => false
+    change_column :gutentag_tags, :taggings_count, :integer,
+      :default => 0,
+      :null    => false
   end
 
   def down
-    change_column :gutentag_tags, :taggings_count, :integer, :default => 0,
-      :null => true
+    change_column :gutentag_tags, :taggings_count, :integer,
+      :default => 0,
+      :null    => true
   end
 end

data/gutentag.gemspec

@@ -1,26 +1,26 @@
+# frozen_string_literal: true
 # -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
-  s.name        = 'gutentag'
-  s.version     = '0.9.0'
-  s.authors     = ['Pat Allan']
-  s.email       = ['pat@freelancing-gods.com']
-  s.homepage    = 'https://github.com/pat/gutentag'
-  s.summary     = 'Good Tags'
-  s.description = 'A good, simple, solid tagging extension for ActiveRecord'
-  s.license     = 'MIT'
+  s.name        = "gutentag"
+  s.version     = "1.0.0"
+  s.authors     = ["Pat Allan"]
+  s.email       = ["pat@freelancing-gods.com"]
+  s.homepage    = "https://github.com/pat/gutentag"
+  s.summary     = "Good Tags"
+  s.description = "A good, simple, solid tagging extension for ActiveRecord"
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  s.require_paths = ['lib']
+  s.require_paths = ["lib"]
 
-  s.add_runtime_dependency     'activerecord', '>= 3.2.0'
+  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.5.5'
-  s.add_development_dependency 'mysql2'
-  s.add_development_dependency 'pg'
-  s.add_development_dependency 'rails'
-  s.add_development_dependency 'rspec-rails',  '~> 3.1'
-  s.add_development_dependency 'sqlite3',      '~> 1.3.7'
+  s.add_development_dependency "appraisal",    "~> 2.1.0"
+  s.add_development_dependency "bundler",      ">= 1.7.12"
+  s.add_development_dependency "combustion",   "0.7.0"
+  s.add_development_dependency "rails"
+  s.add_development_dependency "rspec-rails",  "~> 3.1"
+  s.add_development_dependency "rubocop",      "~> 0.51.0"
 end

data/lib/gutentag.rb

@@ -1,5 +1,6 @@
-require 'active_record/version'
-require 'active_support/deprecation'
+# frozen_string_literal: true
+
+require "active_record/version"
 
 module Gutentag
   def self.dirtier
@@ -27,12 +28,12 @@ module Gutentag
   end
 end
 
-require 'gutentag/active_record'
-require 'gutentag/dirty'
-require 'gutentag/has_many_tags'
-require 'gutentag/persistence'
-require 'gutentag/tag_validations'
-require 'gutentag/tagged_with'
+require "gutentag/active_record"
+require "gutentag/change_state"
+require "gutentag/dirty"
+require "gutentag/persistence"
+require "gutentag/tag_validations"
+require "gutentag/tagged_with"
 
 if ActiveRecord::VERSION::MAJOR == 3
   Gutentag.dirtier = Gutentag::Dirty
@@ -41,10 +42,9 @@ elsif ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR < 2
 end
 
 if defined?(Rails::Engine)
-  require 'gutentag/engine'
+  require "gutentag/engine"
 else
-  require 'active_record'
-  ActiveRecord::Base.extend Gutentag::HasManyTags
-  require_relative '../app/models/gutentag/tag'
-  require_relative '../app/models/gutentag/tagging'
+  require "active_record"
+  require_relative "../app/models/gutentag/tag"
+  require_relative "../app/models/gutentag/tagging"
 end

data/lib/gutentag/active_record.rb

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 class Gutentag::ActiveRecord
   def self.call(model)
-    model.has_many :taggings, :class_name => 'Gutentag::Tagging',
-      :as => :taggable, :dependent => :destroy
-    model.has_many :tags,     :class_name => 'Gutentag::Tag',
-      :through => :taggings
+    model.has_many :taggings,
+      :class_name => "Gutentag::Tagging",
+      :as         => :taggable,
+      :dependent  => :destroy
+    model.has_many :tags,
+      :class_name => "Gutentag::Tag",
+      :through    => :taggings
 
     model.after_save :persist_tags
 
@@ -12,5 +17,5 @@ class Gutentag::ActiveRecord
   end
 end
 
-require 'gutentag/active_record/class_methods'
-require 'gutentag/active_record/instance_methods'
+require "gutentag/active_record/class_methods"
+require "gutentag/active_record/instance_methods"

data/lib/gutentag/active_record/class_methods.rb

@@ -1,19 +1,7 @@
-module Gutentag::ActiveRecord::ClassMethods
-  def tagged_with(*arguments)
-    arguments.flatten!
+# frozen_string_literal: true
 
-    case arguments.first
-    when Hash
-      Gutentag::TaggedWith.call(self, arguments.first)
-    when Integer
-      ActiveSupport::Deprecation.warn "Calling tagged_with with an array of integers will not be supported in Gutentag 1.0. Please use tagged_with :ids => [1, 2] instead."
-      Gutentag::TaggedWith.call(self, :ids => arguments)
-    when Gutentag::Tag
-      ActiveSupport::Deprecation.warn "Calling tagged_with with an array of tags will not be supported in Gutentag 1.0. Please use tagged_with :tags => [tag_a, tag_b] instead."
-      Gutentag::TaggedWith.call(self, :tags => arguments)
-    else
-      ActiveSupport::Deprecation.warn "Calling tagged_with with an array of strings will not be supported in Gutentag 1.0. Please use tagged_with :names => [\"melbourne\", \"ruby\"] instead."
-      Gutentag::TaggedWith.call(self, :names => arguments)
-    end
+module Gutentag::ActiveRecord::ClassMethods
+  def tagged_with(options)
+    Gutentag::TaggedWith.call self, options
   end
 end

data/lib/gutentag/active_record/instance_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gutentag::ActiveRecord::InstanceMethods
   def reset_tag_names
     @tag_names = nil
@@ -16,6 +18,6 @@ module Gutentag::ActiveRecord::InstanceMethods
   private
 
   def persist_tags
-    Gutentag::Persistence.new(self).persist
+    Gutentag::Persistence.new(Gutentag::ChangeState.new(self)).persist
   end
 end

data/lib/gutentag/change_state.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Gutentag::ChangeState
+  attr_reader :taggable
+  attr_writer :normaliser
+
+  def initialize(taggable)
+    @taggable = taggable
+    @existing = normalised taggable.tags.collect(&:name)
+    @changes  = normalised taggable.tag_names
+  end
+
+  def added
+    @added ||= changes - existing
+  end
+
+  def removed
+    @removed ||= existing - changes
+  end
+
+  private
+
+  attr_reader :existing, :changes
+
+  def normalised(names)
+    names.collect { |name| normaliser.call(name) }.uniq
+  end
+
+  def normaliser
+    @normaliser ||= proc { |name| Gutentag.normaliser.call(name) }
+  end
+end