object_attorney 1.2.1 → 2.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDBmMmQ5OTNkMjI2MzRkZGVkNjM5NzgwMDg1NzQ0ZjYzNjhiODUwMQ==
+    ZGE1NWUyMGQ1NzE4YjIyMmM0ZmJhN2YxYWJiZjczYmM1MTk5YzA1Mw==
   data.tar.gz: !binary |-
-    YmQxOGY0OGNiMzEyNDQzOTcxOGM3MGRmZjhiOTVlYTdiOTdlNGVmMw==
+    OTU5Y2FkZThiNDQ2Y2ZjZjhkYmIyNzhlN2ZlNmJhOWQ3OGZmOWU4ZA==
 SHA512:
   metadata.gz: !binary |-
-    ZTU2YjYyYzQ4M2JkZDJjZTZlZTg1N2JjMjNmM2JkZjhmMzczNWRiZjQ1MTBk
-    YzZkYzBiNDg2ZjlhMTU5ZGNhZDIzNWJmNDI4MTQzZWFiYWFjYmQzZjBhZWRl
-    ZjZlYWY1MDk4ZmVlZThkMGE1YTE5OTg1ODVlOTZmMDJjNjIxNjc=
+    OTliNTEyNjU2ZjRhM2QwNjEyOTMyNmFiYzM4ZDJmYTViMmYwMzM0NDE4Y2Fj
+    ZGIzMDhhMjk1YjdjZjFjNWExYzU0NTRiZTdmOGM0NDJmZDk5OWExN2M2MWJk
+    MTI2MTdhNTIyMmExYTQ1MjVlYjY5NmVlZmI4ZGFmZTEwMzE3MDI=
   data.tar.gz: !binary |-
-    NzY5MmJjMTMxMWU0NzVlYzZlZDYwNzM3YzNkM2Y0MzY2ZWIxYWU3MTUwNWYx
-    NWUxNzE3NWUzNWMzZjc4YjI5YjQ3YTM1Y2Q1YWQ2YWZjZDllOGVjM2YzODMw
-    YzRkYTA0ODI4NTMwZjRkZTU5MWM3MDJkYWQxYWNlYzA0ZmFiOTY=
+    MDdiMmRjMjgxMDdkYmNiODU1MTMxYTA0ODU0M2JjZDVmMDYyYjNhNGFlMzFm
+    NDZmODY0NWUxNGYxN2Q2ZTA0NTY3YjBjODMxMTc4Y2IxM2UyNzViZWMyMjA1
+    ZGVjNzMyOWEzZGMyNjIzYjA1MzY0NzkzMWJmMGEzODRiMzE0OTU=

data/db/migrate/20131205114000_create_users.rb

@@ -0,0 +1,13 @@
+class CreateUsers < ActiveRecord::Migration
+  def up
+    create_table :users do |t|
+      t.string :email
+      t.boolean :admin, default: false
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :users
+  end
+end

data/db/migrate/20131205114900_create_posts.rb

@@ -3,7 +3,7 @@ class CreatePosts < ActiveRecord::Migration
     create_table :posts do |t|
       t.string :title
       t.text :body
-      t.boolean :admin, default: false
+      t.integer :user_id
       t.timestamps
     end
   end

data/db/migrate/20131205114901_create_comments.rb

@@ -0,0 +1,13 @@
+class CreateComments < ActiveRecord::Migration
+  def up
+    create_table :comments do |t|
+      t.text :body
+      t.integer :post_id
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :comments
+  end
+end

data/db/migrate/20131205114902_create_addresses.rb

@@ -0,0 +1,13 @@
+class CreateAddresses < ActiveRecord::Migration
+  def up
+    create_table :addresses do |t|
+      t.string :street
+      t.integer :post_id
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :addresses
+  end
+end

data/lib/object_attorney/association_reflection.rb

@@ -1,17 +1,54 @@
 module ObjectAttorney
 
-  class AssociationReflection
-    attr_reader :klass, :macro, :options, :name
+  class AssociationReflection < Reflection
+    attr_reader :related_reflection, :macro
 
-    def initialize(association, options)
-      options = options.is_a?(Hash) ? options : { class_name: options }
-      
-      @name = association
+    def initialize(association, related_reflection, options)
+      super(association, options)
       @macro = options[:macro] || macro_default(association)
-      @klass = options[:class_name] || klass_default(association)
-      @options = options
+      @related_reflection = related_reflection
+    end
+
+    def primary_key
+      @primary_key ||= options[:primary_key] || :id
+    end
+
+    def foreign_key
+      @foreign_key ||= options[:foreign_key] || foreign_key_default
+    end
+
+    def set_relational_keys(origin, destination)
+      if has_many? || has_one?
+        set_foreign_key(destination, primary_key_of(origin))
+      elsif belongs_to?
+        set_foreign_key(origin, primary_key_of(destination))
+      end
+    end
+
+    def set_foreign_key(object, id)
+      setter = "#{foreign_key}="
+      
+      if object.respond_to?(setter)
+        object.send(setter, id)
+      elsif object.respond_to?("send_to_representative")
+        object.send_to_representative(setter, id)
+      end
+    end
+
+    def primary_key_of(object)
+      object.send(primary_key)
+    end
 
-      @klass = @klass.constantize if @klass.is_a?(String)
+    def has_many?
+      macro == :has_many
+    end
+
+    def has_one?
+      macro == :has_one
+    end
+
+    def belongs_to?
+      macro == :belongs_to
     end
 
     private ################################# private
@@ -20,12 +57,12 @@ module ObjectAttorney
       Helpers.plural?(association) ? :has_many : :belongs_to
     end
 
-    def klass_default(association)
-      if Helpers.plural?(association)
-        association.to_s.singularize.camelize
-      else
-        association.to_s.camelize
-      end
+    def foreign_key_default
+      if has_many? || has_one?
+        "#{related_reflection.single_name}_id"
+      elsif belongs_to?
+        "#{single_name}_id"
+      end.to_sym
     end
 
   end

data/lib/object_attorney/helpers.rb

@@ -4,6 +4,10 @@ module ObjectAttorney
 
     extend self
 
+    def is_integer?(string)
+      string.match(/^(\d)+$/)
+    end
+
     def plural?(string)
       string = string.to_s
       string == string.pluralize

data/lib/object_attorney/nested_objects.rb

@@ -1,10 +1,8 @@
+require "object_attorney/association_reflection"
+
 module ObjectAttorney
   module NestedObjects
 
-    def nested_objects
-      self.class.nested_objects.map { |nested_object_sym| self.send(nested_object_sym) }.flatten
-    end
-
     def mark_for_destruction
       @marked_for_destruction = true
     end
@@ -14,35 +12,54 @@ module ObjectAttorney
     end
 
     def mark_for_destruction_if_necessary(object, attributes)
-      return nil unless attributes.kind_of?(Hash)
+      return nil unless attributes.is_a?(Hash)
 
       _destroy = attributes["_destroy"] || attributes[:_destroy]
 
       object.mark_for_destruction if ["true", "1", true].include?(_destroy)
     end
 
+    def nested_objects(macro = nil)
+      nested_objects_list = []
+
+      self.class.reflect_on_all_associations(macro).each do |reflection|
+        [*self.send(reflection.name)].each do |nested_object|
+          nested_objects_list << [reflection, nested_object]
+        end
+      end
+
+      nested_objects_list
+    end
+
     protected #################### PROTECTED METHODS DOWN BELOW ######################
 
-    def save_nested_objects(save_method)
-      nested_objects.map do |nested_object|
-        call_save_or_destroy(nested_object, save_method)
+    def save_or_destroy_nested_objects(save_method, association_macro)
+      nested_objects(association_macro).map do |reflection, nested_object|
+        
+        populate_foreign_key(self, nested_object, reflection, :has_many)
+        populate_foreign_key(self, nested_object, reflection, :has_one)
+
+        saving_result = call_save_or_destroy(nested_object, save_method)
+
+        populate_foreign_key(self, nested_object, reflection, :belongs_to)
+
+        saving_result
+
       end.all?
     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?
+      return true if nested_objects.map do |reflection, nested_object|
+        nested_object.marked_for_destruction? ? true : nested_object.valid?
+      end.all?
+
       import_nested_objects_errors
       false
     end
 
     def import_nested_objects_errors
-      self.class.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
-
+      nested_objects.each do |reflection, nested_object|
+        nested_object.errors.full_messages.each { |message| self.errors.add(reflection.name, message) }
       end
     end
 
@@ -54,6 +71,12 @@ module ObjectAttorney
 
     private #################### PRIVATE METHODS DOWN BELOW ######################
 
+    def populate_foreign_key(origin, destination, reflection, macro)
+      return nil if represented_object.blank? || check_if_marked_for_destruction?(destination) || reflection.macro != macro
+
+      reflection.set_relational_keys(origin, destination)
+    end
+
     def self.included(base)
       base.extend(ClassMethods)
 
@@ -93,7 +116,7 @@ module ObjectAttorney
     end
 
     def update_existing_nested_objects(existing_and_new_nested_objects, nested_object_name)
-      (send("existing_#{nested_object_name}") || []).each do |existing_nested_object|
+      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)
@@ -108,21 +131,60 @@ module ObjectAttorney
         next if attributes["id"].present? || 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)
+        next unless new_nested_object
 
+        mark_for_destruction_if_necessary(new_nested_object, attributes)
         existing_and_new_nested_objects << new_nested_object
       end
     end
 
+    def build_nested_object(nested_object_name, attributes = {})
+      reflection = self.class.reflect_on_association(nested_object_name)
+      
+      new_nested_object = reflection.klass.new(attributes)
+
+      populate_foreign_key(self, new_nested_object, reflection, :has_many)
+
+      new_nested_object
+    end
+
+    def existing_nested_objects(nested_object_name)
+      nested_association_klass = self.class.reflect_on_association(nested_object_name).klass
+
+      existing_list = represented_object.blank? ? nested_association_klass.all : (represented_object.send(nested_object_name) || [])
+      
+      if represented_object.present? && nested_association_klass != self.class.represented_object_class.reflect_on_association(nested_object_name).klass
+        existing_list = existing_list.map { |existing_nested_object| nested_association_klass.new({}, existing_nested_object) }
+      end
+
+      existing_list
+    end
+
     module ClassMethods
 
+      def has_many(nested_object_name, options = {})
+        _accepts_nested_objects_overwrite_macro(nested_object_name, options, :has_many)
+      end
+
+      def has_one(nested_object_name, options = {})
+        _accepts_nested_objects_overwrite_macro(nested_object_name, options, :has_one)
+      end
+
+      def belongs_to(nested_object_name, options = {})
+        _accepts_nested_objects_overwrite_macro(nested_object_name, options, :belongs_to)
+      end
+
       def accepts_nested_objects(nested_object_name, options = {})
-        reflection = AssociationReflection.new(nested_object_name, options)
+        reflection = AssociationReflection.new(nested_object_name, represented_object_reflection, options)
+
         self.instance_variable_set("@#{nested_object_name}_reflection", reflection)
         self.instance_variable_set("@association_reflections", association_reflections | [reflection])
 
         self.send(:attr_accessor, "#{nested_object_name}_attributes".to_sym)
+
         define_method(nested_object_name) { nested_getter(nested_object_name) }
+        define_method("build_#{reflection.single_name}") { |attributes = {}, nested_object = nil| build_nested_object(nested_object_name, attributes) }
+        define_method("existing_#{nested_object_name}") { existing_nested_objects(nested_object_name) }
       end
 
       def association_reflections
@@ -137,8 +199,13 @@ module ObjectAttorney
         macro ? association_reflections.select { |reflection| reflection.macro == macro } : association_reflections
       end
 
-      def nested_objects
-        association_reflections.map(&:name)
+
+      private ############################### PRIVATE METHODS ###########################
+
+      def _accepts_nested_objects_overwrite_macro(nested_object_name, options, macro)
+        default_options = { macro: macro }
+        options = options.is_a?(Hash) ? options.merge(default_options) : default_options
+        accepts_nested_objects(nested_object_name, options)
       end
 
     end

data/lib/object_attorney/orm.rb

@@ -26,15 +26,15 @@ module ObjectAttorney
 
     def destroy
       return true if represented_object.blank?
-      evoke_method_on_object(represented_object, :destroy)
+      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
+        represented_object.present? ? represented_object.send(save_method) : true
       else
         save_method = :destroy if check_if_marked_for_destruction?(object)
-        evoke_method_on_object(object, save_method)
+        object.send(save_method)
       end
     end
 
@@ -48,15 +48,29 @@ module ObjectAttorney
     end
 
     def submit(save_method)
-      save_result = save_represented_object(save_method)
-      save_result = save_nested_objects(save_method) if save_result
+      save_result = save_or_destroy_nested_objects(save_method, :belongs_to)
+      save_result = save_or_destroy_represented_object(save_method) if save_result
+      save_result = save_or_destroy_nested_objects(save_method, :has_many) if save_result
+      save_result = save_or_destroy_nested_objects(save_method, :has_one) if save_result
       save_result
     end
 
-    def save_represented_object(save_method)
+    def save_or_destroy_represented_object(save_method)
       return true if represented_object.blank?
       call_save_or_destroy(represented_object, save_method)
     end
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      def all(*args)
+        represented_object_class.all(*args).map { |represented_object| self.new({}, represented_object) }
+      end
+
+    end
 
     private #################### PRIVATE METHODS DOWN BELOW ######################
 
@@ -64,9 +78,5 @@ module ObjectAttorney
       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

@@ -16,15 +16,15 @@ module ObjectAttorney
 
       def destroy(options = {})
         return true if represented_object.blank?
-        evoke_method_on_object(represented_object, :destroy, options)
+        represented_object.destroy(options).ok?
       end
 
       def call_save_or_destroy(object, save_method, options = {})
         if object == self || object == represented_object
-          represented_object.present? ? evoke_method_on_object(represented_object, save_method, options) : true
+          represented_object.present? ? represented_object.send(save_method, options).ok? : true
         else
           save_method = :destroy if check_if_marked_for_destruction?(object)
-          evoke_method_on_object(object, save_method, options)
+          object.send(save_method, options).ok?
         end
       end
 
@@ -35,26 +35,31 @@ module ObjectAttorney
       end
 
       def submit(save_method, options = {})
-        save_result = save_represented_object(save_method, options)
-        save_result = save_nested_objects(save_method) if save_result
+        save_result = save_or_destroy_nested_objects(save_method, :belongs_to, options)
+        save_result = save_or_destroy_represented_object(save_method, options) if save_result
+        save_result = save_or_destroy_nested_objects(save_method, :has_many, options) if save_result
+        save_result = save_or_destroy_nested_objects(save_method, :has_one, options) if save_result
         save_result
       end
 
-      def save_represented_object(save_method, options = {})
+      def save_or_destroy_represented_object(save_method, options = {})
         return true if represented_object.blank?
-        call_save_or_destroy(represented_object, save_method, options).ok?
+        call_save_or_destroy(represented_object, save_method, options)
       end
+      
+      def save_or_destroy_nested_objects(save_method, association_macro, options = {})
+        nested_objects(association_macro).map do |reflection, nested_object|
+          
+          populate_foreign_key(self, nested_object, reflection, :has_many)
+          populate_foreign_key(self, nested_object, reflection, :has_one)
 
-      def save_nested_objects(save_method, options = {})
-        nested_objects.map do |nested_object|
-          call_save_or_destroy(nested_object, save_method, options).ok?
-        end.all?
-      end
+          saving_result = call_save_or_destroy(nested_object, save_method, options)
 
-      private #################### PRIVATE METHODS DOWN BELOW ######################
+          populate_foreign_key(nested_object, self, reflection, :belongs_to)
 
-      def evoke_method_on_object(object, method, options = {})
-        object.send(method, options)
+          saving_result
+
+        end.all?
       end
 
     end

data/lib/object_attorney/reflection.rb

@@ -0,0 +1,35 @@
+module ObjectAttorney
+
+  class Reflection
+    attr_reader :name, :klass, :options
+
+    def initialize(class_name, options)
+      options = options.is_a?(Hash) ? options : {}
+
+      @name, @options = class_name, options
+
+      @klass = options[:class_name] || klass_default(@name)
+      @klass = @klass.constantize if @klass.is_a?(String)
+    end
+
+    def single_name
+      @single_name ||= options[:single_name] || name.to_s.singularize
+    end
+
+    def plural_name
+      @plural_name ||= options[:plural_name] || name.to_s.pluralize
+    end
+
+    private ################################# private
+
+    def klass_default(class_name)
+      if Helpers.plural?(class_name)
+        class_name.to_s.singularize.camelize
+      else
+        class_name.to_s.camelize
+      end
+    end
+
+  end
+
+end

data/lib/object_attorney/version.rb

@@ -1,3 +1,3 @@
 module ObjectAttorney
-  VERSION = "1.2.1"
+  VERSION = "2.1.1"
 end

data/lib/object_attorney.rb

@@ -1,29 +1,26 @@
 require "object_attorney/version"
 require "object_attorney/helpers"
-require "object_attorney/association_reflection"
+require "object_attorney/reflection"
 require "object_attorney/nested_objects"
 require "object_attorney/orm"
 require 'active_record'
 
 module ObjectAttorney
 
-  def initialize(attributes = {}, object = nil, options = {})
-    if !attributes.kind_of?(Hash) && object.blank?
+  def initialize(attributes = {}, object = nil)
+    if !attributes.is_a?(Hash) && object.blank?
       object = attributes
       attributes = nil
     end
 
     attributes = {} if attributes.blank?
 
-    if !attributes.include?("id") && object.kind_of?(String)
-      attributes["id"] = object
-      object = nil
-    end
-
     @represented_object = object if object.present?
 
     assign_attributes attributes
     mark_for_destruction_if_necessary(self, attributes)
+
+    init(attributes)
   end
 
   def assign_attributes(attributes = {})
@@ -38,10 +35,17 @@ module ObjectAttorney
     respond_to?(attribute) ? send(attribute) : nil
   end
 
+  def send_to_representative(method_name, *args)
+    return false if represented_object.blank?
+
+    represented_object.send(method_name, *args)
+  end
+
   protected #################### PROTECTED METHODS DOWN BELOW ######################
 
+  def init(attributes); end
+
   def allowed_attribute(attribute)
-    attribute = attribute.to_s
     respond_to?("#{attribute}=")
   end
 
@@ -86,9 +90,13 @@ module ObjectAttorney
   module ClassMethods
 
     def represents(represented_object_name, options = {})
-      self.instance_variable_set("@represented_object_reflection", AssociationReflection.new(represented_object_name, options))
+      self.instance_variable_set("@represented_object_reflection", Reflection.new(represented_object_name, options))
 
       define_method(represented_object_name) { represented_object }
+
+      if options.include?(:properties)
+        delegate_properties(*options[:properties], to: represented_object_name)
+      end
     end
 
     def represented_object_reflection

data/spec/object_attorney/bulk_post_form_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+
+shared_examples "a BulkPostsForm" do
+
+  it "1. Creating multiple 'Post's, with a tabless model 'BulkPostsForm' has if it had 'accepts_nested_attributes_for :posts'" do
+    params = {
+      bulk_post: {
+        posts_attributes: {
+          "0" => { title: "My title1" },
+          "1" => { title: "My title2" }
+        }
+      }
+    }
+
+    described_class.new(params[:bulk_post]).save
+    
+    Post.all.count.should == 2
+  end
+
+  it "2. Creating new 'Post', editing another and deleting yet another." do
+    params = {
+      bulk_post: {
+        posts_attributes: {
+          "0" => { title: "new post" },
+          "2" => { id: 1, title: 'altered post' },
+          "1" => { id: 2, title: 'to be destroyed', _destroy: true }
+        }
+      }
+    }
+
+    Post.create(title: "My title1")
+    Post.create(title: "My title2")
+    Post.all.count.should == 2
+    Post.first.title.should == 'My title1'
+
+    described_class.new(params[:bulk_post]).save
+    
+    Post.all.count.should == 2
+    Post.find_by_id(1).title.should == 'altered post'
+    Post.find_by_id(3).title.should == 'new post'
+  end
+
+end
+
+describe BulkPostsForm::Base do
+  it_behaves_like 'a BulkPostsForm'
+end
+
+describe BulkPostsForm::Explicit do
+  it_behaves_like 'a BulkPostsForm'
+end

data/spec/object_attorney/bulk_posts_allow_only_existing_form_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+shared_examples "a BulkPostsAllowOnlyExistingForm" do
+
+  it "1. Tabless model 'BulkPostsAllowOnlyNew' only accepts editings 'Post' requests and ignores new requests." do
+    params = {
+      bulk_post: {
+        posts_attributes: {
+          "0" => { title: "new post" },
+          "1" => { id: 1, title: 'altered post' },
+          "2" => { id: 2, title: '', _destroy: true }
+        }
+      }
+    }
+
+    Post.create(title: "My title1")
+    Post.create(title: "My title2")
+    Post.all.count.should == 2
+    Post.find_by_id(1).title.should == 'My title1'
+    Post.find_by_id(2).title.should == 'My title2'
+
+    buld_posts_form = described_class.new(params[:bulk_post])
+    buld_posts_form.save
+    
+    Post.all.count.should == 1
+    Post.first.title.should == 'altered post'
+  end
+
+end
+
+describe BulkPostsAllowOnlyExistingForm::Base do
+  it_behaves_like 'a BulkPostsAllowOnlyExistingForm'
+end
+
+describe BulkPostsAllowOnlyExistingForm::Explicit do
+  it_behaves_like 'a BulkPostsAllowOnlyExistingForm'
+end