tenacity 0.4.1 → 0.5.0

data/.gitignore

@@ -8,3 +8,4 @@ doc/
 coverage/
 pkg/
 Gemfile.lock
+log/

data/EXTEND.rdoc

@@ -14,6 +14,11 @@ lib/tenacity/association.rb.
 
 == Class Methods
 
+  _t_id_type
+
+The type to use when storing instances of this class in a database.
+Usually String or Integer.
+
   _t_find(id)
 
 Find an object by its id, and return it.  If the object cannot be found,
@@ -34,8 +39,12 @@ and return it.  If no object could be found, return nil.
 
 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.
-If only some of the objects could be found, then simply return those objects
-in the array.
+
+  _t_find_all_ids_by_associate(property, id)
+
+Find all ids of rows/documents/etc by the specified property name, with the
+specified id, and return them in an array.  If no data could be found, return
+an empty array.
 
   _t_delete(ids, run_callbacks=true)
 
@@ -44,6 +53,12 @@ objects should be deleted in such a way that their delete callback methods
 are run.  If false, the objects should be deleted in such a way that their
 delete callback meethods are not run.  Return nothing.
 
+  _t_initialize_tenacity
+
+Perform any database client specific initialization necessary to support Tenacity
+associations.  This could include defining callbacks on the object required for
+all association types.
+
   _t_initialize_has_many_association(association)
 
 Perform any database client specific initialization necessary to support a has
@@ -73,23 +88,5 @@ when the after the object has been deleted.
   _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, 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 one of the object's properties.
-Return nothing.
-
-  _t_get_associate_ids(association)
-
-Get the ids of the objects associated with this object through the specified
-association, and return them in an array.  Return an empty array if there
-are no associated objects.
-
-  _t_clear_associates(association)
-
-Destroy the association between this object and its current associates through
-the specified association.  Return nothing.
+the data fetched from the database.  Returns the instance of the class (self).
 

data/Gemfile

@@ -1,6 +1,4 @@
 source "http://rubygems.org"
 source :gemcutter
 
-gem 'mongo_mapper', :git => 'git://github.com/jnunemaker/mongomapper.git'
-
 gemspec

data/README.rdoc

@@ -87,7 +87,9 @@ much the same way, supporting many of the same options.
 * DataMapper
 * MongoMapper
 * Mongoid
+* Ripple
 * Sequel
+* Toystore
 
 See EXTEND.rdoc for information on extending Tenacity to work with other database clients.
 
@@ -110,7 +112,7 @@ See EXTEND.rdoc for information on extending Tenacity to work with other databas
 
 == Development
 
-* SQLite, MongoDB, and CouchDB must be installed and configured.
+* SQLite, MongoDB, Riak, and CouchDB must be installed, configured, and running.
 * Install the dependencies
 
   bundle install

data/Rakefile

@@ -20,6 +20,7 @@ require 'yard'
 task :default => :test
 
 Rake::TestTask.new(:test) do |test|
+  ENV['TENACITY_TEST'] = 'true'
   test.libs << 'lib' << 'test' << 'test/fixtures'
   test.pattern = ENV['TEST'] || "test/**/*_test.rb"
   test.verbose = true
@@ -31,6 +32,12 @@ task :quick_test do
   Rake::Task["test"].invoke
 end
 
+desc 'Run the full test suite, testing all ORM/ODMs against each other'
+task :long_test do
+  ENV['LONG'] = 'true'
+  Rake::Task["test"].invoke
+end
+
 Rcov::RcovTask.new do |test|
   test.libs << 'test' << 'test/fixtures'
   test.pattern = 'test/**/*_test.rb'

data/history.txt

@@ -1,3 +1,20 @@
+== 0.5.0
+
+* Major enhancements
+
+  * Added code to verify target object in a t_belongs_to association exists when
+    saving the source object
+  * Don't allow the source object in a t_has_one or t_has_many association to be
+    deleted if the target object in the association is holding its id
+  * Removed the need for join tables for t_has_many associations
+  * Added support for Ripple
+  * Added support for Toystore
+
+* Bug fixes
+
+  * Fixed bug preventing an object including the Tenacity module from being saved
+    successfully if it had no associations
+
 == 0.4.1
 
 * Bug fixes

data/lib/tenacity.rb

@@ -15,7 +15,9 @@ require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'couchrest')
 require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'datamapper')
 require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'mongo_mapper')
 require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'mongoid')
+require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'ripple')
 require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'sequel')
+require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'toystore')
 
 module Tenacity #:nodoc:
   include InstanceMethods
@@ -30,7 +32,9 @@ module Tenacity #:nodoc:
     OrmExt::DataMapper.setup(model)
     OrmExt::MongoMapper.setup(model)
     OrmExt::Mongoid.setup(model)
+    OrmExt::Ripple.setup(model)
     OrmExt::Sequel.setup(model)
+    OrmExt::Toystore.setup(model)
 
     raise "Tenacity does not support the database client used by #{model}" unless model.respond_to?(:_t_find)
     model.extend(ClassMethods)

data/lib/tenacity/associates_proxy.rb

@@ -36,13 +36,13 @@ module Tenacity
     end
 
     def destroy_all
-      ids = prepare_for_delete
-      @association.associate_class._t_delete(ids)
+      remove_associates_from_parent
+      @association.associate_class._t_delete(@parent._t_get_associate_ids(@association))
     end
 
     def delete_all
-      ids = prepare_for_delete
-      @association.associate_class._t_delete(ids, false)
+      remove_associates_from_parent
+      @association.associate_class._t_delete(@parent._t_get_associate_ids(@association), false)
     end
 
     def inspect
@@ -51,11 +51,9 @@ module Tenacity
 
     private
 
-    def prepare_for_delete
-      ids = @parent._t_get_associate_ids(@association)
+    def remove_associates_from_parent
       @parent._t_remove_associates(@association)
       @parent.save
-      ids
     end
 
     def method_missing(method, *args)

data/lib/tenacity/association.rb

@@ -35,6 +35,9 @@ module Tenacity
     # Is this association a polymorphic association?
     attr_reader :polymorphic
 
+    # Should this association disable foreign key like constraints
+    attr_reader :disable_foreign_key_constraints
+
     def initialize(type, name, source, options={})
       @type = type
       @name = name
@@ -47,10 +50,6 @@ module Tenacity
       end
 
       @foreign_key = options[:foreign_key]
-      @foreign_keys_property = options[:foreign_keys_property]
-      @join_table = options[:join_table]
-      @association_key = options[:association_key]
-      @association_foreign_key = options[:association_foreign_key]
       @dependent = options[:dependent]
       @readonly = options[:readonly]
       @limit = options[:limit]
@@ -58,12 +57,7 @@ module Tenacity
       @autosave = options[:autosave]
       @polymorphic = options[:polymorphic]
       @as = options[:as]
-
-      if @foreign_keys_property
-        if @foreign_keys_property.to_s == ActiveSupport::Inflector.singularize(name) + "_ids"
-          raise "#{ActiveSupport::Inflector.singularize(name) + "_ids"} is an invalid foreign keys property name"
-        end
-      end
+      @disable_foreign_key_constraints = options[:disable_foreign_key_constraints]
     end
 
     # The name of the association
@@ -93,35 +87,6 @@ module Tenacity
       end
     end
 
-    # Get the property name used to store the foreign key
-    def foreign_keys_property
-      @foreign_keys_property || "t_" + ActiveSupport::Inflector.singularize(name) + "_ids"
-    end
-
-    # Get the name of the join table used by this association
-    def join_table
-      table_name = fetch_table_name
-
-      if @type == :t_has_many && polymorphic?
-        association_name_for_join_table = name.to_s.pluralize
-      else
-        association_name_for_join_table = name
-      end
-
-      @join_table || (name.to_s < table_name ? "#{association_name_for_join_table}_#{table_name}" : "#{table_name}_#{association_name_for_join_table}")
-    end
-
-    # Get the name of the column in the join table that represents this object
-    def association_key
-      table_name = fetch_table_name
-      @association_key || table_name.singularize + '_id'
-    end
-
-    # Get the name of the column in the join table that represents the associated object
-    def association_foreign_key
-      @association_foreign_key || name.to_s.singularize + '_id'
-    end
-
     # Are the associated objects read only?
     def readonly?
       @readonly == true
@@ -137,16 +102,13 @@ module Tenacity
       (name.to_s + "_type").to_sym
     end
 
-    private
-
-    def fetch_table_name
-      if @source.respond_to?(:table_name)
-        @source.table_name.to_s
-      else
-        "#{ActiveSupport::Inflector.underscore(@source)}s"
-      end
+    # Are foreign key constraints enabled for this association?
+    def foreign_key_constraints_enabled?
+      @disable_foreign_key_constraints != true
     end
 
+    private
+
     def belongs_to_foreign_key
       if polymorphic?
         (name.to_s + "_id").to_sym

data/lib/tenacity/associations/belongs_to.rb

@@ -18,8 +18,7 @@ module Tenacity
       def belongs_to_associate(association)
         associate_id = self.send(association.foreign_key)
         clazz = association.associate_class(self)
-        associate = clazz._t_find(associate_id)
-        associate
+        clazz._t_find(associate_id)
       end
 
       def set_belongs_to_associate(association, associate)

data/lib/tenacity/associations/has_many.rb

@@ -3,8 +3,7 @@ module Tenacity
     module HasMany #:nodoc:
 
       def _t_remove_associates(association)
-        instance_variable_set _t_ivar_name(association), []
-        _t_clear_associates(association)
+        instance_variable_set(_t_ivar_name(association), [])
       end
 
       def _t_cleanup_has_many_association(association)
@@ -19,10 +18,23 @@ module Tenacity
               associate.send "#{association.foreign_key(self.class)}=", nil
               associate.save
             end
+          elsif association.foreign_key_constraints_enabled?
+            raise ObjectIdInUseError.new("Unable to delete #{self.class} with id of #{self.id} because its id is being referenced by instances of #{associates.first.class}(id: #{associates.map(&:id).join(',')})!")
           end
         end
       end
 
+      def _t_get_associate_ids(association)
+        if self.id.nil?
+          []
+        else
+          foreign_key = association.foreign_key(self.class)
+          associate_id = self.class._t_serialize_ids(self.id, association)
+          ids = association.associate_class._t_find_all_ids_by_associate(foreign_key, associate_id)
+          self.class._t_serialize_ids(ids, association)
+        end
+      end
+
       private
 
       def has_many_associates(association)
@@ -43,7 +55,7 @@ module Tenacity
 
       def set_has_many_associate_ids(association, associate_ids)
         clazz = association.associate_class
-        instance_variable_set _t_ivar_name(association), clazz._t_find_bulk(associate_ids)
+        instance_variable_set(_t_ivar_name(association), clazz._t_find_bulk(associate_ids))
       end
 
       def save_without_callback
@@ -81,24 +93,12 @@ module Tenacity
           # place of the associated objects.  The actual associated objects
           # will be fetched the first time they are needed.  So, force them to
           # be fetched here, before we clear them out in the database.
-          old_associates.inspect
+          old_associates.first
 
           _t_clear_old_associations(record, association)
 
-          associates = (record.instance_variable_get record._t_ivar_name(association)) || []
-          associates.each do |associate|
-            associate._t_reload
-            associate.send("#{association.foreign_key(record.class)}=", _t_serialize(record.id, association))
-            associate.send "#{association.polymorphic_type}=", self.to_s if association.polymorphic?
-            save_associate(associate)
-          end
-
-          unless associates.blank?
-            associate_ids = associates.map { |associate| _t_serialize(associate.id) }
-            record._t_associate_many(association, associate_ids)
-            save_associate(record)
-          end
-
+          associates = (record.instance_variable_get(record._t_ivar_name(association))) || []
+          establish_relationship_in_target_objects(record, association, associates)
           destroy_orphaned_associates(association, old_associates, associates)
         end
 
@@ -109,9 +109,6 @@ module Tenacity
             old_associate.send("#{property_name}=", nil)
             save_associate(old_associate)
           end
-
-          record._t_clear_associates(association)
-          save_associate(record)
         end
 
         def save_associate(associate)
@@ -132,6 +129,15 @@ module Tenacity
             end
           end
         end
+
+        def establish_relationship_in_target_objects(record, association, associates)
+          associates.each do |a|
+            associate = a._t_reload
+            associate.send("#{association.foreign_key(record.class)}=", _t_serialize(record.id, association))
+            associate.send "#{association.polymorphic_type}=", self.to_s if association.polymorphic?
+            save_associate(associate)
+          end
+        end
       end
 
     end

data/lib/tenacity/associations/has_one.rb

@@ -12,6 +12,8 @@ module Tenacity
           elsif association.dependent == :nullify
             associate.send "#{association.foreign_key(self.class)}=", nil
             associate.save
+          elsif association.foreign_key_constraints_enabled?
+            raise ObjectIdInUseError.new("Unable to delete #{self.class} with id of #{self.id} because its id is being referenced by an instance of #{associate.class}(id: #{associate.id})!")
           end
         end
       end
@@ -20,8 +22,7 @@ module Tenacity
 
       def has_one_associate(association)
         clazz = association.associate_class
-        associate = clazz._t_find_first_by_associate(association.foreign_key(self.class), _t_serialize(self.id, association))
-        associate
+        clazz._t_find_first_by_associate(association.foreign_key(self.class), _t_serialize(self.id, association))
       end
 
       def set_has_one_associate(association, associate)

data/lib/tenacity/class_methods.rb

@@ -140,34 +140,7 @@ module Tenacity
   #   project.milestones(true).size  # fetches milestones from the database
   #   project.milestones             # uses the milestone cache
   #
-  # == Join Tables
-  #
-  # One-to-many assocations that contain a relational database backed object as one of
-  # the assocaites are implemented using an intermediate join table. This differs from
-  # ActiveRecord::Associations, where only many-to-many relationships are implemented
-  # using an intermediate join table.
-  #
-  # Tenacity will not create the join table. It assume one exists, and is named properly.
-  # Unless the join table is explicitly specified as an option, it is guessed using the
-  # lexical order of the class names. So a join between Developer and Project will give
-  # the default join table name of "developers_projects" because "D" outranks "P". Note
-  # that this precedence is calculated using the < operator for String. This means that
-  # if the strings are of different lengths, and the strings are equal when compared up
-  # to the shortest length, then the longer string is considered of higher lexical
-  # precedence than the shorter one. For example, one would expect the tables "paper_boxes"
-  # and "papers" to generate a join table name of "papers_paper_boxes" because of the
-  # length of the name "paper_boxes", but it in fact generates a join table name of
-  # "paper_boxes_papers". Be aware of this caveat, and use the custom :join_table option
-  # if you need to.
-  #
-  # The column names used in the join table are guessed to be the names of the associated
-  # classes, suffixed with "_id".  For example, the "developers_projects" join table
-  # mentioned above is expected to have a column named "developer_id" and a column named
-  # "project_id". The <tt>:associate_key</tt> and <tt>:associate_foreign_key</tt> options
-  # can be used to override these defaults.
-  #
   module ClassMethods
-    attr_reader :_tenacity_associations
 
     # Specifies a one-to-one association with another class. This method should only be used
     # if the other class contains the foreign key. If the current class contains the foreign key,
@@ -210,6 +183,9 @@ module Tenacity
     #   If true, always save the associated object or destroy it if marked for destruction, when saving the parent object. Off by default.
     # [:as]
     #   Specifies a polymorphic interface (See <tt>t_belongs_to</tt>).
+    # [:disable_foreign_key_constraints]
+    #   If true, bypass foreign key constraints, like verifying no other objects are storing the key of the source object
+    #   before deleting it.  Defaults to false.
     #
     # Option examples:
     #   t_has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
@@ -282,6 +258,9 @@ module Tenacity
     # [:polymorphic]
     #   Specify this association is a polymorphic association by passing +true+. (*Note*: IDs for polymorphic associations are always
     #   stored as strings in the database.)
+    # [:disable_foreign_key_constraints]
+    #   If true, bypass foreign key constraints, like verifying the target object exists when the relationship is created.
+    #   Defaults to false.
     #
     # Option examples:
     #   t_belongs_to :project_manager, :class_name => "Person"
@@ -307,10 +286,7 @@ module Tenacity
       end
     end
 
-    # Specifies a one-to-many association. One-to-many associations that contain a
-    # relational database backed object as one of the associates are implemented
-    # using an intermediate join table. See the Join Tables section at the top
-    # for more information.
+    # Specifies a one-to-many association.
     #
     # The following methods for retrieval and query of collections of associated objects will be added:
     #
@@ -375,37 +351,12 @@ module Tenacity
     #   Specify the foreign key used for the association. By default this is guessed to be the name
     #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +t_has_many+
     #   association will use "person_id" as the default <tt>:foreign_key</tt>.
-    # [:foreign_keys_property]
-    #   Specify the name of the property that stores the ids of the associated objects. By default
-    #   this is guessed to be the name of the association with a "t_" prefix and an "_ids" suffix.
-    #   So a class that defines a <tt>t_has_many :people</tt> association will use t_people_ids as
-    #   the property to store the ids of the associated People objects. This option is only valid
-    #   for objects that store associated ids in an array instaed of a join table (CouchRest,
-    #   MongoMapper, etc). <b>WARNING:</b> The name of the association with an "_ids" suffix should
-    #   not be used as the property name, since tenacity adds a method with this name to the object.
     # [:dependent]
     #   If set to <tt>:destroy</tt> all the associated objects are deleted alongside this object
     #   in addition to calling their delete callbacks.  If set to <tt>:delete_all</tt> all
     #   associated objects are deleted *without* calling their delete callbacks.  If set to
     #   <tt>:nullify</tt> all associated objects' foreign keys are set to +NULL+ *without* calling
     #   their save backs.
-    # [:join_table]
-    #   Specify the name of the join table if the default based on lexical order isn't what you want.
-    #   This option is only valid if one of the models in the association is backed by a relational
-    #   database.
-    # [:association_foreign_key]
-    #   Specify the foreign key in the join table used for the association on the receiving side of
-    #   the association. By default this is guessed to be the name of the associated class in
-    #   lower-case and "_id" suffixed. So if a Person class makes a +t_has_many+ association to
-    #   Project, the association will use "project_id" as the default <tt>:association_foreign_key</tt>.
-    #   This option is only valid if one of the associated objects is backed by a relational
-    #   database.
-    # [:association_key]
-    #   Specify the key in the join table used for the association on the declaring side of
-    #   the association. By default this is guessed to be the name of this class in lower-case and
-    #   "_id" suffixed. So if a Person class makes a +t_has_many+ association to Project, the
-    #   association will use "person_id" as the default <tt>:association_key</tt>.  This option is
-    #   only valid if one of the associated objects is backed by a relational database.
     # [:readonly]
     #   If true, all the associated objects are readonly through the association.
     # [:limit]
@@ -418,14 +369,13 @@ module Tenacity
     #   If true, always save any loaded members and destroy members marked for destruction, when saving the parent object. Off by default.
     # [:as]
     #   Specifies a polymorphic interface (See <tt>t_belongs_to</tt>).
+    # [:disable_foreign_key_constraints]
+    #   If true, bypass foreign key constraints, like verifying no other objects are storing the key of the source object
+    #   before deleting it.  Defaults to false.
     #
     # Option examples:
     #   t_has_many :products, :class_name => "SpecialProduct"
     #   t_has_many :engineers, :foreign_key => "project_id"  # within class named SecretProject
-    #   t_has_many :engineers, :foreign_keys_property => "worker_ids"
-    #   t_has_many :managers, :join_table => "project_managers_and_projects"
-    #   t_has_many :managers, :join_table => "project_managers_and_projects",
-    #       :association_foreign_key => "mgr_id", :association_key => "proj_id"
     #   t_has_many :tasks, :dependent => :destroy
     #   t_has_many :reports, :readonly => true
     #   t_has_many :tags, :as => :taggable
@@ -474,6 +424,10 @@ module Tenacity
       end
     end
 
+    def _tenacity_associations
+      @_tenacity_associations || []
+    end
+
     private
 
     def _t_create_association(type, name, options) #:nococ: