flattener 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.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/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Lucas Florio
+
+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,99 @@
+# Flattener
+
+Allows to flat an object (ActiveRecord based) into one level. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flattener'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flattener
+
+## Usage
+
+Say you have something like this:
+
+    class Customer < ActiveRecord::Base
+      has_one :address
+    end
+
+    class Address < ActiveRecord::Base
+      # ... Attributes here
+    end
+
+You could do something like this:
+
+    class Customer < ActiveRecord::Base
+
+      include Flattener
+
+      has_one :address
+
+      flat :address do
+        attribute :address_line_1
+        attribute :address_line_2
+        attribute :city
+        attribute :state
+        attribute :country
+      end
+
+    end
+
+and use it like this: 
+
+    customer = Customer.new address_line_1: "Av. Santa Fe 1234", country: "Argentina"
+  
+Pretty simple. It support all the basic AR methods, like valid?, save or create.
+
+I know what you think. "I can do that with a simple delegate call". Indeed, but you can also do this:
+
+    class Payment < ActiveRecord::Base
+
+      include Flattener
+
+      has_one :payment_profile
+
+      flat :payment_profile do
+
+        attributes :credit_card, :expiration_date
+
+        flat :address do
+          attribute :address_line_1
+          attribute :address_line_2
+        end
+
+      end
+
+    end
+
+And this way getting something really simple:
+
+    payment = Payment.new amount: "23.00", payment_profile_credit_card: "XXXXXXXXXX", expiration_date: "2011/12", 
+      payment_profile_address_line_1: "Av. Mongo 1234"
+
+    payment.payment_profile_address_line_1 #=> "Av. Mongo 1234"
+    # and so on. 
+
+    # supose you have a validation on Address#address_line_2
+    payment.valid? #=> false
+    payment.errors[:payment_profile_address_line_1] #=> ".... is required, blah..."
+
+So what is this gem doing? 
+
+* It builds the flattened objects automatically, or the way you want (configuration option). 
+* It overwrites the AR methods in order to call the flattened methods before, so the right validation errors appear in place. 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/flattener.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flattener/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Lucas Florio"]
+  gem.email         = ["lucasefe@gmail.com"]
+  gem.description   = %q{Allows to flat an object and his children (ActiveRecord based) into one level, so you create them all without building a complex form.  }
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "flattener"
+  gem.require_paths = ["lib"]
+  gem.version       = Flattener::VERSION
+
+  gem.add_dependency 'activerecord'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'shoulda'
+  gem.add_development_dependency 'guard-rspec'
+end

data/lib/flattener/base.rb

@@ -0,0 +1,13 @@
+module Flattener
+  class Base
+    
+    include ActiveModel::Validations
+    extend Flattener
+
+    def initialize attributes = {}
+      attributes.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/flattener/configurator.rb

@@ -0,0 +1,147 @@
+module Flattener
+
+  class Configurator
+    
+    def self.flat klass, object, options = {}, &block
+      new klass, object, options, &block
+    end
+
+    # # nesting
+    def flat object, options = {}, &block
+      NestedConfigurator.new self, object, options, &block
+    end
+
+    attr_accessor :klass, :accessor, :name, :prefix, :options, :attributes
+
+    def initialize(klass, name, options = {}, &block)
+      @klass = klass
+      @name = name
+      @options = options
+      @attributes = {}
+      @prefix = @options[:prefix] || @name.to_s
+      @accessor = @options[:accessor] || @name.to_s
+      prepare!
+      self.instance_eval(&block) if block_given?
+    end
+
+    def prepare!
+      add_build_method!
+      add_proxy_method!
+      add_validator_method!
+
+      unless klass.respond_to?(:flatteners)
+        klass.class_attribute :flatteners
+        klass.flatteners = {}
+      end
+
+      klass.flatteners[name] = self
+    end
+
+    def add_build_method!
+      unless @klass.instance_methods.include?(build_method_name.to_sym)
+        raise "must specify a build option, or the method named #{build_method_name}" unless @options.has_key?(:build)
+        @klass.send :define_method, build_method_name, &@options[:build] 
+      end
+    end
+
+    def add_proxy_method!
+      code = <<-CODE
+        def #{proxy_method_name}
+          if self.#{accessor_method_name}.nil?
+            #{build_method_name} 
+          end
+          self.#{accessor_method_name}
+        end
+      CODE
+      @klass.class_eval code, __FILE__, __LINE__ 
+    end
+
+    def add_validator_method!
+      if defined?(ActiveRecord::Validations) && @klass.included_modules.include?(ActiveRecord::Validations)
+        code =  <<-CODE
+          def #{validate_method_name}
+            unless self.#{accessor_method_name}.blank?
+              self.#{proxy_method_name}.valid?
+    
+              self.#{proxy_method_name}.errors.each do |name, message|
+                flattened_name = self.class.flatteners[:#{name}].attributes[name]
+                self.errors.add flattened_name, message
+              end
+            end
+          end
+        CODE
+        @klass.class_eval code
+        @klass.validate validate_method_name
+      end
+    end
+      
+    # How it access the flattened object
+    def accessor_method_name
+      @accessor
+    end
+    
+    def proxy_method_name
+      "proxy_#{accessor_method_name}"
+    end
+
+    def build_method_name
+      "build_#{accessor_method_name}"
+    end
+
+    def validate_method_name
+      "validate_#{accessor_method_name}"
+    end
+
+    def method_name_for(name)
+      if prefix.blank?
+        name.to_sym
+      else
+        "#{prefix}_#{name}".to_sym
+      end
+    end
+
+    def attribute(name)
+      method_name = method_name_for(name)
+      code = <<-CODE
+        def #{method_name}
+          #{proxy_method_name}.#{name}
+        end
+
+        def #{method_name}=(value)
+          #{proxy_method_name}.#{name} = value
+        end
+      CODE
+      @klass.class_eval code, __FILE__, __LINE__
+      self.attributes[name] = method_name
+    end
+  end
+
+  class NestedConfigurator < Configurator
+    
+    attr_accessor :parent
+
+    def initialize(parent, name, options = {}, &block)
+      @parent = parent
+      options[:prefix] ||= if @parent.prefix.blank?
+        name.to_s
+      else
+        "#{@parent.prefix}_#{name.to_s}"
+      end
+      options[:accessor] ||= "#{parent.accessor_method_name}_#{name}"
+      super(parent.klass, name, options, &block)
+    end
+
+    def prepare!
+      super
+      code = <<-CODE
+        # customer_payment_profile_address
+        
+        def #{parent.accessor_method_name}_#{name}
+          #{parent.proxy_method_name}.#{name}
+        end
+      CODE
+      @klass.class_eval code
+    end
+  end
+
+end

data/lib/flattener/rails.rb

@@ -0,0 +1,7 @@
+module Flattener
+
+  class Railtie < Rails::Railtie
+
+  end
+
+end

data/lib/flattener/version.rb

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

data/lib/flattener.rb

@@ -0,0 +1,12 @@
+require "flattener/version"
+require "flattener/configurator"
+require "flattener/base"
+require "flattener/Rails" if defined?(Rails)
+
+module Flattener
+
+  def flat object, options = {}, &block
+    Flattener::Configurator.flat(self, object, options, &block)
+  end
+
+end

data/spec/lib/flattener/base_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+
+class CustomerBuilder < Flattener::Base
+  attr_accessor :customer
+
+  flat :customer, prefix: "", build: proc {self.customer = Customer.new} do
+
+    attribute :name
+
+    flat :payment_profile, build: proc {  self.proxy_customer.build_payment_profile } do
+      attribute :uuid
+      
+      flat :address, build: proc {  self.proxy_customer_payment_profile.build_address } do
+        attribute :city
+        attribute :street_line_1
+      end
+    end
+  end
+
+end
+
+describe Flattener::Base do
+
+  it "should work as a class too" do
+    instance = CustomerBuilder.new name: "jose", payment_profile_uuid: "GGG-78979", payment_profile_address_city: "Mongo City"
+    instance.name.should == "jose"
+    instance.customer.name.should == "jose"
+
+    instance.payment_profile_uuid.should == instance.customer.payment_profile.uuid
+    instance.payment_profile_address_city.should == instance.customer.payment_profile.address.city
+    instance.should be_valid
+  end
+
+end

data/spec/lib/flattener/configurator_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe "A flattened object" do
+
+  before do
+    @klass = Class.new do
+      extend Flattener
+      attr_accessor :subobject
+    end
+
+    SubClass = Class.new do
+      attr_accessor :name
+    end
+  end
+
+  context "configuration" do
+
+    it "should be flattenable" do
+      @klass.should respond_to(:flat)
+    end
+
+    it "should store the flattened configuration" do
+      @klass.flat :subobject, build: proc { self.subobject = SubClass.new } do
+        attribute :name
+      end
+
+      @klass.should respond_to(:flatteners)
+      @klass.flatteners[:subobject].should_not be_blank
+    end
+
+    it "should keep track of the flattened attributes" do
+      @klass.flat :subobject, build: proc { self.subobject = SubClass.new } do
+        attribute :name
+      end
+      @klass.flatteners[:subobject].attributes.keys.should == [ :name ]
+      @klass.flatteners[:subobject].attributes.values.should == [ :subobject_name ]
+    end
+
+  end
+
+
+  context "basic usage" do
+
+    it "should raise an error if no build option is provided" do
+      lambda {
+        @klass.flat :subobject
+      }.should raise_error(/build/)
+    end
+
+    it "should flat an extra object attribute" do
+      @klass.flat :subobject, build: proc { self.subobject = SubClass.new } do
+        attribute :name
+      end
+
+      instance = @klass.new
+      instance.should respond_to(:subobject_name)
+      instance.should respond_to(:subobject_name=)
+      instance.subobject_name = "name from hell"
+      instance.subobject.should be_an_instance_of(SubClass)
+      instance.subobject.name.should == "name from hell"
+    end
+
+    it "should support to change the prefix (the way the methods are named) " do
+      @klass.flat :subobject, build: proc { self.subobject = SubClass.new }, prefix: "so" do
+        attribute :name
+      end
+
+      instance = @klass.new
+      instance.should respond_to(:so_name)
+      instance.should respond_to(:so_name=)
+      instance.so_name = "name from hell"
+      instance.subobject.should be_an_instance_of(SubClass)
+      instance.subobject.name.should == "name from hell"
+    end
+
+  end
+  
+end
+
+describe "a flattened object with validations" do
+  
+  it "jjj" do
+    instance = Customer.new
+    instance.payment_profile_uuid = "GGG-78979"
+    instance.payment_profile_uuid.should == instance.payment_profile.uuid
+  
+    instance.should be_valid
+    instance.save.should be_true
+    instance.payment_profile.should_not be_new_record
+
+    instance.payment_profile_uuid = nil
+    instance.should_not be_valid
+    
+    instance.errors.should have(1).message
+    instance.errors[:payment_profile_uuid].first.should match(/can't be blank/)
+  
+    instance.save.should_not be_true
+  end
+
+  it "nested flattened objects" do
+    instance = Customer.new
+    instance.payment_profile_uuid = "GGG-78979"
+    instance.payment_profile.should respond_to(:build_address)
+    instance.payment_profile_uuid.should == instance.payment_profile.uuid
+    instance.payment_profile_address_city = "Mongo City"
+    instance.payment_profile_address_city.should == instance.payment_profile.address.city
+    instance.should be_valid
+
+    instance.payment_profile_address_city = nil
+    instance.should_not be_valid 
+    instance.errors[:payment_profile_address_city].first.should match(/can't be blank/)   
+  end
+
+  it "massive assignment" do
+    instance = Customer.new payment_profile_uuid: "GGG-78979", payment_profile_address_city: "Mongo City"
+    instance.payment_profile_uuid.should == instance.payment_profile.uuid
+    instance.payment_profile_address_city.should == instance.payment_profile.address.city
+    instance.should be_valid
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require 'active_record'
+require 'flattener'
+require 'shoulda'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :customers, force: true do |t|
+    t.string :name
+  end
+
+  create_table :payment_profiles, force: true do |t|
+    t.integer :customer_id
+    t.string  :uuid
+  end
+
+  create_table :addresses, force: true do |t|
+    t.integer :payment_profile_id
+    t.string :street_line_1
+    t.string :street_line_2
+    t.string :city
+  end
+
+end
+
+class Address < ActiveRecord::Base
+  belongs_to :payment_profile
+
+  validates :city, presence: true
+
+end
+
+class PaymentProfile < ActiveRecord::Base
+  has_one :address
+  belongs_to :customer
+
+  validates :uuid, presence: true
+end
+
+class Customer < ActiveRecord::Base
+  
+  has_one :payment_profile
+
+  extend Flattener
+
+  flat :payment_profile do
+    attribute :uuid
+    
+    flat :address, build: proc {  self.proxy_payment_profile.build_address } do
+      attribute :city
+      attribute :street_line_1
+    end
+  end
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: flattener
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Florio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70174276620400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70174276620400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70174276619820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174276619820
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70174276619140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174276619140
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70174276618720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174276618720
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70174276618300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174276618300
+description: ! 'Allows to flat an object and his children (ActiveRecord based) into
+  one level, so you create them all without building a complex form.  '
+email:
+- lucasefe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- flattener.gemspec
+- lib/flattener.rb
+- lib/flattener/base.rb
+- lib/flattener/configurator.rb
+- lib/flattener/rails.rb
+- lib/flattener/version.rb
+- spec/lib/flattener/base_spec.rb
+- spec/lib/flattener/configurator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.15
+signing_key: 
+specification_version: 3
+summary: Allows to flat an object and his children (ActiveRecord based) into one level,
+  so you create them all without building a complex form.
+test_files:
+- spec/lib/flattener/base_spec.rb
+- spec/lib/flattener/configurator_spec.rb
+- spec/spec_helper.rb