sundbp-dm-polymorphic 0.10.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Daniel Neighman
+
+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

@@ -0,0 +1,51 @@
+Please see wiki for discussion.
+
+The DM polymorphic gem mimics AR style polymorphism.  It has been decided that DM will not follow this path, since it
+really isn't very nice on the DB and there are other ways, that do not require DBA to cry to achieve the same result.
+
+That being said this is still useful for those ppl wishing to convert rails apps over.  
+
+One Massive Caveat is that using this you will get n+1 calls to the db atm if you do Comments#commentable for example.  It needs a proxy object if anyone cares to write one.
+
+This is highly experimental software, use it at your own risk.
+
+==== Example Usage.
+
+class Comment
+  include DataMapper::Resource
+  
+  is :polymorphic, :commentable
+  
+  property :id,   Integer, :serial => true
+  property :text, String
+end
+    
+class Post
+  include DataMapper::Resource
+  
+  property :id, Integer, :serial => true
+  property :name,  String  
+
+  has n, :comments, :polymorphically => :commentable   
+end
+
+class Article
+  include DataMapper::Resource
+  
+  property :id, Integer, :serial => true
+  property :name,  String  
+
+  has n, :comments, :polymorphically => :commentable
+end
+
+This will then provide the following methods
+
+Comment#commentable
+Comment#post
+Comment#article
+Post#comments
+Article#comments
+
+What is needed is a 
+Comment.commentables or something method so there is a nice proxy to avoid having all the loading issues.
+

data/Rakefile

@@ -0,0 +1,60 @@
+require "rubygems"
+require "spec"
+require "rake/clean"
+require "rake/gempackagetask"
+require "spec/rake/spectask"
+require "pathname"
+
+CLEAN.include "{log,pkg}/"
+
+spec = Gem::Specification.new do |s|
+  s.name             = "sundbp-dm-polymorphic"
+  s.version          = "0.10.2"
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = "DataMapper plugin enabling simple ActiveRecord style polymorphism"
+  s.description      = s.summary
+  s.author           = "Daniel Neighman, Wayne E. Seguin, Ripta Pasay"
+  s.email            = "has.sox@gmail.com, wayneeseguin@gmail.com, github@r8y.org"
+  s.homepage         = "http://github.com/hassox/dm-polymorphic"
+  s.require_path     = "lib"
+  s.files            = FileList[ "{lib,spec}/**/*.rb", "spec/spec.opts", "Rakefile", *s.extra_rdoc_files ]
+  s.add_dependency("dm-core", ">=#{s.version}")
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? "" : ("sudo" unless ENV["SUDOLESS"])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+desc "Run specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << "--options" << "spec/spec.opts" if File.exists?("spec/spec.opts")
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + "spec/**/*_spec.rb")
+
+  begin
+    t.rcov = ENV.has_key?("NO_RCOV") ? ENV["NO_RCOV"] != "true" : true
+    t.rcov_opts << "--exclude" << "spec"
+    t.rcov_opts << "--text-summary"
+    t.rcov_opts << "--sort" << "coverage" << "--sort-reverse"
+  rescue Exception
+    # rcov not installed
+  end
+end

data/lib/associations.rb

@@ -0,0 +1,25 @@
+module DataMapper
+  module Model
+    module Relationship
+      
+      alias_method :has_without_polymorphism, :has
+      
+      def has(cardinality, name, *args)
+        opts = args.extract_options!
+        if interface = opts.delete(:polymorphically)
+          # get the child model
+          child_model_name =  opts.fetch(:class_name, Extlib::Inflection.classify(name))
+          child_klass =       Extlib::Inflection.constantize(child_model_name)
+          belongs_to_name =   Extlib::Inflection.underscore(Extlib::Inflection.demodulize(self.name))
+          
+          # Setup the has with the right stuff
+          has_without_polymorphism cardinality, name,   :child_key => [:"#{interface}_id"], :"#{interface}_class" => self
+          child_klass.belongs_to :"#{belongs_to_name}", :child_key => [:"#{interface}_id"], :"#{interface}_class" => self
+        else
+          has_without_polymorphism(cardinality, name, *(args + [opts]))
+        end
+      end
+      
+    end
+  end
+end

data/lib/dm-polymorphic.rb

@@ -0,0 +1,46 @@
+require "rubygems"
+require "pathname"
+
+gem "dm-core", ">=0.10.0"
+require "dm-core"
+
+
+module DataMapper
+  module Is
+    module Polymorphic
+      
+      def is_polymorphic(name, id_type = Serial)
+        self.class_eval <<-EOS, __FILE__, __LINE__
+          property :"#{name}_class", Klass
+          property :"#{name}_id",    #{id_type}
+          
+          def #{name}
+            return nil if self.#{name}_class.nil? || self.#{name}_class == NilClass
+            return nil if self.#{name}_id.nil?
+            if (self.#{name}_class.class == Class)
+              self.#{name}_class.get(self.#{name}_id)
+            else
+              klass = Kernel.const_get(self.#{name}_class.to_s)
+              if klass.ancestors.include? DataMapper::Resource
+                klass.get(self.#{name}_id)
+              else
+                nil
+              end
+            end
+          end        
+
+          def #{name}=(entity)
+            self.#{name}_class = entity.class
+            self.#{name}_id = entity.id
+          end        
+        EOS
+      end
+      
+    end # Polymophic
+  end # Is
+end
+
+DataMapper::Model.append_extensions DataMapper::Is::Polymorphic
+
+require Pathname(__FILE__).dirname.expand_path / "associations.rb" 
+require Pathname(__FILE__).dirname.expand_path / "types.rb" 

data/lib/tester.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), "dm-polymorphic")
+
+DataMapper::Logger.new(STDOUT, :debug)
+DataMapper.setup(:default, 'sqlite3::memory:')
+
+class Comment
+  include DataMapper::Resource
+  
+  is :polymorphic, :commentable
+  
+  property :id,   Integer, :serial => true
+  property :text, String
+end
+    
+class Post
+  include DataMapper::Resource
+  
+  property :id, Integer, :serial => true
+  property :name,  String  
+
+  has n, :comments, :polymorphically => :commentable   
+end
+
+class Article
+  include DataMapper::Resource
+  
+  property :id, Integer, :serial => true
+  property :name,  String  
+
+  has n, :comments, :polymorphically => :commentable
+end
+
+Comment.auto_migrate!
+Post.auto_migrate!
+Article.auto_migrate!
+
+post1 = Post.create(:name => "post1")
+article1 = Article.create(:name => "article1")
+post2 = Post.create(:name => "post2")
+article2 = Article.create(:name => "article2")
+
+%w(one two three four five six seven eight nine ten).each_with_index do |text, index|
+  [post1, post2, article1, article2].each do |item|
+    item.comments << Comment.new(:text => text)
+  end
+end
+
+Comment.all.each do |c|
+  puts "COMMENT: #{c.text} - #{c.commentable}"
+end

data/lib/types.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Types
+    class Klass < DataMapper::Type
+      primitive Class
+    end # class Klass
+  end # module Types
+end # module DataMapper

data/spec/dm-polymorphic_spec.rb

@@ -0,0 +1,121 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+DataMapper::Logger.new(STDOUT, :debug)
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe "DataMapper::Polymorphic" do
+    
+    class Comment
+      include DataMapper::Resource
+
+      is :polymorphic, :commentable
+
+      property :id,   Serial
+      property :text, String
+    end
+
+    class Post
+      include DataMapper::Resource
+
+      property :id,   Serial
+      property :name, String  
+
+      has n, :comments, :polymorphically => :commentable   
+    end
+
+    class Article
+      include DataMapper::Resource
+
+      property :id,   Serial
+      property :name, String  
+
+      has n, :comments, :polymorphically => :commentable
+    end
+    
+    before :each do
+      Comment.auto_migrate!
+      Post.auto_migrate!
+      Article.auto_migrate!
+    end
+    
+    [Article, Post].each do |klass|
+      it "should create an associated object for #{klass}" do
+        item = klass.create(:name => "item1")
+        item.reload
+        item.comments.create(:text => "A Comment")
+        item.reload
+        item.comments(:text => "A Comment").should have(1).item
+      end
+      
+      it "should add the comment with the << syntax for #{klass}" do
+        item = klass.create(:name => "item2")
+        c = Comment.new(:text => "comment2")
+        item.comments << c
+        c.save
+        item.reload
+        item.comments(:text => "comment2").should have(1).item
+      end
+      
+      it "should not add the comment with the << syntax for #{klass} if comment was not saved" do
+        item = klass.create(:name => "item2a")      
+        c = Comment.new(:text => "comment2a")
+        item.comments << c
+        item.reload
+        item.comments(:text => "comment2a").should have(0).item
+      end
+      
+      it "should access all the comments from the post for #{klass}" do
+        item = klass.create(:name => "item3")
+        c1 = Comment.new(:text => "comment3")
+        c2 = Comment.new(:text => "comment4")
+        [c1,c2].each{|c| item.comments << c}
+        item.comments.save
+        item.reload
+        item.comments.should have(2).items
+      end
+      
+      it "should access the post from the comment for #{klass}" do
+        item = klass.create(:name => "item4")
+        c = Comment.new(:text => "comment5")
+        item.comments << c
+        item.save
+        c.send(Extlib::Inflection.underscore(klass.name).to_sym).should == item
+      end
+      
+      it "should access the commentable from the comment for #{klass}" do
+        item = klass.create(:name => "item5")        
+        c = Comment.new(:text => "comment6")
+        item.comments << c
+        c.save
+        item.reload; c.reload
+        c.commentable.should == item
+      end
+    end
+    
+    # it "should only make one query to each Model" do
+    #   post1 = Post.create(:name => "post1")
+    #   article1 = Article.create(:name => "article1")
+    #   post2 = Post.create(:name => "post2")
+    #   article2 = Article.create(:name => "article2")
+    #   
+    #   %w(one two three four five six seven eight nine ten).each_with_index do |text, index|
+    #     [post1, post2, article1, article2].each do |item|
+    #       item.comments.create(:text => text)
+    #     end
+    #   end
+    #   
+    #   Post.all.each do |c|
+    #     puts "COMMENT: #{c.text} - #{c.commentable_class}"
+    #   end
+    #   
+    #   Post.should_receive(:all).once
+    #   Article.should_receive(:all).once.and_return(Article.comments)
+    #   
+    #   Comment.all.each do |comment|
+    #     [Post, Article].should include(comment.commentable.class)
+    #   end
+    # end
+
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require "rubygems"
+require "pathname"
+
+gem "dm-core", ">=0.10.0"
+require "dm-core"
+
+spec_dir_path = Pathname(__FILE__).dirname.expand_path
+require spec_dir_path.parent + "lib/dm-polymorphic"
+
+def load_driver(name, default_uri)
+  return false if ENV["ADAPTER"] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, ">=0.10.0"
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV["ADAPTER"] ||= "sqlite3"
+
+HAS_SQLITE3  = load_driver(:sqlite3,  "sqlite3::memory:")
+HAS_MYSQL    = load_driver(:mysql,    "mysql://localhost/dm_core_test")
+HAS_POSTGRES = load_driver(:postgres, "postgres://postgres@localhost/dm_core_test")

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: sundbp-dm-polymorphic
+version: !ruby/object:Gem::Version 
+  version: 0.10.2
+platform: ruby
+authors: 
+  - Daniel Neighman, Wayne E. Seguin, Ripta Pasay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-12 00:00:00 +00:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: dm-core
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.10.2
+      version: 
+description: DataMapper plugin enabling simple ActiveRecord style polymorphism
+email: has.sox@gmail.com, wayneeseguin@gmail.com, github@r8y.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - README
+  - LICENSE
+  - TODO
+files: 
+  - lib/associations.rb
+  - lib/dm-polymorphic.rb
+  - lib/tester.rb
+  - lib/types.rb
+  - spec/dm-polymorphic_spec.rb
+  - spec/spec_helper.rb
+  - spec/spec.opts
+  - Rakefile
+  - README
+  - LICENSE
+  - TODO
+has_rdoc: true
+homepage: http://github.com/hassox/dm-polymorphic
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: DataMapper plugin enabling simple ActiveRecord style polymorphism
+test_files: []
+