sbf-dm-core 1.3.0.beta

data/spec/public/associations/many_to_many_spec.rb

@@ -0,0 +1,197 @@
+require_relative '../../spec_helper'
+
+shared_examples 'A Limited Many to Many Collection' do
+  describe '#destroy!' do
+    describe 'on a limited collection' do
+      before :all do
+        @other   = @articles.create
+        @limited = @articles.all(:limit => 1)
+
+        @return = @limited.destroy!
+      end
+
+      it 'only removes the join resource for the destroyed resource' do
+        expect(@join_model.all).not_to be_empty
+      end
+    end
+  end
+end
+
+# run the specs once with a loaded association and once not
+[ false, true ].each do |loaded|
+  describe 'Many to Many Associations with :through => Resource' do
+    extend DataMapper::Spec::CollectionHelpers::GroupMethods
+
+    self.loaded = loaded
+
+    # define the model prior to supported_by
+    before :all do
+      module ::Blog
+        class Author
+          include DataMapper::Resource
+
+          property :id,   Serial
+          property :name, String
+
+          has n, :articles, :through => Resource
+        end
+
+        class Article
+          include DataMapper::Resource
+
+          property :id,         Serial
+          property :title,      String, :required => true
+          property :content,    Text
+          property :subtitle,   String
+          property :attachment, Object
+
+          has n, :authors, :through => Resource
+          belongs_to :original, self, :required => false
+          has n, :revisions, self, :child_key => [ :original_id ]
+          has 1, :previous,  self, :child_key => [ :original_id ], :order => [ :id.desc ]
+          has n, :publications, :through => Resource
+        end
+
+        class Publication
+          include DataMapper::Resource
+
+          property :id,   Serial
+          property :name, String
+
+          has n, :articles, :through => Resource
+        end
+      end
+
+      @author_model      = Blog::Author
+      @article_model     = Blog::Article
+      @publication_model = Blog::Publication
+
+      # initialize the join model
+      DataMapper.finalize
+
+      @join_model = Blog::ArticleAuthor
+    end
+
+    supported_by :all do
+      before :all do
+        @author = @author_model.create(:name => 'Dan Kubb')
+
+        @original = @author.articles.create(:title => 'Original Article')
+        @article  = @author.articles.create(:title => 'Sample Article', :content => 'Sample', :original => @original)
+        @other    = @author.articles.create(:title => 'Other Article',  :content => 'Other')
+
+        # load the targets without references to a single source
+        load_collection = lambda do |query|
+          @author_model.get!(*@author.key).articles(query)
+        end
+
+        @articles       = load_collection.call(:title => 'Sample Article')
+        @other_articles = load_collection.call(:title => 'Other Article')
+
+        @articles.entries if loaded
+      end
+
+      it_behaves_like 'A public Collection'
+      it_behaves_like 'A public Association Collection'
+      it_behaves_like 'A Collection supporting Strategic Eager Loading' unless loaded
+      it_behaves_like 'Finder Interface'
+      it_behaves_like 'Collection Finder Interface'
+      it_behaves_like 'A Limited Many to Many Collection'
+    end
+  end
+
+  describe 'Many to Many Associations :through => one_to_many' do
+    extend DataMapper::Spec::CollectionHelpers::GroupMethods
+
+    self.loaded = loaded
+
+    # define the model prior to supported_by
+    before :all do
+      module ::Blog
+        class Author
+          include DataMapper::Resource
+
+          property :id,   Serial
+          property :name, String
+
+          has n, :sites
+          has n, :articles, :through => :sites
+        end
+
+        class Site
+          include DataMapper::Resource
+
+          property :name, String, :key => true, :default => 'default'
+
+          belongs_to :author
+          has n, :articles
+        end
+
+        class Article
+          include DataMapper::Resource
+
+          property :id,         Serial
+          property :title,      String, :required => true
+          property :content,    Text
+          property :subtitle,   String
+          property :attachment, Object
+
+          property :site_name, String, :default => 'default'
+
+          belongs_to :site
+          has n, :authors, :through => :site
+          belongs_to :original, self, :required => false
+          has n, :revisions, self, :child_key => [ :original_id ]
+          has 1, :previous,  self, :child_key => [ :original_id ], :order => [ :id.desc ]
+          has n, :publications, :through => Resource
+        end
+
+        class Publication
+          include DataMapper::Resource
+
+          property :id,   Serial
+          property :name, String
+
+          has n, :articles, :through => Resource
+        end
+      end
+
+      @author_model      = Blog::Author
+      @article_model     = Blog::Article
+      @publication_model = Blog::Publication
+
+      @join_model = Blog::Site
+    end
+
+    supported_by :all do
+      before :all do
+        @author = @author_model.create(:name => 'Dan Kubb')
+
+        @original_site = @author.sites.create(:name => 'original')
+        @article_site  = @author.sites.create(:name => 'article')
+        @other_site    = @author.sites.create(:name => 'other')
+
+        @original = @original_site.articles.create(:title => 'Original Article')
+        @article  = @article_site.articles.create(:title => 'Sample Article', :content => 'Sample', :original => @original)
+        @other    = @other_site.articles.create(:title => 'Other Article',  :content => 'Other')
+
+        # load the targets without references to a single source
+        load_collection = lambda do |query|
+          @author_model.get!(*@author.key).articles(query)
+        end
+
+        @articles       = load_collection.call(:title => 'Sample Article')
+        @other_articles = load_collection.call(:title => 'Other Article')
+
+        @articles.entries if loaded
+      end
+
+      it_behaves_like 'A public Collection'
+      it_behaves_like 'A public Association Collection'
+      it_behaves_like 'A Collection supporting Strategic Eager Loading' unless loaded
+      it_behaves_like 'Finder Interface'
+      it_behaves_like 'Collection Finder Interface'
+      it_behaves_like 'A Limited Many to Many Collection'
+    end
+  end
+end

data/spec/public/associations/many_to_one_spec.rb

@@ -0,0 +1,83 @@
+require_relative '../../spec_helper'
+
+describe 'Many to One Associations' do
+  before :all do
+    module ::Blog
+      class User
+        include DataMapper::Resource
+
+        property :name,        String, :key => true
+        property :age,         Integer
+        property :summary,     Text
+        property :description, Text
+        property :admin,       Boolean, :accessor => :private
+
+        belongs_to :parent, self, :required => false
+        has n, :children, self, :inverse => :parent
+
+        belongs_to :referrer, self, :required => false
+        has n, :comments
+
+        # FIXME: figure out a different approach than stubbing things out
+        def comment=(*)
+          # do nothing with comment
+        end
+      end
+
+      class Author < User; end
+
+      class Comment
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :body, Text
+
+        belongs_to :user
+      end
+
+      class Article
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :body, Text
+
+        has n, :paragraphs
+      end
+
+      class Paragraph
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :text, String
+
+        belongs_to :article
+      end
+    end
+
+    class ::Default
+      include DataMapper::Resource
+
+      property :name, String, :key => true, :default => 'a default value'
+    end
+    DataMapper.finalize
+
+    @user_model      = Blog::User
+    @author_model    = Blog::Author
+    @comment_model   = Blog::Comment
+    @article_model   = Blog::Article
+    @paragraph_model = Blog::Paragraph
+  end
+
+  supported_by :all do
+    before :all do
+      user    = @user_model.create(:name => 'dbussink', :age => 25, :description => 'Test')
+      comment = @comment_model.create(:body => 'Cool spec', :user => user)
+
+      @comment = @comment_model.get!(*comment.key)
+      @user    = @comment.user
+    end
+
+    it_behaves_like 'A public Resource'
+    it_behaves_like 'A Resource supporting Strategic Eager Loading'
+  end
+end

data/spec/public/associations/many_to_one_with_boolean_cpk_spec.rb

@@ -0,0 +1,40 @@
+require_relative '../../spec_helper'
+
+# TODO: combine this into many_to_one_spec.rb
+
+describe 'Many to One Associations when foreign key is part of a composite key, with an integer and a boolean making up the composite key' do
+  before :all do
+    class ::ManyModel
+      include DataMapper::Resource
+
+      property :integer_key, Integer, :key => true
+      property :boolean_key, Boolean, :key => true
+
+      belongs_to :one_model, :child_key => [ :integer_key ]
+    end
+
+    class ::OneModel
+      include DataMapper::Resource
+
+      property :integer_key, Integer, :key => true
+
+      has n, :many_models, :child_key => [ :integer_key ]
+    end
+    DataMapper.finalize
+  end
+
+  supported_by :all do
+    before :all do
+      @one  = OneModel.create(:integer_key => 1)
+      @many = ManyModel.create(:integer_key => 1, :boolean_key => false)
+    end
+
+    it 'is able to access parent' do
+      expect(@many.one_model).to eq @one
+    end
+
+    it 'is able to access the child' do
+      expect(@one.many_models).to eq [@many]
+    end
+  end
+end

data/spec/public/associations/many_to_one_with_custom_fk_spec.rb

@@ -0,0 +1,49 @@
+require_relative '../../spec_helper'
+
+# TODO: combine this into many_to_one_spec.rb
+
+describe 'Many to One Associations when foreign key is a property subclass' do
+  before :all do
+    class ::CustomPK < DataMapper::Property::String
+      key true
+    end
+
+    class ::Animal
+      include DataMapper::Resource
+
+      property :id,   Serial
+      property :name, String
+
+      belongs_to :zoo
+    end
+
+    class ::Zoo
+      include DataMapper::Resource
+
+      property :id, ::CustomPK
+
+      has n, :animals
+    end
+
+    DataMapper.finalize
+  end
+
+  supported_by :all do
+    before :all do
+      @zoo    = Zoo.create(:id => 'foo')
+      @animal = @zoo.animals.create(:name => 'marty')
+    end
+
+    it 'has FK of the same property type as zoo PK' do
+      expect(Animal.properties[:zoo_id].class).to be(Zoo.properties[:id].class)
+    end
+
+    it 'is able to access parent' do
+      expect(@animal.zoo).to eq @zoo
+    end
+
+    it 'is able to access the children' do
+      expect(@zoo.animals).to eq [@animal]
+    end
+  end
+end

data/spec/public/associations/one_to_many_spec.rb

@@ -0,0 +1,81 @@
+require_relative '../../spec_helper'
+
+# run the specs once with a loaded association and once not
+[ false, true ].each do |loaded|
+  describe 'One to Many Associations' do
+    extend DataMapper::Spec::CollectionHelpers::GroupMethods
+
+    self.loaded = loaded
+
+    # define the model prior to supported_by
+    before :all do
+      module ::Blog
+        class Author
+          include DataMapper::Resource
+
+          property :id,   Serial
+          property :name, String
+
+          has n, :articles
+        end
+
+        class Article
+          include DataMapper::Resource
+
+          property :id,         Serial
+          property :title,      String, :required => true
+          property :content,    Text
+          property :subtitle,   String
+          property :attachment, Object
+
+          belongs_to :author, :required => false
+          belongs_to :original, self, :required => false
+          has n, :revisions, self, :child_key => [ :original_id ]
+          has 1, :previous,  self, :child_key => [ :original_id ], :order => [ :id.desc ]
+          has n, :publications, :through => Resource
+        end
+
+        class Publication
+          include DataMapper::Resource
+
+          property :id,   Serial
+          property :name, String
+
+          has n, :articles, :through => Resource
+        end
+      end
+
+      DataMapper.finalize
+
+      @author_model      = Blog::Author
+      @article_model     = Blog::Article
+      @publication_model = Blog::Publication
+    end
+
+    supported_by :all do
+      before :all do
+        @author  = @author_model.create(:name => 'Dan Kubb')
+
+        @original = @author.articles.create(:title => 'Original Article')
+        @article  = @author.articles.create(:title => 'Sample Article', :content => 'Sample', :original => @original)
+        @other    = @author.articles.create(:title => 'Other Article',  :content => 'Other')
+
+        # load the targets without references to a single source
+        load_collection = lambda do |query|
+          @author_model.get!(*@author.key).articles(query)
+        end
+
+        @articles       = load_collection.call(:title => 'Sample Article')
+        @other_articles = load_collection.call(:title => 'Other Article')
+
+        @articles.entries if loaded
+      end
+
+      it_behaves_like 'A public Collection'
+      it_behaves_like 'A public Association Collection'
+      it_behaves_like 'A Collection supporting Strategic Eager Loading'
+      it_behaves_like 'Finder Interface'
+      it_behaves_like 'Collection Finder Interface'
+    end
+  end
+end

data/spec/public/associations/one_to_one_spec.rb

@@ -0,0 +1,176 @@
+require_relative '../../spec_helper'
+
+describe 'One to One Associations' do
+  before :all do
+    module ::Blog
+      class User
+        include DataMapper::Resource
+
+        property :name,        String, :key => true
+        property :age,         Integer
+        property :summary,     Text
+        property :description, Text
+        property :admin,       Boolean, :accessor => :private
+
+        belongs_to :parent, self, :required => false
+        has n, :children, self, :inverse => :parent
+
+        belongs_to :referrer, self, :required => false
+        belongs_to :comment
+
+        # TODO: remove this after Relationship#inverse can dynamically
+        # create an inverse relationship when no perfect match can be found
+        has n, :referree, self, :child_key => [ :referrer_name ]
+      end
+
+      class Author < User; end
+
+      class Comment
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :body, Text
+
+        has 1, :user
+      end
+
+      class Article
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :body, Text
+
+        has 1, :paragraph
+      end
+
+      class Paragraph
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :text, String
+
+        belongs_to :article
+      end
+    end
+
+    class ::Default
+      include DataMapper::Resource
+
+      property :name, String, :key => true, :default => 'a default value'
+    end
+    DataMapper.finalize
+
+    @user_model      = Blog::User
+    @author_model    = Blog::Author
+    @comment_model   = Blog::Comment
+    @article_model   = Blog::Article
+    @paragraph_model = Blog::Paragraph
+  end
+
+  supported_by :all do
+    before :all do
+      comment = @comment_model.create(:body => 'Cool spec')
+      user    = @user_model.create(:name => 'dbussink', :age => 25, :description => 'Test', :comment => comment)
+
+      @comment = @comment_model.get!(*comment.key)
+      @user    = @comment.user
+    end
+
+    it_behaves_like 'A public Resource'
+    it_behaves_like 'A Resource supporting Strategic Eager Loading'
+  end
+end
+
+describe 'One to One Through Associations' do
+  before :all do
+    module ::Blog
+      class Referral
+        include DataMapper::Resource
+
+        property :referrer_name, String, :key => true
+        property :referree_name, String, :key => true
+
+        belongs_to :referrer, 'User', :child_key => [ :referrer_name ]
+        belongs_to :referree, 'User', :child_key => [ :referree_name ]
+      end
+
+      class User
+        include DataMapper::Resource
+
+        property :name,        String, :key => true
+        property :age,         Integer
+        property :summary,     Text
+        property :description, Text
+        property :admin,       Boolean, :accessor => :private
+
+        belongs_to :parent, self, :required => false
+        has n, :children, self, :inverse => :parent
+
+        has 1, :referral_from, Referral, :child_key => [ :referree_name ]
+        has 1, :referral_to,   Referral, :child_key => [ :referrer_name ]
+
+        has 1, :referrer, self, :through => :referral_from
+        has 1, :referree, self, :through => :referral_to
+        has 1, :comment,        :through => Resource
+      end
+
+      class Author < User; end
+
+      class Comment
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :body, Text
+
+        has 1, :user, :through => Resource
+      end
+
+      class Article
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :body, Text
+
+        has 1, :paragraph, :through => Resource
+      end
+
+      class Paragraph
+        include DataMapper::Resource
+
+        property :id,   Serial
+        property :text, String
+
+        has 1, :article, :through => Resource
+      end
+    end
+
+    class ::Default
+      include DataMapper::Resource
+
+      property :name, String, :key => true, :default => 'a default value'
+    end
+    DataMapper.finalize
+
+    @referral_model  = Blog::Referral
+    @user_model      = Blog::User
+    @author_model    = Blog::Author
+    @comment_model   = Blog::Comment
+    @article_model   = Blog::Article
+    @paragraph_model = Blog::Paragraph
+  end
+
+  supported_by :all do
+    before :all do
+      comment = @comment_model.create(:body => 'Cool spec')
+      user    = @user_model.create(:name => 'dbussink', :age => 25, :description => 'Test', :comment => comment)
+
+      @comment = @comment_model.get!(*comment.key)
+      @user    = @comment.user
+    end
+
+    it_behaves_like 'A public Resource'
+
+    # TODO: make this pass
+    # it_behaves_like 'A Resource supporting Strategic Eager Loading'
+  end
+end

data/spec/public/associations/one_to_one_with_boolean_cpk_spec.rb

@@ -0,0 +1,46 @@
+require_relative '../../spec_helper'
+
+# TODO: combine this into one_to_one_spec.rb
+
+describe 'One to One Associations when foreign key is part of a composite key and contains a boolean, with an integer and a boolean making up the composite key' do
+  before :all do
+    class ::ParentModel
+      include DataMapper::Resource
+
+      property :integer_key, Integer, :key => true
+      property :boolean_key, Boolean, :key => true
+
+      has 1, :child_model, :child_key => [ :integer_key, :boolean_key ]
+    end
+
+    class ::ChildModel
+      include DataMapper::Resource
+
+      property :integer_key,       Integer, :key => true
+      property :other_integer_key, Integer, :key => true
+      property :boolean_key,       Boolean, :key => true
+
+      belongs_to :parent_model, :child_key => [ :integer_key, :boolean_key ]
+    end
+    DataMapper.finalize
+  end
+
+  supported_by :all do
+    before :all do
+      @parent = ParentModel.create(:integer_key => 1, :boolean_key => false)
+      @child  = ChildModel.create(:integer_key => 1, :other_integer_key => 1, :boolean_key => false)
+    end
+
+    it 'is able to access the child' do
+      expect(@parent.child_model).to eq @child
+    end
+
+    it 'is able to access the parent' do
+      expect(@child.parent_model).to eq @parent
+    end
+
+    it 'is able to access the parent_key' do
+      expect(@child.parent_model.key).not_to be_nil
+    end
+  end
+end