audited-ui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c4ee9704d19ebb0589a889be19d2bde64db1310a61b55a26003801a2e989b7c
+  data.tar.gz: 222f4b7330f41c5981cf52d63b9e655cdcc0fb356bcfe193f1aee79ece60f7d3
+SHA512:
+  metadata.gz: 35402dbe3579a018f56ef253e677df749ead37180aefabc684f585523cfdf1fb15865a92fc99ed58259db0619288ffbe7fe7b4b55faac83bbbfc2a32aae7e9a4
+  data.tar.gz: 49f637a6035ac6bf2881d7feda2fc5cb6986f4b05a59aaf71ff599c087df732f7ce0ec8af98b7b1106f4b0dcc87ec0de9d75e72e9464bdf9aa5a8780c7fb0869

data/README.md

@@ -0,0 +1,95 @@
+# Audited::Ui
+
+A UI for [audited](https://github.com/collectiveidea/audited), a [Ruby on Rails](https://rubyonrails.org) extension for auditing models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "audited-ui"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install audited-ui
+```
+
+## Usage
+
+By just installing it, audited-ui will add the following routes:
+
+```
+/audited/audits
+/audited/audits/:auditable_type
+/audited/audits/:auditable_type/:auditable_id
+```
+
+that will allow you to audit all records of all types, all records of a given auditable type, or all records of a given auditable object, respectively.
+
+Audit all records by linking to `audited_audits_path`, like this:
+
+```erb
+<%= link_to "Audit all records", audited_audits_path %>
+```
+
+Or just a specific auditable type, using `audited_auditable_type_audits_path`, like this:
+
+```erb
+<%= link_to "Audit all people records", audited_auditable_type_audits_path(auditable_type: "person") %>
+```
+
+Or a specific record, using `audited_auditable_audits_path`, like this:
+
+```erb
+<%= link_to "Audit this person", audited_auditable_audits_path(auditable_type: "person", auditable_id: person.id) %>
+```
+
+### Customizing views
+
+If you already set it up, you'll notice that audited-ui comes with a barebone UI that you can use. But, purposedly, the UI is very simple. The idea is that you can use it if it's good enough, but in most cases you should customize it to match your application's UI.
+
+To generate the views simply run:
+
+```bash
+$ bundle exec rails g audited:ui:views
+```
+
+### I18n
+
+Every string is I18ned, even class and attributes names. See [this guide](https://guides.rubyonrails.org/i18n.html#translations-for-active-record-models) if you want to translate your audited models and attributes.
+
+By default only english and spanish are supported. You can add other locales by copying the content of [this file](https://github.com/sinaptia/audited-ui/blob/main/config/locales/en.yml) into your app's `config/locale/yourlocale.yml` and translating the given strings. And if you do that send a PR :P .
+
+If you need to customize just one string, copy that string in your app's locale file:
+
+```yml
+en:
+  audited:
+    ui:
+      audits:
+        index:
+          title:
+            all: Auditing everything
+```
+
+## TODO
+
+- [x] Mount the engine with a method, similar to `devise_for`, so we can have more and better control on routes.
+- [ ] AuditedUI configuration, if we need to configure anything.
+- [ ] Ready to use views (tailwind/bootstrap), if it makes sense.
+- [x] Filters (by user, by dates, by changed attribute).
+- [x] Sort by column.
+- [ ] Revert to a specific version.
+- [ ] Tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/audited/ui/audits_controller.rb

@@ -0,0 +1,39 @@
+module Audited
+  module Ui
+    class AuditsController < ::ApplicationController
+      before_action :set_auditable_type
+      before_action :set_auditable
+      before_action :set_audits
+
+      def index
+        @q = @audits.ransack params[:q]
+        @q.sorts = "created_at desc" if @q.sorts.none?
+        @audits = @q.result(distinct: true).includes(:auditable, :user).page params[:page]
+      end
+
+      private
+
+      def set_auditable
+        @auditable = if @auditable_type.present? && params[:auditable_id].present?
+          @auditable_type.find params[:auditable_id]
+        end
+      end
+
+      def set_auditable_type
+        @auditable_type = if params[:auditable_type].present?
+          params[:auditable_type].camelize.constantize
+        end
+      end
+
+      def set_audits
+        @audits = if @auditable.present?
+          @auditable.audits
+        elsif @auditable_type.present?
+          Audited::Audit.where(auditable_type: @auditable_type.to_s)
+        else
+          Audited::Audit.all
+        end
+      end
+    end
+  end
+end

data/app/helpers/audited/ui/audits_helper.rb

@@ -0,0 +1,15 @@
+module Audited
+  module Ui
+    module AuditsHelper
+      def title(auditable, auditable_type)
+        if auditable.present?
+          I18n.t "audited.ui.audits.index.title.auditable", auditable: auditable.to_s
+        elsif auditable_type.present?
+          I18n.t "audited.ui.audits.index.title.auditable_type", auditable_type: auditable_type.to_s.humanize.pluralize.downcase
+        else
+          I18n.t "audited.ui.audits.index.title.all"
+        end
+      end
+    end
+  end
+end

data/app/views/audited/ui/audits/_search_form.html.erb

@@ -0,0 +1,21 @@
+<%= search_form_for @q, url: request.path do |f| %>
+  <div>
+    <%= f.label t("activerecord.attributes.audit.user") %>
+    <%= f.collection_select :user_id_eq, User.all, :id, :email, include_blank: true %>
+  </div>
+
+  <div>
+    <%= f.label t("activerecord.attributes.audit.created_at") %>
+    <%= f.date_field :created_at_gteq %>
+    <%= f.date_field :created_at_lteq %>
+  </div>
+
+  <div>
+    <%= f.label t("activerecord.attributes.audit.audited_changes") %>
+    <%= f.text_field :raw_audited_changes_cont %>
+  </div>
+
+  <div>
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/audited/ui/audits/index.html.erb

@@ -0,0 +1,70 @@
+<h1><%= title @auditable, @auditable_type %></h1>
+
+<%= render "search_form" %>
+
+<table>
+  <thead>
+    <tr>
+      <% if @auditable_type.blank? %>
+        <th><%=t "activerecord.attributes.audit.auditable_type" %></th>
+      <% end %>
+      <% if @auditable.blank? %>
+        <th><%=t "activerecord.attributes.audit.auditable" %></th>
+      <% end %>
+      <th><%= sort_link @q, :version, t("activerecord.attributes.audit.version") %></th>
+      <th><%= sort_link @q, :created_at, t("activerecord.attributes.audit.created_at") %></th>
+      <th><%=t "activerecord.attributes.audit.action" %></th>
+      <th><%=t "activerecord.attributes.audit.user" %></th>
+      <th colspan="3"><%=t "activerecord.attributes.audit.audited_changes" %></th>
+      <th><%=t "activerecord.attributes.audit.comment" %></th>
+    </tr>
+    <tr>
+      <th colspan="<%= 6 - [@auditable_type, @auditable].compact.size %>"></th>
+      <th><%=t ".attribute" %></th>
+      <th><%=t ".before" %></th>
+      <th><%=t ".after" %></th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% if @audits.any? %>
+      <% @audits.each do |audit| %>
+        <% audit.audited_changes.each_with_index do |(attribute, change), i| %>
+          <tr>
+            <% if i.zero? %>
+              <% if @auditable_type.blank? %>
+                <td rowspan="<%= audit.audited_changes.size %>">
+                  <%= link_to t("activerecord.models.#{audit.auditable_type.underscore.downcase}"), audited_auditable_type_audits_path(audit.auditable_type.underscore.downcase) %>
+                </td>
+              <% end %>
+              <% if @auditable.blank? %>
+                <td rowspan="<%= audit.audited_changes.size %>">
+                  <%= link_to audit.auditable, audited_auditable_audits_path(auditable_type: audit.auditable_type.underscore.downcase, auditable_id: audit.auditable_id) %>
+                </td>
+              <% end %>
+              <td rowspan="<%= audit.audited_changes.size %>"><%= audit.version %></td>
+              <td rowspan="<%= audit.audited_changes.size %>"><%= audit.created_at %></td>
+              <td rowspan="<%= audit.audited_changes.size %>"><%=t ".actions.#{audit.action}" %></td>
+              <td rowspan="<%= audit.audited_changes.size %>"><%= audit.user.try(:email) || t(".system") %></td>
+            <% end %>
+            <td><%=t "activerecord.attributes.#{audit.auditable_type.underscore.downcase}.#{attribute}" %></td>
+            <% if change.is_a? Array %>
+              <td><%= change.first %></td>
+              <td><%= change.last %></td>
+            <% else %>
+              <td></td>
+              <td><%= change %></td>
+            <% end %>
+            <td><%= audit.comment %></td>
+          </tr>
+        <% end %>
+      <% end %>
+    <% else %>
+      <tr>
+        <td colspan="8"><%=t ".empty" %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= paginate @audits %>

data/config/locales/en.yml

@@ -0,0 +1,28 @@
+en:
+  activerecord:
+    attributes:
+      audit:
+        action: Action
+        auditable: Auditable
+        auditable_type: Auditable type
+        audited_changes: Changes
+        comment: Comment
+        created_at: Created at
+        user: User
+        version: Version
+  audited:
+    ui:
+      audits:
+        index:
+          actions:
+            create: Create
+            update: Update
+          after: After
+          attribute: Attribute
+          before: Before
+          empty: There are no audit records yet.
+          system: System
+          title:
+            all: Auditing all records
+            auditable: Auditing %{auditable}
+            auditable_type: Auditing all %{auditable_type}

data/config/locales/es.yml

@@ -0,0 +1,28 @@
+es:
+  activerecord:
+    attributes:
+      audit:
+        action: Acción
+        auditable: Registro auditado
+        auditable_type: Tipo de registro
+        audited_changes: Cambios
+        comment: Comentario
+        created_at: Fecha de creación
+        user: Usuario
+        version: Versión
+  audited:
+    ui:
+      audits:
+        index:
+          actions:
+            create: Creación
+            update: Actualización
+          after: Después
+          attribute: Atributo
+          before: Antes
+          empty: No hay registros de auditoría aún.
+          system: Sistema
+          title:
+            all: Auditoría
+            auditable: Auditando %{auditable}
+            auditable_type: Auditando todos los %{auditable_type}

data/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  scope "audited", module: "audited/ui" do
+    resources :audits, only: :index, as: "audited_audits"
+
+    get "audits/:auditable_type", to: "audits#index", as: "audited_auditable_type_audits"
+    get "audits/:auditable_type/:auditable_id", to: "audits#index", as: "audited_auditable_audits"
+  end
+end

data/lib/audited/ui/engine.rb

@@ -0,0 +1,6 @@
+module Audited
+  module Ui
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/audited/ui/version.rb

@@ -0,0 +1,5 @@
+module Audited
+  module Ui
+    VERSION = "0.1.0"
+  end
+end

data/lib/audited/ui.rb

@@ -0,0 +1,43 @@
+require "audited/ui/version"
+require "audited/ui/engine"
+require "ransack"
+
+module Audited
+  module Ui
+  end
+
+  class Audit < ::ActiveRecord::Base
+    ransacker :raw_audited_changes, type: :text do
+      Arel.sql "audited_changes::text"
+    end
+
+    def self.ransackable_associations(auth_object = nil)
+      [
+        "associated",
+        "auditable",
+        "user"
+      ]
+    end
+
+    def self.ransackable_attributes(auth_object = nil)
+      [
+        "action",
+        "associated_id",
+        "associated_type",
+        "auditable_id",
+        "auditable_type",
+        "audited_changes",
+        "comment",
+        "created_at",
+        "id",
+        "raw_audited_changes",
+        "remote_address",
+        "request_uuid",
+        "user_id",
+        "user_type",
+        "username",
+        "version"
+      ]
+    end
+  end
+end

data/lib/generators/audited/ui/views_generator.rb

@@ -0,0 +1,11 @@
+module Audited
+  module Ui
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../../app/views/audited/ui", __FILE__)
+
+      def copy_views
+        directory :audits, "app/views/audited/ui/audits"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: audited-ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patricio Mac Adden
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: audited
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: ransack
+  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: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A UI for Audited.
+email:
+- patriciomacadden@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/audited/ui/audits_controller.rb
+- app/helpers/audited/ui/audits_helper.rb
+- app/views/audited/ui/audits/_search_form.html.erb
+- app/views/audited/ui/audits/index.html.erb
+- config/locales/en.yml
+- config/locales/es.yml
+- config/routes.rb
+- lib/audited/ui.rb
+- lib/audited/ui/engine.rb
+- lib/audited/ui/version.rb
+- lib/generators/audited/ui/views_generator.rb
+homepage: https://github.com/sinaptia/audited_ui
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sinaptia/audited_ui
+  source_code_uri: https://github.com/sinaptia/audited_ui
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A UI for Audited.
+test_files: []