active_record-journal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb7f127b6cc57ca305e8e13e28a5b5d8ef5da514bdc113ccdbb30c6cc58e108f
+  data.tar.gz: 7be419a842b986060aac1fd321022cdfed43492884db515a6118714965b31e4d
+SHA512:
+  metadata.gz: b60babffefb711f427078a97b4461600abc897a90dadb2959f0347744ed6ddb89b97aa6e61d4356f1f78505e323a0d1f0f1186c1d61a46a1c4b3240c33c78c49
+  data.tar.gz: ec58d2399d9445e229c615c499e028426da11b5946a3c2f63d3436bcadd3f857e32a1539f1389e00fbe7ea9b53406d872fc156ed37f17f87e21de743a436498d

data/.circleci/config.yml

@@ -0,0 +1,122 @@
+# Use the latest 2.1 version of CircleCI pipeline process engine.
+# See: https://circleci.com/docs/2.0/configuration-reference
+version: 2.1
+
+executors:
+  gem:
+    docker:
+      - image: cimg/ruby:2.7.0
+        auth:
+          username: $DOCKERHUB_ACCESS_USER
+          password: $DOCKERHUB_ACCESS_TOKEN
+        environment:
+          RAILS_ENV: test
+          RAILS_RELATIVE_URL_ROOT: '/home/circleci/project'
+  postgresql:
+    docker:
+      - image: cimg/ruby:2.7.0
+        auth:
+          username: $DOCKERHUB_ACCESS_USER
+          password: $DOCKERHUB_ACCESS_TOKEN
+        environment:
+          RAILS_ENV: test
+          POSTGRES_HOST_NAME: localhost
+          POSTGRES_USER: $POSTGRES_USER
+          POSTGRES_DB: $POSTGRES_DB
+          POSTGRES_PASSWORD: $POSTGRES_PASSWORD
+          RAILS_RELATIVE_URL_ROOT: '/home/circleci/project'
+      - image: cimg/postgres:14.0
+        auth:
+          username: $DOCKERHUB_ACCESS_USER
+          password: $DOCKERHUB_ACCESS_TOKEN
+        environment:
+          POSTGRES_DB: $POSTGRES_DB
+          POSTGRES_PASSWORD: $POSTGRES_PASSWORD
+
+commands:
+  dependencies:
+    steps:
+      - checkout
+      - run: sudo apt-get update
+      - run:
+          name: Install system dependencies
+          command: sudo apt install -y libpq-dev sqlite3 libsqlite3-dev
+      - run:
+          name: Install gem dependencies
+          command: bundle install
+      - run: chmod +x bin/setup
+      - run: ./bin/setup
+  rubocop:
+    steps:
+      - run:
+          name: Rubocop
+          command: bundle exec rubocop
+  rspec:
+    steps:
+      - run:
+          name: Run Specs
+          command: bundle exec rspec
+      - persist_to_workspace:
+          root: coverage
+          paths:
+            - .last_run.json
+  simplecov:
+    steps:
+      - attach_workspace:
+          at: coverage
+      - run: chmod +x bin/coverage
+      - run: ./bin/coverage
+
+jobs:
+  build:
+    description: 'Build gem dependencies'
+    executor: gem
+    steps:
+      - dependencies
+  linter:
+    description: 'Rubocop'
+    executor: gem
+    steps:
+      - dependencies
+      - rubocop
+  specs:
+    description: 'Run specs'
+    parameters:
+      db:
+        type: string
+      executor:
+        type: string
+    executor: << parameters.executor >>
+    steps:
+      - dependencies
+      - rspec
+    environment:
+      DB_CONFIG: << parameters.db >>
+  coverage:
+    executor: gem
+    steps:
+      - dependencies
+      - simplecov
+
+workflows:
+  integration-workflow:
+    jobs:
+      - build
+      - linter:
+          requires:
+            - build
+      - specs:
+          name: postgres-specs
+          db: postgresql
+          executor: postgresql
+          requires:
+            - build
+      - specs:
+          name: sqlite-specs
+          db: sqlite
+          executor: gem
+          requires:
+            - build
+      - coverage:
+          requires:
+            - sqlite-specs

data/.env

@@ -0,0 +1,6 @@
+POSTGRES_HOST_NAME=pg
+POSTGRES_USER=journal
+POSTGRES_DB=journal
+POSTGRES_HOST_AUTH_METHOD=trust
+RAILS_ENV=test
+RAILS_RELATIVE_URL_ROOT=/active_record-journal

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,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Lint/UnreachableCode:
+  Exclude:
+    - spec/**/*.rb
+
+Style/Documentation:
+  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 nika.kirosh@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.7
+RUN apt-get update
+RUN apt-get install sqlite3
+RUN gem install bundler --no-document
+
+WORKDIR /active_record-journal
+COPY . /active_record-journal
+RUN bundle install
+
+ENTRYPOINT ["bash"]

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_record-journal.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    active_record-journal (0.1.0)
+      activerecord (>= 6.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.2.2)
+      actionview (= 7.0.2.2)
+      activesupport (= 7.0.2.2)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.2.2)
+      activesupport (= 7.0.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.2.2)
+      activesupport (= 7.0.2.2)
+    activerecord (7.0.2.2)
+      activemodel (= 7.0.2.2)
+      activesupport (= 7.0.2.2)
+    activesupport (7.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.10.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.14.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nokogiri (1.13.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pg (1.3.3)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    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.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.2)
+      actionpack (= 7.0.2.2)
+      activesupport (= 7.0.2.2)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.0.3)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (1.4.2)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  active_record-journal!
+  bundler
+  pg
+  pry
+  rake (~> 13.0)
+  rspec-rails (~> 5.0.1)
+  rubocop
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   2.3.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 mkiroshdz
+
+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,161 @@
+[![CircleCI](https://circleci.com/gh/mkiroshdz/active_record-journal/tree/main.svg?style=svg)](https://circleci.com/gh/mkiroshdz/active_record-journal/tree/main)
+
+# ActiveRecord::Journal
+
+ActiveRecord::Journal allows you to keep track of the CRUDs on your ActiveRecord models and tag them with the data of your choice (the user or job that triggered the actions, description, ...).
+
+## Getting started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-journal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record-journal
+
+
+## Setup
+
+### Initialization
+
+```ruby
+  ActiveRecord::Journal.configuration.entries_class = 'BookChangeLog'
+  ActiveRecord::Journal.configuration.tags_class = 'BookChangeTag'
+  ActiveRecord::Journal.configuration.autorecording_enabled = true
+```
+
+### Logs
+
+You need to define the models that will persist the records and tags of the CRUDs.
+
+```ruby
+  class BookChangeLog < ActiveRecord::Base; end
+  class BookChangeTag < ActiveRecord::Base; end
+```
+
+The minimun attributes required for the models are shown in this schema: 
+
+```ruby
+  create_table :book_change_logs do |t| # Table for the records
+    # t.string :changes_map 
+    t.jsonb :changes_map
+    t.string :action
+    t.string :journable_type
+    t.integer :journable_id
+    t.string :journal_tag_type
+    t.integer :journal_tag_id
+    t.datetime :created_at
+  end
+
+  create_table :book_change_tags do |t| # Table for the tags
+    t.string :journable_type
+    t.integer :journable_id
+    t.datetime :created_at
+  end
+```
+
+Note: The gem assumes that the `BookChangeLog#changes_map=` receives a hash and the logic to handle the serialization will be handled by the model regardless of the type of changes_map in the database.
+
+### Extend ActiveRecord::Base
+
+This will provide the required methods to enable tracking in the models.
+
+```ruby
+  class RecordWithLogs < ActiveRecord::Base
+    self.abstract_class = true
+    extend ActiveRecord::Journal::Journable
+  end
+```
+
+### Model tracking
+
+You can use the methods `ActiveRecord::Journal::Journable::journal_writes` and `ActiveRecord::Journal::Journable::journal_reads` to define a set of rules that tell your model how to keep track of the records. Every time a CRUD is triggered all the rules defined are checked and executed if the necessary conditions are met.
+
+```ruby
+  class Author < RecordWithLogs   
+    journal_writes on: %i[create]
+    journal_writes on: %i[update], only: %i[name last_name]
+  end
+
+  class Book < RecordWithLogs    
+    belongs_to :author
+    journal_reads unless: :best_seller?
+    journal_reads entries_class: CustomBookChangeLog, tag_class: BookChangeTag, if: :best_seller?
+    journal_writes
+  end
+```
+
+## Usage
+
+### Tag operations
+
+You can create and associate a tag to a group of CRUDS.
+
+```ruby
+  ActiveRecord::Journal.tag(user: current_user, description: 'Create book') do |tag|
+    tag.actions do
+      author = Author.find_by(id: params[:author_id])
+      Book.create!(title: params[:title], author: author)
+    end
+  end
+```
+
+### Ignore operations
+
+Can ignore actions originally configured to be tracked.
+
+```ruby
+  ActiveRecord::Journal.ignore do |context|
+    context.actions do
+      author = Author.find_by(id: params[:author_id])
+      Book.create!(title: params[:title], author: author)
+    end
+  end
+```
+
+### One time constraints
+
+```ruby
+  ActiveRecord::Journal.tag(user: current_user) do |tag|
+    tag.record(Book, if: ->(record) { record.author.present? })
+    tag.actions do
+      author = Author.find_by(id: params[:author_id])
+      Book.create!(title: params[:title], author: author)
+    end
+  end
+
+  ActiveRecord::Journal.context do |context|
+    context.record(Book, unless: ->(record) { record.author.present? })
+    context.actions do
+      author = Author.find_by(id: params[:author_id])
+      Book.create!(title: params[:title], author: author)
+    end
+  end
+```
+
+## Development
+
+### Setup
+
+After checking out the repo, you can build the required containers by running `docker-compose build` and execute them with `docker-compose run gem`.
+
+To install this gem onto your local, run `bundle exec rake install`. 
+
+### Tests
+
+Inside the container, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mkiroshdz/active_record-journal.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/active_record-journal.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/journal/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record-journal'
+  spec.version       = ActiveRecord::Journal::VERSION
+  spec.authors       = ['mkiroshdz']
+  spec.email         = ['mkirosh@hey.com']
+
+  spec.summary       = 'A gem to track changes on active record models'
+  spec.description   = 'A gem to track changes on active record models'
+  spec.homepage      = 'https://github.com/mkiroshdz/active_record-journal'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/mkiroshdz/active_record-journal'
+    spec.metadata['changelog_uri'] = 'https://github.com/mkiroshdz/active_record-journal/blob/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  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.required_ruby_version = '>= 2.5'
+
+  spec.add_dependency 'activerecord', '>= 6.0.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0.1'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
+end
+# rubocop:enable Metrics/BlockLength

data/bin/coverage

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.root((ENV['RAILS_RELATIVE_URL_ROOT']).to_s)
+result = SimpleCov::LastRun.read[:result].values.min
+threshold = ENV['SPEC_COVERAGE_THRESHOLD']&.to_i
+result >= threshold ? exit(true) : exit(false)

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/docker-compose.yml

@@ -0,0 +1,28 @@
+version: '3'
+
+services:
+  db:
+    image: 'postgres'
+    environment:
+      - POSTGRES_USER=${POSTGRES_USER}
+      - POSTGRES_HOST_AUTH_METHOD=${POSTGRES_HOST_AUTH_METHOD}
+      - POSTGRES_DB=${POSTGRES_DB}
+    networks:
+      - gembrg
+  gem:
+    build: .
+    environment:
+      - RAILS_ENV=${RAILS_ENV}
+      - RAILS_RELATIVE_URL_ROOT=${RAILS_RELATIVE_URL_ROOT}
+      - POSTGRES_HOST_NAME=${POSTGRES_HOST_NAME}
+      - POSTGRES_DB=${POSTGRES_DB}
+      - POSTGRES_USER=${POSTGRES_USER}
+    networks:
+      - gembrg
+    links:
+      - db:pg
+    volumes:
+      - .:/active_record-journal
+
+networks:
+  gembrg: