Ticket #8899: doc_grammar_fixes_for_associations.diff

activerecord/lib/active_record/associations/association_proxy.rb

@@ -143 +143 @@
-        end
-
-        # Can be overwritten by associations that might have the foreign key available for an association without
-
+s
-        def foreign_key_present
-          false
-        end

activerecord/lib/active_record/associations/association_collection.rb

@@ -65 +65 @@
-
-      # Removes all records from this association.  Returns +self+ so method calls may be chained.
-      def clear
-
+it 
-
-        if @reflection.options[:dependent] && @reflection.options[:dependent] == :delete_all
-          destroy_all

activerecord/lib/active_record/associations/has_and_belongs_to_many_association.rb

@@ -14 +14 @@
-      end
-
-      def create(attributes = {})
-sinc
+becaus
-        if attributes.is_a?(Array)
-          attributes.collect { |attr| create(attr) }
-        else
@@ -136 +136 @@
-        end
-
-        # Join tables with additional columns on top of the two foreign keys must be considered ambigious unless a select
-say
-d id column, which
+for example
+ id column. This
-        def finding_with_ambigious_select?(select_clause)
-          !select_clause && @owner.connection.columns(@reflection.options[:join_table], "Join Table Columns").size != 2
-        end

activerecord/lib/active_record/associations/has_one_association.rb

@@ -76 +76 @@
-        end
-
-        def new_record(replace_existing)
-m
+M
-          # instance. Otherwise, if the target has not previously been loaded
-          # elsewhere, the instance we create will get orphaned.
-          load_target if replace_existing

activerecord/lib/active_record/associations/has_many_through_association.rb

@@ -67 +67 @@
-
-      [:push, :concat].each { |method| alias_method method, :<< }
-
-
+s
-      def delete(*records)
-        records = flatten_deeper(records)
-        records.each { |associate| raise_on_type_mismatch(associate) }

activerecord/lib/active_record/associations.rb

@@ -208 +208 @@
-    #
-    # == Is it a belongs_to or has_one association?
-    #
-, t
-saying belongs_to
+. T
+declaring the belongs_to relationship
-    #
-    #   class User < ActiveRecord::Base
-    #     # I reference an account.
@@ -262 +262 @@
-    # === Association callbacks
-    #
-    # Similiar to the normal callbacks that hook into the lifecycle of an Active Record object, you can also define callbacks that get
-ing an object from a
+e an object from an
-    #
-    #   class Project
-    #     has_and_belongs_to_many :developers, :after_add => :evaluate_velocity
@@ -281 +281 @@
-    # Possible callbacks are: before_add, after_add, before_remove and after_remove.
-    #
-    # Should any of the before_add callbacks throw an exception, the object does not get added to the collection. Same with
-,
+;
-    #
-    # === Association extensions
-    #
-s
+
-    # beneficial for adding new finders, creators, and other factory-type methods that are only used as part of this association.
-    # Example:
-    #
@@ -566 +566 @@
-    #
-    # == Options
-    #
- which makes more complex cases
+. This makes cases more complex
-    # possible.
-    module ClassMethods
-.
+:
-      # +collection+ is replaced with the symbol passed as the first argument, so 
-      # <tt>has_many :clients</tt> would add among others <tt>clients.empty?</tt>.
-      # * <tt>collection(force_reload = false)</tt> - returns an array of all the associated objects.
@@ -578 +578 @@
-      # * <tt>collection.delete(object, ...)</tt> - removes one or more objects from the collection by setting their foreign keys to NULL.  
-      #   This will also destroy the objects if they're declared as belongs_to and dependent on this model.
-      # * <tt>collection=objects</tt> - replaces the collections content by deleting and adding objects as appropriate.
-
+'
-      # * <tt>collection_singular_ids=ids</tt> - replace the collection by the objects identified by the primary keys in +ids+
-      # * <tt>collection.clear</tt> - removes every object from the collection. This destroys the associated objects if they
-      #   are associated with <tt>:dependent => :destroy</tt>, deletes them directly from the database if <tt>:dependent => :delete_all</tt>,
-and sets their foreign keys to NULL otherwise
+or otherwise sets their foreign keys to NULL
-      # * <tt>collection.empty?</tt> - returns true if there are no associated objects.
-      # * <tt>collection.size</tt> - returns the number of associated objects.
-      # * <tt>collection.find</tt> - finds an associated object according to the same rules as Base.find.
-      # * <tt>collection.build(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
-
+,
-      #   associated object already exists, not if it's nil!
-      # * <tt>collection.create(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
- and linked to this object through a foreign key
+, linked to this object through a foreign key,
-      #   *Note:* This only works if an associated object already exists, not if it's nil!
-      #
-      # Example: A Firm class declares <tt>has_many :clients</tt>, which will add:
@@ -613 +613 @@
-      #   from the association name. So <tt>has_many :products</tt> will by default be linked to the +Product+ class, but
-      #   if the real class name is +SpecialProduct+, you'll have to specify it with this option.
-      # * <tt>:conditions</tt>  - specify the conditions that the associated objects must meet in order to be included as a "WHERE"
-sql
-sql
+SQL
+SQL
-      #   such as "last_name, first_name DESC"
-sql
+SQL
-      #   such as "category"      
-      # * <tt>:foreign_key</tt> - 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 has_many association will use "person_id"
@@ -636 +636 @@
-      #   associations that depend on multiple tables. Note: When this option is used, +find_in_collection+ is _not_ added.
-      # * <tt>:counter_sql</tt>  - specify a complete SQL statement to fetch the size of the association. If +:finder_sql+ is
-      #   specified but +:counter_sql+, +:counter_sql+ will be generated by replacing SELECT ... FROM with SELECT COUNT(*) FROM.
-, s
+. S
-      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when the collection is loaded.
-GROUP BY
+"GROUP BY"
-      # * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
-      # * <tt>:offset</tt>: An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
-      # * <tt>:select</tt>: By default, this is * as in SELECT * FROM, but can be changed if you for example want to do a join, but not
@@ -684 +684 @@
-        add_deprecated_api_for_has_many(reflection.name)
-      end
-
-.
+:
-      # +association+ is replaced with the symbol passed as the first argument, so 
-      # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.
-      # * <tt>association(force_reload = false)</tt> - returns the associated object. Nil is returned if none is found.
@@ -692 +692 @@
-      #   and saves the associate object.
-      # * <tt>association.nil?</tt> - returns true if there is no associated object.
-      # * <tt>build_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
-
+,
-      #   an association already exists. It will NOT work if the association is nil.
-      # * <tt>create_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
- and linked to this object through a foreign key
+, linked to this object through a foreign key,
-      #
-      # Example: An Account class declares <tt>has_one :beneficiary</tt>, which will add:
-      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
@@ -711 +711 @@
-      #   from the association name. So <tt>has_one :manager</tt> will by default be linked to the +Manager+ class, but
-      #   if the real class name is +Person+, you'll have to specify it with this option.
-      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a "WHERE"
-sql
+SQL
-      # * <tt>:order</tt>       - specify the order from which the associated object will be picked at the top. Specified as
-sql
+SQL
-      # * <tt>:dependent</tt>   - if set to :destroy (or true) the associated object is destroyed when this object is. If set to
-      #   :delete the associated object is deleted *without* calling its destroy method. If set to :nullify the associated
-      #   object's foreign key is set to NULL. Also, association is assigned.
@@ -753 +753 @@
-        deprecated_association_comparison_method(reflection.name, reflection.class_name)
-      end
-
-that this object holds an id to.
+for which this object holds an id:
-      # +association+ is replaced with the symbol passed as the first argument, so 
-      # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.
-      # * <tt>association(force_reload = false)</tt> - returns the associated object. Nil is returned if none is found.
-      # * <tt>association=(associate)</tt> - assigns the associate object, extracts the primary key, and sets it as the foreign key.
-      # * <tt>association.nil?</tt> - returns true if there is no associated object.
-      # * <tt>build_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
-
+,
-      # * <tt>create_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
- and linked to this object through a foreign key
+, linked to this object through a foreign key,
-      #
-      # Example: A Post class declares <tt>belongs_to :author</tt>, which will add:
-      # * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)
@@ -778 +778 @@
-      #   from the association name. So <tt>has_one :author</tt> will by default be linked to the +Author+ class, but
-      #   if the real class name is +Person+, you'll have to specify it with this option.
-      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a "WHERE"
-sql
+SQL
-      # * <tt>:order</tt>       - specify the order from which the associated object will be picked at the top. Specified as
-sql
+SQL
-      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
-      #   of the associated class in lower-case and "_id" suffixed. So a +Person+ class that makes a belongs_to association to a
-      #   +Boss+ class will use "boss_id" as the default foreign_key.
-      # * <tt>:counter_cache</tt> - caches the number of belonging objects on the associate class through use of increment_counter 
-      #   and decrement_counter. The counter cache is incremented when an object of this class is created and decremented when it's
-      #   destroyed. This requires that a column named "#{table_name}_count" (such as comments_count for a belonging Comment class)
-given that
-
+providing 
+a column 
-      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when this object is loaded.
-      # * <tt>:polymorphic</tt> - specify this association is a polymorphic association by passing true.
-      #
@@ -883 +883 @@
-      # ReadOnly (because we can't save changes to the additional attrbutes). It's strongly recommended that you upgrade any
-      # associations with attributes to a real join model (see introduction).
-      #
-.
+:
-      # +collection+ is replaced with the symbol passed as the first argument, so 
-      # <tt>has_and_belongs_to_many :categories</tt> would add among others <tt>categories.empty?</tt>.
-      # * <tt>collection(force_reload = false)</tt> - returns an array of all the associated objects.
@@ -897 +897 @@
-      # * <tt>collection.delete(object, ...)</tt> - removes one or more objects from the collection by removing their associations from the join table.  
-      #   This does not destroy the objects.
-      # * <tt>collection=objects</tt> - replaces the collections content by deleting and adding objects as appropriate.
-
+'
-      # * <tt>collection_singular_ids=ids</tt> - replace the collection by the objects identified by the primary keys in +ids+
-      # * <tt>collection.clear</tt> - removes every object from the collection. This does not destroy the objects.
-      # * <tt>collection.empty?</tt> - returns true if there are no associated objects.
@@ -905 +905 @@
-      # * <tt>collection.find(id)</tt> - finds an associated object responding to the +id+ and that
-      #   meets the condition that it has to be associated with this object.
-      # * <tt>collection.build(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
-
+,
-      # * <tt>collection.create(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
- and linked to this object through the join table
+, linked to this object through the join table,
-      #
-      # Example: An Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
-      # * <tt>Developer#projects</tt>
@@ -938 +938 @@
-      #   guessed to be the name of the associated class in lower-case and "_id" suffixed. So if the associated class is +Project+,
-      #   the has_and_belongs_to_many association will use "project_id" as the default association foreign_key.
-      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a "WHERE"
-sql
-sql
+SQL
+SQL
-      # * <tt>:uniq</tt> - if set to true, duplicate associated objects will be ignored by accessors and query methods
-used to fetch the association with a manual one
-
-one
-
-one
+statement used to fetch the association with a manual statement
+statement 
+statement
+statement 
+statement
-      # * <tt>:extend</tt>  - anonymous module for extending the proxy, see "Association extensions".
-      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when the collection is loaded.
-GROUP BY
+"GROUP BY"
-      # * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
-      # * <tt>:offset</tt>: An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
-      # * <tt>:select</tt>: By default, this is * as in SELECT * FROM, but can be changed if you for example want to do a join, but not