loggable_activity 0.1.56 → 0.1.58

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.erb

@@ -1,23 +0,0 @@
-<tr>
-  <td>
-    <%= render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity } %>
-  </td>
-  <td>
-    <b class="text-secondary"><%= primary_type(activity) %></b>
-    <br>
-    <% activity.primary_payload_attrs.each do |k, v| %>
-      <%= "<i>#{k}:</i> #{v.blank? ? t('loggable.activity.deleted') : v}".html_safe %>
-      <br>
-    <% end %>
-    <br>
-    <% activity.relations_attrs.each do |relation_attrs| %>
-      <b class="text-secondary"><%= relation_type(relation_attrs) %></b>
-      <br>
-      <%= render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation_attrs[:attrs] } %>
-      <br>
-    <% end %>
-  </td>
-  <td>
-    <%= link_to 'Delete', demo_activity_log_path(activity), data: { turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm' %>
-  </td>
-</tr>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_create.html.slim

@@ -1,18 +0,0 @@
-tr
-  td
-    = render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity }
-  td 
-    b.text-secondary  = primary_type(activity)
-    br
-    - activity.primary_payload_attrs.each do |k, v|
-      = "<i>#{k}:</i> #{v.blank? ? t('loggable.activity.deleted') : v}".html_safe
-      br/
-    br
-    - activity.relations_attrs.each do |relation_attrs|
-      b.text-secondary = relation_type(relation_attrs)
-      br/
-      = 
-      = render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation_attrs[:attrs] }
-      br/
-  td 
-    =< link_to 'Delete', demo_activity_log_path(activity), data: {  turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm'

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_destroy.html.erb

@@ -1,18 +0,0 @@
-<tr>
-  <td>
-    <%= render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity } %>
-  </td>
-  <td>
-    <% update_activity_attrs = activity.update_activity_attrs %>
-    <% if update_attrs = update_activity_attrs[:update_attrs] %>
-      <%= render partial: 'loggable_activity/templates/shared/update_attrs', locals: { update_attrs: update_attrs } %>
-    <% end %>
-    <% if updated_relations = update_activity_attrs[:updated_relations_attrs] %>
-      <br>
-      <%= render partial: 'loggable_activity/templates/shared/updated_relations', locals: { updated_relations: updated_relations } %>
-    <% end %>
-  </td>
-  <td>
-    <%= link_to 'Delete', demo_activity_log_path(activity), data: { turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm' %>
-  </td>
-</tr>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_destroy.html.slim

@@ -1,17 +0,0 @@
-tr 
-  td
-    = render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity }
-  td 
-    b.text-secondary = primary_type(activity)
-    br/
-    - activity.primary_payload_attrs.each do |k, v|
-      = "<i>#{k}:</i> #{v.blank? ? t('loggable.activity.deleted') : v}".html_safe
-      br/
-    br/
-    - activity.relations_attrs.each do |relation_attrs|
-      b.text-secondary = relation_type(relation_attrs)
-      br/
-      = render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation_attrs[:attrs] }
-      br/
-  td 
-    =< link_to 'Delete', demo_activity_log_path(activity), data: {  turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm'

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_show.html.erb

@@ -1,18 +0,0 @@
-<tr>
-  <td>
-    <%= render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity } %>
-  </td>
-  <td>
-    <b class="text-secondary"><%= primary_type(activity) %></b><br/>
-    <% activity.primary_payload_attrs.each do |k, v| %>
-      <%= "<i>#{k}:</i> #{v.blank? ? t('loggable.activity.deleted') : v}".html_safe %><br/>
-    <% end %><br/>
-    <% activity.relations_attrs.each do |relation_attrs| %>
-      <b class="text-secondary"><%= relation_type(relation_attrs) %></b><br/>
-      <%= render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation_attrs[:attrs] } %><br/>
-    <% end %>
-  </td>
-  <td>
-    <%= link_to 'Delete', demo_activity_log_path(activity), data: { turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm' %>
-  </td>
-</tr>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_show.html.slim

@@ -1,17 +0,0 @@
-tr
-  td
-    = render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity }
-  td 
-    b.text-secondary = primary_type(activity)
-    br/
-    - activity.primary_payload_attrs.each do |k, v|
-      = "<i>#{k}:</i> #{v.blank? ? t('loggable.activity.deleted') : v}".html_safe
-      br/
-    br/
-    - activity.relations_attrs.each do |relation_attrs|
-      b.text-secondary = relation_type(relation_attrs)
-      br/
-      = render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation_attrs[:attrs] }
-      br/
-  td 
-    =< link_to 'Delete', demo_activity_log_path(activity), data: {  turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm'

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_update.html.erb

@@ -1,18 +0,0 @@
-<tr>
-  <td>
-    <%= render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity } %>
-  </td>
-  <td>
-    <% update_activity_attrs = activity.update_activity_attrs %>
-    <% if update_attrs = update_activity_attrs[:update_attrs] %>
-      <%= render partial: 'loggable_activity/templates/shared/update_attrs', locals: { update_attrs: update_attrs } %>
-    <% end %>
-    <% if updated_relations = update_activity_attrs[:updated_relations_attrs] %>
-      <br>
-      <%= render partial: 'loggable_activity/templates/shared/updated_relations', locals: { updated_relations: updated_relations } %>
-    <% end %>
-  </td>
-  <td>
-    <%= link_to 'Delete', demo_activity_log_path(activity), data: { turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm' %>
-  </td>
-</tr>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/default/_update.html.slim

@@ -1,12 +0,0 @@
-tr
-  td
-    = render partial: 'loggable_activity/templates/shared/activity_info', locals: { activity: activity }
-  td
-    - update_activity_attrs = activity.update_activity_attrs
-    - if update_attrs = update_activity_attrs[:update_attrs]
-      = render partial: 'loggable_activity/templates/shared/update_attrs', locals: { update_attrs: update_attrs }
-    - if updated_relations = update_activity_attrs[:updated_relations_attrs]
-      br/
-      = render partial: 'loggable_activity/templates/shared/updated_relations', locals: { updated_relations: updated_relations }
-  td 
-    =< link_to 'Delete', demo_activity_log_path(activity), data: {  turbo_method: :delete, confirm: 'Are you sure?' }, class: 'btn btn-danger btn-sm'

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_activity_info.html.erb

@@ -1,12 +0,0 @@
-<div class="px-4">
-  <h5><%= t("loggable.activity.#{activity.action}", name: "") %></h5>
-  <b><%= activity.record_display_name %></b>
-  <br>
-  <i>Actor:&nbsp;</i>
-  <br>
-  <%= activity.actor_display_name %>
-  <br>
-  <i>When:&nbsp;</i>
-  <br>
-  <%= I18n.l(activity.created_at, format: :long) %>
-</div>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_activity_info.html.slim

@@ -1,11 +0,0 @@
-.px-4
-  .h5 = t("loggable.activity.#{activity.action}", name: "")
-  b = activity.record_display_name
-  br
-  i Actor: 
-  br
-  = activity.actor_display_name
-  br
-  i When: 
-  br
-  = I18n.l(activity.created_at, format: :long)

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_list_attrs.html.erb

@@ -1,8 +0,0 @@
-<% if attrs == :deleted %>
-  <%= t('loggable.activity.deleted') %>
-<% elsif attrs.is_a?(Hash) %>
-  <% attrs.each do |k, v| %>
-    <%= "<i>#{k}:</i> #{v.blank? ? t('loggable.activity.deleted') : v}".html_safe %>
-    <br>
-  <% end %>
-<% end %>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_list_attrs.html.slim

@@ -1,6 +0,0 @@
-- if attrs == :deleted
-  = t('loggable.activity.deleted')
-- elsif attrs.is_a?(Hash)
-  - attrs.each do |k, v|
-    = "<i>#{k}:</i> #{v.blank? ? t('loggable.activity.deleted') : v}".html_safe
-    br/

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_update_attrs.html.erb

@@ -1,17 +0,0 @@
-<b class="text-secondary"><%= update_relation_class(update_attrs) %></b>
-<br>
-<% if update_attrs[:attrs] == :deleted %>
-  <%= t('loggable.activity.deleted') %>
-<% else %>
-  <% update_attrs[:attrs].each do |attr| %>
-    <% attr.each do |key, from_to| %>
-      <% next if from_to.nil? %>
-      <i><%= key %></i>
-      <br>
-      <%= "from: #{from_to[:from].nil? ? 'Empty' : from_to[:from]}" %>
-      <br>
-      <%= "to: #{from_to[:to].nil? ? 'Empty' : from_to[:to]}" %>
-      <br>
-    <% end %>
-  <% end %>
-<% end %>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_update_attrs.html.slim

@@ -1,14 +0,0 @@
-b.text-secondary = update_relation_class(update_attrs)
-br/
-- if update_attrs[:attrs] == :deleted
-  = t('loggable.activity.deleted') 
-- else
-  - update_attrs[:attrs].each do |attr|
-    - attr.each do |key, from_to|
-      - next if from_to.nil?
-      i = key
-      br/
-      = "from: #{from_to[:from].nil? ? "Empty" : from_to[:from]}"
-      br/
-      = "to: #{from_to[:to].nil? ? "Empty" : from_to[:to]}"
-      br/

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_updated_relations.html.erb

@@ -1,23 +0,0 @@
-<% updated_relations.each do |relation| %>
-  <b class="text-secondary"><%= update_relation_class(relation) %></b>
-  <br>
-  <% if relation[:previous_attrs].present? %>
-    <i>From:</i>
-    <br>
-    <%= render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation[:previous_attrs][:attrs] } %>
-  <% else %>
-    <i>From:</i>
-    <br>
-    Empty
-    <br>
-  <% end %>
-  <% if relation[:current_attrs].present? %>
-    <i>To:</i>
-    <br>
-    <%= render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation[:current_attrs][:attrs] } %>
-  <% else %>
-    <i>To:</i>
-    <br>
-    Empty
-  <% end %>
-<% end %>

data/lib/generators/loggable_activity/templates/views/loggable_activity/templates/shared/_updated_relations.html.slim

@@ -1,21 +0,0 @@
-- updated_relations.each do |relation|
-  b.text-secondary = update_relation_class(relation)
-  br/
-  - if relation[:previous_attrs].present?
-    i From:
-    br/
-    = render partial:'loggable_activity/templates/shared/list_attrs', locals: {attrs: relation[:previous_attrs][:attrs] }
-  - else 
-    i From: 
-    br/ 
-    |Empty
-    br
-  - if relation[:current_attrs].present?
-    i To:
-    br/
-    = render partial: 'loggable_activity/templates/shared/list_attrs', locals: { attrs: relation[:current_attrs][:attrs] }
-  - else 
-    i To: 
-    br/
-    |Empty
-  

data/lib/loggable_activity/payloads_builder.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-module LoggableActivity
-  # This module is responsible for building payloads used in loggable activities.
-  module PayloadsBuilder
-    # Builds payloads for the loggable activity.
-    #
-    #  Example:
-    #    build_payloads
-    #
-    #  Returns:
-    #   #<LoggableActivity::Payload:0x0000000109658718> {
-    #                    :id => 129,
-    #           :record_type => "Demo::Club",
-    #             :record_id => 4,
-    #       :encrypted_attrs => {
-    #           "name" => "z/jigjcm3Fb89L7QT8XiNhvVgjtRXKkmg/xohR6wIc0=\n"
-    #       },
-    #          :payload_type => "current_association",
-    #            :data_owner => nil,
-    #           :activity_id => 50,
-    #            :created_at => Wed, 14 Feb 2024 13:21:13.964339000 UTC +00:00,
-    #            :updated_at => Wed, 14 Feb 2024 13:21:13.964339000 UTC +00:00
-    #   }
-    #
-    def build_payloads
-      build_primary_payload
-      self.class.relations.each do |relation_config|
-        build_relation_payload(relation_config)
-      end
-      @payloads
-    end
-
-    private
-
-    # Builds the primary payload.
-    def build_primary_payload
-      encrypted_attrs = encrypt_attrs(attributes, self.class.loggable_attrs, primary_encryption_key)
-      @payloads << LoggableActivity::Payload.new(
-        record: @record,
-        payload_type: 'primary_payload',
-        encrypted_attrs:,
-        data_owner: true,
-        route: self.class.route
-      )
-    end
-
-    # Builds the payload for destroyed records.
-    def build_destroy_payload
-      encrypted_attrs = encrypt_attrs(attributes, self.class.loggable_attrs, primary_encryption_key)
-      encrypted_attrs.transform_values! { '*** DELETED ***' }
-      @payloads << LoggableActivity::Payload.new(
-        record: @record,
-        payload_type: 'primary_payload',
-        encrypted_attrs:,
-        data_owner: true,
-        route: nil
-      )
-    end
-
-    # Builds payloads for relations
-    #
-    # @param relation_config [Hash] The configuration of the relation.
-    def build_relation_payload(relation_config)
-      relation_config.each_key do |key|
-        case key
-        when 'belongs_to'
-          build_payload(relation_config, 'belongs_to')
-        when 'has_one'
-          build_payload(relation_config, 'has_one')
-        when 'has_many'
-          build_has_many_payloads(relation_config, 'has_many')
-        end
-      end
-    end
-
-    # Builds the payload for a specific relation.
-    #
-    # @param relation_config [Hash] The configuration of the relation.
-    # @param relation_type [String] The type of the relation.
-    def build_payload(relation_config, relation_type)
-      associated_record = send(relation_config[relation_type])
-      return nil if associated_record.nil?
-
-      build_associated_payload(associated_record, relation_config)
-    end
-
-    # Builds payloads for has_many relations.
-    def build_has_many_payloads(relation_config, relation_type)
-      associated_records = send(relation_config[relation_type])
-      return nil if associated_records.empty?
-
-      associated_records.each do |associated_record|
-        build_associated_payload(associated_record, relation_config)
-      end
-    end
-
-    # Builds the payload for an associated record.
-    def build_associated_payload(associated_record, relation_config)
-      associated_loggable_attrs = relation_config['loggable_attrs']
-      encryption_key = associated_record_encryption_key(associated_record, relation_config['data_owner'])
-      encrypted_attrs =
-        encrypt_attrs(
-          associated_record.attributes,
-          associated_loggable_attrs,
-          encryption_key.key
-        )
-
-      @payloads << LoggableActivity::Payload.new(
-        record: associated_record,
-        encrypted_attrs:,
-        payload_type: 'current_association',
-        data_owner: relation_config['data_owner'],
-        route: relation_config['route']
-      )
-    end
-
-    # Retrieves the encryption key for the associated record.
-    #
-    # @param associated_record [ActiveRecord::Base] The associated record.
-    # @param data_owner [Boolean] Whether the associated record is the owner of the data.
-    # @return [LoggableActivity::EncryptionKey] The encryption key for the associated record.
-    def associated_record_encryption_key(associated_record, data_owner)
-      if data_owner
-        LoggableActivity::EncryptionKey.for_record(associated_record, LoggableActivity::EncryptionKey.for_record(self))
-      else
-        LoggableActivity::EncryptionKey.for_record(associated_record)
-      end
-    end
-
-    # Encrypts attributes.
-    #
-    # @param attrs [Hash] The attributes to be encrypted.
-    # @param loggable_attrs [Array<String>] The loggable attributes.
-    # @param encryption_key [String] The encryption key.
-    # @return [Hash] The encrypted attributes.
-    def encrypt_attrs(attrs, loggable_attrs, encryption_key)
-      attrs = attrs.slice(*loggable_attrs)
-      encrypt_attr(attrs, encryption_key)
-    end
-
-    # Encrypts a single attribute.
-    #
-    # @param attrs [Hash] The attributes to be encrypted.
-    # @param encryption_key [String] The encryption key.
-    # @return [Hash] The encrypted attributes.
-    def encrypt_attr(attrs, encryption_key)
-      attrs.each do |key, value|
-        attrs[key] = LoggableActivity::Encryption.encrypt(value, encryption_key)
-      end
-    end
-  end
-end

data/lib/loggable_activity/update_payloads_builder.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-module LoggableActivity
-  # This module is responsible for building update payloads used in loggable activities.
-  module UpdatePayloadsBuilder
-    # Builds payloads for an activity update event.
-    def build_update_payloads
-      @update_payloads = []
-
-      previous_values, current_values = primary_update_attrs
-      build_primary_update_payload(previous_values, current_values)
-
-      self.class.relations.each do |relation_config|
-        build_update_relation_payloads(relation_config)
-      end
-      @update_payloads
-    end
-
-    private
-
-    # Fetch the previous and current values of the primary record.
-    def primary_update_attrs
-      previous_values = saved_changes.transform_values(&:first)
-      current_values = saved_changes.transform_values(&:last)
-
-      [previous_values, current_values]
-    end
-
-    # Builds the primary update payload.
-    def build_primary_update_payload(previous_values, current_values)
-      return if previous_values == current_values
-
-      encrypted_update_attrs = encrypted_update_attrs(previous_values, current_values)
-      @update_payloads << LoggableActivity::Payload.new(
-        record: @record,
-        payload_type: 'update_payload',
-        encrypted_attrs: encrypted_update_attrs,
-        route: self.class.route
-      )
-    end
-
-    # Returns the encrypted attributes for the update payload.
-    def encrypted_update_attrs(previous_values, current_values)
-      changes = []
-      changed_attrs = previous_values.slice(*self.class.loggable_attrs)
-      changed_attrs.each do |key, from_value|
-        from = LoggableActivity::Encryption.encrypt(from_value, primary_encryption_key)
-        to_value = current_values[key]
-        to = LoggableActivity::Encryption.encrypt(to_value, primary_encryption_key)
-        changes << { key => { from:, to: } }
-      end
-      { changes: }
-    end
-
-    # Builds update payloads for relations.
-    def build_update_relation_payloads(relation_config)
-      relation_config.each_key do |key|
-        case key
-        when 'belongs_to'
-          build_relation_update_for_belongs_to(relation_config)
-        when 'has_one'
-          build_relation_update_for_has_one(relation_config)
-        when 'has_many'
-          build_relation_update_for_has_many(relation_config)
-        end
-      end
-    end
-
-    # Builds the update payload for a has_many relation.
-    def build_relation_update_for_has_many(relation_config)
-      # NOTE: This method is not implemented yet.
-      # It requires that there is a form where it is possible to change
-      # the related records. This is not implemented yet. in the Demo app
-      # puts relation_config['has_many']
-    end
-
-    # Builds the update payload for a has_one relation.
-    def build_relation_update_for_has_one(relation_config)
-      # NOTE: This method is not implemented yet.
-      # It requires that there is a form where it is possible to change
-      # the related records. This is not implemented yet. in the Demo app
-      # puts relation_config['has_one']
-    end
-
-    # Builds the update payload for a belongs_to relation.
-    def build_relation_update_for_belongs_to(relation_config)
-      relation_id = "#{relation_config['belongs_to']}_id"
-      model_class_name = relation_config['model']
-      model_class = model_class_name.constantize
-
-      return unless saved_changes.include?(relation_id)
-
-      relation_id_changes = saved_changes[relation_id]
-      previous_relation_id, current_relation_id = relation_id_changes
-
-      [previous_relation_id, current_relation_id].each_with_index do |id, index|
-        relation_record = id ? model_class.find_by(id:) : nil
-        next unless relation_record
-
-        payload_type = index.zero? ? 'previous_association' : 'current_association'
-        build_relation_update_payload(
-          relation_config,
-          relation_record,
-          payload_type
-        )
-      end
-    end
-
-    # Builds the update payload for a relation.
-    def build_relation_update_payload(relation_config, record, payload_type)
-      encryption_key = LoggableActivity::EncryptionKey.for_record(record)&.key
-      encrypted_attrs = relation_encrypted_attrs(record.attributes, relation_config['loggable_attrs'], encryption_key)
-
-      @update_payloads << LoggableActivity::Payload.new(
-        record:,
-        encrypted_attrs:,
-        payload_type:,
-        route: relation_config['route']
-      )
-    end
-
-    # Returns the encrypted attributes for a relation.
-    def relation_encrypted_attrs(attrs, loggable_attrs, encryption_key)
-      encrypt_attrs(attrs, loggable_attrs, encryption_key)
-    end
-  end
-end