acts_as_tracked 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 395a0143c5923febe5d923e31332bcd516bb901915a4515162d5372889a820b9
+  data.tar.gz: 7f717b289f17654c9ccfd02b5504dd1efdf018fff83f110ec84fb0431537af25
+SHA512:
+  metadata.gz: 2c1149d0fee0c6a2a44f51420e758bb6dc600753d6157d3ea9f5ea1ec236acf5057beaaae0472db71fe6304a0b56d1990c08e87a36aaf0b66328996e329b6ac2
+  data.tar.gz: 2370e1de45f80e14a09f3c9b8477773ea9240ac906674ac8702d881bd0f8af751105028ca07cc13215a7c76e883741293c876c79b2733e56be3a7ab804e0d62d

data/.circleci/config.yml

@@ -0,0 +1,52 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2 
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+        environment:
+            RAILS_ENV: test
+            PGHOST: 127.0.0.1
+            PGUSER: root
+      
+      - image: circleci/postgres:9.6.2-alpine
+        environment:
+          POSTGRES_USER: root
+          POSTGRES_DB: acts_as_tracked_test
+
+    executor: ruby/default
+    steps:
+      - checkout
+
+      - restore_cache:
+          name: Restore bundle cache
+          keys:
+            - acts-as-tracked-dependencies
+
+      - run:
+          name: Install Bundler
+          command: gem install bundler
+
+      - run:
+          name: Bundle Install
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+            
+      - run: sudo apt install -y postgresql-client || true
+
+      - save_cache:
+          name: Store bundle cache
+          paths:
+            - ./vendor/bundle
+          key: acts-as-tracked-dependencies
+
+      - run:
+          name: Rubocop check
+          command:  bundle exec rubocop
+
+      - run:
+          name: Test Suite
+          command: PREPARE_COMBUSTION_DB_USING_SCHEMA=true bundle exec rspec
+         

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  NewCops: enable
+Style/Documentation:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sahil.gadimbay@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_tracked.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    acts_as_tracked (1.0.0)
+      actionview (>= 4.2)
+      activerecord (>= 4.2)
+      activesupport (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    builder (3.2.4)
+    codecov (0.1.17)
+      json
+      simplecov
+      url
+    combustion (1.3.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.2)
+    docile (1.3.2)
+    erubi (1.9.0)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pg (1.2.3)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    url (0.3.2)
+    with_model (2.1.4)
+      activerecord (>= 5.2, < 6.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acts_as_tracked!
+  codecov
+  combustion (~> 1.3)
+  pg
+  rake (~> 12.0)
+  rspec-rails
+  rubocop
+  simplecov
+  with_model
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sahil Gadimbayli
+
+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,187 @@
+[![Gem Version](https://badge.fury.io/rb/acts-as-tracked.svg)](https://badge.fury.io/rb/acts-as-tracked)
+[![CircleCI](https://circleci.com/gh/ramblingcode/acts-as-tracked.svg?style=svg)](https://circleci.com/gh/ramblingcode/acts-as-tracked)
+[![codecov](https://codecov.io/gh/ramblingcode/acts-as-tracked/branch/master/graph/badge.svg)](https://codecov.io/gh/ramblingcode/acts-as-tracked)
+
+
+# ActsAsTracked
+
+Welcome to ActsAsTracked! This gem is an extension to your ActiveRecord models to track activities. It does not track everything all the time, but can be used wherever you find it necessary to have a history for changes alongside their actors.
+
+There are few other gems such as [audited](https://github.com/collectiveidea/audited), however, it is tracking every change on your models. ActsAsTracked is controlled by `you` and will track changes only when `used directly`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_tracked'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install acts_as_tracked
+```
+
+## Usage
+
+### Create Activities table
+
+First, you would need to generate a migration to create Activities table in your database.
+
+ActsAsTracked has extension to generate migrations. Please, run:
+
+```shell
+  bundle exec rails generate acts_as_tracked:migration
+```
+
+This will generate following migration:
+
+```ruby
+class ActsAsTrackedMigration < ActiveRecord::Migration<Rails Version>
+  def self.up
+    create_table :activities do |t|
+      t.integer :actor_id, index: true
+      t.string :actor_type
+      t.integer :subject_id, index: true
+      t.string :subject_type
+      t.integer :parent_id, index: true
+      t.string :parent_type
+      t.text :attribute_changes
+      t.string :activity_type
+      t.string :human_description
+      t.timestamps null: false
+    end
+  end
+
+  def self.down
+    drop_table :activity
+  end
+end
+```
+
+Run `bundle exec rails db:migrate` and let's move on to the usage.
+
+### Call acts_as_tracked in your AR model
+
+If you would like to track changes of `Post` model, you would need to call `acts_as_tracked` in it.
+
+```ruby
+  class Post < ApplicationRecord
+    acts_as_tracked
+
+    # You may optionally pass in exluded_activity_attributes
+    # as an argument to not track given fields.
+    #
+    # acts_as_tracked(exclude_activity_attributes: %i[:api_key, :username])
+  end
+```
+
+### Tracking Changes
+
+Now, you are able to track changes on Post.
+
+```ruby
+@post = Post.first
+
+Post.tracking_changes(actor: User.find(1)) do
+  @post.update(
+    content: 'New Content'
+  )  
+end
+```
+
+Let's try to get activities for Post we just changed:
+
+```ruby
+@post.activities
+
+[
+  #<ActsAsTracked::Activity:0x000056475df12840
+  id: 1,
+  actor_id: 1,
+  actor_type: "User",
+  subject_id: 2,
+  subject_type: "Post",
+  parent_id: nil,
+  parent_type: nil,
+  attribute_changes: {"content"=>["Great post content.", "New Content"]},
+  activity_type: "updated",
+  human_description: nil,
+  created_at: Thu, 25 Jun 2020 12:03:39 UTC +00:00,
+  updated_at: Thu, 25 Jun 2020 12:03:39 UTC +00:00>
+]
+```
+
+## More features
+
+You can check activities for the record in which it was an Actor:
+
+```ruby
+@post.activities_as_actor
+
+...activities
+```
+
+You can check activities for the record in which it was a Subject:
+
+```ruby
+@post.activities_as_subject
+
+...activities
+```
+
+You can check activities for collection of records by passing ids:
+
+```ruby
+Post.activities_for([post_id1, post_id2])
+
+...activities
+```
+
+### Extra options to pass to `tracking_changes` call
+
+`tracking_changes` method can accept 3 arguments:
+
+1. actor: mandatory -> actor record
+2. subject: optional -> acting on record, defaults to record you are changing
+3. parent: optional -> parent record for acting on record, defaults to nil
+4. human_description: optional -> description you would like to include on change, defaults to `nil`
+
+```ruby
+Post.tracking_changes(actor: User.first, subject: Post.first, human_description: 'Some description of change', parent: Post.first.parent) do
+...your changes here
+end
+```
+
+### Example application using ActsAsTracked
+
+I have created a Rails 6 application with the usages of ActsAsTracked. Please refer to this [repo](https://github.com/ramblingcode/rails6-acts-as-tracked-usage)
+
+## Credits
+
+Initial work of ActsAsTracked has been done by @rogercampos and @camaloon team. I have refined, packaged, documented, added generators and published it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ramblingcode/acts_as_tracked. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/acts_as_tracked/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActsAsTracked project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/acts_as_tracked/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/acts_as_tracked.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/acts_as_tracked/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acts_as_tracked'
+  spec.version       = ActsAsTracked::VERSION
+  spec.authors       = ['Sahil Gadimbayli']
+  spec.email         = ['sahil.gadimbay@gmail.com']
+
+  spec.summary       = 'Activity Tracker to plug into ActiveRecord.'
+  spec.description   = 'Track activities in your ActiveRecord models.'
+  spec.homepage      = 'https://github.com/ramblingcode/acts-as-tracked'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  # 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(__dir__)) 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_dependency 'actionview', '>= 4.2'
+  spec.add_dependency 'activerecord', '>= 4.2'
+  spec.add_dependency 'activesupport', '>= 4.2'
+
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'combustion', '~> 1.3'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'with_model'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'acts_as_tracked'
+
+# 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/acts_as_tracked.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'acts_as_tracked/version'
+
+require 'active_record'
+require 'active_support'
+
+require 'acts_as_tracked/activity'
+require 'acts_as_tracked/extenders/trackable'
+
+module ActsAsTracked
+  ActiveRecord::Base.extend ActsAsTracked::Extenders::Trackable
+end

data/lib/acts_as_tracked/activity.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ActsAsTracked
+  class Activity < ::ActiveRecord::Base
+    belongs_to :actor, polymorphic: true
+    belongs_to :subject, polymorphic: true
+    belongs_to :parent, polymorphic: true
+
+    before_save { self[:attribute_changes] = self[:attribute_changes].with_indifferent_access }
+
+    store :attribute_changes
+
+    validates :subject, :actor, :activity_type, presence: true
+
+    default_scope -> { order(arel_table[:created_at].desc) }
+
+    def human_changes
+      case activity_type
+      when 'created'
+        attribute_changes.reject { |_, values| values.last.to_s.blank? }
+      when 'updated'
+        attribute_changes.each { |_, values| values.map! { |v| v.presence || 'empty' } }
+      when 'destroyed'
+        attribute_changes.reject { |_, values| values.first.to_s.blank? }
+      end
+    end
+
+    def subject_class
+      @subject_class ||= subject_type&.constantize
+    end
+
+    def parent_class
+      @parent_class ||= parent_type&.constantize
+    end
+  end
+end

data/lib/acts_as_tracked/extenders/trackable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# require 'active_support/concern'
+
+module ActsAsTracked
+  module Extenders
+    module Trackable
+      # extend ActiveSupport::Concern
+
+      # Includes Tracking module in specified model
+      #
+      # @params exclude_activity_attributes [:foo, :bar]
+      # if given, excludes specified params from tracking
+
+      def acts_as_tracked(args = {})
+        require 'acts_as_tracked/tracking'
+
+        include ::ActsAsTracked::Tracking
+
+        exclude_activity_attributes(*args[:exclude_activity_attributes]) if args[:exclude_activity_attributes]
+      end
+    end
+  end
+end

data/lib/acts_as_tracked/tracking.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActsAsTracked
+  module Tracking
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :activities_as_subject, as: :subject, class_name: 'ActsAsTracked::Activity', dependent: :nullify
+      has_many :activities_as_parent, as: :parent, class_name: 'ActsAsTracked::Activity', dependent: :nullify
+      has_many :activities_as_actor, as: :actor, class_name: 'ActsAsTracked::Activity', dependent: :nullify
+
+      after_create :track_create_activity!, if: :tracking_changes?
+      after_update :track_update_activity!, if: :tracking_changes?, prepend: true
+      after_destroy :track_destroy_activity!, if: :tracking_changes?
+
+      cattr_accessor(:__global_activity_attributes) { {} }
+      cattr_accessor(:__global_tracking_changes) { false }
+      cattr_accessor(:__excluded_attributes) { %w[updated_at created_at] }
+    end
+
+    def activities
+      t = Activity.arel_table
+      Activity.where t[:subject_type].eq(self.class.name).and(t[:subject_id].eq(id))
+                                     .or(t[:parent_type].eq(self.class.name).and(t[:parent_id].eq(id)))
+    end
+
+    def tracking_changes(attributes)
+      @activity_attributes = attributes
+      @tracking_changes = true
+      yield
+    ensure
+      @activity_attributes = {}
+      @tracking_changes = false
+    end
+
+    def tracking_changes?
+      @tracking_changes || self.class.__global_tracking_changes
+    end
+
+    def activity_attributes
+      self.class.__global_activity_attributes.merge(@activity_attributes || {})
+    end
+
+    def activity_label
+      raise NotImplementedError, "You must define this method in #{self.class}"
+    end
+
+    class_methods do
+      def tracking_changes(opts)
+        self.__global_activity_attributes = __global_activity_attributes.merge(opts)
+        self.__global_tracking_changes = true
+        yield
+      ensure
+        self.__global_activity_attributes = {}
+        self.__global_tracking_changes = false
+      end
+
+      def exclude_activity_attributes(*attributes)
+        self.__excluded_attributes += attributes.map(&:to_s)
+      end
+
+      def activities_for(ids)
+        ids = Array.wrap(ids)
+        t = Activity.arel_table
+        Activity.where t[:subject_type].eq(name).and(t[:subject_id].in(ids))
+                                       .or(t[:parent_type].eq(name).and(t[:parent_id].in(ids)))
+      end
+    end
+
+    protected
+
+    def track_activity!(type, defaults = {})
+      Activity.create!(defaults.merge(subject: self, activity_type: type))
+    end
+
+    def track_create_activity!
+      return true unless activity_changes.any?
+
+      track_activity!(:created, activity_attributes.merge(attribute_changes: activity_changes))
+      true
+    end
+
+    def track_update_activity!
+      return true unless activity_changes.any?
+
+      track_activity!(:updated, activity_attributes.merge(attribute_changes: activity_changes))
+      true
+    end
+
+    def track_destroy_activity!
+      track_activity!(:destroyed, activity_attributes)
+      true
+    end
+
+    def activity_changes
+      changes = saved_changes.transform_values(&:first).keys.reject do |x|
+        self.class.__excluded_attributes.include?(x.to_s)
+      end
+      changes.map do |x|
+        [x, [send("#{x}_before_last_save").to_s, self[x]]]
+      end.to_h
+    end
+  end
+end

data/lib/acts_as_tracked/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActsAsTracked
+  VERSION = '1.0.0'
+end

data/lib/generators/acts_as_tracked/migration/migration_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+
+module ActsAsTracked
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    MIGRATION_TIMESTAMP_FORMAT = '%Y%m%d%H%M%S'
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', 'active_record')
+    end
+
+    def self.next_migration_number(_path)
+      Time.now.utc.strftime(MIGRATION_TIMESTAMP_FORMAT)
+    end
+
+    def create_migration_file
+      migration_template  'migration.erb',
+                          'db/migrate/acts_as_tracked_migration.rb'
+      { migration_version: migration_version }
+    end
+
+    private
+
+    # Rails 5.x+ requires Rails version to
+    # be specified in migration file
+
+    def migration_version
+      migration_versions = {
+        '5' => '[5.0]',
+        '6' => '[6.0]'
+      }
+
+      migration_versions.fetch(
+        Rails.version[0],
+        nil
+      )
+    end
+  end
+end

data/lib/generators/acts_as_tracked/migration/templates/active_record/migration.erb

@@ -0,0 +1,20 @@
+class ActsAsTrackedMigration < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :activities do |t|
+      t.integer :actor_id, index: true
+      t.string :actor_type
+      t.integer :subject_id, index: true
+      t.string :subject_type
+      t.integer :parent_id, index: true
+      t.string :parent_type
+      t.text :attribute_changes
+      t.string :activity_type
+      t.string :human_description
+      t.timestamps null: false
+    end
+  end
+
+  def self.down
+    drop_table :activity
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_tracked
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sahil Gadimbayli
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Track activities in your ActiveRecord models.
+email:
+- sahil.gadimbay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_tracked.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_tracked.rb
+- lib/acts_as_tracked/activity.rb
+- lib/acts_as_tracked/extenders/trackable.rb
+- lib/acts_as_tracked/tracking.rb
+- lib/acts_as_tracked/version.rb
+- lib/generators/acts_as_tracked/migration/migration_generator.rb
+- lib/generators/acts_as_tracked/migration/templates/active_record/migration.erb
+homepage: https://github.com/ramblingcode/acts-as-tracked
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ramblingcode/acts-as-tracked
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Activity Tracker to plug into ActiveRecord.
+test_files: []