approval2 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Njc2M2YwOTYwNmM0MzM3ZmE0MTE0NzFmNjJhNzBhZGFlMGY3ZWJjYw==
+    NDljMWE3ODNiZjFjMzJhODEyN2MwZDRiYTQ1ZWUxM2IxNzZkZmY4MA==
   data.tar.gz: !binary |-
-    Mjc4YzNlOWFmZTIxZGM5ZDYwYmZkN2FhYTZjZmY2OGE4MjY2NjNjYg==
+    YzYxODYyNjBlNmJkZWM5MDc4MmRmMDc3YmZiZjhiY2FjZjEyMWMzOA==
 SHA512:
   metadata.gz: !binary |-
-    ODE5YWUxYWM0NjFhNWQ3ZmRiYjliMWE2ZjIxYmFkODUyNjYxYjcwMWFhZWEz
-    NTAyNjIyMmE1NmQxNzc5N2ExYTZhMDlkODNlYzQxOGZkYzQxM2NlMzZiZGIz
-    MWJhNzJlZTE2MjhmYTFjYTYxODdlYjM3ZDBkYmQ2NzZhNDZmZDg=
+    ODE3M2FlNDMzMTM0YzU2NGQ0NGQwZTUyYTVhZTMzODdhZTkzODM0N2MzY2E3
+    OWMxYmFmZGY2NzcwNTJhNDY3ZWMwYjNjZjY5MGE4OTI5MTdjY2Y3ZmRiYjJj
+    MTI4MTUxZTkxYjE5ODcyOWU5ZGFmZjQzNTA2ZTI4OGQyMjg1MDg=
   data.tar.gz: !binary |-
-    MjI0NTk4NzFjMTE2OTM1M2JkMWQ5ODAzNDVkMmMzYjk4OTY3NGFkZjY4OWVm
-    Yzc2ZjRlOWEzZGVhYjExNWQzNDg5NGJkYjE4ODE5ZWFiYmQxMzg4ZGExZGYz
-    ZTNkMTM1OTZkZjllNzM1YTdmYjc1MmY5NWRmOWQ3OWVmY2NkNjc=
+    OGFlOGQyOTlhYjQ5NzBmMDQ4OGIwMmU4Mzg3ZWY0YjZlZjkwYzQ0MDI2NzQ5
+    Nzk0ZDg5MGFlZmI1OTA1ZTVkYzNiZjRkZTcyMzc2NTE4YTQ4ZWFjNmQwYmI2
+    Yzg2MmQ0MTYwYmIzZTNkNzg3OTdhOWJlY2ZkY2E3ZDUzMDUwM2I=

data/README.md

@@ -1,9 +1,8 @@
 # Approval2
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/approval2`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A trivial implementation of the 4 eyes principle. All record actions require an approval to take effect.
 
+ 
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,13 +21,14 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+Models that need an approval, should have the standard approval columns (can be added by included t.approval_columns) and should include include Approval2::ModelAdditions in the class.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Doing so adds the following columns to the model
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. approval_status
+2. approved_version
+3. approved_id
+4. last_action
 
 ## Contributing
 

data/approval2.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "audited"
+  spec.add_dependency "will_paginate"
 end

data/lib/approval2/active_record_adapter.rb

@@ -0,0 +1,10 @@
+module ActiveRecord::ConnectionAdapters
+  class TableDefinition
+    def approval_columns(*args)
+      column(:approval_status, :string, limit: 1, default: 'U', null: false, comment: "the approval status of the record, A (approved), U (unapproved)")
+      column(:last_action, :string, limit: 1, default: 'C', comment: "the last action on the record, C (create), U (update), D (delete)")
+      column(:approved_id, :integer, comment: "the id of the approved record that was edited, and resulted in this unapproved record ")
+      column(:approved_version, :integer, comment: "the lock_version of the approved record at the time it was edited, and resulted in this unapproved record")
+    end
+  end
+end

data/lib/approval2/controller_additions.rb

@@ -0,0 +1,61 @@
+module Approval2
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :before_edit, only: :edit
+      before_filter :before_approve, only: :approve
+      before_filter :before_index, only: :index
+    end
+
+    def approve
+    end
+
+    private 
+
+    def before_index
+      if (params[:approval_status].present? and params[:approval_status] == 'U')      
+        modelName = self.class.name.sub("Controller", "").underscore.split('/').last.singularize
+        modelKlass = modelName.classify.constantize
+
+        x = modelKlass.unscoped.where("approval_status =?",'U').order("id desc")
+        instance_variable_set("@#{modelName}s", x.paginate(:per_page => 10, :page => params[:page]))
+      end
+    end
+
+    def before_edit
+      modelName = self.class.name.sub("Controller", "").underscore.split('/').last.singularize
+      modelKlass = modelName.classify.constantize
+
+      x = modelKlass.unscoped.find_by_id(params[:id])
+      if x.approval_status == 'A' && x.unapproved_record.nil?
+        params = (x.attributes).merge({:approved_id => x.id,:approved_version => x.lock_version})
+        x = modelKlass.new(params)
+      end
+
+      instance_variable_set("@#{modelName}", x)
+    end
+
+    def before_approve
+      modelName = self.class.name.sub("Controller", "").underscore.split('/').last.singularize
+      modelKlass = modelName.classify.constantize
+
+      x = modelKlass.unscoped.find(params[:id]) rescue nil
+      modelKlass.transaction do
+        approval = x.approve
+        if approval.empty?
+          flash[:alert] = "#{modelName.humanize.titleize} record was approved successfully"
+        else
+          msg = x.errors.full_messages << approval
+          flash[:alert] = msg
+          raise ActiveRecord::Rollback
+        end
+      end
+      redirect_to x
+    end    
+  end
+end
+
+ActionController::Base.class_eval do
+  include Approval2::ControllerAdditions
+end

data/lib/approval2/model_additions.rb

@@ -0,0 +1,90 @@
+module Approval2
+  module ModelAdditions
+    extend ActiveSupport::Concern
+
+    included do
+      audited except: [:approval_status, :last_action]
+ 
+      # refers to the unapproved record in the common unapproved_record model, this is true only for U records
+      has_one :unapproved_record_entry, :as => :approvable, :class_name => '::UnapprovedRecord'
+ 
+      # refers to the approved/unapproved record in the model
+      belongs_to :unapproved_record, :primary_key => 'approved_id', :foreign_key => 'id', :class_name => self.name, :unscoped => true
+      belongs_to :approved_record, :foreign_key => 'approved_id', :primary_key => 'id', :class_name => self.name, :unscoped => true
+
+      validates_uniqueness_of :approved_id, :allow_blank => true
+      validate :validate_unapproved_record
+
+      def self.default_scope
+        where approval_status: 'A'
+      end
+
+
+      after_create :on_create_create_unapproved_record_entry
+      after_destroy :on_destory_remove_unapproved_record_entries
+      after_update :on_update_remove_unapproved_record_entries
+
+    end
+
+    def validate_unapproved_record
+      errors.add(:base,"Unapproved Record Already Exists for this record") if !unapproved_record.nil? and (approval_status == 'A' and approval_status_was == 'A')
+    end
+
+    def approve
+      return "The record version is different from that of the approved version" if !self.approved_record.nil? and self.approved_version != self.approved_record.lock_version    
+
+  #    make the U the A record, also assign the id of the A record, this looses history
+  #    self.approval_status = 'A'
+  #    self.approved_record.delete unless self.approved_record.nil?
+  #    self.update_column(:id, self.approved_id) unless self.approved_id.nil?   
+  #    self.approved_id = nil
+
+
+      if self.approved_record.nil?
+        # create action, all we need to do is set the status to approved
+        self.approval_status = 'A'
+      else
+        # copy all attributes of the U record to the A record, and delete the U record
+        attributes = self.attributes.select do |attr, value|
+          self.class.column_names.include?(attr.to_s) and 
+          ['id', 'approved_id', 'approval_status', 'lock_version', 'approved_version', 'created_at', 'updated_at', 'updated_by', 'created_by'].exclude?(attr)
+        end
+      
+        self.class.unscoped do
+          approved_record = self.approved_record
+          approved_record.assign_attributes(attributes)
+          approved_record.last_action = 'U'
+          approved_record.updated_by = self.created_by
+          self.destroy
+          # not enought time to test cases where the approval is being done after changes in validations of the model, such that the saving of the approved 
+          # record fails, this can be fixed to return the errors so that they can be shown to the user
+          approved_record.save!
+        end
+      end
+    
+      return ""
+    end
+
+    def enable_approve_button?
+      self.approval_status == 'U' ? true : false
+    end
+
+      def on_create_create_unapproved_record_entry
+      if approval_status == 'U'
+        UnapprovedRecord.create!(:approvable => self)
+      end
+    end
+  
+    def on_destory_remove_unapproved_record_entries
+      if approval_status == 'U'
+        unapproved_record_entry.delete
+      end
+    end
+  
+    def on_update_remove_unapproved_record_entries
+      if approval_status == 'A' and approval_status_was == 'U'
+        unapproved_record_entry.delete
+      end
+    end 
+  end
+end

data/lib/approval2/version.rb

@@ -1,3 +1,3 @@
 module Approval2
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/approval2.rb

@@ -1,5 +1,4 @@
 require "approval2/version"
-
-module Approval2
-  # Your code goes here...
-end
+require "approval2/controller_additions"
+require "approval2/model_additions"
+require 'approval2/active_record_adapter.rb'

data/lib/generators/approval2/install/install_generator.rb

@@ -0,0 +1,37 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Approval2
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations for unapproved_records"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template "create_unapproved_records.rb", "db/migrate/create_unapproved_records.rb"
+      end
+
+      def copy_models
+        copy_file "unapproved_record.rb", "#{Rails.root}/app/models/unapproved_record.rb"
+      end
+
+      def copy_views
+        ["index.html.haml", "_approve.html.haml"].each do |v|
+          copy_file v, "#{Rails.root}/app/views/unapproved_records/#{v}"
+          copy_file v, "#{Rails.root}/app/views/unapproved_records/#{v}"
+        end
+      end
+      
+      def copy_controllers
+        copy_file "unapproved_records_controller.rb", "#{Rails.root}/app/controllers/unapproved_records_controller.rb"
+      end
+      
+    end
+  end
+end

data/lib/generators/approval2/install/templates/_approve.html.haml

@@ -0,0 +1,15 @@
+- can = can? :approve, @record
+- approve_flag = @record.enable_approve_button?
+%a.btn{"data-toggle" => "modal", :href => "#{!(can && approve_flag) ? '#' : '#myModalApprove'}", :role => "button", :class => "btn btn-primary #{(can && approve_flag) ? '' : 'disabled'}"} Approve
+.modal.hide.fade{"id" => "myModalApprove", "aria-hidden" => "true", "aria-labelledby" => "  myModalLabel", :role => "dialog", :tabindex => "-1"}
+  .modal-header
+    %button.close{"aria-hidden" => "true", "data-dismiss" => "modal", :type => "button"} ×
+    %h3#myModalLabel  Acknowledge
+    #error_message{:style => 'color:red'}
+  .modal-body
+    = simple_form_for @record, :url => {:action => 'approve'}, :method => :put, :html=>{:id=>"transition"} do |ef|
+      = ef.input :updated_by, :as => :hidden, :input_html => {:value => current_user.id}
+      = submit_tag "Confirm", :class=>"btn btn-primary transition_button", :id => "transition_button"
+%p{:style => 'color:green;'}
+  = created_or_edited_by(@record)
+%br

data/lib/generators/approval2/install/templates/create_unapproved_records.rb

@@ -0,0 +1,11 @@
+class CreateUnApprovedRecords < ActiveRecord::Migration
+  def change
+    create_table :unapproved_records, {:sequence_start_value => '1 cache 20 order increment by 1'} do |t|
+      t.integer :approvable_id
+      t.string :approvable_type
+      t.timestamps null: false      
+
+      t.index([:approvable_id, :approvable_type], unique: true, name: :uk_unapproved_records)
+    end
+  end
+end

data/lib/generators/approval2/install/templates/index.html.haml

@@ -0,0 +1,23 @@
+%br
+%h1 Unapproved Records
+%br
+- unless @records.nil?
+  %br
+  = will_paginate @records
+  %br
+  %table.table.table-bordered.table-striped.table-hover
+    .thead
+      %th{:style=>'text-align:left; background-color: lightblue;'}
+        Record Type
+      %th{:style=>'text-align:left; background-color: lightblue;'}
+        Record Count
+    .tbody
+      - @records.each do |record|
+        %tr
+          %td{:style=>'text-align:left;'}
+            = record[:record_type]
+          %td{:style=>'text-align:left;'}
+            - if record[:record_type] == 'IncomingFile'
+              = link_to record[:record_count], {:controller => record[:record_type].tableize, :action => :index, :approval_status => 'U', :sc_service => 'AML'}
+            - else
+              = link_to record[:record_count], {:controller => record[:record_type].tableize, :action => :index, :approval_status => 'U'}

data/lib/generators/approval2/install/templates/unapproved_record.rb

@@ -0,0 +1,3 @@
+class UnapprovedRecord < ActiveRecord::Base
+  belongs_to :approvable, :polymorphic => true, :unscoped => true
+end

data/lib/generators/approval2/install/templates/unapproved_records_controller.rb

@@ -0,0 +1,15 @@
+require 'will_paginate/array'
+
+class UnapprovedRecordsController < ApplicationController
+  def index
+    result = []
+    UnapprovedRecord.distinct.select(:approvable_type).each do |m|
+      if m.approvable_type.constantize.column_names.include?('approval_status')
+        count = UnapprovedRecord.where("approvable_type =?", m.approvable_type).count 
+        result << {:record_type => m.approvable_type, :record_count => count}
+      end
+    end
+
+    @records = result.paginate(:per_page => 10, :page => params[:page]) rescue []
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: approval2
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - akil
@@ -38,6 +38,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: audited
+  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: will_paginate
+  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'
 description: 
 email:
 - akhilesh.kataria@quantiguous.com
@@ -55,7 +83,16 @@ files:
 - bin/console
 - bin/setup
 - lib/approval2.rb
+- lib/approval2/active_record_adapter.rb
+- lib/approval2/controller_additions.rb
+- lib/approval2/model_additions.rb
 - lib/approval2/version.rb
+- lib/generators/approval2/install/install_generator.rb
+- lib/generators/approval2/install/templates/_approve.html.haml
+- lib/generators/approval2/install/templates/create_unapproved_records.rb
+- lib/generators/approval2/install/templates/index.html.haml
+- lib/generators/approval2/install/templates/unapproved_record.rb
+- lib/generators/approval2/install/templates/unapproved_records_controller.rb
 homepage: http://quantiguous.com
 licenses:
 - MIT