gutentag 2.5.4 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7af5fa8abd650550bd231819b8b4f043a17a15f0afba13dc443bf1b42ddd7a26
-  data.tar.gz: 7e22c0cc2a8c0de4840264b1e9cceb62c4504fc8df5d0e636a4894aa298152b5
+  metadata.gz: b49f3b3dd099ef714f2b23fa1d0e1b08059c59c15447cdece6ee07ac1a0a1272
+  data.tar.gz: c0ef3dd657f3c0b6fe216b80807f74bed2abbdefcbd2c6c467176a8ca16b38a2
 SHA512:
-  metadata.gz: 44ebaff249f6bba8798d98944177e3eac9569dc7731a3814add6e10fa1b2c5db1f491175e00bda53a25d84d6a96bdd622a5a812adac032017234c54864072002
-  data.tar.gz: fd440589741ffe77dfbde8649095c2bb5fae9a656d5b0cfb110390a8e156d49840cbead9a0e1e19d01a19a527a2d2e85dbd60e31a807fe25c6e2f746e5b59c55
+  metadata.gz: ffeef43eb46712c0a261fc569db0571cc2ad66b68254cac89afbba58df15b8f41142b9401f170997608d692d81c353b744b1d71756520f7a80e4cb9c84caeb37
+  data.tar.gz: 80996c6d6b7f8addfb86092b80c8ffed4c28f60629db98e126fab4303865b215c4efbf76de30e9d5c8ab74e7a76859fbdfb9fff5d1c16905153f9a91d1aa6e7c

data/.gitignore

@@ -2,4 +2,5 @@
 gemfiles
 pkg/*
 spec/internal/db/*.sqlite
+spec/internal/db/migrate/
 .rubocop-*-yml

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.0 - 2021-07-10
+
+### Added
+
+* Queries can now be made for objects that have _none_ of the specified tags using `:match => :none` ([Rares S](https://github.com/laleshii) in [#79](https://github.com/pat/gutentag/pull/79)).
+* Added a generator `gutentag:migration_versions` to update generated migrations so they use the current version of Rails/ActiveRecord's Migration superclass. See discussion in [#80](https://github.com/pat/gutentag/issues/80).
+
+### Changed
+
+* When adding Gutentag to a new app, the migrations require the `gutentag:migration_versions` generator to be run to ensure the latest ActiveRecord migration superclass is used. This change has no impact to existing apps. See discussion in [#80](https://github.com/pat/gutentag/issues/80).
+
 ## 2.5.4 - 2021-02-21
 
 ### Fixed

data/Gemfile

@@ -4,6 +4,10 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "appraisal",
+  :git    => "https://github.com/marcotc/appraisal.git",
+  :branch => "explicit-require-set"
+
 gem "test-unit", :platform => :ruby_22
 
 gem "mysql2",  "~> 0.3",    :platform => :ruby

data/README.md

@@ -8,7 +8,7 @@ A good, simple, solid tagging extension for ActiveRecord.
 
 This was initially built partly as a proof-of-concept, partly to see how a tagging gem could work when it's not all stuffed within models, and partly just because I wanted a simpler tagging library. It's now a solid little tagging Rails engine.
 
-If you want to know more, read [this blog post](http://freelancing-gods.com/posts/gutentag_simple_rails_tagging).
+If you want to know more, read [this blog post](http://freelancing-gods.com/posts/gutentag_simple_rails_tagging), or have a look at [the Examples page](https://github.com/pat/gutentag/wiki/Examples) in the wiki (which includes a starting point for accepting tag values in a form).
 
 ## Contents
 
@@ -67,6 +67,13 @@ To return records that have _all_ specified tags, use `:match => :all`:
 Article.tagged_with(:ids => [tag_a.id, tag_b.id], :match => :all)
 ```
 
+To return records that have _none_ of the specified tags, use `:match => :none`:
+
+```ruby
+# Returns all articles that have *neither* tag_a nor tag_b.
+Article.tagged_with(:ids => [tag_a.id, tag_b.id], :match => :none)
+```
+
 <h2 id="installation">Installation</h2>
 
 ### Dependencies
@@ -86,11 +93,12 @@ Get it into your Gemfile - and don't forget the version constraint!
 gem 'gutentag', '~> 2.5'
 ```
 
-Next: your tags get persisted to your database, so let's import and run the migrations to get the tables set up:
+Next: your tags get persisted to your database, so let's import the migrations, update them to your current version of Rails, and then migrate:
 
 ```Bash
-rake gutentag:install:migrations
-rake db:migrate
+bundle exec rake gutentag:install:migrations
+bundle exec rails generate gutentag:migration_versions
+bundle exec rake db:migrate
 ```
 
 If you're using UUID primary keys, make sure you alter the migration files before running `db:migrate` to use UUIDs for the `taggable_id` foreign key column (as noted in [issue 57](https://github.com/pat/gutentag/issues/57).)

data/db/migrate/1_gutentag_tables.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-superclass = ActiveRecord::VERSION::MAJOR < 5 ?
-  ActiveRecord::Migration : ActiveRecord::Migration[4.2]
-class GutentagTables < superclass
+class GutentagTables < ActiveRecord::Migration
   def up
     create_table :gutentag_taggings do |t|
       t.integer :tag_id,        :null => false

data/db/migrate/2_gutentag_cache_counter.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-superclass = ActiveRecord::VERSION::MAJOR < 5 ?
-  ActiveRecord::Migration : ActiveRecord::Migration[4.2]
-class GutentagCacheCounter < superclass
+class GutentagCacheCounter < ActiveRecord::Migration
   def up
     add_column :gutentag_tags, :taggings_count, :integer, :default => 0
     add_index  :gutentag_tags, :taggings_count

data/db/migrate/3_no_null_counters.rb

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

data/gutentag.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "gutentag"
-  s.version     = "2.5.4"
+  s.version     = "2.6.0"
   s.authors     = ["Pat Allan"]
   s.email       = ["pat@freelancing-gods.com"]
   s.homepage    = "https://github.com/pat/gutentag"
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency     "activerecord", ">= 3.2.0"
 
-  s.add_development_dependency "appraisal",           "~> 2.3"
+  # s.add_development_dependency "appraisal",           "~> 2.3"
   s.add_development_dependency "bundler",             ">= 1.17"
   s.add_development_dependency "combustion",          "~> 1.1"
   s.add_development_dependency "database_cleaner",    "~> 1.6"

data/lib/gutentag/engine.rb

@@ -2,4 +2,8 @@
 
 class Gutentag::Engine < Rails::Engine
   engine_name :gutentag
+
+  generators do
+    require "gutentag/generators/migration_versions_generator"
+  end
 end

data/lib/gutentag/generators/migration_versions_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Gutentag
+  module Generators
+    class MigrationVersionsGenerator < Rails::Generators::Base
+      desc "Update the ActiveRecord version in Gutentag migrations"
+
+      def update_migration_versions
+        if ::ActiveRecord::VERSION::MAJOR < 5
+          puts "No changes required"
+        else
+          migration_files.each do |file|
+            gsub_file file,
+              /< ActiveRecord::Migration$/,
+              "< ActiveRecord::Migration[#{rails_version}]"
+          end
+        end
+      end
+
+      private
+
+      def migration_files
+        Dir[Rails.root.join("db/migrate/*.rb")].select do |path|
+          known_migration_names.any? do |known|
+            File.basename(path)[/\A\d+_#{known}\.gutentag.rb\z/]
+          end
+        end
+      end
+
+      def known_migration_names
+        @known_migration_names ||= begin
+          Dir[File.join(__dir__, "../../../db/migrate/*.rb")].collect do |path|
+            File.basename(path).gsub(/\A\d+_/, "").gsub(/\.rb\z/, "")
+          end
+        end
+      end
+
+      def rails_version
+        @rails_version ||= [
+          ::ActiveRecord::VERSION::MAJOR,
+          ::ActiveRecord::VERSION::MINOR
+        ].join(".")
+      end
+    end
+  end
+end

data/lib/gutentag/tagged_with/query.rb

@@ -8,7 +8,7 @@ class Gutentag::TaggedWith::Query
   end
 
   def call
-    model.where "#{model_id} IN (#{query.to_sql})"
+    model.where "#{model_id} #{operator} (#{query.to_sql})"
   end
 
   private
@@ -20,8 +20,16 @@ class Gutentag::TaggedWith::Query
   end
 
   def query
-    return taggable_ids_query if match == :any || values.length == 1
+    return taggable_ids_query if match_any_or_none? || values.length == 1
 
     taggable_ids_query.having("COUNT(*) = #{values.length}").group(:taggable_id)
   end
+
+  def operator
+    match == :none ? "NOT IN" : "IN"
+  end
+
+  def match_any_or_none?
+    %i[any none].include?(match)
+  end
 end

data/spec/gutentag/active_record_spec.rb

@@ -160,6 +160,26 @@ RSpec.describe Gutentag::ActiveRecord do
       it { is_expected.not_to include oregon_article }
     end
 
+    context "matching excluding one tag" do
+      subject do
+        Article.tagged_with(:names => %w[ melbourne ], :match => :none)
+      end
+
+      it { expect(subject.count).to eq 1 }
+      it { is_expected.to include oregon_article }
+      it do
+        is_expected.not_to include melbourne_oregon_article, melbourne_article
+      end
+    end
+
+    context "matching excluding all tags" do
+      subject do
+        Article.tagged_with(:names => %w[ melbourne oregon ], :match => :none)
+      end
+
+      it { expect(subject.count).to eq 0 }
+    end
+
     it "should work on STI subclasses" do
       thinkpiece = Thinkpiece.create! :tag_names => ["pancakes"]
 

data/spec/spec_helper.rb

@@ -6,7 +6,8 @@ Bundler.require :default, :development
 
 Dir["#{__dir__}/support/**/*.rb"].sort.each { |file| require file }
 
-Combustion.initialize! :active_record
+Combustion.initialize! :active_record, :database_migrate => false
+AdjustMigrations.call(Combustion::Application)
 ActiveSupport.run_load_hooks :gutentag unless defined?(Gutentag::Engine)
 
 require "rspec/rails"

data/spec/support/adjust_migrations.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "gutentag/generators/migration_versions_generator"
+
+class AdjustMigrations
+  def self.call(application)
+    new(application).call
+  end
+
+  def initialize(application)
+    @application = application
+  end
+
+  def call
+    copy_migrations_to_app
+    run_generator
+    run_migrations
+  end
+
+  private
+
+  attr_reader :application
+
+  def copy_migrations_to_app
+    FileUtils.mkdir_p application.root.join("db/migrate")
+
+    Dir["#{__dir__}/../../db/migrate/*.rb"].each do |file|
+      name = File.basename(file.gsub(/rb\z/, "gutentag.rb"))
+      destination = application.root.join("db/migrate/#{name}")
+
+      FileUtils.cp file, destination.to_s
+    end
+  end
+
+  def migration_context
+    if ActiveRecord::MigrationContext.instance_method(:initialize).arity <= 1
+      ActiveRecord::MigrationContext.new migration_paths
+    else
+      ActiveRecord::MigrationContext.new(
+        migration_paths, ActiveRecord::Base.connection.schema_migration
+      )
+    end
+  end
+
+  def migration_paths
+    application.root.join("db/migrate")
+  end
+
+  def run_generator
+    Gutentag::Generators::MigrationVersionsGenerator.start(
+      ["--quiet"], :destination_root => application.root
+    )
+  end
+
+  def run_migrations
+    if ActiveRecord::VERSION::STRING.to_f >= 5.2
+      migration_context.migrate
+    else
+      ActiveRecord::Migrator.migrate migration_paths, nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gutentag
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.6.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +153,7 @@ files:
 - lib/gutentag/change_state.rb
 - lib/gutentag/dirty.rb
 - lib/gutentag/engine.rb
+- lib/gutentag/generators/migration_versions_generator.rb
 - lib/gutentag/persistence.rb
 - lib/gutentag/remove_unused.rb
 - lib/gutentag/tag_names.rb
@@ -191,6 +178,7 @@ files:
 - spec/models/gutentag/tag_spec.rb
 - spec/models/gutentag/tagging_spec.rb
 - spec/spec_helper.rb
+- spec/support/adjust_migrations.rb
 - spec/support/mysql.rb
 homepage: https://github.com/pat/gutentag
 licenses: