activerecord-fusion 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+= 0.1.0 / 2012-12-18
+
+  Derived from piggyback

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/})              { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/models.rb')       { "spec" }
+end
+

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+
+Copyright (c) 2011 Andreas Korth
+
+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/Manifest

@@ -0,0 +1,11 @@
+CHANGELOG
+Guardfile
+MIT-LICENSE
+Manifest
+README.markdown
+Rakefile
+lib/active_record/fusion.rb
+spec/app.rb
+spec/fusion_spec.rb
+spec/schema.rb
+spec/spec_helper.rb

data/README.markdown

@@ -0,0 +1,82 @@
+# Fusion
+
+An extension for merging of ActiveRecord™ models.
+
+### Piggybacking
+
+Piggybacking refers to the technique of dynamically including attributes from an associated model. This is achieved by joining the associated model in a database query and selecting the attributes that should be included with the parent object.
+
+This is best illustrated in an example. Consider these models:
+
+    class User < ActiveRecord::Base
+      has_many :posts
+    end
+    
+    class Post < ActiveRecord::Base
+      belongs_to :user
+    end
+    
+ActiveRecord supports piggybacking simply by joining the associated table and selecting columns from it:
+
+    post = Post.select('posts.*, user.name AS user_name') \
+               .joins("JOIN users ON posts.user_id = users.id") \
+               .first
+
+    post.title      # => "Why piggybacking in ActiveRecord is flawed"    
+    post.user_name  # => "Alec Smart"
+    
+As you can see, the `name` attribute from `User` is treated as if it were an attribute of `Post`. ActiveRecord dynamically determines a model's attributes from the result set returned by the database. Every column in the result set becomes an attribute of the instantiated ActiveRecord objects. Whether the columns originate from the model's own or from a foreign table doesn't make a difference.
+
+Or so it seems. Actually there is a drawback which becomes obvious when we select non-string columns:
+
+    post = Post.select('posts.*, user.birthday AS user_birthday, user.rating AS user_rating') \
+               .joins("JOIN users ON posts.user_id = users.id") \
+               .first
+
+    post.user_birthday  # => "2011-03-01"
+    post.user_rating    # => "4.5"
+    
+Any attributes originating from the `users` table are treated as strings instead of being automatically type-casted as we would expect. The database returns result sets as plain text and ActiveRecord needs to obtain type information separately from the table schema in order to do its type-casting magic. Unfortunately, a model only knows about the columns types in its own table, so type-casting doesn't work with columns selected from foreign tables.
+
+We could work around this by defining attribute reader methods in the `Post` model that implicitly convert the values:
+
+    class Post < ActiveRecord::Base
+      belongs_to :user
+      
+      def user_birthday
+        Date.parse(read_attribute(:user_birthday))
+      end
+      
+      def user_rating
+        read_attribute(:user_rating).to_f
+      end
+    end
+    
+However this is tedious, error-prone and repetitive if you do it in many models. The type-casting code shown above isn't solid and would quickly become more complex in a real-life application. In its current state it won't handle `nil` values properly, for example.
+
+    
+### Fusion to the rescue!
+
+The `fusion` declaration specifies the attributes we want to fuse from associated models. Not only does it take care of the type-casting but also provides us with some additional benefits.
+
+You simply declare which association and attributes you want to fuse:
+
+    class Post < ActiveRecord::Base
+      belongs_to :user
+
+      fusion :user, :only => [:name, :email, :rating, :confirmed_at]
+    end
+
+Now you can do the following:
+
+    post = Post.fuse.first
+    
+    post.name           # => "John Doe"
+    post.rating         # => 4.5
+    post.confirmed_at   # => Tue, 01 Mar 2011
+
+The type-casting works with any type of attribute, even with serialized ones.
+
+Fusion uses `OUTER JOIN` in order to include both records that have an associated record and ones that don't.
+
+Of course, Fusion plays nice with Arel and you can add additional `joins`, `select` and other statements as you like.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'  
+require 'echoe'  
+
+Echoe.new('activerecord-fusion', '0.1.0') do |p|  
+
+  p.description     = "Fuse attributes from associated models with ActiveRecord"  
+  p.url             = "http://github.com/juni0r/activerecord-fusion"  
+  p.author          = "Andreas Korth"  
+  p.email           = "andreas.korth@gmail.com"  
+
+  p.retain_gemspec = true
+
+  p.ignore_pattern = %w{ 
+    Gemfile 
+    Gemfile.lock 
+    vendor/**/*
+    tmp/*
+    log/*
+    *.tmproj
+  }
+                 
+  p.runtime_dependencies     = [ "activerecord >=3.1.0" ]
+  p.development_dependencies = [ "echoe", "sqlite3", "rspec", "guard-rspec", "rb-fsevent", "growl" ]
+end  
+  
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task default: :spec

data/activerecord-fusion.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "activerecord-fusion"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andreas Korth"]
+  s.date = "2012-12-16"
+  s.description = "Fuse attributes from associated models with ActiveRecord"
+  s.email = "andreas.korth@gmail.com"
+  s.extra_rdoc_files = ["CHANGELOG", "README.markdown", "lib/active_record/fusion.rb"]
+  s.files = ["CHANGELOG", "Guardfile", "MIT-LICENSE", "Manifest", "README.markdown", "Rakefile", "lib/active_record/fusion.rb", "spec/app.rb", "spec/fusion_spec.rb", "spec/schema.rb", "spec/spec_helper.rb", "activerecord-fusion.gemspec"]
+  s.homepage = "http://github.com/juni0r/activerecord-fusion"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Activerecord-fusion", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "activerecord-fusion"
+  s.rubygems_version = "1.8.23"
+  s.summary = "Fuse attributes from associated models with ActiveRecord"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.1.0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_development_dependency(%q<growl>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.1.0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_dependency(%q<growl>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.1.0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<rb-fsevent>, [">= 0"])
+    s.add_dependency(%q<growl>, [">= 0"])
+  end
+end

data/lib/active_record/fusion.rb

@@ -0,0 +1,137 @@
+module ActiveRecord
+  module Fusion
+
+    extend ActiveSupport::Concern
+  
+    included do
+      class_attribute :fusion_associations
+      self.fusion_associations = {}
+    end
+  
+    module ClassMethods
+
+      def fusion(name, options = nil)
+        reflection = reflect_on_association(name)
+      
+        if reflection.nil?
+          raise ArgumentError, "#{self.name} has no association #{name.inspect}"
+        end
+      
+        if reflection.collection?
+          raise ArgumentError, "Only belongs_to and has_one associations can be fused"
+        end
+
+        assoc = Association.new(reflection, options)
+
+        self.fusion_associations = fusion_associations.merge(name => assoc)
+      end
+      
+      def fuse(*assocs)
+        context = scoped
+        
+        if context.select_values.empty?
+          context = context.select(arel_table[Arel::star])
+        end
+        
+        assocs = if assocs.any?
+          fusion_associations.values_at(*assocs)
+        else
+          fusion_associations.values
+        end
+        
+        assocs.each do |assoc|
+          context = context.select(assoc.selects).joins(assoc.joins)
+        end
+        
+        context
+      end
+  
+      def define_attribute_methods
+        @attribute_methods_mutex.synchronize do
+          return if attribute_methods_generated?
+
+          fusion_associations.each_value do |assoc|
+            assoc.each_column do |name, column, serialized|
+              columns_hash[name] = column
+              serialized_attributes[name] = serialized if serialized
+              define_fusion_attribute_methods(assoc.name, name)
+            end
+          end
+        end
+
+        super
+      end
+      
+      def define_fusion_attribute_methods(assoc_name, attr_name)
+        generated_attribute_methods.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def __temp__
+            if @attributes.has_key?("#{attr_name}")
+              (v=@attributes["#{attr_name}"]) && #{attribute_cast_code(attr_name)}
+            else
+              #{assoc_name}.#{attr_name}
+            end
+          end
+          alias_method :"#{attr_name}", :__temp__
+          undef_method :__temp__
+
+          def __temp__
+            !!send(:"#{attr_name}")
+          end
+
+          alias_method '#{attr_name}?', :__temp__
+          undef_method :__temp__
+        RUBY
+      end
+    end
+
+    class Association #:nodoc:
+
+      def initialize(reflection, options = nil)
+        @reflection = reflection
+        @options = options.is_a?(Hash) ? options : { only: options }
+        @options.assert_valid_keys(:only, :except)      
+      end
+    
+      def method_missing(method, *args, &block)
+        if @reflection.respond_to? method
+          @reflection.send(method, *args, &block)
+        else
+          super
+        end
+      end
+    
+      def attributes
+        unless @attributes
+          only = Array.wrap(@options[:only]).map(&:to_s)
+          except = Array.wrap(@options[:except]).map(&:to_s)
+
+          @attributes = klass.attribute_names
+          @attributes &= only if only.any?
+          @attributes -= active_record.attribute_names
+          @attributes -= [foreign_key] unless belongs_to?
+          @attributes -= except if except.any?
+        end
+        @attributes
+      end
+        
+      def each_column
+        attributes.each do |name|
+          yield(name, klass.columns_hash[name], klass.serialized_attributes[name])
+        end
+      end
+    
+      def selects     
+        @select ||= attributes.map{ |name| klass.arel_table[name] }
+      end
+      
+      def joins
+        dep = ActiveRecord::Associations::JoinDependency.new(active_record, name, [])
+        dep.join_associations.each{ |a| a.join_type = Arel::OuterJoin }
+      end
+    end  
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::Fusion
+end

data/spec/app.rb

@@ -0,0 +1,27 @@
+require 'schema'
+
+class Essential < ActiveRecord::Base
+  has_many :details
+  has_one  :detail, inverse_of: :essential
+  
+  has_many :features
+  has_one  :feature, conditions:{ active:true }
+
+  fusion :detail, [:first_name, :count, :checked, :birthday, :baggage] 
+
+  fusion :feature, except: :active 
+end
+
+
+class Detail < ActiveRecord::Base
+  belongs_to :essential, inverse_of: :detail
+
+  fusion :essential, :token
+
+  serialize :baggage
+end
+
+
+class Feature < ActiveRecord::Base
+  belongs_to :essential, inverse_of: :detail
+end

data/spec/fusion_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe ActiveRecord::Fusion do
+  
+  context "directive" do
+    
+    def definition_should_raise(message, &block)
+      lambda{ Essential.class_eval(&block) }.should raise_error(ArgumentError, message)
+    end
+    
+    it "should require the association to be defined" do
+      definition_should_raise "Essential has no association :bogus" do
+        fusion :bogus
+      end
+    end
+    
+    it "should not work with has_many associations" do
+      definition_should_raise "Only belongs_to and has_one associations can be fused" do
+        fusion :details
+      end
+    end
+  end
+  
+  it "should respect association options" do
+    essential = Essential.create!
+    Feature.create!(essential_id:essential.id, value:23, active:false)
+    Feature.create!(essential_id:essential.id, value:42, active:true)
+    Feature.create!(essential_id:essential.id, value:45, active:false)      
+    
+    essential = Essential.fuse(:detail).first
+    essential.value.should eql(42)
+  end
+
+  context "relation" do
+    
+    before do
+      Essential.create!(:token => "ESSENTIAL").create_detail(
+        :first_name => "John",
+        :last_name  => "Doe",
+        :count      => 23,
+        :checked    => false,
+        :birthday   => "18.12.1974",
+        :baggage    => {:key => "value"})
+    end
+
+    it "should work with belongs_to associations" do
+      Detail.fuse(:essential).first.token.should eql("ESSENTIAL")
+      Detail.create!
+      Detail.fuse(:essential).should have(2).items
+    end
+  
+    it "should include records without an association" do
+      Essential.fuse(:detail).create!
+      Essential.should have(2).items
+    end
+    
+    it "should include all attributes from the specified associations" do
+      essential = Essential.fuse(:detail, :feature).first
+      essential.attributes.keys.should =~ 
+       %w{ id token created_at updated_at first_name count checked birthday baggage value }
+    end
+  
+    context "attribute methods" do
+      
+      let :essential do
+        Essential.fuse(:detail).first
+      end
+      
+      it "should read string attributes" do
+        essential.first_name.should eql("John")
+      end
+
+      it "should read integer attributes" do
+        essential.count.should eql(23)
+      end
+
+      it "should read boolean attributes" do
+        essential.checked.should eql(false)
+      end
+
+      it "should read date attributes" do
+        essential.birthday.should eql(Date.new(1974,12,18))
+      end
+
+      it "should read serialized attributes" do
+        essential.baggage.should eql({:key => "value"})
+      end
+    end
+  end  
+end

data/spec/schema.rb

@@ -0,0 +1,36 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter   => "sqlite3", 
+  :database  => ":memory:", 
+  :verbosity => "silent"
+)
+
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define(:version => 1) do
+
+    create_table :essentials do |t|
+      t.string :token
+      t.timestamps
+    end
+
+    create_table :details do |t|
+      t.belongs_to :essential
+
+      t.string  :first_name
+      t.string  :last_name
+      t.integer :count
+      t.boolean :checked
+      t.date    :birthday
+      t.text    :baggage
+
+      t.timestamps
+    end
+    
+    create_table :features do |t|
+      t.belongs_to :essential
+      t.integer :value
+      t.boolean :active
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+GEM_ROOT = File.expand_path('../..',__FILE__)
+$: << File.join(GEM_ROOT,'lib')
+
+require 'active_record'
+require 'active_record/fusion'
+require 'app'
+
+ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new(File.join(GEM_ROOT,'log','test.log'))
+ActiveRecord::Base::include_root_in_json = false
+
+RSpec.configure do |config|
+  config.before do 
+    ActiveRecord::Base::descendants.each{ |model| model.delete_all }
+  end
+end
+

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-fusion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andreas Korth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: echoe
+  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: sqlite3
+  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: rspec
+  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: guard-rspec
+  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: rb-fsevent
+  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: growl
+  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'
+description: Fuse attributes from associated models with ActiveRecord
+email: andreas.korth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG
+- README.markdown
+- lib/active_record/fusion.rb
+files:
+- CHANGELOG
+- Guardfile
+- MIT-LICENSE
+- Manifest
+- README.markdown
+- Rakefile
+- lib/active_record/fusion.rb
+- spec/app.rb
+- spec/fusion_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- activerecord-fusion.gemspec
+homepage: http://github.com/juni0r/activerecord-fusion
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Activerecord-fusion
+- --main
+- README.markdown
+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: '1.2'
+requirements: []
+rubyforge_project: activerecord-fusion
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fuse attributes from associated models with ActiveRecord
+test_files: []