foreign_model 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+doc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Nicholaides
+
+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.rdoc

@@ -0,0 +1,17 @@
+= foreign_model
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Mike Nicholaides. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "foreign_model"
+    gem.summary = %Q{ActiveRecord-like associations that work between models of different databases and database types.}
+    gem.description = %Q{Works for ActiveRecord and Mongoid}
+    gem.email = "mike@ablegray.com"
+    gem.homepage = "http://github.com/nicholaides/foreign_model"
+    gem.authors = ["Mike Nicholaides"]
+    gem.add_development_dependency "spec", ">= 1.3.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "foreign_model #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/foreign_model.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{foreign_model}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Nicholaides"]
+  s.date = %q{2010-04-02}
+  s.description = %q{Works for ActiveRecord and Mongoid}
+  s.email = %q{mike@ablegray.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "foreign_model.gemspec",
+     "lib/foreign_model.rb",
+     "spec/foreign_model_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/nicholaides/foreign_model}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{ActiveRecord-like associations that work between models of different databases and database types.}
+  s.test_files = [
+    "spec/foreign_model_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<spec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<spec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<spec>, [">= 1.3.0"])
+  end
+end
+

data/lib/foreign_model.rb

@@ -0,0 +1,92 @@
+module ForeignModel
+  SCOPE_PROCS = {}
+  
+  def self.included(base)
+    SCOPE_PROCS[base] ||= {}
+    base.extend ClassMethods
+  end
+  
+  def self.camelize(str)
+    str.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+  end
+  
+  module ClassMethods
+    def belongs_to_foreign_model(name, options={})
+      options[:class_name] ||= ForeignModel.camelize(name.to_s)
+      
+      ForeignModel::SCOPE_PROCS[self][name.to_s] = begin
+        if options[:scope]
+          options[:scope]
+        elsif options[:polymorphic]
+          proc do |r|
+            type = r.send("#{name}_type")
+            type and eval(type)
+          end
+        else
+          #TODO: this is a hack
+          proc{ eval(options[:class_name]) }
+        end
+      end
+        
+      class_eval %`
+        def parent_proc_for_#{name}
+          @parent_proc_for_#{name} ||= begin
+            ForeignModel::SCOPE_PROCS[self.class]["#{name}"].call(self)
+          end
+        end
+        
+        def #{name}
+          @#{name} ||= parent_proc_for_#{name}.find(#{name}_id) if parent_proc_for_#{name} && #{name}_id 
+        end
+
+        def #{name}=(foreign_model)
+          @#{name} = foreign_model
+          if foreign_model
+            send('#{name}_id=', foreign_model.id)
+            send('#{name}_type=', foreign_model.class.name) if respond_to? '#{name}_type='
+          end
+        end
+
+        def #{name}_id=(foreign_model_id)
+          if #{name}_id != foreign_model_id
+            write_raw_attribute("#{name}_id", foreign_model_id)
+            @#{name} = nil
+          end
+        end
+      `
+      
+      if options[:polymorphic]
+        class_eval %`  
+          def #{name}_type=(foreign_model_type)
+            if #{name}_type != foreign_model_type
+              write_raw_attribute("#{name}_type", foreign_model_type)
+              @#{name} = nil
+            end
+          end
+        `
+      end
+    end
+  end
+end
+
+class Object
+  def write_raw_attribute(name, value)
+    instance_variable_set "@#{name}".to_sym, value
+  end
+end
+
+module ActiveRecord
+  class Base
+    def write_raw_attribute(name, value)
+      write_attribute name.to_sym, value
+    end
+  end
+end
+
+module Mongoid
+  module Document
+    def write_raw_attribute(name, value)
+      raw_attributes[name.to_s] = value
+    end
+  end
+end

data/spec/foreign_model_spec.rb

@@ -0,0 +1,210 @@
+require "spec"
+require File.dirname(__FILE__) + '/../lib/foreign_model'
+
+describe "belongs_to_foreign_model" do
+  class Parent
+    attr_accessor :id
+    def initialize(id="some_id")
+      @id = id
+    end
+    
+    def self.find(id)
+      new(id)
+    end
+    
+    def ==(other)
+      self.class == other.class && self.id == other.id
+    end
+  end
+  
+  class Child
+    attr_reader :parent_id
+    include ForeignModel
+    belongs_to_foreign_model :parent
+  end
+  
+  describe Child do
+    describe "#parent=" do
+      before :each do
+        @parent = Parent.new
+        @child = Child.new
+      end
+      it "should accept nil" do
+        @child.parent = nil
+        @child.parent.should be_nil
+      end
+      it "should set parent" do
+        @child.parent = @parent
+        @child.parent.should == @parent
+      end
+      it "should set parent id" do
+        @child.parent = @parent
+        @child.parent_id.should == @parent.id
+      end
+    end
+  end
+
+  describe "#parent_type_id=" do
+    before :each do
+      @parent = Parent.new
+      @child  = Child.new
+      @child.parent_id = @parent.id
+    end
+    it "should set the parent" do
+     @child.parent.should == @parent
+   end
+    it "should set the parent_id" do
+      @child.parent_id.should == @parent.id
+    end
+    
+    context "when nil" do
+      it "should the assiated model should be nil" do
+        @child  = Child.new
+        @child.parent_id = nil
+        
+        @child.parent.should be_nil
+      end
+    end
+  end
+
+  describe "with :scope => proc{...}" do
+    class ChildWithScope
+      attr_reader :parent_id
+      include ForeignModel
+      belongs_to_foreign_model :parent, :scope => proc{ Scope }
+    end
+    
+    class Scope
+    end
+    
+    it "should find by scope" do
+      @child = ChildWithScope.new
+      @child.parent_id = "another id"
+      
+      @parent = mock("parent found by scope")
+      Scope.should_receive(:find).with("another id").and_return(@parent)
+      
+      @child.parent.should == @parent
+    end
+    
+    context "when parent_id is nil" do
+      it "should give nil as the assiated record" do
+        @child = ChildWithScope.new
+        @child.parent_id = nil
+        @child.parent.should be_nil
+      end 
+    end
+  end
+  
+  describe "with :class_name option" do
+    class ChildWithClassName
+      attr_reader :parent_id
+      include ForeignModel
+      belongs_to_foreign_model :parent, :class_name => "SomeModule::OtherParent"
+    end
+    
+    module SomeModule
+      class OtherParent < ::Parent
+        def self.find(id)
+          new(id)
+        end
+      end
+    end
+    
+    it "should find by scope" do
+      @child = ChildWithClassName.new
+      @child.parent_id = "another id"
+      
+      @child.parent.id.should == "another id"
+      @child.parent.should be_a(SomeModule::OtherParent)
+    end
+    
+    context "when parent_id is nil" do
+      it "should give nil as the assiated record" do
+        @child = ChildWithClassName.new
+        @child.parent_id = nil
+        @child.parent.should be_nil
+      end 
+    end
+  end
+
+  describe "with :polymorphic => true" do
+    class FosterParent
+      attr_accessor :id
+      def initialize(id="some_id")
+        @id = id
+      end
+
+      def self.find(id)
+        new(id)
+      end
+
+      def ==(other)
+        self.class == other.class && self.id == other.id
+      end
+    end
+    
+    class ChildWithPolymorphicParents
+      attr_reader :parent_id
+      attr_reader :parent_type
+      include ForeignModel
+      belongs_to_foreign_model :parent, :polymorphic => true
+    end
+    
+    before :each do
+      @parent        = Parent.new
+      @foster_parent = FosterParent.new
+      @child         = ChildWithPolymorphicParents.new
+    end
+    
+    it "should set the parent to a Parent" do
+      @child.parent = @parent
+      
+      @child.parent.should      == @parent
+      @child.parent_id.should   == @parent.id
+      @child.parent_type.should == "Parent"
+    end
+    
+    it "should set the parent to a FosterParent" do
+      @child.parent = @foster_parent
+      
+      @child.parent.should      == @foster_parent
+      @child.parent_id.should   == @foster_parent.id
+      @child.parent_type.should == "FosterParent"
+    end
+    
+    it "should set the parent by id and type" do
+      @child.parent_id   = @foster_parent.id
+      @child.parent_type = "FosterParent"
+      
+      @child.parent.should == @foster_parent
+    end
+    
+    context "when parent_id is nil" do
+      it "should give nil as the assiated record" do
+        @child = ChildWithPolymorphicParents.new
+        @child.parent_id = nil
+        @child.parent_type = "FosterParent"
+        @child.parent.should be_nil
+      end 
+    end
+    
+    context "when parent_type is nil" do
+      it "should give nil as the assiated record" do
+        @child = ChildWithPolymorphicParents.new
+        @child.parent_id = "2"
+        @child.parent_type = nil
+        @child.parent.should be_nil
+      end 
+    end
+    
+    context "when parent_id and parent_type are nil" do
+      it "should give nil as the assiated record" do
+        @child = ChildWithPolymorphicParents.new
+        @child.parent_id = nil
+        @child.parent_type = nil
+        @child.parent.should be_nil
+      end 
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: foreign_model
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mike Nicholaides
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-02 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: Works for ActiveRecord and Mongoid
+email: mike@ablegray.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- foreign_model.gemspec
+- lib/foreign_model.rb
+- spec/foreign_model_spec.rb
+has_rdoc: true
+homepage: http://github.com/nicholaides/foreign_model
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ActiveRecord-like associations that work between models of different databases and database types.
+test_files: 
+- spec/foreign_model_spec.rb