acts_as_trackable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a700b0c0fba945f6c9876467d413d0600f0a2ab74d99972056dfe927748db138
+  data.tar.gz: 9418887b082a2b132aeccd35141195399199b9ad434cbe89deaaeb29504a4e78
+SHA512:
+  metadata.gz: a1f834409c983cd6edec2afa8f15fcd6d1d1d18d918aba0b00d7fa75c5d31c04d4404903b4980256d31882a3b9a8c6bcdc268f3665029b2c83c09dcc9b03e401
+  data.tar.gz: 0f0c6826c985e4b8de63c2144d2971a6aac46ffb32d1202623e55cefa4e9fa1091358770d60a36254b78bdc1d705be11ece697c3b19c2ae25981596b3d1cb2b5

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/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

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 a.keewan@zenhr.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,10 @@
+source "https://rubygems.org"
+
+gemspec
+gem 'activerecord', '~> 6.1', '>= 6.1.7.10'
+gem 'activesupport', '~> 6.1', '>= 6.1.7.10'
+gem 'rake', '~> 13.2.1'
+
+group :test do
+  gem 'sqlite3', '~> 1.6.8'
+end

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    acts_as_trackable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.7.10)
+      actionview (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.7.10)
+      activesupport (= 6.1.7.10)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activerecord (6.1.7.10)
+      activemodel (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activesupport (6.1.7.10)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    crass (1.0.6)
+    erubi (1.13.0)
+    generator_spec (0.10.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    loofah (2.23.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.1.0)
+    mini_portile2 (2.8.8)
+    minitest (5.25.1)
+    nokogiri (1.15.6)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    racc (1.8.1)
+    rack (2.2.10)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rake (13.2.1)
+    sqlite3 (1.6.9)
+      mini_portile2 (~> 2.8.0)
+    thor (1.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.1, >= 6.1.7.10)
+  activesupport (~> 6.1, >= 6.1.7.10)
+  acts_as_trackable!
+  generator_spec
+  rake (~> 13.2.1)
+  sqlite3 (~> 1.6.8)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ahmad Keewan - ZenHR Engineering
+
+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,74 @@
+<!-- [![Gem Version](https://badge.fury.io/rb/acts_as_trackable.svg)](https://badge.fury.io/rb/acts_as_trackable) -->
+
+# ActsAsTrackable
+
+ActsAsTrackable is a gem that simplifies the process of tracking your DB object's creation and modification.
+
+## Installation
+
+Add this line to your application's Gemfile(For now you have to add it locally v0.1.0):
+
+```ruby
+gem 'acts_as_trackable', path: 'path_to_gem'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install acts_as_trackable
+
+After that run the following commands:
+
+    $ rails generate acts_as_trackable:object_activity ObjectActivity
+    $ rails db:migrate
+
+## Usage
+
+- ActsAsTrackable is auto_loaded, there's no need to add it to ApplicationRecord.rb
+
+- Go to your model and add the following:
+
+  ```ruby
+  acts_as_trackable
+  ```
+
+- If your model is expected to have multiple version of each object, pass the column that tracks the version to acts_as_trackable as a symbol, acts_as_trackable is smart enough to relink the object_activity with the latest version(Previous versions won't be linked to any activity):
+
+  ```ruby
+  acts_as_trackable :latest_x_version_id
+  ```
+
+- Go to your user model and the following:
+    ```ruby
+    acts_as_modifier
+    ```
+- After that, you need to pass the user to the modifier attribute from your controller(or basically anywhere) to your update/create statements as follows(If you don't pass the modifier, track me will simply ignore creating/updating the object activity):
+  ```ruby
+  YourTrackableModel.update(modifier: @current_user)
+  ```
+
+
+- Joining your records with objects_activities:
+  ```ruby
+  @records.left_joins_object_activities(['YourUserModelClassName'])
+  ```
+## 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/a-keewan/acts_as_trackable. 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_trackable/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 ActsAsTrackable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/a-keewan/acts_as_trackable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/acts_as_trackable.gemspec

@@ -0,0 +1,40 @@
+require_relative 'lib/acts_as_trackable/version'
+
+Gem::Specification.new do |spec|
+  spec.name                        = 'acts_as_trackable'
+  spec.version                     = ActsAsTrackable::VERSION
+  spec.authors                     = ['Ahmad Keewan', 'ZenHR Engineering']
+  spec.email                       = ['a.keewan@zenhr.com']
+  spec.homepage                    = 'https://www.zenhr.com'
+  spec.license                     = 'MIT'
+  spec.required_ruby_version       = Gem::Requirement.new('>= 2.7.2')
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/a-keewan/acts_as_trackable'
+  spec.metadata["changelog_uri"]   = 'https://github.com/a-keewan/acts_as_trackable/blob/master/changelog.md'
+
+  spec.summary = <<~DESC
+    ActsAsTrackable is a RoR gem that simplifies tracking the creation and modification of database objects.
+    It provides easy-to-use methods to make any ActiveRecord model trackable
+    and allows tracking of modifications by specific users.
+  DESC
+  spec.description = <<~DESC
+    ActsAsTrackable is designed to simplify the process of tracking database object activities in Ruby on Rails applications.
+    By including the gem and running a few setup commands, developers can make their models trackable with minimal effort.
+    The gem supports tracking multiple versions of objects and associating activities with specific users.
+    It is auto-loaded into ActiveRecord, eliminating the need for manual inclusion in models.
+    ActsAsTrackable also provides methods for joining records with their associated activities,
+    making it easier to query and analyze object changes.
+  DESC
+
+  # 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)/}) || f.end_with?('.gem') }
+  end
+
+  spec.add_development_dependency 'generator_spec'
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acts_as_trackable"
+
+# 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_trackable/modifier.rb

@@ -0,0 +1,10 @@
+require 'active_support/concern'
+
+module Modifier
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :object_activities_as_updater, class_name: 'ObjectActivity', as: :updated_by
+    has_many :object_activities_as_creator, class_name: 'ObjectActivity', as: :created_by
+  end
+end

data/lib/acts_as_trackable/trackable.rb

@@ -0,0 +1,50 @@
+require 'active_support/concern'
+
+module Trackable
+  extend ActiveSupport::Concern
+
+  included do
+    attr_accessor :modifier
+
+    has_one :object_activity, as: :object, dependent: :destroy
+
+    delegate :created_by, :updated_by, to: :object_activity, allow_nil: true
+
+    after_commit :log_object_activity, on: %i[create update], if: -> { modifier.present? }
+
+    scope :left_joins_object_activities, lambda { |user_types|
+      query = left_joins(:object_activity)
+      user_types.each do |user_type|
+        query = query.joins(left_join_users('created_by', user_type))
+                     .joins(left_join_users('updated_by', user_type))
+      end
+
+      query
+    }
+
+    def self.left_join_users(action, user_type)
+      "LEFT JOIN #{user_type.downcase.pluralize} AS #{action}_#{user_type.downcase.pluralize} " \
+      "ON #{action}_#{user_type.downcase.pluralize}.id = object_activities.#{action}_id " \
+      "AND object_activities.#{action}_type = '#{user_type}'"
+    end
+
+    private
+
+    def log_object_activity
+      object_activity              = ObjectActivity.find_or_initialize_by(trackable_object)
+      object_activity.object_id    = id
+      object_activity.created_by ||= modifier
+
+      if object_activity.persisted?
+        object_activity.updated_by = modifier
+        object_activity.updated_at = Time.current
+      end
+
+      object_activity.save!
+    end
+
+    def trackable_object
+      { object_id: send(self.class.trackable_column), object_type: self.class.name }
+    end
+  end
+end

data/lib/acts_as_trackable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsTrackable
+  VERSION = "0.1.0"
+end

data/lib/acts_as_trackable.rb

@@ -0,0 +1,37 @@
+require_relative 'acts_as_trackable/version'
+require_relative 'acts_as_trackable/trackable'
+require_relative 'acts_as_trackable/modifier'
+
+module ActsAsTrackable
+  class Error < StandardError; end
+
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :trackable_column
+  end
+
+  class_methods do
+    def acts_as_trackable(column_name = :id)
+      self.trackable_column = column_name
+      validate_trackable_column
+      include Trackable
+    end
+
+    def acts_as_modifier
+      include Modifier
+    end
+
+    private
+
+    def validate_trackable_column
+      return if column_names.include?(trackable_column.to_s)
+
+      raise ArgumentError, "Column '#{trackable_column}' does not exist in the table"
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActsAsTrackable
+end

data/lib/generators/acts_as_trackable/object_activity_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/active_record'
+require 'rails/generators/named_base'
+
+module ActsAsTrackable
+  module Generators
+    class ObjectActivityGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      def create_migration
+        migration_file_name = "create_object_activity.rb"
+        timestamp           = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        destination         = File.join('db', 'migrate', "#{timestamp}_#{migration_file_name}")
+
+        template migration_file_name, destination
+      end
+
+      def create_model_file
+        template 'object_activity.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      end
+    end
+  end
+end

data/lib/generators/acts_as_trackable/templates/create_object_activity.rb

@@ -0,0 +1,10 @@
+class CreateObjectActivity < ActiveRecord::Migration[6.1]
+  def change
+    create_table :object_activities do |t|
+      t.references :object,     polymorphic: true, index: true, null: false
+      t.references :created_by, polymorphic: true, index: true, null: false
+      t.references :updated_by, polymorphic: true, index: true
+      t.datetime   :updated_at
+    end
+  end
+end

data/lib/generators/acts_as_trackable/templates/object_activity.rb

@@ -0,0 +1,7 @@
+class <%= class_name %> < ApplicationRecord
+  self.record_timestamps = false
+
+  belongs_to :updated_by, polymorphic: true, optional: true
+  belongs_to :created_by, polymorphic: true
+  belongs_to :object,     polymorphic: true
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_trackable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmad Keewan
+- ZenHR Engineering
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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: |
+  ActsAsTrackable is designed to simplify the process of tracking database object activities in Ruby on Rails applications.
+  By including the gem and running a few setup commands, developers can make their models trackable with minimal effort.
+  The gem supports tracking multiple versions of objects and associating activities with specific users.
+  It is auto-loaded into ActiveRecord, eliminating the need for manual inclusion in models.
+  ActsAsTrackable also provides methods for joining records with their associated activities,
+  making it easier to query and analyze object changes.
+email:
+- a.keewan@zenhr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_trackable.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_trackable.rb
+- lib/acts_as_trackable/modifier.rb
+- lib/acts_as_trackable/trackable.rb
+- lib/acts_as_trackable/version.rb
+- lib/generators/acts_as_trackable/object_activity_generator.rb
+- lib/generators/acts_as_trackable/templates/create_object_activity.rb
+- lib/generators/acts_as_trackable/templates/object_activity.rb
+homepage: https://www.zenhr.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.zenhr.com
+  source_code_uri: https://github.com/a-keewan/acts_as_trackable
+  changelog_uri: https://github.com/a-keewan/acts_as_trackable/blob/master/changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: ActsAsTrackable is a RoR gem that simplifies tracking the creation and modification
+  of database objects. It provides easy-to-use methods to make any ActiveRecord model
+  trackable and allows tracking of modifications by specific users.
+test_files: []