loggable_activity 0.1.48 → 0.1.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3e20a374ac054a343ce5ff1c35c5fcce765fb631788fb6d9b738e52161a16a
-  data.tar.gz: 042cc1db90cf6b99eeb2c8d5ab3f16a5473178c00085f42400c4eec344a99731
+  metadata.gz: e3a71b62ddccb997e31e0592a4069f3c1684043fe5dee77691801930ebd86a43
+  data.tar.gz: 7b8cf906c1357bbc2e90172020de8ab712132ba43de3a53fc0d4058cfa391bd8
 SHA512:
-  metadata.gz: 1f4063eb4cd98a16061d151759735e0b5cc98e7747151dc2c56856f2010f23936c2c338991c5cc85dfd3c72af4f60133a4e39271f29ec76e5ee04383ad6dd073
-  data.tar.gz: 8be57a52cfd948825e273648ffaec5809975dc14863f49206ee8f364f07b58a193758d80d867155f21760522a24bc2cf49d183ba757c503af1fdf51317b78202
+  metadata.gz: a951d551a83e4cab2c58ec1b6a3b00c1814ecd099bdf38682d024a99298417912f6efcaf1c1d625f8ee4f877ac60f7ab851cc9a00b2c7201fb9fba2cf1e093b1
+  data.tar.gz: 4821fd58720ad28bd77d7f958f0c1ce39de246503b93a4027097fa61c3b5f4b4e3ca3f673f37271205a121717905f3dbb12337ad3193e40fe12f6098f69667ec

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 - nothing so far
+## [0.1.49] - 2024-02-18
+- Metadata, pointing to hompage 
 
 ## [0.1.48] - 2024-02-16
 ### Breaking change
@@ -7,14 +9,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,26 +8,77 @@ 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*
+```
+Demo::Club: 
+  record_display_name: name 
+  loggable_attrs: 
+    - name
+  auto_log:
+    - create
+    - update
+    - destroy
+  relations:
+    - belongs_to: :address
+      model: Demo::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
+- 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 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.
+
+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
+  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.
+
+
+## Configuration
+
 ```
 User: 
   record_display_name: full_name

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoggableActivity
-  VERSION = '0.1.48'
+  VERSION = '0.1.49'
 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.49
 platform: ruby
 authors:
 - "Max \nGroenlund"
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -116,6 +116,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 +134,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: