audited_views 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47781b975820493b0c4183ebc83d5ec10d30dc63
+  data.tar.gz: 1a59ba2b3821cdae2a457128c9629efa4bb177e6
+SHA512:
+  metadata.gz: 7c816f7826c69b8807963ef74dbf3faadb82223304e53ef11b8d111cf184677b584cfc192d2312c384c597e355fbc60570dc766a7f2bc8b62af42589011bb137
+  data.tar.gz: 426bf4f2d3d3f5800788669ee3f1612b1b2492cb49e44026405d197a3e8bee1a33690369a04b0d50a7e1df59982fe6b2a1d1ee76d7876b1b3a76dffb973582b3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Douglas Lise
+
+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

@@ -0,0 +1,35 @@
+# AuditedViews
+Views to show change logs collected by audited gem.
+
+## Usage
+Add this to your `show` views:
+```
+<%= audited_controls(@product) %>
+```
+And this to your `index` views:
+```
+<%= audited_controls(@products) %>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'audited_views'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install audited_views
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+begin
+ require 'bundler/setup'
+rescue LoadError
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/helpers/audited_views_helper.rb

@@ -0,0 +1,115 @@
+module AuditedViewsHelper
+
+  def audited_controls(model)
+    render "controls", model: model
+  end
+
+  #Retorna audits para o model ou para todos os models caso o parâmetro for uma relation ou array
+  #Retorna audits para todos os associados aos models
+  def audits_for(models)
+    models = [models] unless models.kind_of?(Array) || models.kind_of?(ActiveRecord::Relation)
+    audits = []
+    models.each do |model|
+      audits += model.audits#.reject {|a| a.action =~ /create/ }
+      audits += model.associated_audits if model.respond_to?(:associated_audits)
+    end
+    audits.sort do |a,b|
+      b.created_at <=> a.created_at
+    end
+  end
+
+  def audit_link(model, text = nil)
+    text ||= I18n.t("audits.link_text")
+    unless params[:show_log]
+      puts "request.path: '#{request.path}'"
+      link_to "#{request.path}?show_log=true#audits", class: 'btn btn-default pull-right' do
+        text
+      end
+    end
+  end
+
+  def audit_object_info(audit)
+    classe = audit.auditable_type.constantize
+    content_tag(:span, title: "Id #{audit.auditable_id}") do
+      begin
+        begin
+          classe.find(audit.auditable_id).to_s
+        rescue
+          if classe.respond_to?(:with_deleted)
+            classe.with_deleted.find(audit.auditable_id).to_s
+          else
+            raise
+          end
+        end
+      rescue ActiveRecord::RecordNotFound => e
+        I18n.t(:registro_excluido, scope: 'audits')
+      end
+    end
+  end
+
+  def created_by_info(model)
+    html = []
+
+    html << t("audits.created_at")
+    html << ltime(model.created_at)
+    if (nome = get_model_creator(model))
+      html << t("audits.created_by")
+      html << nome
+    end
+
+    raw html.join(" ")
+  end
+
+  def ldate(date)
+    I18n.l(date, format: :data) if date
+  end
+
+  def ltime(time)
+    I18n.l(time, format: :short) if time
+  end
+
+  def format_audited_value(value)
+    case value
+    when true, false
+      t("audited.#{value}_word")
+    when Date
+      ldate value
+    when NilClass
+      "-"
+    when String
+      sanitize(value)
+    else
+      value
+    end
+  end
+
+  def get_model_creator(model)
+    model.audits.where(action: 'create').first.try(:user)
+  end
+
+  def created_by(model)
+    raw [nome_usuario(get_model_creator(model)), ltime(model.created_at)]
+      .compact
+      .delete_if(&:empty?)
+      .join(" - ")
+  end
+
+  def panel_class_for_audit_action(action)
+    case action
+    when "create"  then "panel-success"
+    when "update"  then "panel-info"
+    when "destroy" then "panel-danger"
+    else                "panel-default"
+    end
+  end
+
+  def audit_record_human_field(audit_record, field)
+    # The most of reference field locales are defined only with the association name (not field name)
+    normalized_field = field.gsub(/_id$/, "")
+    audit_record
+      .auditable_type
+      .constantize
+      .human_attribute_name(normalized_field)
+  end
+
+end

data/app/models/audit.rb

@@ -0,0 +1,4 @@
+class Audit < ActiveRecord::Info
+  belongs_to :user, polypmorphic: true
+
+end

data/app/views/application/_audit_record.html.erb

@@ -0,0 +1,55 @@
+<% if audit_record.audited_changes.find{|field, (old_value,new_value)| !old_value.blank? || !new_value.blank? } %>
+  <div class="panel <%= panel_class_for_audit_action(audit_record.action) %>">
+    <div class="panel-heading">
+      <b><%= t(audit_record.action, scope: "audits") %></b> -
+      <%= ltime audit_record.created_at %> -
+      <%= audit_record.user %>
+    </div>
+    <div class="panel-body">
+      <p>
+        <%= audit_record.auditable_type.constantize.model_name.human %>:
+        <b><%= audit_object_info(audit_record) %></b>
+      </p>
+
+      <table class="table audits">
+        <tr>
+          <th><%= t("audits.field") %></th>
+          <th><%= t("audits.old_value") %></th>
+          <th><%= t("audits.new_value") %></th>
+        </tr>
+        <% audit_record.audited_changes.each do |field, (old_value, new_value)| %>
+          <%# if !old_value.blank? || !new_value.blank? %>
+            <tr data-audited-field="<%= field %>">
+              <td>
+                <%= audit_record_human_field(audit_record, field) %>
+              </td>
+              <% if audit_record.action == "update" && audit_record.auditable_type.constantize.column_for_attribute(field.to_sym).type == :text %>
+                <td colspan="2" class="diff">
+                  <%= sanitize Differ.diff(new_value, old_value).format_as(:html) %>
+                </td>
+              <% else %>
+                <td>
+                  <% if audit_record.action == "create" %>
+                    -
+                  <% else %>
+                    <%= format_audited_value old_value %>
+                  <% end %>
+                </td>
+                <td>
+                  <% if audit_record.action == "create" %>
+                    <!-- #Como audited changes so possui um elemento no array de campos, aqui ele aparece no primeiro elemento, logo old_value do parametro do bloco -->
+                    <%= format_audited_value old_value  %>
+                  <% elsif audit_record.action == "destroy" %>
+                    -
+                  <% else %>
+                    <%= format_audited_value new_value %>
+                  <% end %>
+                </td>
+              <% end %>
+            </tr>
+          <%# end %>
+        <% end %>
+      </table>
+    </div>
+  </div>
+<% end %>

data/app/views/application/_audits.html.erb

@@ -0,0 +1,7 @@
+<a name="audits"></a>
+<hr>
+<h2><%= t("audits.partial_title") %></h2>
+
+<% audits_for(model).each do |audit| %>
+  <%= render partial: "audit_record", locals: {audit_record: audit} %>
+<% end %>

data/app/views/application/_controls.html.erb

@@ -0,0 +1,10 @@
+<hr>
+
+<% if model.is_a?(ActiveRecord::Base) %>
+  <span class="audit-created-at">
+    <%= created_by_info(model) %>
+  </span>
+<% end %>
+
+<%= audit_link(model) %>
+<%= render "audits", model: model if params[:show_log] %>

data/config/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  audits:
+    field: Field
+    create: Creation
+    created_at: Created at
+    created_by: by
+    data_hora: Date/Time
+    destroy: Exclusion
+    link_text: Show Change Log
+    model: Table
+    new_value: New Value
+    old_value: Old Value
+    registro: Record
+    registro_excluido: Deleted Record
+    partial_title: Change Log
+    update: Update
+    usuario: User
+    true_word: Yes
+    false_word: No

data/config/locales/pt-BR.yml

@@ -0,0 +1,19 @@
+pt-BR:
+  audits:
+    field: Campo
+    create: Criação
+    created_at: Registro criado em
+    created_by: por
+    data_hora: Data/Hora
+    destroy: Exclusão
+    link_text: Visualizar Log de Alterações
+    model: Tabela
+    new_value: Novo Valor
+    old_value: Valor Anterior
+    registro: Registro
+    registro_excluido: Registro Excluído
+    partial_title: Log de Alterações
+    update: Alteração
+    usuario: Usuário
+    true_word: Sim
+    false_word: Não

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :products
+end

data/lib/audited_views.rb

@@ -0,0 +1,5 @@
+require "audited_views/engine"
+
+module AuditedViews
+  # Your code goes here...
+end

data/lib/audited_views/engine.rb

@@ -0,0 +1,4 @@
+module AuditedViews
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/audited_views/version.rb

@@ -0,0 +1,3 @@
+module AuditedViews
+  VERSION = '0.0.1'
+end

data/lib/tasks/audited_views_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :audited_views do
+#   # Task goes here
+# end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/products_controller.rb

@@ -0,0 +1,58 @@
+class ProductsController < ApplicationController
+  before_action :set_product, only: [:show, :edit, :update, :destroy]
+
+  # GET /products
+  def index
+    @products = Product.all
+  end
+
+  # GET /products/1
+  def show
+  end
+
+  # GET /products/new
+  def new
+    @product = Product.new
+  end
+
+  # GET /products/1/edit
+  def edit
+  end
+
+  # POST /products
+  def create
+    @product = Product.new(product_params)
+
+    if @product.save
+      redirect_to @product, notice: 'Product was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT /products/1
+  def update
+    if @product.update(product_params)
+      redirect_to @product, notice: 'Product was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  # DELETE /products/1
+  def destroy
+    @product.destroy
+    redirect_to products_url, notice: 'Product was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_product
+      @product = Product.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def product_params
+      params.require(:product).permit(:sku, :title, :price, :active, :description)
+    end
+end