tenacity 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.swp
+*.swo
+.bundle
+rdoc/
+coverage/
+pkg/

data/EXTEND.rdoc

@@ -0,0 +1,79 @@
+For Tenacity to interact with an ORM, the ORM needs to be extended to support
+the methods listed below.  Beyond that, no additional configuration or code is
+necessary.  Tenacity communicates with the ORM using these methods only, so
+as long as they have been implemented and are available on the model object,
+Tenacity will be able to manage the object's relationships.
+
+
+== A note about IDs
+
+An ID can be an integer, a string, or an object, depending on the database
+and ORM you are using.  To be as compatible as possible, Tenacity treats
+all IDs as strings.  So, all ORM extensions should accept strings for IDs
+as input parameters, and return strings for IDs.
+
+
+== Class Methods
+
+  _t_find(id)
+
+Find an object by its id, and return it.  If the object cannot be found,
+return nil.
+
+  _t_find_bulk(ids=[])
+
+Find many objects by the specified ids, and return them in an array.
+If no objects could be found, return an empty array.
+
+  _t_find_first_by_associate(property, id)
+
+Find the first object by the specified property name, with the specified id,
+and return it.  If no object could be found, return nil.
+
+  _t_find_all_by_associate(property, id)
+
+Find all objects by the specified property name, with the specified id, and
+return them in an array.  If no objects could be found, return an empty array.
+
+  _t_initialize_has_many_association(association_id)
+
+Perform any ORM specific initialization necessary to support a has many
+association.  This could include defining properties, or callback methods,
+on the object.  This method is optional, and does not need to be defined.
+
+  _t_initialize_belongs_to_association(association_id)
+
+Perform any ORM specific initialization necessary to support a belongs to
+association.  This could include defining properties, or callback methods,
+on the object.  This method is optional, and does not need to be defined.
+
+  _t_initialize_has_one_association(association_id)
+
+Perform any ORM specific initialization necessary to support a has one
+association.  This could include defining properties, or callback methods,
+on the object.  This method is optional, and does not need to be defined.
+
+
+== Instance Methods
+
+  _t_reload
+
+Reload the object from the database, overwriting the objects properties with
+the data fetched from the database.  Return nothing.
+
+  _t_associate_many(association_id, associate_ids)
+
+Create has_many associations between this object and the objects with ids
+specified in the array of associate_ids.  This method could involve writing
+the associate_ids into a join table, or into an object's hash.
+
+  _t_get_associate_ids(association_id)
+
+Get the ids of the objects associated with this object through the specified
+association, and return them in an array.
+
+  _t_clear_associates(association_id)
+
+Destroy the association between this object and its current associates through
+the specified association.  Return nothing.
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+source :gemcutter
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    tenacity (0.1.0)
+      activesupport (>= 2.3)
+
+GEM
+  remote: http://rubygems.org/
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    bson (1.1.5)
+    bson_ext (1.1.5)
+    builder (2.1.2)
+    couchrest (1.0.1)
+      json (>= 1.4.6)
+      mime-types (>= 1.15)
+      rest-client (>= 1.5.1)
+    couchrest_model (1.0.0.beta7)
+      activemodel (>= 3.0.0.beta4)
+      activesupport (>= 2.3.5)
+      couchrest (>= 1.0.0.beta)
+      mime-types (>= 1.15)
+    i18n (0.5.0)
+    jnunemaker-validatable (1.8.4)
+      activesupport (>= 2.3.4)
+    json (1.4.6)
+    mime-types (1.16)
+    mongo (1.1.5)
+      bson (>= 1.1.5)
+    mongo_mapper (0.8.6)
+      activesupport (>= 2.3.4)
+      jnunemaker-validatable (~> 1.8.4)
+      plucky (~> 0.3.6)
+    mysql (2.8.1)
+    plucky (0.3.6)
+      mongo (~> 1.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    shoulda (2.11.3)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.0)
+  activesupport (>= 2.3)
+  bson_ext (~> 1.1.3)
+  bundler (~> 1.0.0)
+  couchrest (~> 1.0.0)
+  couchrest_model
+  mongo_mapper (~> 0.8.6)
+  mysql (~> 2.8.1)
+  rake (~> 0.8.7)
+  rcov (~> 0.9.9)
+  shoulda (~> 2.11.3)
+  tenacity!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John Wood
+
+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,103 @@
+= Tenacity
+
+An ORM independent way of specifying simple relationships between models
+backed by different databases.
+
+It is sometimes necessary, or advantageous, to use more than one database in a
+given application.  However, most ORMs do not support inter-database
+relationships.  While supporting such relationships isn't difficult, it can
+add quite a bit of boilerplate code to your project.
+
+Tenacity aims to address this by providing an ORM independent way of specifying
+simple relationships between models backed by different databases.
+
+Tenacity is heavily based on ActiveRecord's associations, and aims to behave in
+much the same way, supporting many of the same options.
+
+
+== Example
+
+  class User
+    include MongoMapper::Document
+    include Tenacity
+
+    t_has_many :entries
+  end
+
+  class Entry < ActiveRecord::Base
+    include Tenacity
+
+    t_belongs_to :user
+  end
+
+
+  # Fetch related object from the respective database
+  entry.user
+
+  # Set the related object
+  entry.user = some_user
+  entry.save
+
+  # Fetch related objects from the respective database
+  user.entries
+
+  # Add a related object to the collection
+  user.entries << some_entry
+  user.save
+
+
+== Additional Usage Details
+
+* The directories that contain your model classes must be in your load path in order for Tenacity to find them.
+
+
+== Supported ORMs
+
+* ActiveRecord
+* MongoMapper
+* CouchRest (CouchModel and ExtendedDocument)
+
+See EXTEND.rdoc for information on extendeding Tenacity to work with other ORMs.
+
+
+== Documentation
+* http://rdoc.info/github/jwood/tenacity/master/frames
+
+
+== Contributing to Tenacity
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+== Development
+
+* MySQL, MongoDB, and CouchDB must be installed and configured.
+* Install the dependencies
+
+  bundler install
+
+* Create the test databases
+
+  rake db:create
+
+* Setup the test databases
+
+  rake db:test:prepare
+
+* Run the tests
+
+  rake test
+
+* Code away!
+
+
+== Copyright
+
+Copyright (c) 2010 John Wood. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' << 'test/fixtures'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test' << 'test/fixtures'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tenacity #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('EXTEND*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Delete rcov, rdoc, and other generated files'
+task :clobber => [:clobber_rcov, :clobber_rdoc]
+
+begin
+  require 'test/helpers/active_record_test_helper'
+  namespace :db do
+    desc "Create the test databases"
+    task :create do
+      system "mysqladmin -u root create tenacity_test"
+    end
+
+    desc "Drop the test databases"
+    task :drop do
+      system "mysqladmin -u root drop -f tenacity_test"
+    end
+
+    desc "Reset the test databases"
+    task :reset => [:drop, :create] do
+      Rake::Task['db:test:prepare'].invoke
+    end
+
+    namespace :test do
+      desc "Setup the test databases"
+      task :prepare do
+        ActiveRecord::Schema.define :version => 0 do
+
+          create_table :active_record_cars, :force => true do |t|
+          end
+
+          create_table :active_record_climate_control_units, :force => true do |t|
+            t.string :mongo_mapper_dashboard_id
+          end
+
+          create_table :active_record_cars_mongo_mapper_wheels, :force => true do |t|
+            t.integer :active_record_car_id
+            t.string :mongo_mapper_wheel_id
+          end
+
+          create_table :active_record_nuts, :force => true do |t|
+            t.string :mongo_mapper_wheel_id
+          end
+
+          create_table :active_record_nuts_mongo_mapper_wheels, :force => true do |t|
+            t.integer :active_record_nut_id
+            t.string :mongo_mapper_wheel_id
+          end
+
+        end
+      end
+    end
+  end
+rescue LoadError
+  # No ActiveRecord
+end

data/lib/tenacity/associations/belongs_to.rb

@@ -0,0 +1,28 @@
+module Tenacity
+  module BelongsTo #:nodoc:
+
+    private
+
+    def belongs_to_associate(association_id)
+      associate_id = self.send("#{association_id}_id")
+      clazz = associate_class(association_id)
+      clazz._t_find(associate_id)
+    end
+
+    def set_belongs_to_associate(association_id, associate)
+      self.send "#{association_id}_id=", associate.id.to_s
+    end
+
+    module ClassMethods #:nodoc:
+      def initialize_belongs_to_association(association_id)
+        _t_initialize_belongs_to_association(association_id) if self.respond_to?(:_t_initialize_belongs_to_association)
+      end
+
+      def _t_stringify_belongs_to_value(record, association_id)
+        record.send "#{association_id}_id=", record.send("#{association_id}_id").to_s
+      end
+    end
+
+  end
+end
+

data/lib/tenacity/associations/has_many.rb

@@ -0,0 +1,86 @@
+module Tenacity
+  module HasMany #:nodoc:
+
+    private
+
+    def has_many_associates(association_id)
+      ids = _t_get_associate_ids(association_id)
+      clazz = associate_class(association_id)
+      clazz._t_find_bulk(ids)
+    end
+
+    def has_many_associate_ids(association_id)
+      _t_get_associate_ids(association_id)
+    end
+
+    def set_has_many_associate_ids(association_id, associate_ids)
+      clazz = associate_class(association_id)
+      instance_variable_set ivar_name(association_id), clazz._t_find_bulk(associate_ids)
+    end
+
+    def save_without_callback
+      @perform_save_associates_callback = false
+      save
+    ensure
+      @perform_save_associates_callback = true
+    end
+
+    def has_many_property_name(association_id)
+      self.class.has_many_property_name(association_id)
+    end
+
+    module ClassMethods #:nodoc:
+      def initialize_has_many_association(association_id)
+        _t_initialize_has_many_association(association_id) if self.respond_to?(:_t_initialize_has_many_association)
+
+        attr_accessor :perform_save_associates_callback
+      end
+
+      def _t_save_associates(record, association_id)
+        return if record.perform_save_associates_callback == false
+
+        _t_clear_old_associations(record, association_id)
+
+        associates = (record.instance_variable_get "@_t_#{association_id.to_s}") || []
+        associates.each do |associate|
+          associate.send("#{property_name_for_record(record)}=", record.id.to_s)
+          save_associate(associate)
+        end
+
+        unless associates.blank?
+          associate_ids = associates.map { |associate| associate.id.to_s }
+          record._t_associate_many(association_id, associate_ids)
+          save_associate(record)
+        end
+      end
+
+      def _t_clear_old_associations(record, association_id)
+        clazz = associate_class(association_id)
+        property_name = property_name_for_record(record)
+
+        old_associates = clazz._t_find_all_by_associate(property_name, record.id.to_s)
+        old_associates.each do |old_associate|
+          old_associate.send("#{property_name}=", nil)
+          save_associate(old_associate)
+        end
+
+        record._t_clear_associates(association_id)
+        save_associate(record)
+      end
+
+      def property_name_for_record(record)
+        "#{ActiveSupport::Inflector.underscore(record.class.to_s)}_id"
+      end
+
+      def has_many_property_name(association_id)
+        "t_" + ActiveSupport::Inflector.singularize(association_id) + "_ids"
+      end
+
+      def save_associate(associate)
+        associate.respond_to?(:_t_save_without_callback) ? associate._t_save_without_callback : associate.save
+      end
+    end
+
+  end
+end
+

data/lib/tenacity/associations/has_one.rb

@@ -0,0 +1,40 @@
+module Tenacity
+  module HasOne #:nodoc:
+
+    private
+
+    def has_one_associate(association_id)
+      clazz = associate_class(association_id)
+      clazz._t_find_first_by_associate(property_name, self.id.to_s)
+    end
+
+    def set_has_one_associate(association_id, associate)
+      associate.send "#{property_name}=", self.id.to_s
+      associate.save
+    end
+
+    def property_name
+      "#{ActiveSupport::Inflector.underscore(self.class.to_s)}_id"
+    end
+
+    module ClassMethods #:nodoc:
+      def initialize_has_one_association(association_id)
+        begin
+          require association_id.to_s
+        rescue Exception => e
+          puts "ERROR: #{association_id.to_s} does not appear to be in the load path. Please make sure all model files are in the load path."
+          raise
+        end
+
+        clazz = associate_class(association_id)
+        clazz._t_initialize_has_one_association(ActiveSupport::Inflector.underscore(self.to_s)) if clazz.respond_to?(:_t_initialize_has_one_association)
+      end
+
+      def _t_stringify_has_one_value(record, association_id)
+        record.send "#{association_id}_id=", record.send("#{association_id}_id").to_s
+      end
+    end
+
+  end
+end
+