object_attorney 0.0.2 → 0.0.9

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.DS_Store

data/lib/object_attorney.rb

@@ -1,12 +1,9 @@
 require "object_attorney/version"
+require "object_attorney/nested_objects"
+require "object_attorney/orm"
 
 module ObjectAttorney
 
-  ################# EXAMPLES ##################
-  # represents :user
-  # accepts_nested_objects :addess, :posts
-  #############################################
-
   def initialize(attributes = {}, object = nil, options = {})
     if !attributes.kind_of?(Hash) && object.blank?
       object = attributes
@@ -20,50 +17,12 @@ module ObjectAttorney
       object = nil
     end
 
-    @object = object if object.present?
-    @trusted_data = options[:trusted_data] if options.present? && options.kind_of?(Hash)
+    @represented_object = object if object.present?
 
     assign_attributes attributes
     mark_for_destruction_if_necessary(self, attributes)
   end
 
-  def nested_objects
-    unless nested_objects_updated
-      @nested_objects = self.class.instance_variable_get("@nested_objects").map { |nested_object_sym| self.send(nested_object_sym) }.flatten
-      nested_objects_updated = true
-    end
-    
-    @nested_objects
-  end
-
-  def new_record?
-    @object.try_or_return(:new_record?, true)
-  end
-
-  def persisted?
-    @object.try_or_return(:persisted?, false)
-  end
-
-  def mark_for_destruction
-    @marked_for_destruction = true
-  end
-
-  def marked_for_destruction?
-    @marked_for_destruction
-  end
-
-  def save
-    save_process
-  end
-
-  def save!
-    save_process true
-  end
-
-  def destroy
-    @object.try_or_return(:destroy, true) && nested_objects.all?(&:destroy)
-  end
-
   def assign_attributes(attributes = {})
     return if attributes.blank?
 
@@ -72,234 +31,91 @@ module ObjectAttorney
     end
   end
 
-  def mark_for_destruction_if_necessary(object, attributes)
-    return nil unless attributes.kind_of?(Hash)
-
-    _destroy = attributes["_destroy"] || attributes[:_destroy]
-
-    object.mark_for_destruction if ["true", "1"].include?(_destroy)
-  end
-
   def read_attribute_for_serialization(attribute)
     respond_to?(attribute) ? send(attribute) : nil
   end
 
   protected #--------------------------------------------------protected
 
-  def self.included(base)
-    base.extend(ClassMethods)
-
-    base.class_eval do
-      include ActiveModel::Validations
-      include ActiveModel::Conversion
-
-      attr_accessor :nested_objects_updated, :trusted_data
-      validate :validate_own_object, :validate_nested_objects
-
-      def valid?
-        override_valid? ? true : super
-      end
-    end
-
-    base.instance_variable_set("@nested_objects", [])
-    base.instance_variable_set("@white_list", [])
-    base.instance_variable_set("@black_list", [])
-  end
-
   def allowed_attribute(attribute)
     attribute = attribute.to_s
 
-    return false  if !respond_to?("#{attribute}=") || black_list.include?(attribute)
-    return true   if self.class.instance_variable_get("@white_list").empty?
-
-    self.class.instance_variable_get("@white_list").include?(attribute)
-  end
-
-  def black_list
-    [*self.class.instance_variable_get("@black_list"), "trusted_data", "nested_objects_updated", "_destroy"]
-  end
-
-  def save_process(raise_exception = false)
-    before_save
-    save_result = raise_exception ? _save! : _save
-    after_save if save_result
-    save_result
-  end
-
-  def before_save; end
-  def after_save; end
-
-  def _save
-    begin
-      ActiveRecord::Base.transaction { _save! }
-    rescue
-      valid?
-      false
-    end
-  end
+    return false  if !respond_to?("#{attribute}=") || self.class.black_list.include?(attribute)
+    return true   if self.class.white_list.empty?
 
-  def _save!
-    result = (save_or_raise_rollback! ? save_or_destroy_nested_objects : false)
-    valid?
-    result
+    self.class.white_list.include?(attribute)
   end
 
-  def save_or_raise_rollback!
-    if valid?
-      save_own_object
-    else
-      raise ActiveRecord::Rollback
-    end
+  def validate_represented_object
+    valid = override_validations? ? true : try_or_return(@represented_object, :valid?, true)
+    import_represented_object_errors unless valid
+    valid
   end
 
-  def save_own_object
-    @object.try_or_return(:save!, true)
+  def import_represented_object_errors
+    @represented_object.errors.each { |key, value| self.errors.add(key, value) }
   end
 
-  def save_or_destroy_nested_objects
-    result = nested_objects.map do |nested_object|
-      nested_object.marked_for_destruction? ? nested_object.destroy : nested_object.save!
-    end.all?
-
-    self.errors.add(:base, "Some errors where found while saving the nested objects.") unless result
+  private #################### PRIVATE METHODS DOWN BELOW ######################
 
-    result
-  end
-
-  def validate_own_object
-    valid = override_valid? ? true : @object.try_or_return(:valid?, true)
-    import_own_object_errors unless valid
-    valid
-  end
-
-  def validate_nested_objects
-    #nested_objects.all?(&:valid?) #will not validate all nested_objects
-    return true if nested_objects.reject(&:marked_for_destruction?).map(&:valid?).all?
-    import_nested_objects_errors
-    false
-  end
+  def self.included(base)
+    base.extend(ClassMethods)
 
-  def get_attributes_for_existing(nested_object_name, existing_nested_object)
-    attributes = send("#{nested_object_name}_attributes")
-    return {} if attributes.blank?
-    attributes.present? ? (attributes.values.select { |x| x[:id].to_i == existing_nested_object.id }.first || {}) : {}
-  end
+    base.class_eval do
+      include ActiveModel::Validations
+      include ActiveModel::Conversion
+      include ObjectAttorney::NestedObjects
+      include ObjectAttorney::ORM
 
-  def import_own_object_errors
-    @object.errors.each { |key, value| self.errors.add(key, value) }
-  end
+      validate :validate_represented_object
 
-  def import_nested_objects_errors
-    self.class.instance_variable_get("@nested_objects").map do |nested_object_sym|
-      
-      [*self.send(nested_object_sym)].each do |nested_object|
-        nested_object.errors.full_messages.each { |message| self.errors.add(nested_object_sym, message) }
+      def valid?
+        override_validations? ? true : super
       end
-
     end
   end
 
-  # def return_hash_with_existing_errors(hash, object = nil)
-  #   object ||= self
-  #   object.errors.empty? ? hash : hash.merge({ errors: object.errors })
-  # end
-
-  private #------------------------------ private
-
-  def attributes_without_destroy(attributes)
-    return nil unless attributes.kind_of?(Hash)
-
-    _attributes = attributes.dup
-    _attributes.delete("_destroy")
-    _attributes.delete(:_destroy)
-
-    _attributes
-  end
-
-  def override_valid?
+  def override_validations?
     marked_for_destruction?
   end
 
-  def nested_getter(nested_object_name)
-    nested_instance_variable = self.instance_variable_get("@#{nested_object_name}")
-
-    if nested_instance_variable.nil?
-      nested_instance_variable = get_existing_and_new_nested_objects(nested_object_name)
-      self.instance_variable_set("@#{nested_object_name}", nested_instance_variable)
-    end
-
-    nested_instance_variable
+  def try_or_return(object, method, default_value)
+    returning_value = object.try(method)
+    returning_value.nil? ? default_value : returning_value
   end
 
-  def get_existing_and_new_nested_objects(nested_object_name)
-    existing_and_new_nested_objects = []
-    
-    update_existing_nested_objects(existing_and_new_nested_objects, nested_object_name)
-    build_new_nested_objects(existing_and_new_nested_objects, nested_object_name)
-
-    existing_and_new_nested_objects
-  end
-
-  def update_existing_nested_objects(existing_and_new_nested_objects, nested_object_name)
-    (send("existing_#{nested_object_name}") || []).each do |existing_nested_object|
-      attributes = get_attributes_for_existing(nested_object_name, existing_nested_object)
+  module ClassMethods
 
-      mark_for_destruction_if_necessary(existing_nested_object, attributes)
-      existing_nested_object.assign_attributes(attributes_without_destroy(attributes))
+    def represents(represented_object, represented_object_class = nil)
+      represented_object_class ||= represented_object.to_s.camelize
 
-      existing_and_new_nested_objects << existing_nested_object
+      define_method(represented_object) do
+        @represented_object ||= represented_object_class.constantize.new
+      end
     end
-  end
-
-  def build_new_nested_objects(existing_and_new_nested_objects, nested_object_name)
-    (send("#{nested_object_name}_attributes") || {}).values.each do |attributes|
-      next if attributes["id"].present?
 
-      new_nested_object = send("build_#{nested_object_name.to_s.singularize}", attributes_without_destroy(attributes))
-      mark_for_destruction_if_necessary(new_nested_object, attributes)
-
-      existing_and_new_nested_objects << new_nested_object
+    def delegate_properties(*properties, options)
+      properties.each { |property| delegate_propertiy(property, options) }
     end
-  end
 
-  module ClassMethods
-    
-    attr_accessor :own_object_class
-
-    def represents(own_object)
-      define_method(own_object) do
-        own_object_class = self.class.instance_variable_get(:@own_object_class)
-        own_object_class ||= own_object.to_s.camelize
-        @object ||= own_object_class.constantize.new
-      end
+    def delegate_propertiy(property, options)
+      delegate property, "#{property}=", options
     end
 
-    def accepts_nested_objects(*nested_objects_list)
-      self.instance_variable_set("@nested_objects", nested_objects_list)
-      self.send(:attr_accessor, *nested_objects_list.map { |attribute| "#{attribute}_attributes".to_sym })
-      define_nested_objects_getter_methods nested_objects_list
+    def attr_white_list=(*white_list)
+      @white_list = white_list.map(&:to_s)
     end
 
-    def attr_white_list(*white_list)
-      self.class.instance_variable_set("@white_list", white_list.map(&:to_s))
+    def white_list
+      @white_list ||= []
     end
 
     def attr_black_list(*black_list)
-      self.class.instance_variable_set("@black_list", black_list.map(&:to_s))
-    end
-
-    def reflect_on_association(association)
-      nil
+      @black_list = black_list.map(&:to_s)
     end
 
-    private #------------------------ private
-
-    def define_nested_objects_getter_methods(nested_objects_list)
-      nested_objects_list.each do |nested_object_name|
-        define_method(nested_object_name) do
-          nested_getter(nested_object_name)
-        end
-      end
+    def black_list
+      @black_list ||= ["_destroy"]
     end
 
   end

data/lib/object_attorney/nested_objects.rb

@@ -0,0 +1,138 @@
+module ObjectAttorney
+  module NestedObjects
+
+    def nested_objects
+      self.class.instance_variable_get("@nested_objects").map { |nested_object_sym| self.send(nested_object_sym) }.flatten
+    end
+
+    def mark_for_destruction
+      @marked_for_destruction = true
+    end
+
+    def marked_for_destruction?
+      @marked_for_destruction
+    end
+
+    def mark_for_destruction_if_necessary(object, attributes)
+      return nil unless attributes.kind_of?(Hash)
+
+      _destroy = attributes["_destroy"] || attributes[:_destroy]
+
+      object.mark_for_destruction if ["true", "1"].include?(_destroy)
+    end
+
+    protected #################### PROTECTED METHODS DOWN BELOW ######################
+
+    def validate_nested_objects
+      #nested_objects.all?(&:valid?) #will not validate all nested_objects
+      return true if nested_objects.reject(&:marked_for_destruction?).map(&:valid?).all?
+      import_nested_objects_errors
+      false
+    end
+
+    def import_nested_objects_errors
+      self.class.instance_variable_get("@nested_objects").map do |nested_object_sym|
+        
+        [*self.send(nested_object_sym)].each do |nested_object|
+          nested_object.errors.full_messages.each { |message| self.errors.add(nested_object_sym, message) }
+        end
+
+      end
+    end
+
+    def get_attributes_for_existing(nested_object_name, existing_nested_object)
+      attributes = send("#{nested_object_name}_attributes")
+      return {} if attributes.blank?
+      attributes.present? ? (attributes.values.select { |x| x[:id].to_i == existing_nested_object.id }.first || {}) : {}
+    end
+
+    private #################### PRIVATE METHODS DOWN BELOW ######################
+
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base.class_eval do
+        validate :validate_nested_objects
+      end
+
+      base.instance_variable_set("@nested_objects", [])
+    end
+
+    def attributes_without_destroy(attributes)
+      return nil unless attributes.kind_of?(Hash)
+
+      _attributes = attributes.dup
+      _attributes.delete("_destroy")
+      _attributes.delete(:_destroy)
+
+      _attributes
+    end
+
+    def nested_getter(nested_object_name)
+      nested_instance_variable = self.instance_variable_get("@#{nested_object_name}")
+
+      if nested_instance_variable.nil?
+        nested_instance_variable = get_existing_and_new_nested_objects(nested_object_name)
+        self.instance_variable_set("@#{nested_object_name}", nested_instance_variable)
+      end
+
+      nested_instance_variable
+    end
+
+    def get_existing_and_new_nested_objects(nested_object_name)
+      existing_and_new_nested_objects = []
+      
+      update_existing_nested_objects(existing_and_new_nested_objects, nested_object_name)
+      build_new_nested_objects(existing_and_new_nested_objects, nested_object_name)
+
+      existing_and_new_nested_objects
+    end
+
+    def update_existing_nested_objects(existing_and_new_nested_objects, nested_object_name)
+      (send("existing_#{nested_object_name}") || []).each do |existing_nested_object|
+        attributes = get_attributes_for_existing(nested_object_name, existing_nested_object)
+
+        mark_for_destruction_if_necessary(existing_nested_object, attributes)
+        existing_nested_object.assign_attributes(attributes_without_destroy(attributes))
+
+        existing_and_new_nested_objects << existing_nested_object
+      end
+    end
+
+    def build_new_nested_objects(existing_and_new_nested_objects, nested_object_name)
+      (send("#{nested_object_name}_attributes") || {}).values.each do |attributes|
+        next if attributes["id"].present?
+
+        new_nested_object = send("build_#{nested_object_name.to_s.singularize}", attributes_without_destroy(attributes))
+        mark_for_destruction_if_necessary(new_nested_object, attributes)
+
+        existing_and_new_nested_objects << new_nested_object
+      end
+    end
+
+    module ClassMethods
+
+      def accepts_nested_objects(*nested_objects_list)
+        self.instance_variable_set("@nested_objects", nested_objects_list)
+        self.send(:attr_accessor, *nested_objects_list.map { |attribute| "#{attribute}_attributes".to_sym })
+        define_nested_objects_getter_methods nested_objects_list
+      end
+
+      def reflect_on_association(association)
+        nil
+      end
+
+      private #################### PRIVATE METHODS DOWN BELOW ######################
+
+      def define_nested_objects_getter_methods(nested_objects_list)
+        nested_objects_list.each do |nested_object_name|
+          define_method(nested_object_name) do
+            nested_getter(nested_object_name)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/object_attorney/nested_uniqueness_validator.rb

@@ -0,0 +1,33 @@
+module ActiveModel
+
+  module Validations
+
+    class NestedUniquenessValidator < EachValidator
+      def validate_each(record, attr_name, value)
+        uniq_value, existing_objects, first_element = options[:uniq_value], [], nil
+
+        record.send(attr_name).each do |object|
+          next if object.marked_for_destruction?
+
+          first_element = object if first_element.nil?
+
+          if existing_objects.include?(object.send(uniq_value))
+            object.errors.add(uniq_value, :taken)
+            record.errors.add(attr_name, :taken)
+          else
+            existing_objects << object.send(uniq_value)
+          end
+        end
+
+      end
+    end
+
+    module HelperMethods
+      
+      def validates_nested_uniqueness(*attr_names)
+        validates_with NestedUniquenessValidator, _merge_attributes(attr_names)
+      end
+
+    end
+  end
+end

data/lib/object_attorney/orm.rb

@@ -0,0 +1,60 @@
+require "object_attorney/orm_handlers/smooth_operator"
+
+module ObjectAttorney
+  module ORM
+  
+    def new_record?
+      try_or_return(@represented_object, :new_record?, true)
+    end
+
+    def persisted?
+      try_or_return(@represented_object, :persisted?, false)
+    end
+
+    def save
+      save!(:save)
+    end
+
+    def save!(save_method = :save!)
+      before_save
+      save_result = valid? ? save_after_validations(save_method) : false
+      after_save if valid? && save_result
+      save_result
+    end
+
+    def destroy
+      return true if @represented_object.blank?
+      evoke_method_on_object(@represented_object, :destroy)
+    end
+
+    def call_save_or_destroy(object, save_method)
+      if object == self
+        @represented_object.present? ? evoke_method_on_object(@represented_object, save_method) : true
+      else
+        save_method = :destroy if check_if_marked_for_destruction?(object)
+        evoke_method_on_object(object, save_method)
+      end
+    end
+
+    protected #################### PROTECTED METHODS DOWN BELOW ######################
+
+    def before_save; end
+    def after_save; end
+
+    def save_after_validations(save_method)
+      return true if @represented_object.blank?
+      evoke_method_on_object(@represented_object, save_method)
+    end
+
+    private #################### PRIVATE METHODS DOWN BELOW ######################
+
+    def check_if_marked_for_destruction?(object)
+      object.respond_to?(:marked_for_destruction?) ? object.marked_for_destruction? : false
+    end
+
+    def evoke_method_on_object(object, method)
+      object.send(method)
+    end
+
+  end
+end

data/lib/object_attorney/orm_handlers/smooth_operator.rb

@@ -0,0 +1,51 @@
+module ObjectAttorney
+  module OrmHandlers
+
+    module SmoothOperator
+
+      def save(options = {})
+        save!(options, :save)
+      end
+
+      def save!(options = {}, save_method = :save!)
+        before_save
+        save_result = valid? ? save_after_validations(save_method, options) : false
+        after_save if valid? && save_result
+        save_result
+      end
+
+      def destroy(options = {})
+        return true if @represented_object.blank?
+        evoke_method_on_object(@represented_object, :destroy, options)
+      end
+    
+      def rollback(options = {})
+        @represented_object.rollback(options)
+      end
+
+      def call_save_or_destroy(object, save_method, options = {})
+        if object == self
+          @represented_object.present? ? evoke_method_on_object(@represented_object, save_method, options) : true
+        else
+          save_method = :destroy if check_if_marked_for_destruction?(object)
+          evoke_method_on_object(object, save_method, options)
+        end
+      end
+
+      protected #################### PROTECTED METHODS DOWN BELOW ######################
+
+      def save_after_validations(save_method, options = {})
+        return true if @represented_object.blank?
+        evoke_method_on_object(@represented_object, save_method, options)
+      end
+
+      private #################### PRIVATE METHODS DOWN BELOW ######################
+
+      def evoke_method_on_object(object, method, options = {})
+        object.send(method, options)
+      end
+
+    end
+
+  end
+end

data/lib/object_attorney/version.rb

@@ -1,3 +1,3 @@
 module ObjectAttorney
-  VERSION = "0.0.2"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object_attorney
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,10 @@ files:
 - README.md
 - Rakefile
 - lib/object_attorney.rb
+- lib/object_attorney/nested_objects.rb
+- lib/object_attorney/nested_uniqueness_validator.rb
+- lib/object_attorney/orm.rb
+- lib/object_attorney/orm_handlers/smooth_operator.rb
 - lib/object_attorney/version.rb
 - object_attorney.gemspec
 homepage: https://github.com/goncalvesjoao/object_attorney