loggable_activity 0.1.48 → 0.1.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3e20a374ac054a343ce5ff1c35c5fcce765fb631788fb6d9b738e52161a16a
-  data.tar.gz: 042cc1db90cf6b99eeb2c8d5ab3f16a5473178c00085f42400c4eec344a99731
+  metadata.gz: 562b5492910176c8bc5816b7f5691ae386c015d1a969b71a33c45f708383c185
+  data.tar.gz: 577534f63904b76ac414d1dba76aac35725892b127a3f268de650eeb4ed4629e
 SHA512:
-  metadata.gz: 1f4063eb4cd98a16061d151759735e0b5cc98e7747151dc2c56856f2010f23936c2c338991c5cc85dfd3c72af4f60133a4e39271f29ec76e5ee04383ad6dd073
-  data.tar.gz: 8be57a52cfd948825e273648ffaec5809975dc14863f49206ee8f364f07b58a193758d80d867155f21760522a24bc2cf49d183ba757c503af1fdf51317b78202
+  metadata.gz: 631979df293ae2f1e03125b0a900c7eb432a59f163b0ab1c3a2c7e559d5e9e75f33e7fb0f686fece6f80888264f5b703719bfe7c2d6069a2a49512424414d913
+  data.tar.gz: 749dd6e36b9017f5c6b92572b1a9bf47e4c0e8fbe418d0d38e6ab0cd51553ccd64fa92f286ed45bc9e39d7a4dab2e5d74517093da6772578b82044379f53048d

data/.rubocop.yml

@@ -1,13 +1,16 @@
 AllCops:
-  # TargetRubyVersion: '3.0.1'
+  TargetRubyVersion: '3.2.0'
   NewCops: enable
   Exclude:
     - 'db/schema.rb'
-    - 'vendor/**/*'
+    # - 'vendor/**/*'
 
 Style/Documentation:
   Enabled: false
 
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
 Layout/LineLength:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
-- nothing so far
+## [0.1.51] - 2024-02-18
+- Added RSpec test
+- Added rubocop
+
+## [0.1.49] - 2024-02-18
+- Metadata, pointing to homepage 
 
 ## [0.1.48] - 2024-02-16
 ### Breaking change
@@ -7,14 +11,19 @@
 - Updated README.md
 - Updated GETTING_STARTED.md
 - Added PULL_REQUEST_TEMPLATE.md
+
 ## [0.1.46] - 2024-02-16
 - Fixed spelling error in EncryptionKey 
+
 ## [0.1.43] - 2024-02-15
 - Updated README.md and GETTING-STARTED.md 
+
 ## [0.1.39] - 2024-02-12
 - Updated README.md and GETTING-STARTED.md 
+
 ## [0.1.38] - 2024-02-12
 - Removed dependency on awesome print
+
 ## [0.1.35] - 2024-02-11
 - Initial release
 

data/GETTING-STARTED.md

@@ -8,77 +8,95 @@ This document should you getting started with `LoggableActivity`
 ## Demo Application
 You can download a demo application from<br/>
 [https://github.com/maxgronlund/LoggableActivityDemoApp](https://github.com/maxgronlund/LoggableActivityDemoApp)
+<br/>
+You can try a demo here<br/>
+[https://loggableactivity-efe7b931c886.herokuapp.com/](https://loggableactivity-efe7b931c886.herokuapp.com/)
+
+## Getting started
+First we add the loggable_activity gem to the Gemfile `gem 'loggable_activity', '~> x.x.xx'` and then `$ bundle install`<br/>
+Then we have to generate some migrations and additionals files<br/>
+`rails generate loggable_activity:install Activity`<br/>
 
 ## Configuration
-First you have to create a configuration file named `loggable_activity.yml` and locate it in the config folder.<br/>
-It has the following tags
-- `User` (example)<br>
-This is the name of the model you are configuring, as you can see there is alos a `Demo::Address` in the configuration file below, So if you have a model named `Demo::Club` you have to create at tag for that and fill in the other tags under that.
-- record_display_name: <br>
-Used to display something human to identify a given log entry, in this example the  **User** model has a method named `full_name`
-
-- loggable_attrs:<br/>
-This are the attributes on a model and reflect the fields in  the database you HAS to define, what fields to log.
-
-- auto_log:<br/>
-This are the actions that will be logged automatically, although you can log manually at any time.
-Note there is no hook for `Show` in Rails so you would have to log that manually like this `log(:show)`, more about that later.
-
-- relations:<br/>
-If a model has `belongs_to` and `has_one` relations you can log them automatically as well<br>
-<br/>
-*Example confuguration for logging of the user model*
+You need a configuration file inside the `config/loggable_activity.yaml`
+This file defines:
+- What tables to log
+- What fields in a table to log
+- How data is aggregated.
+- What should happen to the aggregation if a record is deleted.
+- What actions to log.
+
+*Here is an example*
 ```
-User: 
-  record_display_name: full_name
+Demo::Club: 
+  record_display_name: name 
   loggable_attrs: 
-    - first_name
-    - last_name 
+    - name
   auto_log:
     - create
     - update
     - destroy
   relations:
-    - belongs_to: :demo_address
+    - belongs_to: :address
       model: Demo::Address
       loggable_attrs:
         - street
         - city
-Demo::Address: 
-  record_display_name: full_address
-  actor_display_name: email
-  loggable_attrs:
-    - street
-    - city
-    - country
-    - postal_code
 ```
-Then you HAVE TO to add `LogggableActivity::Hooks` to the `User Model` like this
+
+Lets break this down.
+- First we can se that we are logging a model named Demo::Club.
+- `record_display_name:` is the field/method on the on the model we want to display as a headline in the log
+- Then we can se that we are logging the **name** of the club, in this example that's all there is to log.
+- Then we can se that we are **logging create, update, and destroy** automatically.
+- Then there are some relations: that we want to collect and add to the log, in this example we are logging the address as well.
+
+Next we have to include some hooks to the model we want to log.
 
 ```
 class User < ApplicationRecord
   include LoggableActivity::Hooks
-  ...
 ```
 
-And finally you have to add this to the `ApplicationController`
+And then we have to add a this to the application_controller.rb
 ```
 class ApplicationController < ActionController::Base
   include LoggableActivity::CurrentUser
 ```
+This will give us access to the current_user.
 
-Now if you create a model like this:
+And then we have to add this to `config/application.rb`
 ```
-$ rails c
-$ User.create(first_name: 'John', last_name: 'Doe')
+  config.loggable_activity = ActiveSupport::OrderedOptions.new
+  config.loggable_activity.actor_display_name = :full_name
+  config.loggable_activity.current_user_model_name = 'User'
+  LoggableActivity::Configuration.load_config_file('config/loggable_activity.yaml')
 ```
+actor_display_name: this is a method on the User model we want to use when presenting the actor.
+current_user_model: This is the name of the model we use for current_user
+load_config_file: this is the configuration file from above.
+
+
+Then you HAVE TO to add `LogggableActivity::Hooks` to the `User Model` like this
 
-Then an `LoggableActivity::Activity` is created. You can inspect it from the terminal like this.
 ```
-puts activity = Loggable::Activity.last
-puts activity.attrs
+class User < ApplicationRecord
+  include LoggableActivity::Hooks
+  ...
+  resto of your code here.
+
+```
+
+
+### Log the show action
+If you want to log the show action you can add this to your controllers show method
+```
+def show
+  @user.log(:show)
 ```
 
+
+
 ## For developers
 If you want to contribute to the development and try it out in the process
 - 1 Down the demo project from [demo project on github](https://github.com/maxgronlund/LoggableActivityDemoApp)

data/README.md

@@ -20,14 +20,14 @@ Most organizations needs to keep a log of how users interact with data stored in
 
 *Super simplified example from the healthcare.*
 - Each patient has a journal, that is updated on a regular basis.
-- Supervisor needs to follow the journal, how was it updated, who read it.
+- Supervisor needs to follow the journal, how was it updated, who read it, did it get deleted.
 - Security personnel needs to know how the journal is handled, who did what when.
-- Patients has the right to know how their journal is handled and that the log is deleted.
+- Patients has the right to know how their journal is handled and that their data will be removed when required.
 
 Beside the journal in the db, an activity log is kept so it is possible to track how the journal is used.<br/>
 At some point in time the patients data from the DB and the activity log has to be removed according to GDPR.<br/>
 
-
+### Contribute
 👉 Join the Slack channel here: [LoggableActivity Slack Workspace](https://join.slack.com/t/loggableactivity/shared_invite/zt-2a3tvgv37-mGwjHJTrBXBH2srXFRRSXQ)
 <br/>
 👉 Want to play around with an online version: [Show Demo](https://loggableactivity-efe7b931c886.herokuapp.com/)
@@ -35,3 +35,6 @@ At some point in time the patients data from the DB and the activity log has to
 We value each contribution and believe in the power of community. Looking forward to seeing you there!
 
 
+### Test
+We embrace the philosophy of black-box testing, where we focus on the input and output of the public interface without worrying about internal implementation details.<br/>
+This approach aligns with the principle of testing behavior rather than implementation.

data/lib/generators/loggable_activity/install_generator.rb

@@ -25,6 +25,7 @@ module LoggableActivity
         template 'loggable_activity.en.yml', 'config/locales/loggable_activity.en.yml'
         template 'loggable_activity.yml', 'config/loggable_activity.yml'
         template 'current_user.rb', 'app/controllers/concerns/loggable_activity/current_user.rb'
+        # template 'loggable_activity_helper.rb', 'app/helpers/loggable_activity_helper.rb'
       end
     end
   end

data/lib/generators/loggable_activity/templates/loggable_activity_helper.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module LoggableActivityHelper
+  include ApplicationHelper
+
+  def render_activity(activity)
+    render partial: template_path(activity), locals: { activity: }
+  end
+
+  def primary_type(activity)
+    I18n.t("loggable.activity.models.#{activity.record_type}")
+  end
+
+  def relation_type(relation_attrs)
+    I18n.t("loggable.activity.models.#{relation_attrs[:record_class]}")
+  end
+
+  def update_relation_class(update_attrs)
+    I18n.t("loggable.activity.models.#{update_attrs[:record_class]}")
+  end
+
+  private
+
+  def action_template_path(activity)
+    "loggable_activity/templates/#{activity.action.gsub('.', '/')}"
+  end
+
+  def template_path(activity)
+    template_path = action_template_path(activity)
+    if lookup_context.template_exists?(template_path, [], true)
+      template_path
+    else
+      action = activity.action.split('.').last || 'default'
+      "loggable_activity/templates/default/#{action}"
+    end
+  end
+
+  def activity_payload(activity)
+    @activity_payload ||= build_payload(activity)
+  end
+
+  def activity_attrs(activity)
+    @activity_attrs ||= activity_payload(activity).fetch(:activity, {})
+  end
+
+  def build_payload(activity)
+    Loggable::JsonPayloadFactory.new(activity).build_payload
+  end
+end

data/lib/loggable_activity/activity.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_record'
+
 module LoggableActivity
   # Represents one action in the activity log.
   class Activity < ActiveRecord::Base
@@ -224,6 +226,13 @@ module LoggableActivity
         .limit(limit)
     end
 
+    # Returns the last activity.
+    def self.last(limit = 1)
+      return latest(1).first if limit == 1
+
+      latest(limit)
+    end
+
     private
 
     def update_attrs

data/lib/loggable_activity/encryption_key.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_record'
+
 module LoggableActivity
   # This class represents the encryption key used to unlock the data for one payload.
   # When deleted, only the encryption_key field is deleted.

data/lib/loggable_activity/hooks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+
 # This is the main module for loggable.
 # When included to a model, it provides the features for creating the activities.
 require 'loggable_activity/payloads_builder'

data/lib/loggable_activity/payload.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_record'
+
 module LoggableActivity
   # This class represents a payload in the log, containing encrypted data of one record in the database.
   # When the record is deleted, the encryption key for the payload is also deleted.

data/lib/loggable_activity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoggableActivity
-  VERSION = '0.1.48'
+  VERSION = '0.1.51'
 end

data/lib/loggable_activity.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# require 'rails'
-
+require_relative 'loggable_activity/version'
 require_relative 'loggable_activity/activity'
 require_relative 'loggable_activity/configuration'
 require_relative 'loggable_activity/encryption'
@@ -10,7 +9,6 @@ require_relative 'loggable_activity/hooks'
 require_relative 'loggable_activity/payload'
 require_relative 'loggable_activity/payloads_builder'
 require_relative 'loggable_activity/update_payloads_builder'
-require_relative 'loggable_activity/version'
 
 module LoggableActivity
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.48
+  version: 0.1.51
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,102 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.1.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.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
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.6
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.60.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.60.2
 description: |2
       LoggableActivity is a powerful gem for Ruby on Rails that provides seamless user activity logging
       prepared for GDPR compliance and supporting record relations. It allows you to effortlessly
@@ -116,6 +212,7 @@ files:
 - lib/generators/loggable_activity/templates/current_user.rb
 - lib/generators/loggable_activity/templates/loggable_activity.en.yml
 - lib/generators/loggable_activity/templates/loggable_activity.yml
+- lib/generators/loggable_activity/templates/loggable_activity_helper.rb
 - lib/loggable_activity.rb
 - lib/loggable_activity/.DS_Store
 - lib/loggable_activity/activity.rb
@@ -133,6 +230,9 @@ homepage: https://loggableactivity-efe7b931c886.herokuapp.com/
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://loggableactivity-efe7b931c886.herokuapp.com/
+  source_code_uri: https://github.com/maxgronlund/LoggableActivity
+  changelog_uri: https://github.com/maxgronlund/LoggableActivity/CHANGELOG.md
   documentation_uri: https://maxgronlund.github.io/LoggableActivity/
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -143,7 +243,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="