correspondence 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create default@correspondence

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in correspondence.gemspec
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+#Correspondence
+####Next generation associations
+
+##Todo
+* `one` associations<br/>
+  Support defining a class and method to find associated object
+* `many` assocations<br/>
+  Support defining a class and finding multiple related objects
+* Arbitrary item `many` associations<br/>
+  Support finding N arbitrary objects related to the querying object
+* Automagically inferring inverse relationships.
+
+##Usage
+    class User
+      corresponds_with :profile
+    end
+
+This will create a `profile` method on any instance of the user class. By
+default the `profile` method will call `Profile.find(id)` where `id` is a
+method on the user class.
+
+###Options
+* `:class_name` specify a string for the association class name.
+* `:class` allows specifying a string, class, symbol or proc.  Symbols must be
+  class methods on the associating class, procs should resolve to the
+  association class.
+* `:on` a symbol or string specifying the method that should be called on the
+  associating class as a reference to the association. Defaults to `:id`.
+* `:using` a symbol or string that is the method that will be called on the
+  association call.  This method will be passed the results of `:on`. Defaults
+  to `:find`.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/correspondence.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "correspondence/version"
+
+Gem::Specification.new do |s|
+  s.name        = "correspondence"
+  s.version     = Correspondence::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Adam Hunter", "Ben Vandgrift"]
+  s.email       = ["adamhunter@me.com", "ben@vandgrift.com"]
+  s.homepage    = ""
+  s.summary     = %q[Next generation object associations.]
+  s.description = %q[Associate related ruby objects, like ActiveRecord assocations for arbitrary classes. Useful for polyglot programming across seperate data stores using different Object Mappers.]
+
+  s.add_dependency 'activesupport', '~> 3.0.0'
+  s.add_dependency 'i18n',          '~> 0.5'
+
+  s.add_development_dependency 'rspec', '~> 2.5'
+
+  s.rubyforge_project = "correspondence"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/correspondence.rb

@@ -0,0 +1,7 @@
+require 'active_support/all'
+
+module Correspondence
+end
+
+require 'correspondence/with'
+require 'correspondence/version'

data/lib/correspondence/version.rb

@@ -0,0 +1,3 @@
+module Correspondence
+  VERSION = "0.0.1"
+end

data/lib/correspondence/with.rb

@@ -0,0 +1,29 @@
+require 'correspondence'
+
+module Correspondence
+  module With
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+
+    autoload :ManyProxy
+    autoload :OneProxy
+    autoload :Proxy
+    
+    module ClassMethods
+      def corresponds_with(association, options={}, &block)
+        type = plural_association?(association) ? 'Many' : 'One'
+        correspondences[association.to_sym] = const_get("#{type}Proxy").new(self, association, options)
+      end
+
+      def correspondences
+        @correspondences ||= Hash.new
+      end
+
+      private
+
+        def plural_association?(association)
+          association.to_s.pluralize == association.to_s
+        end
+    end
+  end
+end

data/lib/correspondence/with/many_proxy.rb

@@ -0,0 +1,10 @@
+module Correspondence
+  module With
+    class ManyProxy < Proxy
+
+      protected
+        def create_association
+        end
+    end
+  end
+end

data/lib/correspondence/with/one_proxy.rb

@@ -0,0 +1,15 @@
+module Correspondence
+  module With
+    class OneProxy < Proxy
+
+      protected
+        def create_association
+          root.class_eval <<-RB
+            def #{name}
+              #{@target}.#{@options[:using]}(#{@options[:on]})
+            end
+          RB
+        end
+    end
+  end
+end

data/lib/correspondence/with/proxy.rb

@@ -0,0 +1,39 @@
+module Correspondence
+  module With
+    class Proxy
+      attr_reader :root, :name, :target
+
+      def initialize(root, name, options)
+        @root    = root
+        @name    = name.to_sym
+        @options = options
+        @target  = set_target
+        @options[:on]    ||= :id
+        @options[:using] ||= :find
+        create_association
+      end
+
+      protected
+        def set_target
+          @options[:class] = @options[:class_name] if @options[:class_name]
+
+          if @options[:class].is_a?(Class)
+            @options[:class]
+          elsif @options[:class].is_a?(String)
+            @options[:class].constantize
+          elsif @options[:class].is_a?(Symbol)
+            root.send(@options[:class])
+          elsif @options[:class].respond_to?(:call)
+            @options[:class].call
+          else
+            @name.to_s.classify.constantize 
+          end
+        end
+
+        def create_association
+          raise NotImplementedError
+        end
+
+    end
+  end
+end

data/spec/correspondence/with/many_proxy_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Correspondence::With::OneProxy do
+
+
+end

data/spec/correspondence/with/one_proxy_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Correspondence::With::OneProxy do
+  before :all do
+    Bar.corresponds_with :foo
+  end
+
+  after :all do
+    Bar.instance_variable_set(:@correspondences, {})
+  end
+
+  it "should add the associated method to the associating class" do
+    Bar.new.should respond_to(:foo)
+  end
+
+end

data/spec/correspondence/with/proxy_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Correspondence::With::Proxy do
+
+  it "should assume the target is association name" do
+    proxy = TestProxy.new(Bar, :foo, {})
+    proxy.target.should eq(Foo) 
+  end
+
+  it "should allow specifiying the target's class_name" do
+    proxy = TestProxy.new(Bar, :foo, {:class_name => 'Box'})
+    proxy.target.should eq(Box)
+  end
+
+  it "should allow specifiying the target's class" do
+    proxy = TestProxy.new(Bar, :foo, {:class => Foo})
+    proxy.target.should eq(Foo)
+  end
+
+  it "should allow using a string to specify the target's class" do
+    proxy = TestProxy.new(Bar, :foo, {:class => 'Foo'})
+    proxy.target.should eq(Foo)
+  end
+
+  it "should allow using a proc to specify the target's class" do
+    proxy = TestProxy.new(Bar, :foo, {:class => proc { Foo }})
+    proxy.target.should eq(Foo)
+  end
+
+  it "should allow passing a symbol to reference a method to determine the target's class" do
+    proxy = TestProxy.new(Bar, :foo, {:class => :foo_class_name})
+    proxy.target.should eq(Foo)
+  end
+
+end
+

data/spec/correspondence/with_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Correspondence::With do
+
+  describe "creating an association" do
+    it "should instantiate a one association when corresponding with a singular symbol" do
+      Foo.corresponds_with :bar
+      Foo.correspondences[:bar].should be_a(Correspondence::With::OneProxy)
+    end
+
+    it "should instantiate a many association when corresponding with a plural symbol" do
+      Bar.corresponds_with :boxes
+      Bar.correspondences[:boxes].should be_a(Correspondence::With::ManyProxy)
+    end
+
+    it "should create an assocation with the associated class" do
+      Profile.stub!(:find).with(1).and_return(@profile = mock('Profile', :id => 1))
+      @user = User.new
+      @user.id = 1
+      @user.profile.should eq(@profile)
+    end
+
+    it "should assume the default finder method is :find"
+    it "should allow specifiying the :finder_method"
+    it "should assume the default correspondence method is :id"
+    it "should allow specifiying the method to use to correspond to the associated object"
+  end
+
+end

data/spec/correspondence_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Correspondence do
+
+  it "should have a version number" do
+    Correspondence::VERSION.should be_a(String)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems' # Use the gems path only for the spec suite
+require 'correspondence'
+require 'rspec'
+
+Dir[File.join(File.dirname(__FILE__), "support", "*.rb")].each {|f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+

data/spec/support/basics.rb

@@ -0,0 +1,10 @@
+class Bar
+  def self.foo_class_name; Foo; end
+end
+
+class Foo ; end
+class Box ; end
+class Baz ; end
+
+[Foo, Bar, Box, Baz].each {|c| c.send(:include, Correspondence::With)}
+

data/spec/support/profile.rb

@@ -0,0 +1,2 @@
+class Profile
+end

data/spec/support/test_proxy.rb

@@ -0,0 +1,5 @@
+class TestProxy < Correspondence::With::Proxy
+  def create_association
+    "test association"
+  end
+end

data/spec/support/user.rb

@@ -0,0 +1,7 @@
+class User
+  include Correspondence::With
+
+  attr_accessor :id
+
+  corresponds_with :profile
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: correspondence
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Hunter
+- Ben Vandgrift
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id003
+description: Associate related ruby objects, like ActiveRecord assocations for arbitrary classes. Useful for polyglot programming across seperate data stores using different Object Mappers.
+email: 
+- adamhunter@me.com
+- ben@vandgrift.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- correspondence.gemspec
+- lib/correspondence.rb
+- lib/correspondence/version.rb
+- lib/correspondence/with.rb
+- lib/correspondence/with/many_proxy.rb
+- lib/correspondence/with/one_proxy.rb
+- lib/correspondence/with/proxy.rb
+- spec/correspondence/with/many_proxy_spec.rb
+- spec/correspondence/with/one_proxy_spec.rb
+- spec/correspondence/with/proxy_spec.rb
+- spec/correspondence/with_spec.rb
+- spec/correspondence_spec.rb
+- spec/spec_helper.rb
+- spec/support/basics.rb
+- spec/support/profile.rb
+- spec/support/test_proxy.rb
+- spec/support/user.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: correspondence
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Next generation object associations.
+test_files: 
+- spec/correspondence/with/many_proxy_spec.rb
+- spec/correspondence/with/one_proxy_spec.rb
+- spec/correspondence/with/proxy_spec.rb
+- spec/correspondence/with_spec.rb
+- spec/correspondence_spec.rb
+- spec/spec_helper.rb
+- spec/support/basics.rb
+- spec/support/profile.rb
+- spec/support/test_proxy.rb
+- spec/support/user.rb