bmaland-has_many_polymorphs 2.5.0

data/CHANGELOG

@@ -0,0 +1,86 @@
+v2.2. Various fixes.
+
+v2.13. Merge various fixes for Rails 2.2.2.
+
+v2.12. Improvements to the test suite; bugfixes for STI children (rsl). Remove fancy dependency system in favor of using Dispatcher::to_prepare every time.
+
+v2.11. Rails 1.2.6 tagging generator compatibility; change test suite to use included integration app.
+
+v2.10. Add :parent_conditions option; bugfix for nullified conditions; bugfix for self-referential tagging generator; allow setting of has_many_polymorphs_options hash in Configuration's after_initialize if you need to adjust the autoload behavior; clear error message on missing or improperly namespaced models; fix .build on double-sided relationships; add :namespace key for easier set up of Camping apps or other unusual class structures.
+
+v2.9. Gem version renumbering; my apologies if this messes anyone up.
+
+v2.8. RDoc documentation; repository relocation; Rakefile cleanup; remove deprecated plugin-specific class caching.
+
+v2.7.5. Various bugfixes; Postgres problems may remain on edge.
+
+v2.7.3. Use new :source and :source_type options in 1.2.3 (David Lemstra); fix pluralization bug; add some tests; experimental tagging generator.
+
+v2.7.2. Deprecate has_many_polymorphs_cache_classes= option because it doesn't really work. Use config.cache_classes= instead to cache all reloadable items.
+
+v2.7.1. Dispatcher.to_prepare didn't fire in the console; now using a config.after_initialize wrapper instead.
+
+v2.7. Dependency injection framework elimates having to care about load order.
+
+v2.6. Make the logger act sane for the gem version.
+
+v2.5.2. Allow :skip_duplicates on double relationships.
+
+v2.5.1. Renamed :ignore_duplicates to :skip_duplicates to better express its non-passive behavior; made sure not to load target set on push unless necessary.
+
+v2.5. Activerecord compatibility branch becomes trunk: extra options now supported for double polymorphism; conditions nulled-out and propogated to child relationships; more tests; new :ignore_duplicates option on macro can be set to false if you want << to push duplicate associations.
+
+v2.4.1. Code split into multiple files; tests added for pluralization check; Rails 1.1.6 no longer supported.
+
+v2.4. Unlimited mixed class association extensions for both single and double targets and joins.
+
+v2.3. Gem version
+
+v2.2. API change; prefix on methods is now singular when using :rename_individual_collections.
+
+v2.1. Add configuration option to cache polymorphic classes in development mode.
+
+v2.0. Collection methods (push, delete, clear) now on individual collections.
+
+v1.9.2. Disjoint collection sides bugfix, don't raise on new records.
+
+v1.9.1. Double classify bugfix.
+
+v1.9. Large changes to properly support double polymorphism.
+
+v1.8.2. Bugfix to make sure the type gets checked on doubly polymorphic parents.
+
+v1.8.1. Bugfix for sqlite3 child attribute retrieval.
+
+v1.8. Bugfix for instantiating attributes of namespaced models.
+
+v1.7.1. Bugfix for double polymorphic relationships.
+
+v1.7. Double polymorphic relationships (includes new API method).
+
+v1.6. Namespaced model support.
+
+v1.5. Bugfix for Postgres and Mysql under 1.1.6; refactored tests (hildofur); properly handles legacy table names set with set_table_name().
+
+v1.4. STI support added (use the child class names, not the base class).
+
+v1.3. Bug regarding table names with underscores in SQL query fixed.
+
+v1.2. License change, again.
+
+v1.1. File_column bug fixed.
+
+v1.0. Tests written; after_find and after_initialize now correctly called.
+
+v0.5. SQL performance enhancements added.
+
+v0.4. Rewrote singletons as full-fledged proxy class so that marshalling works (e.g. in the session).
+
+v0.3. Caching added.
+
+v0.2. Fixed dependency reloading problem in development mode.
+
+v0.1. License change.
+
+v0. Added :dependent support on the join table; no changelog before this version.
+

data/LICENSE

@@ -0,0 +1,184 @@
+Academic Free License (AFL) v. 3.0
+
+This Academic Free License (the "License") applies to any original work
+of authorship (the "Original Work") whose owner (the "Licensor") has
+placed the following licensing notice adjacent to the copyright notice
+for the Original Work:
+
+Licensed under the Academic Free License version 3.0
+
+1) Grant of Copyright License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, for the duration of
+the copyright, to do the following:
+
+a) to reproduce the Original Work in copies, either alone or as part of
+a collective work;
+
+b) to translate, adapt, alter, transform, modify, or arrange the
+Original Work, thereby creating derivative works ("Derivative Works")
+based upon the Original Work;
+
+c) to distribute or communicate copies of the Original Work and
+Derivative Works to the public, under any license of your choice that
+does not contradict the terms and conditions, including Licensor's
+reserved rights and remedies, in this Academic Free License;
+
+d) to perform the Original Work publicly; and
+
+e) to display the Original Work publicly.
+
+2) Grant of Patent License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, under patent claims
+owned or controlled by the Licensor that are embodied in the Original
+Work as furnished by the Licensor, for the duration of the patents, to
+make, use, sell, offer for sale, have made, and import the Original Work
+and Derivative Works.
+
+3) Grant of Source Code License. The term "Source Code" means the
+preferred form of the Original Work for making modifications to it and
+all available documentation describing how to modify the Original Work.
+Licensor agrees to provide a machine-readable copy of the Source Code of
+the Original Work along with each copy of the Original Work that
+Licensor distributes. Licensor reserves the right to satisfy this
+obligation by placing a machine-readable copy of the Source Code in an
+information repository reasonably calculated to permit inexpensive and
+convenient access by You for as long as Licensor continues to distribute
+the Original Work.
+
+4) Exclusions From License Grant. Neither the names of Licensor, nor the
+names of any contributors to the Original Work, nor any of their
+trademarks or service marks, may be used to endorse or promote products
+derived from this Original Work without express prior permission of the
+Licensor. Except as expressly stated herein, nothing in this License
+grants any license to Licensor's trademarks, copyrights, patents, trade
+secrets or any other intellectual property. No patent license is granted
+to make, use, sell, offer for sale, have made, or import embodiments of
+any patent claims other than the licensed claims defined in Section 2.
+No license is granted to the trademarks of Licensor even if such marks
+are included in the Original Work. Nothing in this License shall be
+interpreted to prohibit Licensor from licensing under terms different
+from this License any Original Work that Licensor otherwise would have a
+right to license.
+
+5) External Deployment. The term "External Deployment" means the use,
+distribution, or communication of the Original Work or Derivative Works
+in any way such that the Original Work or Derivative Works may be used
+by anyone other than You, whether those works are distributed or
+communicated to those persons or made available as an application
+intended for use over a network. As an express condition for the grants
+of license hereunder, You must treat any External Deployment by You of
+the Original Work or a Derivative Work as a distribution under section
+1(c).
+
+6) Attribution Rights. You must retain, in the Source Code of any
+Derivative Works that You create, all copyright, patent, or trademark
+notices from the Source Code of the Original Work, as well as any
+notices of licensing and any descriptive text identified therein as an
+"Attribution Notice." You must cause the Source Code for any Derivative
+Works that You create to carry a prominent Attribution Notice reasonably
+calculated to inform recipients that You have modified the Original
+Work.
+
+7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants
+that the copyright in and to the Original Work and the patent rights
+granted herein by Licensor are owned by the Licensor or are sublicensed
+to You under the terms of this License with the permission of the
+contributor(s) of those copyrights and patent rights. Except as
+expressly stated in the immediately preceding sentence, the Original
+Work is provided under this License on an "AS IS" BASIS and WITHOUT
+WARRANTY, either express or implied, including, without limitation, the
+warranties of non-infringement, merchantability or fitness for a
+particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL
+WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential
+part of this License. No license to the Original Work is granted by this
+License except under this disclaimer.
+
+8) Limitation of Liability. Under no circumstances and under no legal
+theory, whether in tort (including negligence), contract, or otherwise,
+shall the Licensor be liable to anyone for any indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or the use of the Original Work including,
+without limitation, damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages
+or losses. This limitation of liability shall not apply to the extent
+applicable law prohibits such limitation.
+
+9) Acceptance and Termination. If, at any time, You expressly assented
+to this License, that assent indicates your clear and irrevocable
+acceptance of this License and all of its terms and conditions. If You
+distribute or communicate copies of the Original Work or a Derivative
+Work, You must make a reasonable effort under the circumstances to
+obtain the express assent of recipients to the terms of this License.
+This License conditions your rights to undertake the activities listed
+in Section 1, including your right to create Derivative Works based upon
+the Original Work, and doing so without honoring these terms and
+conditions is prohibited by copyright law and international treaty.
+Nothing in this License is intended to affect copyright exceptions and
+limitations (including "fair use" or "fair dealing"). This License shall
+terminate immediately and You may no longer exercise any of the rights
+granted to You by this License upon your failure to honor the conditions
+in Section 1(c).
+
+10) Termination for Patent Action. This License shall terminate
+automatically and You may no longer exercise any of the rights granted
+to You by this License as of the date You commence an action, including
+a cross-claim or counterclaim, against Licensor or any licensee alleging
+that the Original Work infringes a patent. This termination provision
+shall not apply for an action alleging patent infringement by
+combinations of the Original Work with other software or hardware.
+
+11) Jurisdiction, Venue and Governing Law. Any action or suit relating
+to this License may be brought only in the courts of a jurisdiction
+wherein the Licensor resides or in which Licensor conducts its primary
+business, and under the laws of that jurisdiction excluding its
+conflict-of-law provisions. The application of the United Nations
+Convention on Contracts for the International Sale of Goods is expressly
+excluded. Any use of the Original Work outside the scope of this License
+or after its termination shall be subject to the requirements and
+penalties of copyright or patent law in the appropriate jurisdiction.
+This section shall survive the termination of this License.
+
+12) Attorneys' Fees. In any action to enforce the terms of this License
+or seeking damages relating thereto, the prevailing party shall be
+entitled to recover its costs and expenses, including, without
+limitation, reasonable attorneys' fees and costs incurred in connection
+with such action, including any appeal of such action. This section
+shall survive the termination of this License.
+
+13) Miscellaneous. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable.
+
+14) Definition of "You" in This License. "You" throughout this License,
+whether in upper or lower case, means an individual or a legal entity
+exercising rights under, and complying with all of the terms of, this
+License. For legal entities, "You" includes any entity that controls, is
+controlled by, or is under common control with you. For purposes of this
+definition, "control" means (i) the power, direct or indirect, to cause
+the direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+15) Right to Use. You may use the Original Work in all ways not
+otherwise restricted or conditioned by this License or by law, and
+Licensor promises not to interfere with or be responsible for such uses
+by You.
+
+16) Modification of This License. This License is Copyright (c) 2005
+Lawrence Rosen. Permission is granted to copy, distribute, or
+communicate this License without modification. Nothing in this License
+permits You to modify this License as applied to the Original Work or to
+Derivative Works. However, You may modify the text of this License and
+copy, distribute or communicate your modified version (the "Modified
+License") and apply it to other original works of authorship subject to
+the following conditions: (i) You may not indicate in any way that your
+Modified License is the "Academic Free License" or "AFL" and you may not
+use those names in the name of your Modified License; (ii) You must
+replace the notice specified in the first paragraph above with the
+notice "Licensed under <insert your license name here>" or with a notice
+of your own that is not confusingly similar to the notice in this
+License; and (iii) You may not claim that your original works are open
+source software unless your Modified License has been approved by Open
+Source Initiative (OSI) and You comply with its license review and
+certification process.
+

data/README

@@ -0,0 +1,205 @@
+Has_many_polymorphs
+
+An ActiveRecord plugin for self-referential and double-sided polymorphic associations.
+
+== License
+
+Copyright 2006-2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. 
+
+The public certificate for the gem is here[http://blog.evanweaver.com/files/evan_weaver-original-public_cert.pem]. 
+
+If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails.
+
+== Description
+
+This plugin lets you define self-referential and double-sided polymorphic associations in your models. It is an extension of <tt>has_many :through</tt>.
+
+“Polymorphic” means an association can freely point to any of several unrelated model classes, instead of being tied to one particular class.
+
+== Features
+
+* self-references
+* double-sided polymorphism
+* efficient database usage
+* STI support
+* namespace support
+* automatic individual and reverse associations
+
+The plugin also includes a generator for a tagging system, a common use case (see below).
+
+== Requirements
+
+* Rails 2.2.2 or greater
+
+= Usage
+
+== Installation
+
+To install the Rails plugin, run:
+  script/plugin install git://github.com/fauna/has_many_polymorphs.git
+
+There's also a gem version. To install it instead, run: 
+  sudo gem install has_many_polymorphs
+  
+If you are using the gem, make sure to add <tt>require 'has_many_polymorphs'</tt> to <tt>environment.rb</tt>, before Rails::Initializer block.
+
+== Configuration
+
+Setup the parent model as so:
+
+  class Kennel < ActiveRecord::Base
+    has_many_polymorphs :guests, :from => [:dogs, :cats, :birds]
+  end
+
+The join model:
+
+  class GuestsKennel < ActiveRecord::Base
+    belongs_to :kennel
+    belongs_to :guest, :polymorphic => true
+  end
+
+One of the child models:
+
+  class Dog < ActiveRecord::Base
+    # nothing
+  end
+
+For your parent and child models, you don't need any special fields in your migration. For the join model (GuestsKennel), use a migration like so:
+
+  class CreateGuestsKennels < ActiveRecord::Migration
+    def self.up
+      create_table :guests_kennels do |t|
+        t.references :guest, :polymorphic => true
+        t.references :kennel
+      end
+    end
+  
+    def self.down
+      drop_table :guests_kennels
+    end
+  end
+
+See ActiveRecord::Associations::PolymorphicClassMethods for more configuration options.
+
+== Helper methods example
+
+  >> k = Kennel.find(1)
+  #<Kennel id: 1, name: "Happy Paws">
+  >> k.guests.map(&:class) 
+  [Dog, Cat, Cat, Bird]
+  
+  >> k.guests.push(Cat.create); k.cats.size
+  3
+  >> k.guests << Cat.create; k.cats.size
+  4
+  >> k.guests.size
+  6
+
+  >> d = k.dogs.first
+  #<Dog id: 3, name: "Rover">
+  >> d.kennels 
+  [#<Kennel id: 1, name: "Happy Paws">]
+  
+  >> k.guests.delete(d); k.dogs.size
+  0
+  >> k.guests.size
+  5  
+  
+Note that the parent method is always plural, even if there is only one parent (<tt>Dog#kennels</tt>, not <tt>Dog#kennel</tt>).
+
+See ActiveRecord::Associations::PolymorphicAssociation for more helper method details.
+
+= Extras
+
+== Double-sided polymorphism
+
+Double-sided relationships are defined on the join model:
+
+  class Devouring < ActiveRecord::Base
+    belongs_to :guest, :polymorphic => true
+    belongs_to :eaten, :polymorphic => true
+  
+    acts_as_double_polymorphic_join(
+      :guests =>[:dogs, :cats], 
+      :eatens => [:cats, :birds]
+    )       
+  end
+  
+Now, dogs and cats can eat birds and cats. Birds can't eat anything (they aren't <tt>guests</tt>) and dogs can't be eaten by anything (since they aren't <tt>eatens</tt>). The keys stand for what the models are, not what they do. 
+
+In this case, each guest/eaten relationship is called a Devouring.
+
+In your migration, you need to declare both sides as polymorphic:
+
+  class CreateDevourings < ActiveRecord::Migration
+    def self.up
+      create_table :devourings do |t|
+        t.references :guest, :polymorphic => true
+        t.references :eaten, :polymorphic => true
+      end
+    end
+  
+    def self.down
+      drop_table :devourings
+    end
+  end
+
+See ActiveRecord::Associations::PolymorphicClassMethods for more.
+
+== Tagging generator
+
+Has_many_polymorphs includes a tagging system generator. Run:
+  script/generate tagging Dog Cat [...MoreModels...]
+
+This adds a migration and new Tag and Tagging models in <tt>app/models</tt>. It configures Tag with an appropriate <tt>has_many_polymorphs</tt> call against the models you list at the command line. It also adds the file <tt>lib/tagging_extensions.rb</tt> and <tt>requires</tt> it in <tt>environment.rb</tt>. 
+
+Tests will also be generated. 
+
+Once you've run the generator, you can tag records as follows:
+
+  >> d = Dog.create(:name => "Rover")
+  #<Dog id: 3, name: "Rover">
+  >> d.tag_list
+  ""
+  >> d.tag_with "fierce loud"
+  #<Dog id: 3, name: "Rover">
+  >> d.tag_list
+  "fierce loud"
+  >> c = Cat.create(:name => "Chloe")
+  #<Cat id: 1, name: "Chloe">
+  >> c.tag_with "fierce cute"
+  #<Cat id: 1, name: "Chloe">
+  >> c.tag_list
+  "cute fierce"
+  >> Tag.find_by_name("fierce").taggables 
+  [#<Cat id: 1, name: "Chloe">, #<Dog id: 3, name: "Rover">]
+
+The generator accepts the optional flag <tt>--skip-migration</tt> to skip generating a migration (for example, if you are converting from <tt>acts_as_taggable</tt>). It also accepts the flag <tt>--self-referential</tt> if you want to be able to tag tags.
+
+See ActiveRecord::Base::TaggingExtensions, Tag, and Tagging for more.
+
+== Troubleshooting
+
+Some debugging tools are available in <tt>lib/has_many_polymorphs/debugging_tools.rb</tt>.
+
+If you are having trouble, think very carefully about how your model classes, key columns, and table names relate. You may have to explicitly specify options on your join model such as <tt>:class_name</tt>, <tt>:foreign_key</tt>, or <tt>:as</tt>. The included tests are a good place to look for examples.
+
+Note that because of the way Rails reloads model classes, the plugin can sometimes bog down your development server. Set <tt>config.cache_classes = true</tt> in <tt>config/environments/development.rb</tt> to avoid this. 
+
+== Reporting problems
+
+The support forum is here[http://github.com/fauna/has_many_polymorphs/issues].
+
+Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC.
+
+== Further resources
+
+* http://blog.evanweaver.com/articles/2007/08/15/polymorphs-tutorial
+* http://blog.evanweaver.com/articles/2007/02/22/polymorphs-25-total-insanity-branch
+* http://blog.evanweaver.com/articles/2007/02/09/how-to-find-the-most-popular-tags
+* http://blog.evanweaver.com/articles/2007/01/13/growing-up-your-acts_as_taggable
+* http://blog.evanweaver.com/articles/2006/12/02/polymorphs-19
+* http://blog.evanweaver.com/articles/2006/11/05/directed-double-polymorphic-associations
+* http://blog.evanweaver.com/articles/2006/11/04/namespaced-model-support-in-has_many_polymorphs
+* http://blog.evanweaver.com/articles/2006/09/26/sti-support-in-has_many_polymorphs
+* http://blog.evanweaver.com/articles/2006/09/11/make-polymorphic-children-belong-to-only-one-parent