paper_trail-association_tracking 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844d3ff1eb96a7bae834ad57625e2fb87cf37ebbea76bd489621a31c2a57d6f7
-  data.tar.gz: 0cd147df0a5ee52494abcda09e0fc44c10ebae176cc567a3659debb7533ad72c
+  metadata.gz: 32ff5ab37c0c0ed5ffdbc1c51ecb7a436be425a15631da3bb2fb00b8dbb1653d
+  data.tar.gz: 40609621efbec9948e8bb880de590a251c98a95531356e0436fff8b88719af1f
 SHA512:
-  metadata.gz: b49a595381d282b2ace65a18405921fba2970a22dde79841b5b7e42d148392b37caac9323136721cbebb9e0f0b74962d333e38883f923a934bb599b54dcf967a
-  data.tar.gz: '0180dff00868dfb4e49be3722df2210c630aa1550cf2963714d445f1b0c7d4eadfc96db258bcf88b4554949720821a33f3f00178b2ee4aeb61c52c26238de047'
+  metadata.gz: ad7e68bb6c2a890cfcdd1300796dc32c8ad1d428dd73f4041fb81339532573fab8b78cf0a5616b28630d558b95fcd8406d7b421a31c697d32dd4beb983cad573
+  data.tar.gz: 492671a7f7a042246fd294e78092b2b59498166d5180032cc4db83aa836e93aad029dabcc9321831ea56901c8b23869a369dbd959bed74791c80f12f6808fa23

data/CHANGELOG.md

@@ -1,11 +1,21 @@
 # CHANGELOG
 
-## Unreleased
+## 2.0.0 - Unreleased
 
-- None
+- [#11](https://github.com/westonganger/paper_trail-association_tracking/issues/11) - Remove null constraint on `version_associations.foreign_type` column which was added in `v1.1.0`. This fixes issues adding the column to existing projects who are upgrading.
+- Add generator `rails g paper_trail_association_tracking:add_foreign_type_to_version_associations` for `versions_associations.foreign_type` column for upgrading applications from `v1.0.0` or earlier.
+
+### How to Upgrade from v1.0.0 or earlier
+
+- Run `rails g paper_trail_association_tracking:add_foreign_type_to_version_associations` and then migrate your database.
+
+## 1.1.1 - 2018-01-14
+
+- Same as v2 release, this is released simply to maintain a working `v1` branch since `v1.1.0` was broken
 
 ## 1.1.0 - 2018-12-28
 
+- Note: This release is somewhat broken, please upgrade to `v2.0.0` or stay on `v1.0.0`
 - [#10](https://github.com/westonganger/paper_trail-association_tracking/pull/9) - The `has_many: true` option now reifies polymorphic associations. Previously they were skipped.
 - [#9](https://github.com/westonganger/paper_trail-association_tracking/pull/9) - The `belongs_to: true` option now reifies polymorphic associations. Previously they were skipped.
 

data/README.md

@@ -9,8 +9,7 @@ Plugin for the [PaperTrail](https://github.com/paper-trail-gem/paper_trail.git)
 **PR's will happily be accepted**
 
 This gem was extracted from PaperTrail in v9.2 to simplify things in PaperTrail and association tracking seperately. 
-At this time, `paper_trail` has a runtime dependency on this gem and will keep running the existing tests related 
-to association tracking. This arrangement will be maintained for a few years, if practical.
+At this time, `paper_trail` only has a development dependency in order to run the tests. If you want use this gem in your project you must add it to your own Gemfile.
 
 A little history lesson, discussed as early as 2009, and first implemented in late 2014, association
 tracking was part of PT core until 2018 as an experimental feature and was use at your own risk. This gem now

data/lib/generators/paper_trail_association_tracking/add_foreign_type_to_version_associations_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module PaperTrailAssociationTracking
+  # Installs PaperTrail in a rails app.
+  class AddForeignTypeToVersionAssociationsGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    # Class names of MySQL adapters.
+    # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
+    # - `Mysql2Adapter` - Used by `mysql2` gem.
+    MYSQL_ADAPTERS = [
+      "ActiveRecord::ConnectionAdapters::MysqlAdapter",
+      "ActiveRecord::ConnectionAdapters::Mysql2Adapter"
+    ].freeze
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Generates (but does not run) a migration to add a the foreign_type column to the version_associations table after upgrading from v1.0 or earlier."
+
+    def create_migrations
+      add_paper_trail_migration("add_foreign_type_to_version_associations")
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    protected
+
+    def add_paper_trail_migration(template)
+      migration_dir = File.expand_path("db/migrate")
+      if self.class.migration_exists?(migration_dir, template)
+        ::Kernel.warn "Migration already exists: #{template}"
+      else
+        migration_template(
+          "#{template}.rb.erb",
+          "db/migrate/#{template}.rb",
+          migration_version: migration_version
+        )
+      end
+    end
+
+    private
+
+    def migration_version
+      major = ActiveRecord::VERSION::MAJOR
+      if major >= 5
+        "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/paper_trail_association_tracking/templates/add_foreign_type_to_version_associations.rb.erb

@@ -0,0 +1,11 @@
+# This migration and AddTransactionIdColumnToVersions provide the necessary
+# schema for tracking associations.
+class AddForeignTypeToVersionAssociations < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    add_column :version_associations, :foreign_type, :string, index: true
+  end
+
+  def self.down
+    remove_column :version_associations, :foreign_type
+  end
+end

data/lib/generators/paper_trail_association_tracking/templates/create_version_associations.rb.erb

@@ -6,7 +6,7 @@ class CreateVersionAssociations < ActiveRecord::Migration<%= migration_version %
       t.integer  :version_id
       t.string   :foreign_key_name, null: false
       t.integer  :foreign_key_id
-      t.string   :foreign_type, null: false
+      t.string   :foreign_type
     end
     add_index :version_associations, [:version_id]
     add_index :version_associations,

data/lib/paper_trail_association_tracking/reifiers/has_many.rb

@@ -100,7 +100,7 @@ module PaperTrailAssociationTracking
             select("MIN(version_id)").
             where("foreign_key_name = ?", assoc.foreign_key).
             where("foreign_key_id = ?", model.id).
-            where("foreign_type = ?", model.class.name).
+            where(foreign_type: [model.class.name, nil]).
             where("#{version_table}.item_type = ?", assoc.klass.base_class.name).
             where("created_at >= ? OR transaction_id = ?", version_at, tx_id).
             group("item_id").

data/lib/paper_trail_association_tracking/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaperTrailAssociationTracking
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-association_tracking
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Weston Ganger
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -210,7 +210,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/generators/paper_trail_association_tracking/add_foreign_type_to_version_associations_generator.rb
 - lib/generators/paper_trail_association_tracking/install_generator.rb
+- lib/generators/paper_trail_association_tracking/templates/add_foreign_type_to_version_associations.rb.erb
 - lib/generators/paper_trail_association_tracking/templates/add_transaction_id_column_to_versions.rb.erb
 - lib/generators/paper_trail_association_tracking/templates/create_version_associations.rb.erb
 - lib/paper_trail-association_tracking.rb
@@ -252,7 +254,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Plugin for the PaperTrail gem to track and reify associations