acts_as_tracked 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 395a0143c5923febe5d923e31332bcd516bb901915a4515162d5372889a820b9
-  data.tar.gz: 7f717b289f17654c9ccfd02b5504dd1efdf018fff83f110ec84fb0431537af25
+  metadata.gz: 7bdeaabe771f68654d6ccf3728485a212801ee2e8f18bc637953c3c822c0f5c7
+  data.tar.gz: c44e7cc2cffdbce56cc13e95e54a6ea28e267ffac71ecaa46f0ad56e652a45b1
 SHA512:
-  metadata.gz: 2c1149d0fee0c6a2a44f51420e758bb6dc600753d6157d3ea9f5ea1ec236acf5057beaaae0472db71fe6304a0b56d1990c08e87a36aaf0b66328996e329b6ac2
-  data.tar.gz: 2370e1de45f80e14a09f3c9b8477773ea9240ac906674ac8702d881bd0f8af751105028ca07cc13215a7c76e883741293c876c79b2733e56be3a7ab804e0d62d
+  metadata.gz: 21b20a551df69c57b0379ef45157e65dd8c51f6db4f0fe71454ece79b487ef118fd28add076288bb9e2a66774f4749b449ad0e3b660b67cf91eaeaeae3481b6f
+  data.tar.gz: 65f261411562f9d336cbbe692ef093f5bbf504a29a008abe80004257b0413d47c96398b8b5858b239d33cb9d2e7ec539b15ad4afe80aa730a80f19aad8b4abe2

data/README.md

@@ -1,13 +1,13 @@
-[![Gem Version](https://badge.fury.io/rb/acts-as-tracked.svg)](https://badge.fury.io/rb/acts-as-tracked)
+[![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.
+Welcome to ActsAsTracked! This gem is an extension to your ActiveRecord models to track activities. It does not track everything all the time or in the background, 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`.
+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 explicitly`.
 
 ## Installation
 
@@ -20,13 +20,13 @@ gem 'acts_as_tracked'
 And then execute:
 
 ```shell
-$ bundle install
+bundle install
 ```
 
 Or install it yourself as:
 
 ```shell
-$ gem install acts_as_tracked
+gem install acts_as_tracked
 ```
 
 ## Usage
@@ -44,15 +44,12 @@ ActsAsTracked has extension to generate migrations. Please, run:
 This will generate following migration:
 
 ```ruby
-class ActsAsTrackedMigration < ActiveRecord::Migration<Rails Version>
+class ActsAsTrackedMigration < ActiveRecord::Migration
   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.references :actor, polymorphic: true
+      t.references :subject, polymorphic: true
+      t.references :parent, polymorphic: true
       t.text :attribute_changes
       t.string :activity_type
       t.string :human_description
@@ -79,7 +76,7 @@ If you would like to track changes of `Post` model, you would need to call `acts
     # 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])
+    # acts_as_tracked(exclude_activity_attributes: %i[api_key, username])
   end
 ```
 
@@ -160,13 +157,41 @@ Post.tracking_changes(actor: User.first, subject: Post.first, human_description:
 end
 ```
 
+### Excluding attributes from change sets
+
+Sometimes you would like to not track some fields of the record in change sets.
+
+You can use exclude_activity_attributes and ActsAsTracked will not include them in activities.
+
+```ruby
+  class Post < ApplicationRecord
+    acts_as_tracked(exclude_activity_attributes: %i[api_key, username])
+  end
+```
+
+### Differences between [PaperTrail](https://github.com/paper-trail-gem/paper_trail), [Audited](https://github.com/collectiveidea/audited), and [PublicActivity](https://github.com/chaps-io/public_activity) gems
+
+Main difference is that ActsAsTracked does not track anything unless used `explicitly`. It does not store versions of the record that you can rollback to.
+
+It's minimal, and only does 1 thing, that is creating activity records with change sets whenever used.
+
+It's a feature extension to your models to use when *needed*, instead of being a hook that acts in the background.
+
+```ruby
+Post.tracking_changes(actor: @user) do
+  ...changes on posts
+end
+```
+
+You can check the `tracking` module which is just a shy over 100 lines that gets plugged in your models [here](https://github.com/ramblingcode/acts-as-tracked/blob/master/lib/acts_as_tracked/tracking.rb).
+
 ### 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.
+Initial work of ActsAsTracked has been done by [@rogercampos](https://github.com/rogercampos) and [@camaloon](https://github.com/camaloon) team. I have refined, packaged, documented, added generators and published it.
 
 ## Development
 
@@ -176,7 +201,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+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
 

data/lib/acts_as_tracked/version.rb

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

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

@@ -1,12 +1,9 @@
 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.references :actor, polymorphic: true
+      t.references :subject, polymorphic: true
+      t.references :parent, polymorphic: true
       t.text :attribute_changes
       t.string :activity_type
       t.string :human_description

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tracked
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Sahil Gadimbayli
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview