loggable_activity 0.2.1 → 0.5.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,87 +25,99 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 7.1.3
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: bootstrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 5.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 5.3.3
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.2
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.1.2
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.1
-  type: :development
+        version: 7.1.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 7.1.2
 - !ruby/object:Gem::Dependency
-  name: rspec-mocks
+  name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
-  type: :development
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +153,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.9.2
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -149,7 +161,7 @@ dependencies:
         version: '6.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.6
+        version: 6.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -159,7 +171,41 @@ dependencies:
         version: '6.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.6
+        version: 6.4.3
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -193,100 +239,68 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".document"
-- ".nojekyll"
-- ".rspec"
-- ".rspec_status"
 - ".rubocop.yml"
 - ".vscode/commands.json"
 - ".vscode/terminals.json"
 - CHANGELOG.md
+- CHEAT_SHEET.md
 - CODE_OF_CONDUCT.md
-- CONSIDERTIONS.md
-- GETTING-STARTED.md
-- LICENSE.txt
-- PAYLOAD_EXAMPLE.md
+- MIT-LICENSE
 - README.md
-- ROADMAP.md
 - Rakefile
-- docs/LoggableActivity.html
-- docs/LoggableActivity/Activity.html
-- docs/LoggableActivity/Configuration.html
-- docs/LoggableActivity/ConfigurationError.html
-- docs/LoggableActivity/DataOwner.html
-- docs/LoggableActivity/Encryption.html
-- docs/LoggableActivity/EncryptionError.html
-- docs/LoggableActivity/EncryptionKey.html
-- docs/LoggableActivity/Error.html
-- docs/LoggableActivity/Hooks.html
-- docs/LoggableActivity/Payload.html
-- docs/LoggableActivity/Services.html
-- docs/LoggableActivity/Services/BasePayloadsBuilder.html
-- docs/LoggableActivity/Services/DestroyPayloadsBuilder.html
-- docs/LoggableActivity/Services/PayloadsBuilder.html
-- docs/LoggableActivity/Services/UpdatePayloadsBuilder.html
-- docs/created.rid
-- docs/css/fonts.css
-- docs/css/rdoc.css
-- docs/fonts/Lato-Light.ttf
-- docs/fonts/Lato-LightItalic.ttf
-- docs/fonts/Lato-Regular.ttf
-- docs/fonts/Lato-RegularItalic.ttf
-- docs/fonts/SourceCodePro-Bold.ttf
-- docs/fonts/SourceCodePro-Regular.ttf
-- docs/images/add.png
-- docs/images/arrow_up.png
-- docs/images/brick.png
-- docs/images/brick_link.png
-- docs/images/bug.png
-- docs/images/bullet_black.png
-- docs/images/bullet_toggle_minus.png
-- docs/images/bullet_toggle_plus.png
-- docs/images/date.png
-- docs/images/delete.png
-- docs/images/find.png
-- docs/images/loadingAnimation.gif
-- docs/images/macFFBgHack.png
-- docs/images/package.png
-- docs/images/page_green.png
-- docs/images/page_white_text.png
-- docs/images/page_white_width.png
-- docs/images/plugin.png
-- docs/images/ruby.png
-- docs/images/tag_blue.png
-- docs/images/tag_green.png
-- docs/images/transparent.png
-- docs/images/wrench.png
-- docs/images/wrench_orange.png
-- docs/images/zoom.png
-- docs/index.html
-- docs/js/darkfish.js
-- docs/js/navigation.js
-- docs/js/navigation.js.gz
-- docs/js/search.js
-- docs/js/search_index.js
-- docs/js/search_index.js.gz
-- docs/js/searcher.js
-- docs/js/searcher.js.gz
-- docs/table_of_contents.html
-- help/loggable_activity_help.txt
-- lib/generators/.DS_Store
-- lib/generators/loggable_activity/.DS_Store
-- lib/generators/loggable_activity/install_generator.rb
-- lib/generators/loggable_activity/templates/.DS_Store
-- lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb
-- lib/generators/loggable_activity/templates/config/locales/loggable_activity.en.yml
-- lib/generators/loggable_activity/templates/config/loggable_activity.yaml
-- lib/generators/loggable_activity/templates/create_loggable_activities.rb
-- lib/generators/loggable_activity/templates/current_user.rb
-- lib/generators/loggable_activity/templates/loggable_activity.en.yaml
+- app/assets/config/loggable_activity_manifest.js
+- app/assets/images/loggable_activity/.keep
+- app/assets/javascripts/loggable_activity/application.js
+- app/assets/stylesheets/loggable_activity/application.scss
+- app/controllers/concerns/.keep
+- app/controllers/loggable_activity/activities_controller.rb
+- app/controllers/loggable_activity/application_controller.rb
+- app/helpers/loggable_activity/activities_helper.rb
+- app/helpers/loggable_activity/application_helper.rb
+- app/jobs/loggable_activity/application_job.rb
+- app/mailers/loggable_activity/application_mailer.rb
+- app/models/loggable_activity/application_record.rb
+- app/views/kaminari/kaminari-turbo-bootstrap/_first_page.html.erb
+- app/views/kaminari/kaminari-turbo-bootstrap/_gap.html.erb
+- app/views/kaminari/kaminari-turbo-bootstrap/_last_page.html.erb
+- app/views/kaminari/kaminari-turbo-bootstrap/_next_page.html.erb
+- app/views/kaminari/kaminari-turbo-bootstrap/_page.html.erb
+- app/views/kaminari/kaminari-turbo-bootstrap/_paginator.html.erb
+- app/views/kaminari/kaminari-turbo-bootstrap/_prev_page.html.erb
+- app/views/layouts/loggable_activity/application.html.erb
+- app/views/loggable_activity/activities/_activities.html.erb
+- app/views/loggable_activity/activities/index.html.erb
+- app/views/loggable_activity/activities/show.html.erb
+- config/initializers/kaminari_config.rb
+- config/routes.rb
+- db/migrate/20240702092648_create_loggable_activity_tables.rb
+- git-org/HEAD
+- git-org/config
+- git-org/description
+- git-org/hooks/applypatch-msg.sample
+- git-org/hooks/commit-msg.sample
+- git-org/hooks/fsmonitor-watchman.sample
+- git-org/hooks/post-update.sample
+- git-org/hooks/pre-applypatch.sample
+- git-org/hooks/pre-commit.sample
+- git-org/hooks/pre-merge-commit.sample
+- git-org/hooks/pre-push.sample
+- git-org/hooks/pre-rebase.sample
+- git-org/hooks/pre-receive.sample
+- git-org/hooks/prepare-commit-msg.sample
+- git-org/hooks/push-to-checkout.sample
+- git-org/hooks/update.sample
+- git-org/info/exclude
 - lib/loggable_activity.rb
 - lib/loggable_activity/.DS_Store
 - lib/loggable_activity/activity.rb
+- lib/loggable_activity/concerns/current_user.rb
+- lib/loggable_activity/config_schema.json
 - lib/loggable_activity/configuration.rb
 - lib/loggable_activity/data_owner.rb
 - lib/loggable_activity/encryption.rb
 - lib/loggable_activity/encryption_key.rb
+- lib/loggable_activity/engine.rb
 - lib/loggable_activity/error.rb
 - lib/loggable_activity/hooks.rb
 - lib/loggable_activity/payload.rb
@@ -296,17 +310,15 @@ files:
 - lib/loggable_activity/services/payloads_builder.rb
 - lib/loggable_activity/services/update_payloads_builder.rb
 - lib/loggable_activity/version.rb
-- lib/schemas/config_schema.json
-- pkg/loggable_activity-0.1.35.gem
-- sig/loggable_activity.rbs
+- lib/tasks/loggable_activity_tasks.rake
 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/
+  source_code_uri: https://github.com/LoggableActivity/LoggableActivity
+  changelog_uri: https://github.com/LoggableActivity/LoggableActivity/CHANGELOG.md
+  documentation_uri: https://LoggableActivity.github.io/LoggableActivity/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/.document

@@ -1 +0,0 @@
-lib/loggable_activity

data/.nojekyll

@@ -1 +0,0 @@
-- keep

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/CONSIDERTIONS.md

@@ -1,129 +0,0 @@
-# Considerations, Work in progress.
-This document is stored here and might deleted<br/>
-<br/>
-It should be easy to configure and use the *LoggablActivity* without having to collect and format data all over the system.<br/>
-It should also be possible to delete a data owner and then all data related to that data owner should be inaccessible.  
-
-
-### Protection of data that belongs to a data owner
-One way to protect data in a field is to encrypt it, when requested it can then be decrypted.<br/>
-If the data is required permanently deleted all there is to do is to throw away the key.<br/>
-Another way is to delete the content in all fields for a given data owner on request.<br/>
-
-### Composition of data in a log entry
-Lets consider an example with a user, the user has som personal information directly on the users DB Record.
-The user also has a relation to an address and the user might have a couple relations to other users, friends family members etc.<br/> 
-All this is created from one form and when it is submitted we want to log it. 
-One way of do it is to collect all the data from the DB and pack it into a json payload and submit it to the log, but then we have no control of<br/>
-What data is confidential and who it belongs to. So instead lets make some configurations for how data are handled.
-<br/>*Example*
-```
-┌──────────────────────┐      ┌──────────────────────┐
-│         User         │  ┌──▶│       Address        │
-├──────────────────────┤  │   ├──────────────────────┤
-│name: String          │  │   │street: String        │
-├──────────────────────┤  │   ├──────────────────────┤
-│date_of_birth: Date   │  │   │city: String          │
-├──────────────────────┤  │   └──────────────────────┘
-│address_id: Reference │──┘                           
-├──────────────────────┤                              
-│system_task_uuid: UUID│                              
-└──────────────────────┘                              
-            ┼                                         
-            │                                         
-           ╱│╲                                        
-┌──────────────────────┐                              
-│       Friend         │                              
-├──────────────────────┤                              
-│user_a_id: Reference  │                              
-├──────────────────────┤                              
-│user_b_id: Reference  │                              
-└──────────────────────┘    
-```
-Then a payload could look like this
-```
-
-{
-  user: {
-    name: Sting
-    date_of_birth "October 2, 1951"
-    address: {
-      street: "some street",
-      city: "London"
-    },
-    friend: [
-      user: {
-        name: "Bob"
-        date_of_birth: "September 01, 1991
-      }
-    ]
-  }
-}
-```
-But what about Bob, he is in the system and want to have control of his own data.<br/> 
-To achieve this we need to organize the way we store log entries so owners can be identified even within a payload.
-```
-        ┌────────────────────────┐
-        │        Activity        │
-        ├────────────────────────┤
-        │key: String             │
-        ├────────────────────────┤
-        │who_did_it_type: String │
-        ├────────────────────────┤
-        │who_did_it_id: UUID     │
-        ├────────────────────────┤
-        │time: DateTime          │
-        └────────────────────────┘
-                    ┼            
-                    │            
-                    │            
-                   ╱│╲           
-        ┌────────────────────────┐
-        │        Payload         │
-        ├────────────────────────┤
-        │data: Json              │
-        ├────────────────────────┤
-        │record_id: UUID         │
-        ├────────────────────────┤
-        │record_type: String     │
-        └────────────────────────┘
-```
-So now we can control access to Bobs data in the Logging DB
-
-### example of how a `Loggable::Activity` is formatted for the view 
-```
-activity = Loggable::Activity.lastest.last
-activity.attrs ==>
-
-payloads: [
-  primary: {
-    name: "User",
-    changes: {
-      attrs: {
-        first_name: {
-          from: "Bob",
-          to: "Rob"
-        }
-      }
-    }
-  }
-  relations: [
-    name: "Demo::Address
-    changes: {
-      street: {
-        from: "5th Avenue",
-        to: "Broadway"
-      } 
-    }
-  ]
-]
-
-
-```
-
-
-
-
-
-
-

data/GETTING-STARTED.md

@@ -1,119 +0,0 @@
-# Getting started 
-This document should you getting started with `LoggableActivity`
-
-## Prerequisite
-1 A running Rails Application<br/>
-2 An authorization system where there is a current user available.
-
-## 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<br/>
-```
-$ bundle install
-```
-Then we have to generate some migrations and additionals files<br/>
-```
-$ rails generate loggable_activity:install
-```
-This will install the following files
-- app/controllers/concerns/loggable_activity/current_user.rb
-- config/loggable_activity.yml
-- config/locales/loggable_activity.en.yml
-- db/migrate/xxxxxxxxxxxxxx_create_loggable_activities
-
-
-## Add hoks to models to be logged
-```
-class User < ApplicationRecord
-  include LoggableActivity::Hooks
-```
-
-## Configuration
-Update `config/application.rb`, you might do it differently in production
-```
-  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 we will look at next.
-
-## loggable_activity.yaml
-You have to update the configuration file installed inside the `config/loggable_activity.yaml`
-This file defines:
-- What fields in a table to log
-- What relations to include in a logged activity 
-- What should happen to the aggregation if a record is deleted.
-- What actions to log automatically
-
-**!Catch**<br/>
-`show` can not `auto_log` so it has to be handled manually, more about that later.<br/>
-*Here is an example of content for the config/loggable_activity.yaml file*
-```
-Demo::Club: 
-  record_display_name: email 
-  route: show_demo_club
-  loggable_attrs: 
-    - email
-    - name
-  auto_log:
-    - create
-    - update
-    - destroy
-  relations:
-    - belongs_to: :address
-      model: Demo::Address
-      route: show_address
-      loggable_attrs:
-        - street
-        - city
-```
-
-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
-- `route` is a flag used to generate a link to the model logged, more on that later.
-- Then we can se that we are logging the `email` and `name`.
-- 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.<br/> 
-In this example the club belongs to an address so we add the street and city from the address to the log.
-
-
-## Set current user
-Add a this to the application_controller.rb
-```
-class ApplicationController < ActionController::Base
-  include LoggableActivity::CurrentUser
-```
-If there is not current_user nothing will be logged. <br/>
-You can look inside `app/controllers/concerns/current_user.rb` and alter it with a default `current_user` if needed. 
-
-## Log the show action
-As mentioned earlier, show can not be logged automatically<br/>
-If you want to log the show action you can add this to your controllers show method
-```
-def show
-  @user.log(:show)
-```
-
-## Relations
-Supported relations at the moment is 
-- belongs_to
-- has_one
-- has_many
-
-
-
-## For developers and contributors 
-If you can download and play around with a demo app
-- 1 Down the demo project from [demo project on github](https://github.com/maxgronlund/LoggableActivityDemoApp)
-- 2 Update the Gemfile in the demo project so it points to your localhost.
-- 3 you can now build and test you version of the gem `$ gem build loggable_activity.gemspec`

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Max Groenlund
-
-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.