correlate 0.1.0

data/lib/correlate/validator.rb

@@ -0,0 +1,49 @@
+module Correlate
+  class Validator < ::CouchRest::Validation::GenericValidator
+
+    def initialize( field_name, options = {} )
+      super
+      @field_name, @options = field_name, options
+    end
+
+    def call( target )
+      results = []
+
+      target.class.correlations.each do |correlation|
+        case correlation.type
+        when :some
+          results << validate_some( correlation, target )
+        when :a
+          results << validate_a( correlation, target )
+        end
+      end
+
+      !results.any? { |r| r == false }
+    end
+
+    def validate_some( correlation, target )
+      results = true
+
+      case correlation.requires
+      when Fixnum
+        unless target.send( correlation.name, true ).size >= correlation.requires
+          target.errors.add( correlation.name, "Requires at least #{correlation.requires} #{correlation.name}" )
+          results = false
+        end
+      end
+
+      results
+    end
+
+    def validate_a( correlation, target )
+      results = true
+
+      if correlation.required && target.send( correlation.name ).nil?
+        target.errors.add( correlation.name, "is required" )
+        results = false
+      end
+
+      results
+    end
+  end
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Correlate, ActiveRecord do
+  fixtures :article, :comment
+
+  before(:each) do
+    @article = Article.create( :title => 'Correlations in C' )
+  end
+
+  it "should have an empty association" do
+    @article.comments.should be_empty
+  end
+
+  it "should accept a new associated document" do
+    comment = Comment.create( :comment => 'awesome' )
+    @article.comments << comment
+
+    @article.comments.should == [ comment ]
+  end
+
+  it "should be reciprocal" do
+    comment = Comment.create( :comment => 'extreme' )
+    comment.article = @article
+
+    comment.article.should == @article
+    comment.save
+
+    Comment.get( comment.id ).article.should == @article
+  end
+end

data/spec/activerecord_helper.rb

@@ -0,0 +1,17 @@
+require 'activerecord'
+
+# Setup connection
+def reset_test_sqlitedb!
+  ActiveRecord::Base.connection.disconnect! rescue nil
+  ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => ':memory:'
+  )
+
+  ActiveRecord::Schema.verbose = false
+  ActiveRecord::Schema.define do
+    create_table :articles do |t|
+      t.string 'title'
+    end
+  end
+end

data/spec/correlate_spec.rb

@@ -0,0 +1,132 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Correlate do
+  fixtures :person, :reader, :news_feed, :crawler
+
+  describe "extends classes" do
+    it "to track correlations" do
+      Person.correlations.should_not be_empty
+
+      correlation = Person.correlations.first
+      correlation.should be_a_kind_of( Correlate::Correlation )
+      correlation.type.should == :some
+      correlation.name.should == :people
+      correlation.target.should == 'Person'
+      correlation.source.should == Person
+    end
+
+    it "should define a view for looking up rels" do
+      Person.should have_view('by_rel')
+    end
+  end
+
+  describe "to self" do
+    before(:each) do
+      @person = Person.new
+    end
+
+    it "should have an empty array" do
+      @person.people.should be_a_kind_of( Array )
+      @person.people.should be_empty
+    end
+
+    it "should accept new associations" do
+      person = Person.create :name => 'John'
+      @person.people << person
+
+      @person.links.should == [{ 'rel' => 'person', 'href' => person.id }]
+      @person.save!
+
+      Person.get( @person.id ).links.should == [{ 'rel' => 'person', 'href' => person.id }]
+    end
+
+    it "should load objects from associations" do
+      person = Person.create :name => 'Jack'
+      @person.people << person
+      @person.save!
+
+      @person.people.should == [ person ]
+    end
+
+    it "should have the raw associations" do
+      person = Person.create :name => 'Jack'
+      @person.people << person
+      @person.save!
+
+      @person.people( true ).should == [{'rel' => 'person', 'href' => person.id }]
+    end
+  end
+
+  describe "to some others" do
+    before(:each) do
+      @reader = Reader.new
+    end
+
+    it "should have an empty array" do
+      @reader.news_feeds.should be_empty
+    end
+
+    it "should accept new associations" do
+      feed = NewsFeed.create :url => 'http://planet.couchdb.com/atom.xml'
+      @reader.news_feeds << feed
+
+      @reader.links.should == [{ 'rel' => 'news_feed', 'href' => feed.id }]
+      @reader.save!
+
+      Reader.get( @reader.id ).links.should == [{ 'rel' => 'news_feed', 'href' => feed.id }]
+    end
+
+    it "should load objects from associations" do
+      feed = NewsFeed.create :url => 'http://planet.couchdb.com/atom.xml'
+      @reader.news_feeds << feed
+      @reader.save!
+
+      @reader.news_feeds.should == [ feed ]
+    end
+
+    it "should have access to the raw accosiations" do
+      feed = NewsFeed.create :url => 'http://planet.couchdb.com/atom.xml'
+      @reader.news_feeds << feed
+      @reader.save!
+
+      @reader.news_feeds( true ).should == [{ 'rel' => 'news_feed', 'href' => feed.id }]
+    end
+  end
+
+  describe "to another" do
+    before(:each) do
+      @feed = NewsFeed.new( :url => 'http://planet.couchdb.com/atom.xml' )
+    end
+
+    it "should have a nil instance" do
+      @feed.crawler.should be_nil
+    end
+
+    it "should accept a new instance" do
+      crawler = Crawler.create :host => 'foo.example.com'
+      @feed.crawler = crawler
+
+      @feed.links.should == [{ 'rel' => 'crawler', 'href' => crawler.id }]
+      @feed.save!
+
+      NewsFeed.get( @feed.id ).links.should == [{ 'rel' => 'crawler', 'href' => crawler.id }]
+    end
+
+    it "should load the object from the association" do
+      crawler = Crawler.create :host => 'foo.example.com'
+      @feed.crawler = crawler
+      @feed.save!
+
+      @feed.crawler.should == crawler
+    end
+
+    it "should give access to the raw association" do
+      crawler = Crawler.create :host => 'foo.example.com'
+      @feed.crawler = crawler
+      @feed.save!
+
+      @feed.crawler( true ).should == { 'rel' => 'crawler', 'href' => crawler.id }
+    end
+  end
+
+end

data/spec/fixtures/article.rb

@@ -0,0 +1,8 @@
+class Article < ActiveRecord::Base
+
+  include Correlate
+
+  related_to do
+    some :comments, :class => 'Comment'
+  end
+end

data/spec/fixtures/blank_doc.rb

@@ -0,0 +1,4 @@
+class BlankDoc < CouchRest::ExtendedDocument
+
+  include Correlate
+end

data/spec/fixtures/comment.rb

@@ -0,0 +1,11 @@
+class Comment < CouchRest::ExtendedDocument
+
+  use_database DB
+
+  include Correlate
+  include CouchRest::Validation
+
+  related_to do
+    a :article, :class => 'Article', :required => true
+  end
+end

data/spec/fixtures/course.rb

@@ -0,0 +1,5 @@
+# Students are enlisted into courses
+class Course < CouchRest::ExtendedDocument
+
+  use_database DB
+end

data/spec/fixtures/crawler.rb

@@ -0,0 +1,6 @@
+# Responsible for updating the news feeds
+class Crawler < CouchRest::ExtendedDocument
+
+  use_database DB
+
+end

data/spec/fixtures/news_feed.rb

@@ -0,0 +1,13 @@
+# The news feeds read by a reader, and has a crawler that updates it
+class NewsFeed < CouchRest::ExtendedDocument
+
+  include Correlate
+
+  use_database DB
+
+  property :url
+
+  related_to do
+    a :crawler, :class => 'Crawler'
+  end
+end

data/spec/fixtures/note.rb

@@ -0,0 +1,2 @@
+#class Note < CouchRest::ExtendedDocument
+#end

data/spec/fixtures/person.rb

@@ -0,0 +1,11 @@
+# Test on a 'simple social graph'
+class Person < CouchRest::ExtendedDocument
+
+  use_database DB
+
+  include Correlate
+
+  related_to do
+    some :people, :class => 'Person', :rel => 'person'
+  end
+end

data/spec/fixtures/project.rb

@@ -0,0 +1,2 @@
+#class Project < ActiveRecord::Base
+#end

data/spec/fixtures/reader.rb

@@ -0,0 +1,11 @@
+# A reader of articles from different feeds
+class Reader < CouchRest::ExtendedDocument
+
+  include Correlate
+
+  use_database DB
+
+  related_to do
+    some :news_feeds, :class => 'NewsFeed', :rel => 'news_feed'
+  end
+end

data/spec/fixtures/student.rb

@@ -0,0 +1,11 @@
+class Student < CouchRest::ExtendedDocument
+
+  use_database DB
+
+  include Correlate
+  include CouchRest::Validation
+
+  related_to do
+    some :enlistments, :class => 'Course', :rel => 'course', :requires => 1
+  end
+end

data/spec/links_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Correlate::Links do
+  fixtures :person
+
+  before(:each) do
+    @blank = Correlate::Links.new( Person )
+
+    @links = Correlate::Links.new( Person )
+    @links << { 'rel' => 'foo', 'href' => 'bar' }
+  end
+
+  it "should be able to find by rel" do
+    @links.rel( 'foo' ).should == [{ 'rel' => 'foo', 'href' => 'bar' }]
+  end
+
+  it "should be able to replace by rel" do
+    @links.replace({ 'rel' => 'foo', 'href' => 'baz' })
+
+    @links.should == [{ 'rel' => 'foo', 'href' => 'baz' }]
+  end
+
+  it "should be able to delete by rel" do
+    @links.delete({ 'rel' => 'foo', 'href' => 'bar' })
+    @links.should be_empty
+  end
+end

data/spec/relationships_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Correlate::Relationships do
+  fixtures :blank_doc
+
+  it "should be able to configure a class" do
+    relationships = lambda {
+      some :foo
+    }
+
+    Correlate::Relationships.configure!( BlankDoc, &relationships )
+
+    link_property = BlankDoc.properties.detect { |p| p.name == 'links' }
+    link_property.should_not be_nil
+    link_property.type.should == 'Correlate::Links'
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'correlate'
+require 'spec'
+require 'spec/autorun'
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+require 'couchrest'
+require 'activerecord_helper'
+
+unless defined?( COUCHHOST )
+  COUCHHOST = "http://127.0.0.1:5984"
+  TESTDB    = 'correlate-test'
+  TEST_SERVER    = CouchRest.new
+  TEST_SERVER.default_database = TESTDB
+  DB = TEST_SERVER.database(TESTDB)
+end
+
+Spec::Runner.configure do |config|
+  config.before(:suite) do
+    reset_test_sqlitedb!
+  end
+
+  config.before(:all) do
+    reset_test_couchdb!
+  end
+end
+
+def fixtures( *args )
+  args.each do |file|
+    file = file.to_s
+    if File.exists?( File.join( File.dirname(__FILE__), 'fixtures', "#{file}.rb" ) )
+      require File.join( File.dirname(__FILE__), 'fixtures', file )
+    end
+  end
+end
+
+def reset_test_couchdb!
+  DB.recreate! rescue nil
+  DB
+end

data/spec/validation_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Correlate do
+  describe "validations for 'some'" do
+    fixtures :student, :course
+
+    before(:each) do
+      @student = Student.new
+    end
+
+    it "should be enforced" do
+      @student.should_not be_valid
+    end
+
+    it "should be met" do
+      @student.enlistments << Course.create( :name => 'B.Sc Foo' )
+      @student.should be_valid
+    end
+  end
+
+  describe "validations for 'a'" do
+    fixtures :comment, :article
+
+    before(:each) do
+      @comment = Comment.new
+    end
+
+    it "should be enforced" do
+      @comment.should_not be_valid
+    end
+
+    it "should be met" do
+      article = Article.create( :title => 'Validating the system' )
+      @comment.article = article
+      @comment.should be_valid
+    end
+  end
+end