loggable_activity 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c639f2566d6a3dd820a7657b9b8bb398e5a861347ae1bc7d7474724c6c344b4c
-  data.tar.gz: 8551b4aab8f630be997b6af7b8372d7efd84221824bbacb25bb6c444f6c83978
+  metadata.gz: 62e1b197ae053af29d55c9b183c358a773f43186691c20c8e124ba7786bde586
+  data.tar.gz: ae8bd2c8d9a9718c02fc246c2a5a703b6fad9b27823cf357a51020d96b0a5a16
 SHA512:
-  metadata.gz: 03422fe2e2d154f894da7a0eab5fac78f1048b6e6d3d4addbf1fa0bd66d9a674913ca666a4a4e743cbaf95ff5edbfb8711641596330b370d5d29d3e0922f4af6
-  data.tar.gz: '08de4b66e4aba0d210be64f83eb78b51fcb6c351d3340e9f1dfba334194d5c6a705daeefe6f66aae8a7cc8409a94b1ba4ec33d222a957e549b0811629f6ebfcb'
+  metadata.gz: 7ed08eae394bc830b08d21f68de6b3f77811fde3b73d4278351bc807ee7c9de3369632bb349f16e45dd518e74297064494b1f810bb1b2c3cf1744d34f898adf9
+  data.tar.gz: 91891b25f6826cd70fcacc3bd3365a14b50e319c6d3af6ceecf72cb8340adb1298a79d28a1d08964087011c9e3766e188fe80193a3d293d087611a543817a7f4

data/.rubocop.yml

@@ -1,51 +1,38 @@
 AllCops:
-  TargetRubyVersion: '3.2.0'
-  NewCops: enable
-  Exclude:
-    # - 'vendor/**/*'
-    
-Style/OpenStructUse:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-
+  Exclude:
+    - 'db/migrate/20240702092648_create_loggable_activity_tables.rb'
 Layout/LineLength:
-  Enabled: false
-
+  Exclude:
+    - 'lib/loggable_activity/services/payloads_builder.rb'
+    - 'lib/loggable_activity/hooks.rb'
+    - 'lib/loggable_activity/activity.rb'
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/loggable_activity/encryption.rb'
 Metrics/BlockLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
+  Exclude:
+    - 'test/dummy/config/environments/development.rb'
+    - 'loggable_activity.gemspec'
+    - 'test/dummy/db/schema.rb'
 Metrics/ClassLength:
   Exclude:
-    - lib/loggable_activity/services/update_payloads_builder.rb
-
-Metrics/ParameterLists:
+    - 'lib/loggable_activity/services/update_payloads_builder.rb'
+Metrics/MethodLength:
   Exclude:
-    - lib/loggable_activity/services/base_payloads_builder.rb
-
+    - 'lib/loggable_activity/services/update_payloads_builder.rb'
+    - 'lib/loggable_activity/services/destroy_payloads_builder.rb'
+    - 'lib/loggable_activity/services/base_payloads_builder.rb'
+    - 'lib/loggable_activity/hooks.rb'
+    - 'lib/loggable_activity/encryption.rb'
+    - 'lib/loggable_activity/activity.rb'
+    - 'lib/loggable_activity/services/payloads_builder.rb'
+    - 'lib/loggable_activity/hooks.rb'
 Metrics/ModuleLength:
   Exclude:
-    - lib/loggable_activity/hooks.rb
-
-Metrics/AbcSize:
+    - 'lib/loggable_activity/hooks.rb'
+Style/Documentation:
   Exclude:
-    - lib/loggable_activity/encryption.rb
-    # - lib/loggable_activity/update_payloads_builderx.rb
-    - lib/generators/loggable_activity/templates/binary_ids/create_loggable_activities.rb
-    - lib/generators/loggable_activity/templates/create_loggable_activities.rb
+    - 'test/**/*'
+    - 'app/models/loggable_activity/application_record.rb'
+    - 'app/mailers/loggable_activity/application_mailer.rb'
+    - 'app/helpers/loggable_activity/application_helper.rb'

data/.vscode/commands.json

@@ -9,7 +9,7 @@
       "alignment": "right",
       "priority": 300,
       "tooltip": "Run test for current line",
-      "filterFileRegex": ".*_spec\\.rb"
+      "filterFileRegex": ".*_test\\.rb"
     },
     {
       "command": "terminals.runTerminalByName",
@@ -20,7 +20,7 @@
       "alignment": "right",
       "priority": 290,
       "tooltip": "Run test for current file",
-      "filterFileRegex": ".*_spec\\.rb"
+      "filterFileRegex": ".*_test\\.rb"
     }
   ]
 }

data/.vscode/terminals.json

@@ -8,10 +8,10 @@
       "onlySingle": true,
       "icon": "run",
       "commands": [
-        "dir=[file] && test_path=${${(s:/spec/:)dir}[1]} && file=\"spec/\"${${(s:/spec/:)dir}[2]}",
-        "echo \"$dir\\n$test_path\\n$file:[lineNumber]\"",
-        "cd $test_path",
-        "rspec $file:[lineNumber]"
+        "dir=$(dirname [file]) && test_file=$(basename [file])",
+        "echo \"$dir\\n$test_file:[lineNumber]\"",
+        "cd $dir",
+        "rails test $dir/$test_file:[lineNumber]"
       ]
     },
     {
@@ -21,10 +21,10 @@
       "onlySingle": true,
       "icon": "run-all",
       "commands": [
-        "dir=[file] && test_path=${${(s:/spec/:)dir}[1]} && file=\"spec/\"${${(s:/spec/:)dir}[2]}",
-        "echo \"$dir\\n$test_path\\n$file\"",
-        "cd $test_path",
-        "rspec $file"
+        "dir=$(dirname [file]) && test_file=$(basename [file])",
+        "echo \"$dir\\n$test_file\"",
+        "cd $dir",
+        "rails test $dir/$test_file"
       ]
     }
   ]

data/CHEAT_SHEET.md

@@ -0,0 +1,31 @@
+### Build gem on localhost
+```
+gem build loggable_activity.gemspec
+```
+
+### Release gem
+- Catch DONT update VERSION, this is done by `gem bump --version x.x.x`
+- Update the CHANGE_LOG.md
+
+Make sure `gem install gem-release` is installed
+
+```
+$ gem bump --version 0.3.0
+$ rake release
+$ read terminal output and authorize release
+```
+
+### Heroku
+```
+$ heroku pg:backups:capture --app loggableactivity
+$ heroku pg:backups:download --app loggableactivity
+```
+install on localhost
+```
+$ pg_restore --verbose --clean --no-acl --no-owner -h localhost -U maxgronlund -d activity_logger_development latest.dump
+```
+
+## Build documentation
+```
+$ rdoc -o docs/ --all --main 
+```

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright 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.

data/README.md

@@ -1,45 +1,31 @@
-# Loggable Activity 🌟
-Secure protect data and log how it is handled
-- Keep an activity log of how data in the db are handled.
-- Protect and secure the privacy of data stored in Activity Logs
-- Prepare for General Data Protection Regulation (GDPR) compliance.
-- Handles activities that involves more than one table in the DB.
-- Encrypt data stored in the activity log
-- Support binary_ids
-
-### Important!
-This project is under development and not ready for production. There might be breaking changes, so please consult the CHANGELOG.md
-### What it is not
-- An error logging system
-- A paper trails system with rollback.
-- A backup system
-
-### Applications
-Most organizations needs to keep a log of how users interact with data stored in the DB
-- Finance
-- Healthcare
-- Sales and Support
-
-*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, 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 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/>
-
-### Getting started
-please read the [GETTING-STARTED.md](https://github.com/maxgronlund/LoggableActivity/blob/main/GETTING-STARTED.md) guide
-
-### 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/)
-<br/>
-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.
+# LoggableActivity
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "loggable_activity"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install loggable_activity
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+##
+bin/rails loggable_activity:install:migrations

data/Rakefile

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
 
-RSpec::Core::RakeTask.new(:spec)
+load 'rails/tasks/statistics.rake'
 
-task default: :spec
+require 'bundler/gem_tasks'

data/app/assets/config/loggable_activity_manifest.js

@@ -0,0 +1,4 @@
+//= link_directory ../stylesheets/loggable_activity .css
+//= link application.css
+//= link_directory ../javascripts/loggable_activity .js
+//= link application.js

data/app/assets/javascripts/loggable_activity/application.js

@@ -0,0 +1,2 @@
+//= require bootstrap
+

data/app/assets/stylesheets/loggable_activity/application.scss

@@ -0,0 +1,20 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+@import "bootstrap/functions";
+@import "bootstrap/variables";
+@import "bootstrap/mixins";
+@import "bootstrap";

data/app/controllers/loggable_activity/activities_controller.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  # Controller for activities
+  class ActivitiesController < ApplicationController
+    def index
+      @activities = LoggableActivity::Activity.order(created_at: :desc).page params[:page]
+    end
+
+    def show; end
+  end
+end

data/app/controllers/loggable_activity/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/loggable_activity/activities_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  # Helper methods for activities
+  module ActivitiesHelper
+    require 'json'
+    def activity_action(activity)
+      I18n.t("loggable_activity.#{activity.action}")
+    end
+
+    def format_json_for_display(hash_data)
+      JSON.pretty_generate(hash_data)
+    rescue JSON::ParserError
+      hash_data.to_s
+    end
+  end
+end

data/app/helpers/loggable_activity/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  module ApplicationHelper
+  end
+end

data/app/jobs/loggable_activity/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/loggable_activity/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/loggable_activity/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module LoggableActivity
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/kaminari/kaminari-turbo-bootstrap/_first_page.html.erb

@@ -0,0 +1,14 @@
+<%# Link to the "First" page
+  - available local variables
+    url:           url to the first page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.first? %>
+<li class="page-item">
+  <%# <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, :class => 'page-link', :remote => remote %> 
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, class: 'page-link', data: { turbo: true } %>
+</li>
+<% end %>

data/app/views/kaminari/kaminari-turbo-bootstrap/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="page-item disabled"><a href="#" onclick="return false;" class="page-link"><%= raw(t 'views.pagination.truncate') %></a></li>

data/app/views/kaminari/kaminari-turbo-bootstrap/_last_page.html.erb

@@ -0,0 +1,13 @@
+<%# Link to the "Last" page
+  - available local variables
+    url:           url to the last page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.last? %>
+<li class="page-item">
+  <%= link_to_unless current_page.last?, raw(t('views.pagination.last')), url, class: 'page-link', data: { turbo: true } %>
+</li>
+<% end %>

data/app/views/kaminari/kaminari-turbo-bootstrap/_next_page.html.erb

@@ -0,0 +1,13 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.last? %>
+<li class="page-item">
+  <%= link_to_unless current_page.last?, raw(t('views.pagination.next')), url, class: 'page-link', rel: 'next', data: { turbo: true }, remote: remote %>
+</li>
+<% end %>

data/app/views/kaminari/kaminari-turbo-bootstrap/_page.html.erb

@@ -0,0 +1,14 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<li class="page-item<%= ' active' if page.current? %>">
+  <%#= link_to page, url, opts = {:remote => remote, :class => 'page-link', :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>
+  <%= link_to page, url, class: 'page-link', rel: page.next? ? 'next' : page.prev? ? 'prev' : nil, data: { turbo: true }, remote: remote %>
+
+</li>

data/app/views/kaminari/kaminari-turbo-bootstrap/_paginator.html.erb

@@ -0,0 +1,27 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%- pagination_class ||= '' %>
+<%- nav_class ||= '' %>
+<%= paginator.render do -%>
+<nav class="<%= nav_class %>">
+  <ul class="pagination <%= pagination_class %>">
+    <%= first_page_tag unless current_page.first? %>
+    <%= prev_page_tag unless current_page.first? %>
+    <% each_page do |page| -%>
+      <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
+        <%= page_tag page %>
+      <% elsif !page.was_truncated? -%>
+        <%= gap_tag %>
+      <% end -%>
+    <% end -%>
+    <%= next_page_tag unless current_page.last? %>
+    <%= last_page_tag unless current_page.last? %>
+  </ul>
+</nav>
+<% end -%>

data/app/views/kaminari/kaminari-turbo-bootstrap/_prev_page.html.erb

@@ -0,0 +1,14 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<% unless current_page.first? %>
+<li class="page-item">
+  <%#= link_to_unless current_page.first?, raw(t 'views.pagination.previous'), url, :rel => 'prev', :remote => remote, :class => 'page-link' %>
+  <%= link_to_unless current_page.first?, raw(t('views.pagination.previous')), url, rel: 'prev', class: 'page-link', data: { turbo: true }, remote: remote %>
+</li>
+<% end %>

data/app/views/layouts/loggable_activity/application.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Loggable activity</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_link_tag    "loggable_activity/application", media: "all" %>
+  <%= javascript_include_tag 'loggable_activity/application', defer: true %>
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/themes/prism.min.css" rel="stylesheet">
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.24.1/prism.min.js"></script>
+
+</head>
+<body>
+<div class="container">
+  <%= yield %>
+</div>
+
+</body>
+</html>

data/app/views/loggable_activity/activities/_activities.html.erb

@@ -0,0 +1,56 @@
+<table class="table table-borderless">
+  <thead>
+    <tr>
+      <th>
+        <div class="row">
+          <div class="col-3">
+            <b class="text-secondary">Action</b>
+          </div>
+          <div class="col-3">
+            <b class="text-secondary">Record</b>
+          </div>
+          <div class="col-3">
+            <b class="text-secondary">Actor</b>
+          </div>
+          <div class="col-3">
+            <b class="text-secondary">Created At</b>
+          </div>
+        </div>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @activities.each do |activity| %>
+      <tr>
+        <td>
+          <div class="alert alert-info" type="button" data-bs-toggle="collapse" data-bs-target="#activity_<%= activity.id %>" aria-expanded="false" aria-controls="collapseExample">
+            <div class="row">
+              <div class="col-3">
+                <%= activity_action(activity) %>
+              </div>
+              <div class="col-3">
+                <%= t(activity.record_display_name) %>
+              </div>
+              <div class="col-3">
+                <%= t(activity.actor_display_name) %>
+              </div>
+              <div class="col-3">
+                <%= l(activity.created_at, format: :long) %>
+              </div>
+            </div>
+          </div>
+          <div class="collapse" id="activity_<%= activity.id %>">
+            <pre>
+              <code class="language-json">
+                <%= format_json_for_display(activity.attrs) %>
+              </code>
+            </pre>
+          </div>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<script>
+  Prism.highlightAll();
+</script>

data/app/views/loggable_activity/activities/index.html.erb

@@ -0,0 +1,7 @@
+<h1>Activities</h1>
+ <%= render partial: "activities", activities: @activities %>
+ 
+ <%= paginate @activities, theme: 'kaminari-turbo-bootstrap' %>
+
+
+

data/app/views/loggable_activity/activities/show.html.erb

@@ -0,0 +1,2 @@
+<h1>Activities#show</h1>
+<p>Find me in app/views/loggable_activity/activities/show.html.erb</p>

data/config/initializers/kaminari_config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Kaminari.configure do |config|
+  config.default_per_page = 3
+  # config.max_per_page = nil
+  # config.window = 4
+  # config.outer_window = 0
+  # config.left = 0
+  # config.right = 0
+  # config.page_method_name = :page
+  # config.param_name = :page
+  # config.max_pages = nil
+  # config.params_on_first_page = false
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+LoggableActivity::Engine.routes.draw do
+  resources :activities, only: %i[index show]
+
+  root to: 'activities#index'
+end