activerecord_activity_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c09229f37893a454390cccc6cc3443cd969bc7c
+  data.tar.gz: 9c5cb93539f0c16fe7ddb8376a2e0c9a9aa95c93
+SHA512:
+  metadata.gz: 6ec127a4a30576b4308835c5a126d090f94604b18865b250bf32c6a278605e9017c8e161ebd2fa064dd70feec513a6793a420bda4c66f39bb7f2217f247b722a
+  data.tar.gz: 4157605a7bacbbb6953dc33f7e38026d57c0028c8849362d7fd99dff4b727908d1eb7525ad617c433215124fc4941bfc233ac0ccfc6df9b8222fb682bc290912

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Mudafar
+
+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,270 @@
+# ActiverecordActivityTracker
+`activerecord_activity_tracker` provides simple yet powerful activity tracker for your Rails **ActiveRecord** models.
+
+This gem will allows you to create the data model for social **news feed** used in many modern platform in no time.
+
+`Note:` This is an abstract gem, thus there are no views or controllers provided.
+
+
+
+
+
+
+
+
+
+
+
+### Features
+- Track model's creation and/or updating activities. 
+- Track any custom activity's event easily.
+- Add optional data to any custom activity.
+- Set owner once, and use it in all tracked models seamlessly.
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+## Usage
+
+### Track a model
+- Include `ActiverecordActivityTracker::ActsAsTrackable`
+- For automatic tracking add `acts_as_trackable`
+- For custom event use `create_ar_activity`
+
+### Set default owner (user)
+- Include `ActiverecordActivityTracker::Owner`
+- To set the owner use `set_owner(current_user)`
+- To get the owner use `get_owner`
+- To clear owner use `clear_owner`
+
+`Note:` setting the owner is required, as each activity must have an owner, see [set default owner example](#set-default-owner-to-devise-current_user)
+ 
+
+### Access model's tracked activities
+- Include `ActiverecordActivityTracker::ActsAsTrackable`
+- Use `ar_activities`
+
+### Examples
+
+#### Track comment's creation
+```ruby
+# app/models/comment.rb
+class Comment < ApplicationRecord
+  include ActiverecordActivityTracker::ActsAsTrackable
+
+  acts_as_trackable [:create]
+end
+ ```
+ 
+#### Track comment's creation and modification
+```ruby
+# app/models/comment.rb
+class Comment < ApplicationRecord
+  include ActiverecordActivityTracker::ActsAsTrackable
+
+  acts_as_trackable [:create, :update]
+end
+ ``` 
+
+#### Track comment's custom event (title's change)
+
+```ruby
+# app/models/comment.rb
+class Comment < ApplicationRecord
+  include ActiverecordActivityTracker::ActsAsTrackable
+
+  after_update :add_title_change_activity
+    
+  private
+    
+  def add_title_change_activity
+    create_ar_activity(key: 'comment.title.change') if saved_change_to_title?
+  end
+    
+end
+ ``` 
+
+#### Set default owner to devise current_user
+`Note:` owner is a polymorphic relation, thus any model can be used, not just user.
+ 
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  include ActiverecordActivityTracker::Owner
+
+  protect_from_forgery with: :exception
+
+  around_action :set_ar_activity_owner
+
+
+  private
+
+  def set_ar_activity_owner
+    set_owner current_user
+    yield
+  ensure
+    clear_owner
+  end
+
+end
+```
+
+### Access comment's activities
+
+```html
+<!-- app/views/comments/show.erb -->
+  <% @comment.ar_activities.each do |activity| %>
+      <%= activity.key %>
+      <br>
+  <% end %>
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_activity_tracker'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install activerecord_activity_tracker
+```
+
+### Setup
+Execute this line in your application's directory:
+```bash
+$ rails generate activerecord_activity_tracker:install
+``` 
+
+And then execute:
+```bash
+$ rails db:migrate
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+### Documentation / API
+#### ActiverecordActivityTracker::ActsAsTrackable
+- `acts_as_trackable(tracked = [:create, :update]) => nil`
+    Overview:
+    Track model automatically.
+
+    Parameters:
+    tracked (array) (defaults to: [:create, :update]) -- instance options to set the tracked events.
+
+
+- `create_ar_activity(options = {}) => nil`
+    Overview:
+    Create custom activity, prevent duplication.
+
+    Options:
+    - key (string) (defaults to: "#{model_name.param_key}.create"). 
+    - owner (active_record_relation) (defaults to: get_owner).
+    - data (string) (defaults to: nil).
+
+    Parameters:
+-- options (hash) (defaults to: {}) -- instance options to set custom params.
+
+
+- `create_ar_activity!(options = {}) => nil`
+    Overview:
+    Similar to `create_ar_activity` but allows duplication.
+
+
+
+- `has_many :ar_activities, as: :trackable, dependent: :destroy`
+    Overview: 
+    Handle activities' relations.    
+    
+#### ActiverecordActivityTracker::Owner
+- `get_owner() => owner (active_record_model or nil)`
+    Overview: Get the current owner
+
+- `set_owner(owner) => nil`
+    Overview: Set the current owner.
+    
+    Parameters:
+    owner (active_record_model) -- instance active record model to set current owner.
+    
+    
+- `clear_owner => nil`
+    Overview: Set the current owner to nil.   
+
+
+#### ArActivityTracker 
+- ##### Description
+    Activity model, to handle trackable and owner relations.
+
+- ##### Data structure
+    `    t.string "trackable_type"
+     t.integer "trackable_id"
+     t.string "owner_type"
+     t.integer "owner_id"
+     t.string "key"
+     t.string "data"
+`
+- ##### Key default format
+    MODEL_NAME.ACTIVITY_TYPE
+
+    **For example:**
+Given a `tracked` comment model `Comment`, then the keys (by default) will be:
+`comment.create` and `comment.update` for creation and modification activities respectively. 
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/mudafar/activerecord_activity_tracker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiverecordActivityTracker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/activerecord_activity_tracker.rb

@@ -0,0 +1,7 @@
+require 'activerecord_activity_tracker/acts_as_trackable'
+require 'activerecord_activity_tracker/owner'
+
+module ActiverecordActivityTracker
+
+
+end

data/lib/activerecord_activity_tracker/acts_as_trackable.rb

@@ -0,0 +1,59 @@
+# require 'activerecord_activity_tracker/activerecord_activity'
+require 'activerecord_activity_tracker/owner'
+
+module ActiverecordActivityTracker
+  module ActsAsTrackable
+    extend ActiveSupport::Concern
+    include ActiverecordActivityTracker::Owner
+
+    class_methods do
+      def acts_as_trackable(tracked = [:create, :update])
+        if tracked.include?(:create)
+          before_create -> {ar_activities.build(owner: get_owner, key: "#{model_name.param_key}.create")}
+        end
+
+        if tracked.include?(:update)
+          before_update -> {ar_activities.build(owner: get_owner, key: "#{model_name.param_key}.update")}
+        end
+      end
+    end
+
+
+    included do
+      has_many :ar_activities, as: :trackable, dependent: :destroy
+
+      # Prevent duplication by default
+      def create_ar_activity(options = {})
+        _create_ar_activity(false, options)
+      end
+
+      # Allow duplication
+      def create_ar_activity!(options = {})
+        _create_ar_activity(true, options)
+      end
+
+    end
+
+
+    private
+
+    def _create_ar_activity(allow_dup, options = {})
+      default_options = {
+          key: "#{model_name.param_key}.create",
+          data: nil,
+          owner: get_owner
+      }
+      default_options.merge!(options)
+
+
+      if allow_dup ||
+          (!ar_activities.exists?(key: default_options[:key]) ||
+              !ar_activities.exists?(owner: default_options[:owner]) ||
+              !ar_activities.exists?(data: default_options[:data])
+          )
+        ar_activities.create(default_options)
+      end
+    end
+
+  end
+end

data/lib/activerecord_activity_tracker/current_owner.rb

@@ -0,0 +1,6 @@
+module ActiverecordActivityTracker
+  module CurrentOwner
+    thread_mattr_accessor :owner
+  end
+end
+

data/lib/activerecord_activity_tracker/owner.rb

@@ -0,0 +1,19 @@
+require 'activerecord_activity_tracker/current_owner'
+
+module ActiverecordActivityTracker
+  module Owner
+
+    def get_owner
+      ActiverecordActivityTracker::CurrentOwner.owner
+    end
+
+    def set_owner(owner)
+      ActiverecordActivityTracker::CurrentOwner.owner = owner
+    end
+
+    def clear_owner
+      ActiverecordActivityTracker::CurrentOwner.owner = nil
+    end
+
+  end
+end

data/lib/activerecord_activity_tracker/version.rb

@@ -0,0 +1,3 @@
+module ActiverecordActivityTracker
+  VERSION = '0.1.0'
+end

data/lib/generators/activerecord_activity_tracker.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/named_base'
+
+module ActiverecordActivityTracker
+  # A generator module with Activity table schema.
+  module Generators
+    # A base module
+    module Base
+      # Get path for migration template
+      def source_root
+        @_activerecord_activity_tracker_source_root ||= File.expand_path(File.join('../activerecord_activity_tracker', generator_name, 'templates'), __FILE__)
+      end
+    end
+  end
+end

data/lib/generators/activerecord_activity_tracker/install/install_generator.rb

@@ -0,0 +1,21 @@
+require 'generators/activerecord_activity_tracker'
+require 'rails/generators/active_record'
+
+module ActiverecordActivityTracker
+  module Generators
+    # Migration generator that creates migration file from template
+    class InstallGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, type: :string, default: 'create_activerecord_activities'
+
+      def generate_model
+        Rails::Generators.invoke('active_record:model',
+                                 %w(ArActivity trackable:references{polymorphic} owner:references{polymorphic} key:string data:string),
+                                 behavior: behavior)
+      end
+
+
+    end
+  end
+end

data/lib/tasks/activerecord_activity_tracker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :activerecord_activity_tracker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_activity_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mudafar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: This gem will allows you to create the data model for social news feed
+  used in many modern platform in no time.
+email:
+- mudafar@ula.ve
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/activerecord_activity_tracker.rb
+- lib/activerecord_activity_tracker/acts_as_trackable.rb
+- lib/activerecord_activity_tracker/current_owner.rb
+- lib/activerecord_activity_tracker/owner.rb
+- lib/activerecord_activity_tracker/version.rb
+- lib/generators/activerecord_activity_tracker.rb
+- lib/generators/activerecord_activity_tracker/install/install_generator.rb
+- lib/tasks/activerecord_activity_tracker_tasks.rake
+homepage: https://github.com/mudafar/activerecord_activity_tracker
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: activerecord_activity_tracker provides simple yet powerful activity tracker
+  for your Rails ActiveRecord models.
+test_files: []