approvable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: b8c9ad5fa11f3a6ca079cc935124013edace0ce5
-  data.tar.gz: 727445aa21a877ea3340f9f07aeb83a87188b1ab
+  metadata.gz: 44c15bf9a39dd40e95b9d8455bf00c5bdcd44824
+  data.tar.gz: b91c51047334ead882747819116a498858a42c88
 SHA512:
-  metadata.gz: 4151b5d043c9766856283cee5cbb6e837cb5600e68cbf4ef82e4664b4c76911038af4cefd84c3d71c5abd12647d8b18f4805bca3859e15b488ca46f9adff51ad
-  data.tar.gz: af85d4ccc38564186c27f9b7978733fd3dd75ee0719454d93602d00c3e361b496a1804c7f088231bf0e5d2ddbf308f9b096eedcf862265825c157a9582f5053e
+  metadata.gz: 7f2c4b284e223bd22b5139b0d1d98cc2597fa3d5a580c6294d11510f52a618b773632dbf40e040060ee375ddc106c9dafc2efc80a303e5aaf2b83e640197f157
+  data.tar.gz: 8155feb1924e39a3aa114c67d5147481fdf3036e3645c32394e68a942489246b51060f1b5f784c422c2ff8acb3597463f28a1487502143b69f4058a26ee72d85

data/app/models/approvable/change_request.rb

@@ -1,54 +1,69 @@
 module Approvable
   class ChangeRequest < ActiveRecord::Base
-    belongs_to :approvable, :dependent => :destroy, :polymorphic => true
+    belongs_to :approvable, :polymorphic => true
     belongs_to :approver, :polymorphic => true
 
     validate :no_outstanding_change_requests, on: :create
-    validate :not_submitted_or_approved, if: :requested_changes_changed?
+    # validate :not_submitted_or_approved, if: :requested_changes_changed?
 
     after_save :update_rejected_to_pending, if: :requested_changes_changed?
     
     scope :unapproved, -> {where.not(state: 'approved')}
     
-    state_machine :initial => :pending do        
+    include AASM
+    
+    aasm column: :state do
+      
+      state :pending, :initial => true
+      state :submitted
+      state :rejected
+      state :approved
+      
       event :submit do
-        transition [:rejected, :pending] => :submitted
+        transitions from: [:rejected, :pending], to: :submitted
       end
       
       event :unsubmit do
-        transition :submitted => :pending
+        transitions from: :submitted, to: :pending
       end
 
       event :approve do
-        transition :submitted => :approved
+        transitions from: :submitted, to: :approved
       end
-
+      
       event :reject do
-        transition :submitted => :rejected
+        transitions from: :submitted, to: :rejected, :on_transition => Proc.new {|obj, *args| obj.transition_options(*args)}
       end
       
       event :unreject do
-        transition :rejected => :pending
+        transitions from: :rejected, to: :pending
       end
     end
     
+    def transition_options(options = {})
+      note = options[:note] if options
+      self.notes_will_change! if note
+      self.notes ||= {}
+      self.notes[Time.now.to_s] = note if note      
+    end
+    
     private
     
     def not_submitted_or_approved
-      if approved? || submitted? 
+      if ['approved', 'submitted'].include? state_was
         errors.add(:base, "cannot change a #{state} request")
       end
     end
-    
+
     def no_outstanding_change_requests
       if self.class.where(approvable: approvable).unapproved.any?
         errors.add(:base, 'please use the existing change request')
-      end  
+      end
     end
     
     def update_rejected_to_pending
       if rejected?
-        unreject
+        unreject!
       end
     end
     

data/db/migrate/20140807145534_create_approvable_change_requests.rb

@@ -3,7 +3,7 @@ class CreateApprovableChangeRequests < ActiveRecord::Migration
     create_table :approvable_change_requests do |t|
       t.string :approvable_type
       t.integer :approvable_id
-      t.json :requested_changes
+      t.json :requested_changes, default: {}
       t.string :state
       t.string :approver_type
       t.integer :approver_id

data/db/migrate/20140809183112_add_notes_to_approvable_change_requests.rb

@@ -0,0 +1,5 @@
+class AddNotesToApprovableChangeRequests < ActiveRecord::Migration
+  def change
+    add_column :approvable_change_requests, :notes, :json, default: {}
+  end
+end

data/lib/approvable/acts_as_approvable.rb

@@ -6,78 +6,143 @@ module Approvable
     end
  
     module ClassMethods
-      def acts_as_approvable(options = {})
+      def acts_as_approvable **options      
         include Approvable::ActsAsApprovable::LocalInstanceMethods
 
-        has_many :change_requests, as: :approvable, class_name: 'Approvable::ChangeRequest'
-        has_one :current_change_request, -> {where.not(state: 'approved') }, as: :approvable, class_name: 'Approvable::ChangeRequest'
-                
-        alias_method_chain :save, :change_request
-        alias_method_chain :save!, :change_request
-        accepts_nested_attributes_for :current_change_request, update_only: true
+        has_many :change_requests, as: :approvable, class_name: 'Approvable::ChangeRequest', dependent: :destroy
+        has_one :current_change_request, -> {where.not(state: 'approved') }, as: :approvable, class_name: 'Approvable::ChangeRequest', autosave: true
+        
+        before_save :apply_changes, if: :auto_approve?
+        after_save :force_approve!, if: :auto_approve?
         
+        cattr_accessor :filter_attrs, :filter_type
+        if options[:except]
+          self.filter_type = :except
+          self.filter_attrs = options[:except]
+        elsif options[:only]
+          self.filter_type = :only
+          self.filter_attrs = options[:only]
+        else
+          self.filter_type = :except
+          self.filter_attrs = []
+        end
+                
+        unless method_defined?(:assign_attributes_without_change_request)
+          alias_method_chain :assign_attributes, :change_request
+          alias_method :attributes=, :assign_attributes_with_change_request
+          
+        end
       end
+
     end
     
     module LocalInstanceMethods
+               
+      def requested_changes
+        current_change_request ? current_change_request.requested_changes.with_indifferent_access : {}
+      end
       
+      # use current_change_request here so that we dont get pending from a newly built change_request
       def change_status
-        current_change_request.state if current_change_request
+        current_change_request ? current_change_request.state : 'approved'
       end
-      
-      def with_changes
-        self.attributes = current_change_request.requested_changes || {}
+
+      def change_status_notes
+        current_change_request ? current_change_request.notes : {}
+      end
+            
+      def apply_changes
+        self.assign_attributes_without_change_request requested_changes
         self
       end
       
       def submit_changes
-        current_change_request.submit
+        transaction do
+          current_change_request.submit! if current_change_request
+          reload
+        end 
       end
       
       def unsubmit_changes
-        current_change_request.unsubmit
+        transaction do
+          current_change_request.unsubmit! if current_change_request
+          reload
+        end
       end
       
       def approve_changes
-        if with_changes.save_without_change_request
-          current_change_request.approve
+        transaction do
+          current_change_request.approve! if current_change_request
+          apply_changes.save
+          reload
         end
       end
       
-      def reject_changes
-        current_change_request.reject
+      def reject_changes options = {}
+        current_change_request.reject! :rejected, options if current_change_request
+        reload
       end
       
-      private
+      def assign_attributes_with_change_request new_attributes
+        ignored_params = ignored_attributes(new_attributes)
+        approvable_params = approvable_attributes(new_attributes)
+
+        if approvable_params.any?
+          current_change_request || build_current_change_request(requested_changes: {})       
+          current_change_request.requested_changes = requested_changes.merge approvable_params
+        end
       
-      def existing_changes
-        current_change_request.try(:requested_changes) || {}
-      end
+        assign_attributes_without_change_request ignored_params
+      end      
+
+      private
       
-      def new_changes
-        self.attributes.select {|k,v| changed_attributes.keys.include? k}
+      def ignored_attributes(new_attributes)
+        process_nested_hash(new_attributes, self.class.filter_attrs, filter_type == :except)
       end
-        
       
-      def all_changes
-        existing_changes.merge new_changes
+      def approvable_attributes(new_attributes)
+        process_nested_hash(new_attributes, self.class.filter_attrs, filter_type == :only )
       end
       
-      def move_changes_to_change_request
-        self.current_change_request_attributes = {requested_changes: all_changes}
-        self.attributes = self.changed_attributes
+      # h = {"first_name"=>"Leif", "last_name"=>"Gensert", "address"=>{"street"=>"Preysinstraße", "city"=>"München"}}
+      def process_nested_hash(attributes, keys, should_match)
+        attributes = attributes.dup.stringify_keys!
+        hash = {}
+        [*keys].each do |key|
+          if key.is_a? Hash
+            key.each do |k,v| 
+              hash[k.to_s] = process_nested_hash(attributes[k.to_s], v, should_match) if attributes[k.to_s]
+            end
+          elsif key.is_a? Array
+            key.each do|k|
+              process_nested_hash(attributes[k.to_s], k, should_match) if attributes[k.to_s]
+            end
+          else
+            value = attributes.delete(key.to_s)  
+            hash[key.to_s] = value if value
+          end
+        end
+        
+        if should_match
+          return hash
+        else
+          return attributes
+        end
+        
       end
+
+      # process_nested_hash h, [:first_name, {address: :street}], true
+      # process_nested_hash h, [:first_name, {address: :street}], false
       
-      def save_with_change_request
-        move_changes_to_change_request
-        save_without_change_request
+      def auto_approve?
+        Approvable.auto_approve == true
       end
       
-      def save_with_change_request!
-        move_changes_to_change_request
-        save_without_change_request!
+      def force_approve!
+        current_change_request.update_column :state, 'approved' if current_change_request
       end
-      
+
     end
   end
 end

data/lib/approvable/engine.rb

@@ -1,9 +1,10 @@
 require 'approvable/acts_as_approvable'
-require 'state_machine'
-require 'graphviz' # Optional: only required for graphing
-require 'state_machine/version'
+require 'aasm'
+require 'activesupport/json_encoder'
 
 module Approvable
+  cattr_accessor :disabled, :auto_approve
+  
   class Engine < ::Rails::Engine
     isolate_namespace Approvable
 
@@ -15,19 +16,6 @@ module Approvable
       end
     end
     
-
-    initializer :state_machine do |app|
-     unless StateMachine::VERSION == '1.2.0'
-       # If you see this message, please test removing this file
-       # If it's still required, please bump up the version above
-       Rails.logger.warn "Please remove me, StateMachine version has changed"
-     end
-
-     module StateMachine::Integrations::ActiveModel
-       public :around_validation
-     end
-   end
-    
     
     config.generators do |g|
       g.test_framework      :rspec,        :fixture => false

data/lib/approvable/version.rb

@@ -1,3 +1,3 @@
 module Approvable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/dummy/app/models/foobar.rb

@@ -0,0 +1,6 @@
+class Foobar < ActiveRecord::Base
+  acts_as_approvable
+
+  store_accessor :json_hash, :foo, :bar
+  
+end

data/spec/dummy/app/models/listing.rb

@@ -1,3 +1,5 @@
 class Listing < ActiveRecord::Base
   acts_as_approvable
+  
+  validates :title, presence: true
 end

data/spec/dummy/db/migrate/20140816143802_create_foobars.rb

@@ -0,0 +1,9 @@
+class CreateFoobars < ActiveRecord::Migration
+  def change
+    create_table :foobars do |t|
+      t.json :json_hash
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,11 +11,43 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140807144654) do
+ActiveRecord::Schema.define(version: 20140816143802) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
+  create_table "approvable_change_requests", force: true do |t|
+    t.string   "approvable_type"
+    t.integer  "approvable_id"
+    t.json     "requested_changes", default: {}
+    t.string   "state"
+    t.string   "approver_type"
+    t.integer  "approver_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.json     "notes",             default: {}
+  end
+
+  create_table "bars", force: true do |t|
+    t.string   "title"
+    t.integer  "listing_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "foobars", force: true do |t|
+    t.json     "json_hash"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "foos", force: true do |t|
+    t.string   "title"
+    t.integer  "listing_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
   create_table "listings", force: true do |t|
     t.string   "title"
     t.text     "description"

data/spec/factories/change_requests.rb

@@ -7,44 +7,21 @@ FactoryGirl.define do
 
 
     trait :approved do
-      after(:create) {|c| c.submit; c.approve}
+      state :approved
     end
 
     trait :pending do
+      state :pending
+      
     end
     
     trait :submitted do
-      after(:create) {|c| c.submit}
+      state :submitted
     end
     
     trait :rejected do
-      after(:create) {|c| c.submit; c.reject}
+      state :rejected
     end
-
-        
-    # trait :pending do
-    #   submitted_at nil
-    #   approved_at nil
-    #   rejected_at nil
-    # end
-    #
-    # trait :submitted do
-    #   submitted_at {Time.now}
-    #   approved_at nil
-    #   rejected_at nil
-    # end
-    #
-    # trait :approved do
-    #   submitted_at {Time.now}
-    #   approved_at {Time.now}
-    #   rejected_at nil
-    # end
-    #
-    # trait :rejected do
-    #   submitted_at {Time.now}
-    #   approved_at nil
-    #   rejected_at {Time.now}
-    # end
     
   end
 end