object_attorney 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in object_attorney.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 goncalvesjoao
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ObjectAttorney
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'object_attorney'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_attorney
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/object_attorney/version.rb

@@ -0,0 +1,3 @@
+module ObjectAttorney
+  VERSION = "0.0.1"
+end

data/lib/object_attorney.rb

@@ -0,0 +1,307 @@
+require "object_attorney/version"
+
+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
+      attributes = nil
+    end
+
+    attributes = {} if attributes.blank?
+
+    if !attributes.include?("id") && object.kind_of?(String)
+      attributes["id"] = object
+      object = nil
+    end
+
+    @object = object if object.present?
+    @trusted_data = options[:trusted_data] if options.present? && options.kind_of?(Hash)
+
+    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?
+
+    attributes.each do |name, value|
+      send("#{name}=", value) if allowed_attribute(name)
+    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
+
+  def _save!
+    result = (save_or_raise_rollback! ? save_or_destroy_nested_objects : false)
+    valid?
+    result
+  end
+
+  def save_or_raise_rollback!
+    if valid?
+      save_own_object
+    else
+      raise ActiveRecord::Rollback
+    end
+  end
+
+  def save_own_object
+    @object.try_or_return(:save!, true)
+  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
+
+    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 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
+
+  def import_own_object_errors
+    @object.errors.each { |key, value| self.errors.add(key, value) }
+  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 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?
+    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
+  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
+    
+    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
+    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
+    end
+
+    def attr_white_list(*white_list)
+      self.class.instance_variable_set("@white_list", white_list.map(&:to_s))
+    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
+    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
+    end
+
+  end
+
+end

data/object_attorney.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'object_attorney/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "object_attorney"
+  spec.version       = ObjectAttorney::VERSION
+  spec.authors       = ["João Gonçalves"]
+  spec.email         = ["goncalves.joao@gmail.com"]
+  spec.description   = %q{Form Object Patter Implementation}
+  spec.summary       = %q{This gem allows you to extract the code responsible for Validations, Nested Objects and Forms, from your model, into a specific class for a specific use case.}
+  spec.homepage      = "https://github.com/goncalvesjoao/object_attorney"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency(%q<rails>, [">= 3.0.0"])
+  spec.add_dependency(%q<actionpack>, [">= 3.0.0"])
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: object_attorney
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- João Gonçalves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Form Object Patter Implementation
+email:
+- goncalves.joao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/object_attorney.rb
+- lib/object_attorney/version.rb
+- object_attorney.gemspec
+homepage: https://github.com/goncalvesjoao/object_attorney
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This gem allows you to extract the code responsible for Validations, Nested
+  Objects and Forms, from your model, into a specific class for a specific use case.
+test_files: []
+has_rdoc: