activerecord-embedding 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gemspec
+

data/README.md

@@ -0,0 +1,84 @@
+# activerecord-embedding
+
+Adds MongoDB style `embeds_many` to `ActiveRecord`.
+
+## Example
+
+```
+class Invoice < ActiveRecord::Base
+  include ActiveRecord::Embedding
+
+  embeds_many :items
+end
+```
+
+Now you can do all the magic `ActiveRecord` does not support natively.
+
+```
+@invoice = Invoice.new
+@invoice.attributes = {items: [{description: "Some fancy ORM",                       value: 10.00},
+                               {description: "When ActiveRecord does what you want", value: "priceless"}]}
+```
+
+You can also change your items and ActiveRecord will mark them for destruction and destroy them later.
+
+```
+# Imagine an Invoice with two items...
+@invoice.find(1)
+Items.count           # => 2
+@invoice.items.length # => 2
+
+# When we change the items to zero...
+@invoice.attributes = {items: []}
+@invoice.items.length # => 0
+Items.count           # => 2 (because not saved yet)
+
+# It will write the changes after we save them
+@invoice.save!
+@invoice.items.length # => 0
+Items.count           # => 0
+```
+
+Hopefully someday there will be native support for this in ActiveRecord.
+
+## Usage
+
+Add the gem to your `Gemfile`
+
+```
+gem "activerecord-embedding"
+```
+
+Then use in your models.
+```
+class Invoice < ActiveRecord::Base
+  include ActiveRecord::Embedding
+
+  embeds_many :items
+end
+```
+
+Remember to `include ActiveRecord::Embedding`!
+
+## Development
+
+There are some pretty evil hacks in the source. Feel free to fix them and send
+me a pull request. Please comment your code and write tests. You can run the
+test suite with `rake`. Please do not modify the `version.rb` file.
+
+## Release
+
+(Because my short time memory lasts for less than 23 ignoseconds, I need to write this down)
+
+```
+# Remember to run the tests and to bump the version
+gem build activerecord-embedding.gemspec
+gem push activerecord-embedding-$version.gem
+```
+
+## Credits
+
+I must admit that this code is mostly based on a gist of netzpirat.  Michael,
+you did a great job! I just improved your code, added a few really really ugly
+hacks to work around some strange ActiveRecord behavior and wrote some tests.
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+

data/activerecord-embedding.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/active_record/embedding/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "activerecord-embedding"
+  s.version     = ActiveRecord::Embedding::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Markus Fenske"]
+  s.email       = ["iblue@gmx.net"]
+  s.homepage    = "http://github.com/iblue/activerecord-embedding"
+  s.summary     = "Adds MongoMapper embeds_many style behavior to ActiveRecord"
+  s.description = "Adds MongoMapper embeds_many style behavior to ActiveRecord"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "debugger"
+  s.add_development_dependency "sqlite3"
+
+  s.add_dependency "activerecord", "~> 3.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end
+

data/lib/active_record/embedding.rb

@@ -0,0 +1,155 @@
+# The code is based on this original source by Michael Kessler (netzpirat):
+# Original source: https://gist.github.com/892426
+module ActiveRecord
+  # Allows embedding of ActiveRecord models.
+  #
+  # Embedding other ActiveRecord models is a composition of the two
+  # and leads to the following behaviour:
+  #
+  # - Nested attributes are accepted on the parent without the _attributes suffix
+  # - Mass assignment security allows the embedded attributes
+  # - Embedded models are destroyed with the parent when not appearing in an update again
+  # - Embedded documents appears in the JSON output
+  # - Embedded documents that are deleted are not visible to the parent anymore, but
+  #   will be deleted *after* save has been caled
+  #
+  # You have to manually include this module
+  #
+  # @example
+  #   class Invoice
+  #     include ActiveRecord::Embedding
+  #
+  #     embeds_many :items
+  #   end
+  #
+  # @author Michael Kessler
+  # modified by Markus Fenske <iblue@gmx.net>
+  #
+  module Embedding
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      mattr_accessor :embeddings
+      self.embeddings = []
+
+      # Embeds many ActiveRecord model
+      #
+      # @param models [Symbol] the name of the embedded models
+      # @param options [Hash] the embedding options
+      #
+      def embeds_many(models, options = { })
+        has_many models, options.merge(:dependent => :destroy, :autosave => true)
+        embed_attribute(models)
+        attr_accessible "#{models}_attributes".to_sym
+
+        # What is marked for destruction does not evist anymore from
+        # our point of view. FIXME: Really evil hack.
+        alias_method "_super_#{models}".to_sym, models
+        define_method models do
+          # This is an evil hack. Because activerecord uses the items method itself to
+          # find out which items are deleted, we need to act differently if called by
+          # ActiveRecord. So we look at the paths in the Backtrace. If there is
+          # activerecord-3 anywhere there, this is called by AR. This will work until
+          # AR 4.0...
+          if caller(0).select{|x| x =~ /activerecord-3/}.any?
+            return send("_super_#{models}".to_sym) 
+          end
+
+          # Otherwise, when we are called by someone else, we will not return the items
+          # marked for destruction.
+          send("_super_#{models}".to_sym).reject(&:marked_for_destruction?)
+        end
+      end
+
+      # Embeds many ActiveRecord models which have been referenced
+      # with has_many.
+      #
+      # @param models [Symbol] the name of the embedded models
+      #
+      def embeds(models)
+        embed_attribute(models)
+      end
+
+      private
+
+      # Makes the child model accessible by accepting nested attributes and
+      # makes the attributes accessible when mass assignment security is enabled.
+      #
+      # @param name [Symbol] the name of the embedded model
+      #
+      def embed_attribute(name)
+        accepts_nested_attributes_for name, :allow_destroy => true
+        attr_accessible "#{ name }_attributes".to_sym if _accessible_attributes?
+        self.embeddings << name
+      end
+    end
+
+    # Sets the attributes
+    #
+    # @param new_attributes [Hash] the new attributes
+    #
+    def attributes=(attrs)
+      return unless attrs.is_a?(Hash)
+
+      # Create a copy early so we do not overwrite the argument
+      new_attributes = attrs.dup
+
+      mark_for_destruction(new_attributes)
+
+      self.class.embeddings.each do |embed|
+        if new_attributes[embed]
+          new_attributes["#{embed}_attributes"] = new_attributes[embed]
+          new_attributes.delete(embed)
+        end
+      end
+
+      super(new_attributes)
+    end
+
+    # Update attributes and destroys missing embeds
+    # from the database.
+    #
+    # @params attributes [Hash] the attributes to update
+    #
+    def update_attributes(attributes)
+      super(mark_for_destruction(attributes))
+    end
+
+    # Update attributes and destroys missing embeds
+    # from the database.
+    #
+    # @params attributes [Hash] the attributes to update
+    #
+    def update_attributes!(attributes)
+      super(mark_for_destruction(attributes))
+    end
+
+    # Add the embedded document in JSON serialization
+    #
+    # @param options [Hash] the rendering options
+    #
+    def as_json(options = { })
+      super({ :include => self.class.embeddings }.merge(options || { }))
+    end
+
+    private
+
+    # Marks missing models as deleted. Writes the changes to the database,
+    # after save has been called.
+    #
+    # @param attributes [Hash] the attributes
+    #
+    def mark_for_destruction(attributes)
+      self.class.embeddings.each do |embed|
+        if attributes[embed]
+          updates = attributes[embed].map { |model| model[:id] }.compact
+          destroy = updates.empty? ? send("_super_#{embed}".to_sym).select(:id) : send("_super_#{embed}".to_sym).select(:id).where('id NOT IN (?)', updates)
+          destroy.each { |model| attributes[embed] << { :id => model.id, :_destroy => '1' } }
+        end
+      end
+
+      attributes
+    end
+  end
+end
+

data/lib/active_record/embedding/version.rb

@@ -0,0 +1,6 @@
+module ActiveRecord
+  module Embedding
+    VERSION = "0.0.1"
+  end
+end
+

data/lib/activerecord-embedding.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'active_record/embedding.rb'
+require 'active_record/embedding/version.rb'
+

data/test/models/invoice.rb

@@ -0,0 +1,10 @@
+class Invoice < ActiveRecord::Base
+  include ActiveRecord::Embedding
+
+  embeds_many :items
+
+  def total
+    items.map{|i| i.amount * i.value}.compact.reduce(:+) || 0.0
+  end
+end
+

data/test/models/item.rb

@@ -0,0 +1,6 @@
+class Item < ActiveRecord::Base
+  belongs_to :invoice
+
+  attr_accessible :amount, :description, :value
+end
+

data/test/schema/schema.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+ActiveRecord::Schema.define do
+  create_table "invoices", :force => true do |t|
+    t.string   "recipient_email"
+  end
+
+  create_table "items", :force => true do |t|
+    t.integer  "invoice_id"
+    t.integer  "amount"
+    t.string   "description"
+    t.float    "value"
+  end
+end
+

data/test/test_main.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'debugger'
+
+require 'test/unit'
+require 'active_record'
+require 'active_record/base'
+require 'logger'
+
+require 'activerecord-embedding'
+
+require 'models/invoice'
+require 'models/item'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database  => "/tmp/test.db"
+)
+load "schema/schema.rb"
+
+
+# Make sure we see whats happening
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+class MainTest < Test::Unit::TestCase
+  def test_embedding
+    # Build a new invoice, do not save anything, exists in memory only
+    puts "--- Should not issue a query"
+    @invoice = Invoice.new
+    @invoice.attributes = {items: [{amount: 1, description: "Item 1", value: 10.00}, {amount: 2, description: "Item 2", value: 8.00}]}
+    assert_equal 0, Invoice.count
+    assert_equal 0, Item.count
+    assert_equal 26.00, @invoice.total
+    puts "   end"
+
+    # Create everything, make sure it gets saved to the database
+    puts "--- Should INSERT 1 invoice and 2 items"
+    @invoice.save!
+    assert_equal 1, Invoice.count
+    assert_equal 2, Item.count
+    assert_equal ["Item 1", "Item 2"], Item.all.map(&:description)
+    assert_equal 26.00, @invoice.total
+    puts "   end"
+
+    # Change attributes, make sure it exists in memory only and does not get
+    # saved to the database
+    puts "--- Should not issue a query"
+    @invoice.attributes = {items: [{amount: 1, description: "Item 3", value: 10.00}]}
+    assert_equal 1, Invoice.count
+    assert_equal 2, Item.count
+    assert_equal ["Item 1", "Item 2"], Item.all.map(&:description)
+    assert_equal 10.00, @invoice.total # But the total value in memory should change
+    puts "   end"
+
+    # Now save changes to database.
+    puts "--- Should DELETE 2 items, INSERT 1 item"
+    @invoice.save!
+    assert_equal 1, Invoice.count
+    assert_equal 1, Item.count
+    assert_equal ["Item 3"], Item.all.map(&:description)
+    assert_equal 10.00, @invoice.total # Total value in memory should stay the same
+    puts "   end"
+
+    # Delete everything, make sure it's gone.
+    puts "--- Should DELETE 1 item, DELETE 1 invoice"
+    @invoice.destroy
+    assert_equal 0, Invoice.count
+    assert_equal 0, Item.count
+    puts "   end"
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-embedding
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Markus Fenske
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 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.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Adds MongoMapper embeds_many style behavior to ActiveRecord
+email:
+- iblue@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-embedding.gemspec
+- lib/active_record/embedding.rb
+- lib/active_record/embedding/version.rb
+- lib/activerecord-embedding.rb
+- test/models/invoice.rb
+- test/models/item.rb
+- test/schema/schema.rb
+- test/test_main.rb
+homepage: http://github.com/iblue/activerecord-embedding
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds MongoMapper embeds_many style behavior to ActiveRecord
+test_files: []
+has_rdoc: