approval2 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDljMWE3ODNiZjFjMzJhODEyN2MwZDRiYTQ1ZWUxM2IxNzZkZmY4MA==
+    YzM2YjVmY2EwOTRlOTk1MmQ3ZGQ4NTRhYzU5N2ZlNTUwOWM4NmNiMw==
   data.tar.gz: !binary |-
-    YzYxODYyNjBlNmJkZWM5MDc4MmRmMDc3YmZiZjhiY2FjZjEyMWMzOA==
+    NGIxYTM1NDY5ZGRmNmE0MDc2MzNjYzJkNzhhMTJmOWI0MTlmOWFhMA==
 SHA512:
   metadata.gz: !binary |-
-    ODE3M2FlNDMzMTM0YzU2NGQ0NGQwZTUyYTVhZTMzODdhZTkzODM0N2MzY2E3
-    OWMxYmFmZGY2NzcwNTJhNDY3ZWMwYjNjZjY5MGE4OTI5MTdjY2Y3ZmRiYjJj
-    MTI4MTUxZTkxYjE5ODcyOWU5ZGFmZjQzNTA2ZTI4OGQyMjg1MDg=
+    NWVjNGIxMGI0ZTRkNTk5NGQ0MDU5ZjQ3YzM3Y2Y1Nzk5MGJhMzI0MWU5Nzg4
+    MmEwYjYyOWVmYWY2NTcyN2NmYTRjNzQ5NDA2MjEwMTc2MmJiZTg5YTZhNGM0
+    MTg0ZGVlOGE1M2IxMjc2MWUyYmZkZDM5ODA2ZDVhMmM3NmIyM2E=
   data.tar.gz: !binary |-
-    OGFlOGQyOTlhYjQ5NzBmMDQ4OGIwMmU4Mzg3ZWY0YjZlZjkwYzQ0MDI2NzQ5
-    Nzk0ZDg5MGFlZmI1OTA1ZTVkYzNiZjRkZTcyMzc2NTE4YTQ4ZWFjNmQwYmI2
-    Yzg2MmQ0MTYwYmIzZTNkNzg3OTdhOWJlY2ZkY2E3ZDUzMDUwM2I=
+    MmU4NGY2ZTdkZjZiMzE0YWNkNDdiYmFkMmM4OTUyMGVhYTEzYjM3YmZjZGI3
+    ODViMmU0MDY1ZTllMDU0NGQ3MTlhOGQyZGZlNmM5MGNlYjNkMDFhNGJiOWIw
+    N2Q5MGI3YmE5NTVkZTA3NzQxYWJjNGE5Mjg1ODYwMjM2YTMwOTk=

data/README.md

@@ -2,6 +2,10 @@
 
 A trivial implementation of the 4 eyes principle. All record actions require an approval to take effect.
 
+Models that require an approval have a column called approval_status, a value of U implies that the record is un-approved, and a value of A implies that the record is approved.
+
+A default scope on the model ensures that only records with approval_status = 'A' are used.
+
  
 ## Installation
 
@@ -21,15 +25,42 @@ Or install it yourself as:
 
 ## Usage
 
-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.
+The gem provides a generator to get started
+
+```ruby
+rails g approval2:install
+```
+This creates a migration for unapproved_records, and its associated model & controller. This is used to keep track of all unapproved records across the application, and can be used to create an 'approval worklist'.
 
-Doing so adds the following columns to the model
+Models that need an approval, should have the following columns 
 
 1. approval_status
 2. approved_version
 3. approved_id
 4. last_action
 
+These columns can be added by calling 'approval_columns' in the migration. This method is added by the gem to the TableGeneator.
+
+In addition to these columns, the model should include the module Approval2::ModelAdditions in its class.
+
+The gem does not yet modify the routes, and an approve action needs to be added for each model manually. 
+
+All unique indexes on the model need to be modified to include 'approval_status' as an additional column, this is required because the Edit action creates a new record. 
+
+## The Approval Cycle
+
+### Create
+When a record is created, it has approval_status 'U', and a entry is added to unapproved_records. 
+When the record is approved, the approval_status is updated from 'U' to 'A' 
+
+### Edit
+When a record is edited, a clone of the record is created. This clone has approval_status = 'U and the approved_version and approved_id is set to the id & lock_version of the record that was edited. This clone is persisted, and you now have 2 records in the table, one with approval_status = A (the record that was edited, but without any changes), and one with approval_status = U (the clone, with the changes applied). 
+When the changes are approved, the record with approval_status = 'A' is deleted, and the approval_status of the cloned record is changed from 'U' to 'A'. To prevent buried updates, this is done only if the lock_version of the A record is still the same as the approved_version of the U record . ( It is expected that any application that updates such records increments lock_version whenever it updates an A record)
+
+
+
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/approval2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/approval2/model_additions.rb

@@ -31,7 +31,7 @@ module Approval2
     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    
+       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'
@@ -43,6 +43,7 @@ module Approval2
       if self.approved_record.nil?
         # create action, all we need to do is set the status to approved
         self.approval_status = 'A'
+        self.save!
       else
         # copy all attributes of the U record to the A record, and delete the U record
         attributes = self.attributes.select do |attr, value|
@@ -87,4 +88,4 @@ module Approval2
       end
     end 
   end
-end
+end

data/lib/approval2/version.rb

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

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

@@ -1,4 +1,4 @@
-class CreateUnApprovedRecords < ActiveRecord::Migration
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: approval2
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - akil
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-08 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler