mongoid-pending_changes 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bd82313b3257fc4ad09831d3e0eb69d3e7476fb
-  data.tar.gz: 3d2e1f5ae522957bcaeb3f9cf118a614fa767379
+  metadata.gz: 6dce5a15518ca9176d773b7a3364788f96e4581d
+  data.tar.gz: 787ff3f834156ec643507b2036e5d25ecfb00e44
 SHA512:
-  metadata.gz: d64d2fc2a53a055b47d45027d18611230cdae57312d4154017ca50af92d0c207d9877038e5f687432e720e3839c1e226ec74527fa8ee9ff2227161b46abc1ee0
-  data.tar.gz: 3aa68495c2b686e84d74d0e50680f30e3873fab655931d7c68033f76dba06d1e85222423afaea40dd720c0b88a4d95f66611507b5761ed1841528f683c9af02f
+  metadata.gz: e9507da094c0945f4ba81bf5a19b324810d6d6b3bea8d097acf78347ad804068b3ae1fd7893cc18e15436f792ec71fef3c9de4433f594ce42b8b10dec907e363
+  data.tar.gz: 4b33a0475a311829cd7389332588139151b9e5b0a13a5e0de6298fa34af5737f640d98c9e8842836ce0916fc0479e7820e0536a7cc9efbb0f38ca20efe4d062d

data/README.md

@@ -10,6 +10,9 @@ This is an initial effort to develop an approval system to control changes to co
 
 ## Change Log
 
+v0.4.0: 
+Creating the `appendable` helper, which flags an Array field as a collection of values. When applying changes for appendable fields, instead of replacing them.
+
 v0.3.0:
 Adding methods '#apply_change' and '#reject_change'
 
@@ -80,5 +83,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Bug reports and pull requests are welcome on GitHub at https://github.com/matheus208/mongoid-pending_changes.
 
 ## TODO list
- * Write the TODO list
-
+ * Create a class to represent a "Change" (instead of using arrays)
+ * Make `appendable` work for Hashes.
+ * Create options for `appendable`, like: whether or not it merges two arrays (or it just appends the second array to the first, creating a nested array), how to make a change remove or replace the field, instead of appending to it, etc...
+ * Have a conversion modifier parameter when applying changes. E.g.: when applying change, pass a block that will receive the change data as a parameter, and could modify it (useful for converting between different versions maybe?)
+ * Test if it works on relations. (I.e. change with a relation swap)
+ * Enforce type on changes.
+ * ... Complete the TODO list

data/lib/mongoid/pending_changes/pending_changes.rb

@@ -4,6 +4,7 @@ module Mongoid
   module PendingChanges
     extend ActiveSupport::Concern
     GLOBAL_PENDING_CHANGES_FLAG = 'mongoid_pending_changes_enabled'
+
     included do
       include Mongoid::Document
 
@@ -11,6 +12,9 @@ module Mongoid
       field :last_version, type: Integer
       field :changelist, type: Array
 
+      mattr_accessor :__appendable_fields
+
+
       before_create do
         self.version = 0
         self.last_version = 0
@@ -77,6 +81,13 @@ module Mongoid
       end
 
       private
+
+        def self.appendable(field)
+          #Make it private so we can one set a field as appendable on the Class definition, not on Runtime (is this the best idea?)
+          self.__appendable_fields ||= []
+          self.__appendable_fields << field
+        end
+
         def apply(data)
           backup = {}
 
@@ -87,10 +98,30 @@ module Mongoid
               backup[field] = self[field]
             end
             #Update
-            self[field] = value
+            incorporate_change field, value
           end
 
           backup
+        end
+
+        def incorporate_change(field, value)
+          #Check if this field is appendable or not
+
+          if self.__appendable_fields && self.__appendable_fields.include?(field.intern)
+            #Append
+            self[field] ||= []
+            if value.is_a? Array
+              #Append all values
+              self.set "#{field}" => self[field] + value
+            else
+              #Append single value
+              self.set "#{field}" => self[field].push(value)
+            end
+
+          else
+            #Replace
+            self.set "#{field}" => value
+          end
 
         end
 

data/lib/mongoid/pending_changes/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module PendingChanges
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-pending_changes
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - matheus208
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler