loggable_activity 0.1.49 → 0.1.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3a71b62ddccb997e31e0592a4069f3c1684043fe5dee77691801930ebd86a43
-  data.tar.gz: 7b8cf906c1357bbc2e90172020de8ab712132ba43de3a53fc0d4058cfa391bd8
+  metadata.gz: 562b5492910176c8bc5816b7f5691ae386c015d1a969b71a33c45f708383c185
+  data.tar.gz: 577534f63904b76ac414d1dba76aac35725892b127a3f268de650eeb4ed4629e
 SHA512:
-  metadata.gz: a951d551a83e4cab2c58ec1b6a3b00c1814ecd099bdf38682d024a99298417912f6efcaf1c1d625f8ee4f877ac60f7ab851cc9a00b2c7201fb9fba2cf1e093b1
-  data.tar.gz: 4821fd58720ad28bd77d7f958f0c1ce39de246503b93a4027097fa61c3b5f4b4e3ca3f673f37271205a121717905f3dbb12337ad3193e40fe12f6098f69667ec
+  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,7 +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 hompage 
+- Metadata, pointing to homepage 
 
 ## [0.1.48] - 2024-02-16
 ### Breaking change

data/GETTING-STARTED.md

@@ -65,7 +65,7 @@ class ApplicationController < ActionController::Base
 ```
 This will give us access to the current_user.
 
-And then we have to add this to 'config/application.rb'
+And then we have to add this to `config/application.rb`
 ```
   config.loggable_activity = ActiveSupport::OrderedOptions.new
   config.loggable_activity.actor_display_name = :full_name
@@ -77,59 +77,26 @@ 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.
 
 
-## Configuration
-
-```
-User: 
-  record_display_name: full_name
-  loggable_attrs: 
-    - first_name
-    - last_name 
-  auto_log:
-    - create
-    - update
-    - destroy
-  relations:
-    - belongs_to: :demo_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
 
 ```
 class User < ApplicationRecord
   include LoggableActivity::Hooks
   ...
-```
+  resto of your code here.
 
-And finally you have to add this to the `ApplicationController`
-```
-class ApplicationController < ActionController::Base
-  include LoggableActivity::CurrentUser
 ```
 
-Now if you create a model like this:
-```
-$ rails c
-$ User.create(first_name: 'John', last_name: 'Doe')
-```
 
-Then an `LoggableActivity::Activity` is created. You can inspect it from the terminal like this.
+### Log the show action
+If you want to log the show action you can add this to your controllers show method
 ```
-puts activity = Loggable::Activity.last
-puts activity.attrs
+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/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.49'
+  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.49
+  version: 0.1.51
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-18 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
@@ -147,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:
   - - ">="