tenacity 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tenacity (0.1.0)
+    tenacity (0.1.1)
       activesupport (>= 2.3)
 
 GEM

data/README.rdoc

@@ -4,9 +4,9 @@ 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.
+given application (polyglot persistence).  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.
@@ -17,33 +17,61 @@ much the same way, supporting many of the same options.
 
 == Example
 
-  class User
+  class Car
     include MongoMapper::Document
     include Tenacity
 
-    t_has_many :entries
+    t_has_many :wheels
+    t_has_one  :dashboard
   end
 
-  class Entry < ActiveRecord::Base
+  class Wheel < ActiveRecord::Base
     include Tenacity
 
-    t_belongs_to :user
+    t_belongs_to :car
   end
 
+  class Dashboard < CouchRest::ExtendedDocument
+    include Tenacity
+    use_database MY_COUCHDB_DATABASE
 
-  # Fetch related object from the respective database
-  entry.user
+    t_belongs_to :car
+  end
+
+  car = Car.create
 
   # Set the related object
-  entry.user = some_user
-  entry.save
+  dashboard = Dashboard.create({})
+  car.dashboard = dashboard
+  car.save
+
+  # Fetch related object from the respective database
+  car.dashboard
 
-  # Fetch related objects from the respective database
-  user.entries
+  # Fetch related object id
+  car.dashboard.car_id
+
+  # Set related objects
+  wheel_1 = Wheel.create
+  wheel_2 = Wheel.create
+  wheel_3 = Wheel.create
+  wheels = [wheel_1, wheel_2, wheel_3]
+  car.wheels = wheels
+  car.save
+
+  wheel_1.car_id    # car.id
+
+  # Fetch array of related objects from the respective database
+  car.wheels        # [wheel_1, wheel_2, wheel_3]
+
+  # Fetch ids of related objects from the database
+  car.wheel_ids     # [wheel_1.id, wheel_2.id, wheel_3.id]
 
   # Add a related object to the collection
-  user.entries << some_entry
-  user.save
+  new_wheel = Wheel.create
+  car.wheels << new_wheel
+  car.save
+  car.wheels        # [wheel_1, wheel_2, wheel_3, wheel_4]
 
 
 == Additional Usage Details
@@ -82,13 +110,9 @@ See EXTEND.rdoc for information on extendeding Tenacity to work with other ORMs.
 
   bundler install
 
-* Create the test databases
-
-  rake db:create
-
 * Setup the test databases
 
-  rake db:test:prepare
+  rake test:prepare
 
 * Run the tests
 

data/Rakefile

@@ -45,49 +45,35 @@ 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
+  namespace :test do
+    desc "Setup the test databases"
+    task :prepare 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
+      system "mysqladmin -u root create tenacity_test"
 
-          create_table :active_record_cars, :force => true do |t|
-          end
+      ActiveRecord::Schema.define :version => 0 do
 
-          create_table :active_record_climate_control_units, :force => true do |t|
-            t.string :mongo_mapper_dashboard_id
-          end
+        create_table :active_record_cars, :force => true do |t|
+        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_climate_control_units, :force => true do |t|
+          t.string :mongo_mapper_dashboard_id
+        end
 
-          create_table :active_record_nuts, :force => true do |t|
-            t.string :mongo_mapper_wheel_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_mongo_mapper_wheels, :force => true do |t|
-            t.integer :active_record_nut_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

data/history.txt

@@ -0,0 +1,14 @@
+== 0.1.1
+
+* Bug fixes
+
+  * Fixed issue that was causing a load error if mongo mapper was not installed
+
+== 0.1.0
+
+* Major enhancements
+
+  * Initial release
+  * Support for has_one, belongs_to, and has_many associations
+  * Support for ActiveRecord, CouchRest, and MongoMapper
+

data/lib/tenacity/class_methods.rb

@@ -217,7 +217,7 @@ module Tenacity
       end
     end
 
-    def associate_class(association_id)
+    def associate_class(association_id) #:nodoc:
       Kernel.const_get(association_id.to_s.singularize.camelcase.to_sym)
     end
 

data/lib/tenacity/orm_ext/activerecord.rb

@@ -1,47 +1,47 @@
-# 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:
-#
-#   class Car < ActiveRecord::Base
-#     include Tenacity
-#
-#     t_has_many    :wheels
-#     t_has_one     :dashboard
-#     t_belongs_to  :driver
-#   end
-#
-#
-# == t_belongs_to
-#
-# The +t_belongs_to+ association requires that a property exist in the table
-# to hold the id of the assoicated object.
-#
-#   create_table :cars do |t|
-#     t.string :driver_id
-#   end
-#
-#
-# == t_has_one
-#
-# The +t_has_one+ association requires no special column in the table, since
-# the associated object holds the foreign key.
-#
-#
-# == t_has_many
-#
-# The +t_has_many+ association requires that a join table exist to store the
-# associations.  The name of the join table follows ActiveRecord conventions.
-# The name of the join table in this example would be cars_wheels, since cars
-# comes before wheels when shorted alphabetically.
-#
-#   create_table :cars_wheels do |t|
-#     t.integer :car_id
-#     t.string :wheel_id
-#   end
-#
 begin
   require 'active_record'
 
+  # 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:
+  #
+  #   class Car < ActiveRecord::Base
+  #     include Tenacity
+  #
+  #     t_has_many    :wheels
+  #     t_has_one     :dashboard
+  #     t_belongs_to  :driver
+  #   end
+  #
+  #
+  # == t_belongs_to
+  #
+  # The +t_belongs_to+ association requires that a property exist in the table
+  # to hold the id of the assoicated object.
+  #
+  #   create_table :cars do |t|
+  #     t.string :driver_id
+  #   end
+  #
+  #
+  # == t_has_one
+  #
+  # The +t_has_one+ association requires no special column in the table, since
+  # the associated object holds the foreign key.
+  #
+  #
+  # == t_has_many
+  #
+  # The +t_has_many+ association requires that a join table exist to store the
+  # associations.  The name of the join table follows ActiveRecord conventions.
+  # The name of the join table in this example would be cars_wheels, since cars
+  # comes before wheels when shorted alphabetically.
+  #
+  #   create_table :cars_wheels do |t|
+  #     t.integer :car_id
+  #     t.string :wheel_id
+  #   end
+  #
   module ActiveRecord
     class Base #:nodoc:
 

data/lib/tenacity/orm_ext/couchrest/couchrest_extended_document.rb

@@ -1,41 +1,41 @@
-# Tenacity relationships on CouchRest objects require no special keys
-# defined on the object.  Tenacity will define the keys that it needs
-# to support the relationships.  Take the following class for example:
-#
-#   class Car < CouchRest::ExtendedDocument
-#     include Tenacity
-#
-#     t_has_many    :wheels
-#     t_has_one     :dashboard
-#     t_belongs_to  :driver
-#   end
-#
-# == t_belongs_to
-#
-# The +t_belongs_to+ association will define a property named after the association.
-# The example above will create a property named <tt>:driver_id</tt>
-#
-#
-# == t_has_one
-#
-# The +t_has_one+ association will not define any new properties on the object, since
-# the associated object holds the foreign key.  If the CouchRest::ExtendedDocument class
-# is the target of a t_has_one association from another class, then a property
-# named after the association will be created on the CouchRest::ExtendedDocument object to
-# hold the foreign key to the other object.
-#
-#
-# == t_has_many
-#
-# The +t_has_many+ association will define a property named after the association.
-# The example above will create a property named <tt>:wheels_ids</tt>
-#
-
 begin
   require 'couchrest'
 
-  module CouchRest
-    class ExtendedDocument #:nodoc:
+  module CouchRest #:nodoc:
+
+    # Tenacity relationships on CouchRest objects require no special keys
+    # defined on the object.  Tenacity will define the keys that it needs
+    # to support the relationships.  Take the following class for example:
+    #
+    #   class Car < CouchRest::ExtendedDocument
+    #     include Tenacity
+    #
+    #     t_has_many    :wheels
+    #     t_has_one     :dashboard
+    #     t_belongs_to  :driver
+    #   end
+    #
+    # == t_belongs_to
+    #
+    # The +t_belongs_to+ association will define a property named after the association.
+    # The example above will create a property named <tt>:driver_id</tt>
+    #
+    #
+    # == t_has_one
+    #
+    # The +t_has_one+ association will not define any new properties on the object, since
+    # the associated object holds the foreign key.  If the CouchRest::ExtendedDocument class
+    # is the target of a t_has_one association from another class, then a property
+    # named after the association will be created on the CouchRest::ExtendedDocument object to
+    # hold the foreign key to the other object.
+    #
+    #
+    # == t_has_many
+    #
+    # The +t_has_many+ association will define a property named after the association.
+    # The example above will create a property named <tt>:wheels_ids</tt>
+    #
+    class ExtendedDocument
       include CouchRest::TenacityInstanceMethods
       extend CouchRest::TenacityClassMethods
     end

data/lib/tenacity/orm_ext/couchrest/couchrest_model.rb

@@ -1,40 +1,41 @@
-# Tenacity relationships on CouchRest objects require no special keys
-# defined on the object.  Tenacity will define the keys that it needs
-# to support the relationships.  Take the following class for example:
-#
-#   class Car < CouchRest::Model::Base
-#     include Tenacity
-#
-#     t_has_many    :wheels
-#     t_has_one     :dashboard
-#     t_belongs_to  :driver
-#   end
-#
-# == t_belongs_to
-#
-# The +t_belongs_to+ association will define a property named after the association.
-# The example above will create a property named <tt>:driver_id</tt>
-#
-#
-# == t_has_one
-#
-# The +t_has_one+ association will not define any new properties on the object, since
-# the associated object holds the foreign key.  If the CouchRest::Model class
-# is the target of a t_has_one association from another class, then a property
-# named after the association will be created on the CouchRest::Model object to
-# hold the foreign key to the other object.
-#
-#
-# == t_has_many
-#
-# The +t_has_many+ association will define a property named after the association.
-# The example above will create a property named <tt>:wheels_ids</tt>
-#
 begin
   require 'couchrest'
 
-  module CouchRest
-    module Model
+  module CouchRest #:nodoc:
+    module Model #:nodoc:
+
+      # Tenacity relationships on CouchRest objects require no special keys
+      # defined on the object.  Tenacity will define the keys that it needs
+      # to support the relationships.  Take the following class for example:
+      #
+      #   class Car < CouchRest::Model::Base
+      #     include Tenacity
+      #
+      #     t_has_many    :wheels
+      #     t_has_one     :dashboard
+      #     t_belongs_to  :driver
+      #   end
+      #
+      # == t_belongs_to
+      #
+      # The +t_belongs_to+ association will define a property named after the association.
+      # The example above will create a property named <tt>:driver_id</tt>
+      #
+      #
+      # == t_has_one
+      #
+      # The +t_has_one+ association will not define any new properties on the object, since
+      # the associated object holds the foreign key.  If the CouchRest::Model class
+      # is the target of a t_has_one association from another class, then a property
+      # named after the association will be created on the CouchRest::Model object to
+      # hold the foreign key to the other object.
+      #
+      #
+      # == t_has_many
+      #
+      # The +t_has_many+ association will define a property named after the association.
+      # The example above will create a property named <tt>:wheels_ids</tt>
+      #
       class Base
         include CouchRest::TenacityInstanceMethods
         extend CouchRest::TenacityClassMethods

data/lib/tenacity/orm_ext/couchrest/tenacity_class_methods.rb

@@ -1,5 +1,5 @@
 module CouchRest
-  module TenacityClassMethods
+  module TenacityClassMethods #:nodoc:
     def _t_find(id)
       get(id)
     end

data/lib/tenacity/orm_ext/couchrest/tenacity_instance_methods.rb

@@ -1,5 +1,5 @@
 module CouchRest
-  module TenacityInstanceMethods
+  module TenacityInstanceMethods #:nodoc:
     def _t_reload
       new_doc = database.get(self.id)
       self.clear

data/lib/tenacity/orm_ext/mongo_mapper.rb

@@ -101,7 +101,7 @@ end
 begin
   require 'mongo_mapper'
   MongoMapper::Document.append_inclusions(TenacityPluginAddition)
-rescue
+rescue LoadError
   # MongoMapper not available
 end
 

data/lib/tenacity/version.rb

@@ -1,3 +1,3 @@
 module Tenacity
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/tenacity.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |s|
   s.summary     = %Q{A ORM independent way of specifying simple relationships between models backed by different databases.}
   s.description = %Q{Tenacity provides an ORM independent way of specifying simple relationships between models backed by different databases.}
 
+  s.rubyforge_project = "tenacity"
+
   s.required_rubygems_version = ">= 1.3.6"
 
   s.add_runtime_dependency "activesupport", ">= 2.3"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - John Wood
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-25 00:00:00 -06:00
+date: 2010-12-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -185,6 +185,7 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- history.txt
 - lib/tenacity.rb
 - lib/tenacity/associations/belongs_to.rb
 - lib/tenacity/associations/has_many.rb
@@ -244,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: tenacity
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3