active_record-journal 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb7f127b6cc57ca305e8e13e28a5b5d8ef5da514bdc113ccdbb30c6cc58e108f
-  data.tar.gz: 7be419a842b986060aac1fd321022cdfed43492884db515a6118714965b31e4d
+  metadata.gz: b021661495e48089865f294b07b27a8c2916328e26df0449bbdf44ee23e1004b
+  data.tar.gz: d2803f703867441b96bba2ce74a69125984ab12b1d751e75df6572b18651dd20
 SHA512:
-  metadata.gz: b60babffefb711f427078a97b4461600abc897a90dadb2959f0347744ed6ddb89b97aa6e61d4356f1f78505e323a0d1f0f1186c1d61a46a1c4b3240c33c78c49
-  data.tar.gz: ec58d2399d9445e229c615c499e028426da11b5946a3c2f63d3436bcadd3f857e32a1539f1389e00fbe7ea9b53406d872fc156ed37f17f87e21de743a436498d
+  metadata.gz: 174691c8f5d8cf85d2c7437f27b57fa1d3d4e833b8eb8e6d6008d7deb61b297eef6c81afecfaa0c46132d9d540d3f6f08d4d407b9706b29904f93097daae0a31
+  data.tar.gz: 81a0339f9a81796b3365e1ffb166d27d4a3cf751e06ee1b559eff1733f38d4b2b443b20e7785f9896a4da665902cc313100cfb8bb317ba091481b5f824d6cd3d

data/.circleci/config.yml

@@ -46,11 +46,6 @@ commands:
           command: bundle install
       - run: chmod +x bin/setup
       - run: ./bin/setup
-  rubocop:
-    steps:
-      - run:
-          name: Rubocop
-          command: bundle exec rubocop
   rspec:
     steps:
       - run:
@@ -73,12 +68,6 @@ jobs:
     executor: gem
     steps:
       - dependencies
-  linter:
-    description: 'Rubocop'
-    executor: gem
-    steps:
-      - dependencies
-      - rubocop
   specs:
     description: 'Run specs'
     parameters:
@@ -102,9 +91,6 @@ workflows:
   integration-workflow:
     jobs:
       - build
-      - linter:
-          requires:
-            - build
       - specs:
           name: postgres-specs
           db: postgresql

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## \[Unreleased\]
+
+## \[[0.1.1](https://github.com/mkiroshdz/active_record-journal/compare/v0.1.0...v0.1.1)\] - 2022-03-11
+### Fixed
+- [#14](https://github.com/mkiroshdz/active_record-journal/pull/14) Prevents tracking of rails timestamps attributes.
+- [#15](https://github.com/mkiroshdz/active_record-journal/pull/15) Allow exceptions to bubble up in order to be handled properly.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_record-journal (0.1.0)
+    active_record-journal (0.1.1)
       activerecord (>= 6.0.0)
 
 GEM
@@ -131,4 +131,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.3.8
+   2.3.9

data/README.md

@@ -1,7 +1,9 @@
-[![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
 
+[![CircleCI](https://circleci.com/gh/mkiroshdz/active_record-journal/tree/main.svg?style=svg)](https://circleci.com/gh/mkiroshdz/active_record-journal/tree/main)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3654af1924a941acb437adb133824ace)](https://www.codacy.com/gh/mkiroshdz/active_record-journal/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mkiroshdz/active_record-journal&utm_campaign=Badge_Grade)
+[![Gem Version](https://badge.fury.io/rb/active_record-journal.svg)](https://badge.fury.io/rb/active_record-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
@@ -20,125 +22,9 @@ 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
-```
+Check the [wiki](https://github.com/mkiroshdz/active_record-journal/wiki/Index) for usage and configurations.
 
 ## Development
 

data/lib/active_record/journal/journable/attributes.rb

@@ -27,7 +27,13 @@ module ActiveRecord
         end
 
         def default_ignored_keys
-          [model.primary_key, model.inheritance_column, model.locking_column].compact
+          [
+            model.primary_key,
+            model.inheritance_column,
+            model.locking_column,
+            'created_at',
+            'updated_at'
+          ].compact.map(&:to_s)
         end
       end
     end

data/lib/active_record/journal/journable/context.rb

@@ -52,6 +52,7 @@ module ActiveRecord
           ActiveRecord::Journal.context_override = nil
         rescue StandardError
           ActiveRecord::Journal.context_override = nil
+          raise
         end
 
         def ignore_actions

data/lib/active_record/journal/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Journal
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-journal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mkiroshdz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -148,7 +148,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- CODE_OF_CONDUCT.md
+- CHANGELOG.md
 - Dockerfile
 - Gemfile
 - Gemfile.lock

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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/