audit_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b9079e64cb35e5229690f0ea50e4464767249e8b6154af79035ba584b3caf1a
+  data.tar.gz: 42206ff6944bdc9770a73ee1692e3f508b586c9f65fc19d408a592ed0c39329e
+SHA512:
+  metadata.gz: dc762930e22fb6036963eae309ed6d08bf0a3c25ac4bca21b8913b23e322c93b3f68c5e9338887a5165b0d38c22c5c44a4b6267e45da475048f9c837bfe7ab59
+  data.tar.gz: c225767c844fc9c5025352ec4fe14b774cf6580bb74708a85241fb613236a7855a4f2e2f18d481c5f4341514d10719bfd082a15f5828a07a7d11a7fa974b6a0a

data/.rubocop.yml

@@ -0,0 +1,2 @@
+require:
+  - rubocop-powerhome

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in audit_tracker.gemspec
+gemspec
+
+rails_version = ENV.fetch("RAILS_VERSION", ">= 5.2.8.1")
+
+gem "rails", rails_version
+
+gem "byebug"
+gem "license_finder", ">= 7.0"
+gem "rake", ">= 13.0"
+gem "rspec", ">= 3.0"
+gem "rubocop", ">= 1.32"
+gem "rubocop-powerhome", ">= 0.5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Power Home Remodeling
+
+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/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/audit_tracker.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/audit_tracker/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "audit_tracker"
+  spec.version = AuditTracker::VERSION
+  spec.authors = ["Carlos Palhares"]
+  spec.email = ["chjunior@gmail.com"]
+
+  spec.summary = "AuditTracker helps you centralize data tracking configuration to be used across different models"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/powerhome/power-tools"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/packages/audit_tracker/docs/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "activerecord", ">= 5.2.8.1"
+  spec.add_development_dependency "combustion", "~> 1.3"
+  spec.add_development_dependency "rspec-rails", "~> 5.1.2"
+  spec.add_development_dependency "shoulda-matchers", "~> 5.1.0"
+  spec.add_development_dependency "sqlite3", "~> 1.4.2"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/doc/dependency_decisions.yml

@@ -0,0 +1,3 @@
+---
+- - :inherit_from
+  - https://raw.githubusercontent.com/powerhome/oss-guide/master/license_rules.yml

data/docs/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-28
+
+- Initial release

data/docs/README.md

@@ -0,0 +1,128 @@
+# AuditTracker
+
+AuditTracker helps you centralize data tracking configuration to be used across different models.
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+    $ bundle add audit_tracker
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install audit_tracker
+
+## Usage Example
+
+In this example, we'll track the actors that created or updated different models, like the user, title, and their department at the time. This is represented like this in AuditTracker:
+
+```ruby
+AuditTracker.setup do
+  tracker :user do
+    value { ::Internal::Current.user }
+    create :created_by, foreign_key: :created_by_id, class_name: "::Internal::User"
+    update :updated_by, foreign_key: :updated_by_id, class_name: "::Internal::User"
+  end
+  tracker :user_department do
+    value { ::Internal::Current.user&.department }
+    create :created_by_department, foreign_key: :created_by_department_id, class_name: "::Internal::Department"
+    update :updated_by_department, foreign_key: :updated_by_department_id, class_name: "::Internal::Department"
+  end
+end
+```
+
+Then, enable the trackers on each model:
+
+```ruby
+class Lead < ApplicationRecord
+  track_audit_data user: true, user_department: true
+end
+```
+
+This will create each relation setup by the tracker:
+
+```ruby
+lead.created_by => User
+lead.created_by_department => Department
+lead.updated_by => User
+lead.updated_by_department => Department
+```
+
+When a relation is disabled, the tracker is not setup:
+
+```ruby
+module Internal
+  class Home < ::Internal::ApplicationRecord
+    track_audit_data user: true
+  end
+end
+
+home.created_by => User
+home.created_by_department => NoMethodError
+home.updated_by => User
+home.updated_by_department => NoMethodError
+```
+
+### Disabling individual relations
+
+To enable each relation, AuditTracker will first check if the column exists (`foreign_key`). If it doesn't exist, the relation won't be created, and the tracker won't be enabled for it.
+
+```ruby
+module Internal
+  class Sale < ::Internal::ApplicationRecord
+    track_audit_data user: true
+  end
+end
+
+Sale.column_names => ["id", "price", "updated_by_id"]
+sale.created_by => User
+sale.created_by_department => NoMethodError
+sale.updated_by => NoMethodError
+sale.updated_by_department => NoMethodError
+```
+
+### Overriding relation options
+
+To override a relation option in a tracker, use the tracker options:
+
+```ruby
+
+module Internal
+  class Score < ::Internal::ApplicationRecord
+    track_audit_data(
+      user: {
+        created_by: {
+          class_name: "::Internal::ManagerUser",
+          value: -> { ::Internal::Current.user.becomes(::Internal::ManagerUser) },
+        },
+        updated_by: {
+          class_name: "::Internal::ManagerUser",
+          value: -> { ::Internal::Current.user.becomes(::Internal::ManagerUser) },
+        },
+      }
+    )
+  end
+end
+
+score.created_by => ManagerUser
+score.updated_by => ManagerUser
+```
+
+## Internal Example
+
+The above example lives in our [specs](specs/internal).
+
+
+## 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 the created tag, 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/powerhome/power-tools.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/audit_tracker/dsl.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module AuditTracker
+  # AuditTracker DSL modules
+  module DSL
+    def self.build(&block)
+      Setup.module_eval(&block)
+    end
+
+    # AuditTracker::DSL::Setup is the DSL cotext of the block in AuditTracker.setup
+    #
+    module Setup
+    module_function
+
+      def tracker(key, &block)
+        ::AuditTracker.trackers[key] = Tracking.build(&block)
+      end
+    end
+
+    # AuditTracker::DSL::Setup is the DSL cotext of the block in `DSL::Setup.tracker`
+    #
+    class Tracking
+      def self.build(&block)
+        tracker = new
+        tracker.instance_eval(&block)
+        tracker.tracker
+      end
+
+      def tracker
+        ::AuditTracker::Tracker.new(on: @on, value: @value)
+      end
+
+      def on(event, relation, **options)
+        @on ||= []
+        @on << [event, relation, options]
+      end
+
+      def update(relation, **options)
+        on(:save, relation, **options)
+      end
+
+      def create(relation, **options)
+        on(:create, relation, **options)
+      end
+
+      def value(&block)
+        @value = block
+      end
+    end
+  end
+end

data/lib/audit_tracker/model_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AuditTracker
+  # Model helper for setting up trackers in an ActiveRecord model
+  #
+  module ModelHelper
+    #
+    # Helper to apply AuditTracker to a model. This helper is automatically added
+    # to ActiveRecord::Base when it loads (@see {AuditTracker::Railtie})
+    #
+    # `track_audit_data` options are the keys of the trackers defined. Each tracker is
+    # enabled by passing `true` to it's key.
+    #
+    # I.e.:
+    #
+    #   track_audit_data user: true, user_department: true
+    #
+    # A hash of options can also be used to override any tracker option:
+    #
+    #   track_audit_data(
+    #     user: {
+    #       created_by: { class_name: "::ManagerUser" },
+    #       updated_by: { class_name: "::ManagerUser" },
+    #     }
+    #   )
+    #
+    # And the value block can also be overriden:
+    #
+    #   track_audit_data(
+    #     user: {
+    #       created_by: { class_name: "::ManagerUser", value: -> { User.current.becomes(ManagerUser) } },
+    #       updated_by: { class_name: "::ManagerUser", value: -> { User.current.becomes(ManagerUser) } },
+    #     }
+    #   )
+    #
+    # @param options [Hash<Symbol,(Hash, Boolean)>] options hash
+    def track_audit_data(**options)
+      ::AuditTracker.apply(self, **options)
+    end
+  end
+end

data/lib/audit_tracker/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AuditTracker
+  # Auto injects the ::AuditTracker::ModelHelper into ActiveRecord classes
+  #
+  class Railtie < Rails::Railtie
+    railtie_name :audit_tracker
+
+    initializer "audit_tracker.initialize_model_helper" do
+      ActiveSupport.on_load(:active_record) do
+        extend ::AuditTracker::ModelHelper
+      end
+    end
+  end
+end

data/lib/audit_tracker/tracker.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module AuditTracker
+  #
+  # ::AuditTracker::Tracker represents the tracker and is responsible
+  # for setting up the models to be tracked
+  #
+  # I.e.:
+  #
+  #   tracker = Tracker.new(
+  #     create: [:created_by, class_name: "User", foreign_key: "created_by_id"]),
+  #     update: [:updated_by, class_name: "User", foreign_key: "updated_by_id"]),
+  #     value: -> { User.current }
+  #   )
+  #   tracker.apply(MyTrackedModel)
+  #
+  # After applying, if MyTrackedModel represents a table that contains the
+  # necessary foreign keys, the relationships (`created_by` and `updated_by`)
+  # and callbacks (before create / update) will be added to it.
+  #
+  # ::AuditTracker::Tracker is the core of AuditTracker, and a collection of trackers
+  # is built into AuditTracker.trackers via AuditTracker.setup.
+  #
+  class Tracker
+    def initialize(on:, value:)
+      @on = on
+      @value = value
+
+      super()
+    end
+
+    def apply(model, overrides)
+      @on.each do |event, relation, options|
+        options = options.merge(overrides[relation] || {})
+        apply_relation(model, relation, options, event)
+      end
+    end
+
+  private
+
+    def apply_relation(model, relation, options, event)
+      return unless table_exists?(model)
+      return unless foreign_key_exist?(model, relation, **options)
+
+      value = options.delete(:value) || @value
+
+      model.belongs_to(relation, **options) unless relation_exist?(model, relation)
+      model.set_callback event, :before, Callback.new(value, relation, event)
+    end
+
+    def relation_exist?(model, relation)
+      model.reflect_on_association(relation).present?
+    end
+
+    def foreign_key_exist?(model, relation, foreign_key: nil, **)
+      raise ArgumentError, "foreign_key is not set for #{relation}" unless foreign_key
+
+      model.column_names.include?(foreign_key.to_s)
+    end
+
+    def table_exists?(model)
+      model.table_exists?
+    rescue
+      false
+    end
+
+    # :nodoc:
+    class Callback
+      def initialize(value_fn, relation, event)
+        @value = value_fn
+        @relation = relation
+        @event = event
+      end
+
+      def respond_to_missing?(method)
+        method.to_s.eql?("before_#{@event}")
+      end
+
+      def method_missing(method, ...)
+        if respond_to_missing?(method)
+          call(...)
+        else
+          super
+        end
+      end
+
+    private
+
+      def call(record)
+        association = record.association(@relation)
+        return if record.attribute_changed?(association.reflection.foreign_key)
+
+        association.writer(@value.call(record))
+      end
+    end
+  end
+end

data/lib/audit_tracker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AuditTracker
+  VERSION = "0.1.0"
+end

data/lib/audit_tracker.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "audit_tracker/dsl"
+require_relative "audit_tracker/model_helper"
+require_relative "audit_tracker/railtie" if defined?(Rails)
+require_relative "audit_tracker/tracker"
+require_relative "audit_tracker/version"
+
+# AuditTracker helps you centralize data tracking configuration to be used accross
+# different models
+module AuditTracker
+  # Trackers setup in AuditTracker
+  #
+  # @return [Hash<Symbol,::AuditTracker::Tracker>]
+  #
+  def self.trackers
+    @trackers ||= {}
+  end
+
+  # Setup `AuditTracker::Tracker`'s
+  #
+  # setup entry point for data trackers. Multiple calls to this method are cumulative,
+  # and trackers with the same key override each other depending on load order.
+  #
+  # I.e.:
+  #
+  #   AuditTracker.setup do
+  #     tracker :user do
+  #       value { ::Internal::Current.user }
+  #       create :created_by, foreign_key: :created_by_id, class_name: "::Internal::User"
+  #       update :updated_by, foreign_key: :updated_by_id, class_name: "::Internal::User"
+  #     end
+  #     tracker :user_department do
+  #       value { ::Internal::Current.user&.department }
+  #       create(
+  #         :created_by_department,
+  #         foreign_key: :created_by_department_id,
+  #         class_name: "::Internal::Department"
+  #       )
+  #       update(
+  #         :updated_by_department,
+  #         foreign_key: :updated_by_department_id,
+  #         class_name: "::Internal::Department"
+  #       )
+  #     end
+  #   end
+  #
+  # Trackers will track a specific value, so the `value`` is always required to be defined.
+  # Each line after that define a different event. `create` and `update` are helper methods
+  # to create events.
+  #
+  # `update` is tied to the `:save` event of activerecord. That means that the value will be
+  # tracked before create and before update.
+  #
+  # Each event defined will generate an active record relation, and will update that relation
+  # before the event (i.e.: `before_update`, `before_create`).
+  #
+  def self.setup(&block)
+    ::AuditTracker::DSL.build(&block)
+  end
+
+  # Enables the given trackers in the given model
+  #
+  # I.e.:
+  #
+  #  The following would create two trackers (user and user_department), but only apply the
+  #  former to Lead:
+  #
+  #  AuditTracker.setup do
+  #    tracker(:user) do
+  #      update :updated_by, foreign_key: "updated_by_id", class_name: "::User"
+  #      value { User.current }
+  #    end
+  #    tracker(:user_department) do
+  #      update :updated_by_department, foreign_key: "updated_by_department_id", class_name: "::Department"
+  #      value { User.current&.department }
+  #    end
+  #  end
+  #
+  #  AuditTracker.apply(::Lead, user: true)
+  #
+  # @param model [ActiveRecord::Base] any activerecord model
+  # @param options [Hash<Symbol,(Hash,Boolean)>] tracking options
+  # @see ::AuditTracker::ModelHelper
+  def self.apply(model, options)
+    @trackers.each do |key, tracker|
+      next unless options[key]
+
+      tracker.apply(model, options[key] == true ? {} : options[key])
+    end
+  end
+end

data/mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: Audit Tracker
+nav:
+  - "Home": "README.md"
+  - "Changelog": "CHANGELOG.md"
+plugins:
+  - techdocs-core

data/sig/audit_tracker.rbs

@@ -0,0 +1,4 @@
+module AuditTracker
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: audit_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlos Palhares
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: AuditTracker helps you centralize data tracking configuration to be used
+  across different models
+email:
+- chjunior@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".standard.yml"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- audit_tracker.gemspec
+- config.ru
+- doc/dependency_decisions.yml
+- docs/CHANGELOG.md
+- docs/README.md
+- lib/audit_tracker.rb
+- lib/audit_tracker/dsl.rb
+- lib/audit_tracker/model_helper.rb
+- lib/audit_tracker/railtie.rb
+- lib/audit_tracker/tracker.rb
+- lib/audit_tracker/version.rb
+- mkdocs.yml
+- sig/audit_tracker.rbs
+homepage: https://github.com/powerhome/power-tools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/powerhome/power-tools
+  source_code_uri: https://github.com/powerhome/power-tools
+  changelog_uri: https://github.com/powerhome/power-tools/blob/main/packages/audit_tracker/docs/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: AuditTracker helps you centralize data tracking configuration to be used
+  across different models
+test_files: []