tenacity 0.2.0 → 0.3.0

data/.gitignore

@@ -1,7 +1,10 @@
 *.swp
 *.swo
+.yardoc
+.rvmrc
 .bundle
 rdoc/
+doc/
 coverage/
 pkg/
 Gemfile.lock

data/EXTEND.rdoc

@@ -30,7 +30,8 @@ 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.
+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_first_by_associate(property, id)
 
@@ -41,6 +42,15 @@ 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_delete(ids, run_callbacks=true)
+
+Delete all objects with the specified ids.  If <tt>run_callbacks</tt> is true, the
+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_has_many_association(association)
 

data/README.rdoc

@@ -83,8 +83,11 @@ much the same way, supporting many of the same options.
 == Supported Database Clients
 
 * ActiveRecord
-* MongoMapper
 * CouchRest (CouchModel and ExtendedDocument)
+* DataMapper
+* MongoMapper
+* Mongoid
+* Sequel
 
 See EXTEND.rdoc for information on extending Tenacity to work with other database clients.
 

data/Rakefile

@@ -10,16 +10,21 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
 
+require 'rake'
 require 'rake/testtask'
+require 'rcov/rcovtask'
+require 'rake/rdoctask'
+require 'yard'
+
+task :default => :test
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test' << 'test/fixtures'
-  test.pattern = 'test/**/*_test.rb'
+  test.pattern = ENV['TEST'] || "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'
@@ -27,12 +32,8 @@ Rcov::RcovTask.new do |test|
   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*')
@@ -40,6 +41,16 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-desc 'Delete rcov, rdoc, and other generated files'
-task :clobber => [:clobber_rcov, :clobber_rdoc]
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', '-', 'EXTEND.rdoc']
+end
+
+desc 'Delete rcov, rdoc, yard, and other generated files'
+task :clobber => [:clobber_rcov, :clobber_rdoc, :clobber_yard]
+
+desc 'Delete yard generated files'
+task :clobber_yard do
+  puts 'rm -rf doc .yardoc'
+  FileUtils.rm_rf ['doc', '.yardoc']
+end
 

data/history.txt

@@ -1,3 +1,24 @@
+== 0.3.0
+
+* Major enhancements
+
+  * Added support for Mongoid
+  * Added support for DataMapper
+  * Added support for Sequel
+
+* Minor enhancements
+
+  * Automatically save object when added to a t_has_many association, unless the
+    parent object is not yet saved itself.
+  * Added suport for destroy_all to the t_has_many association
+  * Added suport for delete_all to the t_has_many association
+  * Added support for push and concat to t_has_many association
+
+* Bug fixes
+
+  * Found and fixed many minor bugs thanks to a new test suite that tests all
+    associations against all supported database clients.
+
 == 0.2.0
 
 * Major enhancements

data/lib/tenacity.rb

@@ -1,5 +1,6 @@
 require File.join('active_support', 'inflector')
 
+require File.join(File.dirname(__FILE__), 'tenacity', 'associates_proxy')
 require File.join(File.dirname(__FILE__), 'tenacity', 'association')
 require File.join(File.dirname(__FILE__), 'tenacity', 'class_methods')
 require File.join(File.dirname(__FILE__), 'tenacity', 'instance_methods')
@@ -7,11 +8,11 @@ require File.join(File.dirname(__FILE__), 'tenacity', 'associations', 'belongs_t
 require File.join(File.dirname(__FILE__), 'tenacity', 'associations', 'has_many')
 require File.join(File.dirname(__FILE__), 'tenacity', 'associations', 'has_one')
 require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'activerecord')
-require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'couchrest', 'tenacity_class_methods')
-require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'couchrest', 'tenacity_instance_methods')
-require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'couchrest', 'couchrest_extended_document')
-require File.join(File.dirname(__FILE__), 'tenacity', 'orm_ext', 'couchrest', 'couchrest_model')
+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', 'sequel')
 
 module Tenacity #:nodoc:
   include InstanceMethods
@@ -21,6 +22,13 @@ module Tenacity #:nodoc:
   include HasOne
 
   def self.included(model)
+    ActiveRecord.setup(model)
+    CouchRest.setup(model)
+    DataMapper.setup(model)
+    MongoMapper.setup(model)
+    Mongoid.setup(model)
+    Sequel.setup(model)
+
     raise "Tenacity does not support the database client used by #{model}" unless model.respond_to?(:_t_find)
     model.extend(ClassMethods)
   end

data/lib/tenacity/associates_proxy.rb

@@ -0,0 +1,67 @@
+module Tenacity
+  class AssociatesProxy #:nodoc:
+    alias_method :proxy_respond_to?, :respond_to?
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_|^object_id$)/ }
+
+    def initialize(parent, target, association)
+      @parent = parent
+      @target = target
+      @association = association
+    end
+
+    def respond_to?(*args)
+      proxy_respond_to?(*args) || @target.respond_to?(*args)
+    end
+
+    # Explicitly proxy === because the instance method removal above doesn't catch it.
+    def ===(other)
+      other === @target
+    end
+
+    def <<(object)
+      object.save unless @parent.id.nil?
+      @target << object
+    end
+
+    def push(*objects)
+      objects.each { |object| object.save } unless @parent.id.nil?
+      @target.push(*objects)
+    end
+
+    def concat(objects)
+      objects.each { |object| object.save } unless @parent.id.nil?
+      @target.concat(objects)
+    end
+
+    def destroy_all
+      ids = prepare_for_delete
+      @association.associate_class._t_delete(ids)
+    end
+
+    def delete_all
+      ids = prepare_for_delete
+      @association.associate_class._t_delete(ids, false)
+    end
+
+    def inspect
+      @target.inspect
+    end
+
+    private
+
+    def prepare_for_delete
+      ids = @parent._t_get_associate_ids(@association)
+      @parent._t_remove_associates(@association)
+      @parent.save
+      ids
+    end
+
+    def method_missing(method, *args)
+      if block_given?
+        @target.send(method, *args) { |*block_args| yield(*block_args) }
+      else
+        @target.send(method, *args)
+      end
+    end
+  end
+end

data/lib/tenacity/association.rb

@@ -1,5 +1,10 @@
 module Tenacity
+
+  # The Associaiton class represents a Tenacity association.  Using this class,
+  # you can retrieve all sorts of information about the association, including
+  # it name, type, source, target class, etc.
   class Association
+
     # Type type of the association (<tt>:t_has_one</tt>, <tt>:t_has_many</tt>, or <tt>:t_belongs_to</tt>)
     attr_reader :type
 
@@ -62,21 +67,29 @@ module Tenacity
 
     # Get the name of the join table used by this association
     def join_table
-      if @join_table || @source.respond_to?(:table_name)
-        @join_table || (name.to_s < @source.table_name ? "#{name}_#{@source.table_name}" : "#{@source.table_name}_#{name}")
-      end
+      table_name = fetch_table_name
+      @join_table || (name.to_s < table_name ? "#{name}_#{table_name}" : "#{table_name}_#{name}")
     end
 
     # Get the name of the column in the join table that represents this object
     def association_key
-      if @association_key || @source.respond_to?(:table_name)
-        @association_key || @source.table_name.singularize + '_id'
-      end
+      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
+
+    private
+
+    def fetch_table_name
+      if @source.respond_to?(:table_name)
+        @source.table_name.to_s
+      else
+        "#{ActiveSupport::Inflector.underscore(@source)}s"
+      end
+    end
   end
 end

data/lib/tenacity/associations/has_many.rb

@@ -1,6 +1,11 @@
 module Tenacity
   module HasMany #:nodoc:
 
+    def _t_remove_associates(association)
+      instance_variable_set _t_ivar_name(association), []
+      _t_clear_associates(association)
+    end
+
     private
 
     def has_many_associates(association)
@@ -39,6 +44,7 @@ module Tenacity
 
         associates = (record.instance_variable_get record._t_ivar_name(association)) || []
         associates.each do |associate|
+          associate._t_reload
           associate.send("#{association.foreign_key(record.class)}=", record.id.to_s)
           save_associate(associate)
         end

data/lib/tenacity/class_methods.rb

@@ -7,6 +7,7 @@ module Tenacity
   # methods.
   #
   #   class Project
+  #     include SupportedDatabaseClient
   #     include Tenacity
   #
   #     t_belongs_to    :portfolio
@@ -57,6 +58,47 @@ module Tenacity
   #     t_belongs_to :manager     # foreign key - manager_id
   #   end
   #
+  # == Is it a +t_belongs_to+ or +t_has_one+ association?
+  #
+  # Both express a 1-1 relationship. The difference is mostly where to place
+  # the foreign key, which is owned by the class declaring the +t_belongs_to+
+  # relationship.  Example:
+  #
+  #   class Employee < ActiveRecord::Base
+  #     include Tenacity
+  #     t_has_one :office
+  #   end
+  #
+  #   class Office
+  #     include MongoMapper::Document
+  #     include Tenacity
+  #     t_belongs_to :employee
+  #   end
+  #
+  # In this example, the foreign key, <tt>employee_id</tt>, would belong to the
+  # Office class.  If possible, tenacity will define the property to hold the
+  # foreign key.  When it cannot, it assumes that the foreign key has been
+  # defined.  See the documentation for the respective database client
+  # extension to see if tenacity will declare the foreign_key property.
+  #
+  # == Unsaved objects and associations
+  #
+  # You can manipulate objects and associations before they are saved to the database, but there is some special behavior you should be
+  # aware of, mostly involving the saving of associated objects.
+  #
+  # === One-to-one associations
+  #
+  # * Assigning an object to a +t_has_one+ association automatically saves that object and the object being replaced (if there is one), in
+  #   order to update their primary keys - except if the parent object is not yet stored in the database.
+  # * Assigning an object to a +t_belongs_to+ association does not save the object, since the foreign key field belongs on the parent. It
+  #   does not save the parent either.
+  #
+  # === Collections
+  #
+  # * Adding an object to a collection (+t_has_many+) automatically saves that object, except if the parent object
+  #   (the owner of the collection) is not yet stored in the database.
+  # * All unsaved members of the collection are automatically saved when the parent is saved.
+  #
   # == Caching
   #
   # All of the methods are built on a simple caching principle that will keep the result
@@ -218,9 +260,18 @@ module Tenacity
     #   An empty array is returned if none are found.
     # [collection<<(object, ...)]
     #   Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
-    #   Note that this operation does not update the association until the parent object is saved.
+    # [collection.push(object, ...)]
+    #   Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
+    # [collection.concat(other_array)]
+    #   Adds the objects in the other array to the collection by setting their foreign keys to the collection's primary key.
     # [collection.delete(object, ...)]
     #   Removes one or more objects from the collection.
+    # [collection.destroy_all]
+    #   Removes all objects from the collection, and deletes them from their respective
+    #   database. If the deleted objects have any delete callbacks defined, they will be called.
+    # [collection.delete_all]
+    #   Removes all objects from the collection, and deletes them from their respective
+    #   database. No delete callbacks will be called, regardless of whether or not they are defined.
     # [collection=objects]
     #   Replaces the collections content by setting it to the list of specified objects.
     # [collection_singular_ids]

data/lib/tenacity/instance_methods.rb

@@ -8,11 +8,11 @@ module Tenacity
     private
 
     def get_associate(association, params)
-      _t_reload
+      _t_reload unless id.nil?
       force_reload = params.first unless params.empty?
-      value = instance_variable_get _t_ivar_name(association)
+      value = create_proxy(instance_variable_get(_t_ivar_name(association)), association)
       if value.nil? || force_reload
-        value = yield
+        value = create_proxy(yield, association)
         instance_variable_set _t_ivar_name(association), value
       end
       value
@@ -23,5 +23,9 @@ module Tenacity
       instance_variable_set _t_ivar_name(association), associate
     end
 
+    def create_proxy(value, association)
+      value.respond_to?(:each) ? AssociatesProxy.new(self, value, association) : value
+    end
+
   end
 end

data/lib/tenacity/orm_ext/activerecord.rb

@@ -1,6 +1,4 @@
-begin
-  require 'active_record'
-
+module Tenacity
   # Tenacity relationships on ActiveRecord objects require that certain columns
   # exist on the associated table, and that join tables exist for one-to-many
   # relationships.  Take the following class for example:
@@ -43,33 +41,53 @@ begin
   #   end
   #
   module ActiveRecord
-    class Base #:nodoc:
 
-      def self._t_find(id)
+    def self.setup(model)
+      require 'active_record'
+      if model.ancestors.include?(::ActiveRecord::Base)
+        model.send :include, ActiveRecord::InstanceMethods
+        model.extend ActiveRecord::ClassMethods
+      end
+    rescue LoadError
+      # ActiveRecord not available
+    end
+
+    module ClassMethods #:nodoc:
+      def _t_find(id)
         find_by_id(id)
       end
 
-      def self._t_find_bulk(ids)
+      def _t_find_bulk(ids)
         return [] if ids.nil? || ids.empty?
         find(:all, :conditions => ["id in (?)", ids])
       end
 
-      def self._t_find_first_by_associate(property, id)
+      def _t_find_first_by_associate(property, id)
         find(:first, :conditions => ["#{property} = ?", id.to_s])
       end
 
-      def self._t_find_all_by_associate(property, id)
+      def _t_find_all_by_associate(property, id)
         find(:all, :conditions => ["#{property} = ?", id.to_s])
       end
 
-      def self._t_initialize_has_many_association(association)
+      def _t_initialize_has_many_association(association)
         after_save { |record| record.class._t_save_associates(record, association) }
       end
 
-      def self._t_initialize_belongs_to_association(association)
+      def _t_initialize_belongs_to_association(association)
         before_save { |record| record.class._t_stringify_belongs_to_value(record, association) }
       end
 
+      def _t_delete(ids, run_callbacks=true)
+        if run_callbacks
+          destroy_all(["id in (?)", ids])
+        else
+          delete_all(["id in (?)", ids])
+        end
+      end
+    end
+
+    module InstanceMethods #:nodoc:
       def _t_reload
         reload
       end
@@ -88,12 +106,11 @@ begin
       end
 
       def _t_get_associate_ids(association)
+        return [] if self.id.nil?
         rows = self.connection.execute("select #{association.association_foreign_key} from #{association.join_table} where #{association.association_key} = #{self.id}")
         ids = []; rows.each { |r| ids << r[0] }; ids
       end
-
     end
+
   end
-rescue LoadError
-  # ActiveRecord not available
 end