activerecord-track-dirty-associations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 587159a470a6a857fb43d0fb56bd0b9acb3c17fec0be96740ae4e4114752ff66
+  data.tar.gz: 1e824fc3dc61adf7f2c696ff3a2f8aab38fcc95a0a54213acd8f392c86b0e8fd
+SHA512:
+  metadata.gz: 6c63e54cdf4e142c4f35a34ed5fe0b844fd8f874da632ad188d91d190814941b903caa12b0099d77a21ce8437dbd686dd5f43f7bc04e8a0d68e4035b817b3d52
+  data.tar.gz: 881c626861a08b50ce5034fb1820bf24c910814d1caaa5a601b5a066eb5683cdca9c966abfa0c90f686607257ec0bc7e2eb28d3bc029c59297a3278be3fe8beb

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-track-dirty-associations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Lynge Poulsgaard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# README #
+
+This is the readme for the activerecord-track-dirty-associations gem. A gem that adds the functionality to track dirty associations in activerecords.
+
+### How do I get set up? ###
+
+* Add the gem to your gemfile
+* Add the line track_dirty_associations *association_types to the model you wish to be able to track dirty associations for
+* You can now call dirty_associations? to check if tracked associations have changed, be aware that tracking an association does not automatically track that models associations. For this to work you have to add track_dirty_associations for the associations you want to track on that model as well.
+* You can use dirty_associations to get all dirty associations and their changes (added, removed or changed)
+* You can use {association}_changed? to see if a specific association have changed or {association}_changes to get the changes for a specific association.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/activerecord-track-dirty-associations.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-track-dirty-associations"
+  spec.version       = Activerecord::TrackDirtyAssociations::VERSION
+  spec.authors       = ["Lynge Poulsgaard"]
+  spec.email         = ["lpo@webshipper.com"]
+
+  spec.summary       = %q{Define track_dirty_associations method}
+  spec.description   = %q{This gem enables tracking of dirty associations on ActiveRecord objects}
+  spec.homepage      = %q{https://webshipper.io}
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://bitbucket.org/lyngekp/activerecord-track-dirty-associations"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'activerecord', '~> 5.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/track/dirty/associations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord/track_dirty_associations.rb

@@ -0,0 +1,122 @@
+module ActiveRecord
+  module TrackDirtyAssociations
+    def self.included(base)
+      base.extend ClassMethods
+      attr_accessor :dirty_assocs
+    end
+
+    module ClassMethods
+      def track_dirty_associations *association_types
+        klass = self
+
+        klass.send :after_save, -> { dirty_assocs = {} }
+
+        klass.singleton_class.send :alias_method, :old_has_many, :has_many
+
+        klass.singleton_class.send :define_method, :has_many do |*args, **opts|
+          association_type = args.first
+          options = opts
+          if association_types.empty? || association_types.include?(association_type)
+            create_association_methods association_type
+            options.merge!({
+              after_add: ->(object, association) { add_association association_type, object, association },
+              before_remove: ->(object, association) { remove_association association_type, object, association }
+            })
+          end
+          old_has_many *args, options
+        end
+
+        klass.singleton_class.send :alias_method, :old_has_one, :has_one
+
+        klass.singleton_class.send :define_method, :has_one do |*args, **opts|
+          association_type = args.first
+          options = opts
+          if association_types.empty? || association_types.include?(association_type)
+            create_association_methods association_type
+          end
+          old_has_one *args, options
+        end
+
+        klass.singleton_class.send :alias_method, :old_belongs_to, :belongs_to
+
+        klass.singleton_class.send :define_method, :belongs_to do |*args, **opts|
+          association_type = args.first
+          options = opts
+          if association_types.empty? || association_types.include?(association_type)
+            create_association_methods association_type
+          end
+          old_belongs_to *args, options
+        end
+
+        klass.singleton_class.send :define_method, :belongs_to do |*args, **opts|
+          association_type = args.first
+          options = opts
+          if association_types.empty? || association_types.include?(association_type)
+            create_association_methods association_type
+          end
+          old_belongs_to *args, options
+        end
+
+        define_method 'dirty_associations' do
+          dirty_associations = dirty_assocs || {}
+          association_types.each do |association_type|
+            dirty_associations[association_type] = association_changes(association_type) if association_changes(association_type).any?
+          end
+          dirty_associations
+        end
+
+        define_method 'dirty_associations?' do
+          send(:dirty_associations).any?
+        end
+      end
+
+      private
+
+      def create_association_methods association_type
+        define_method "#{association_type}_changes" do
+          association_changes(association_type)
+        end
+
+        define_method "#{association_type}_changed?" do
+          send("#{association_type}_changes".to_sym).any?
+        end
+      end
+
+      def add_association association_type, object, association
+        handle_association :added, association_type, object, association
+      end
+
+      def remove_association association_type, object, association
+        handle_association :removed, association_type, object, association
+      end
+
+      def handle_association action, association_type, object, association
+        return if object.new_record?
+        object.dirty_assocs = {} unless object.dirty_assocs
+        object.dirty_assocs[association_type] = {} unless object.dirty_assocs[association_type]
+        (object.dirty_assocs[association_type][action] ||= []) << association
+      end
+    end
+
+    def association_changes association_type
+      association_changes = dirty_assocs&.dig(association_type) || {}
+      changes = []
+
+      assocs = send association_type
+      assocs = [assocs] unless assocs.is_a? Enumerable
+      assocs.each do |assoc|
+        assoc_changes = {}
+        assoc_changes.merge!(assoc.changes) if assoc.respond_to?(:changes)
+        assoc_changes.merge!(assoc.dirty_associations) if assoc.respond_to?(:dirty_associations)
+        changes << assoc_changes if assoc_changes.any?
+      end
+
+      association_changes[:changes] = changes if changes.any?
+      association_changes
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include ActiveRecord::TrackDirtyAssociations
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module TrackDirtyAssociations
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-track-dirty-associations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lynge Poulsgaard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: This gem enables tracking of dirty associations on ActiveRecord objects
+email:
+- lpo@webshipper.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-track-dirty-associations.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/track_dirty_associations.rb
+- lib/version.rb
+homepage: https://webshipper.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://webshipper.io
+  source_code_uri: https://bitbucket.org/lyngekp/activerecord-track-dirty-associations
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Define track_dirty_associations method
+test_files: []