Permalink
Browse files

edit pass: the names of Rails components have a space, ie, "Active Re…

…cord", not "ActiveRecord"
  • Loading branch information...
1 parent b442edb commit f17159b02996ef478fd2376f1c88adf33a1a1b78 @fxn fxn committed Jun 14, 2010
Showing with 48 additions and 48 deletions.
  1. +2 −2 actionmailer/lib/action_mailer/base.rb
  2. +1 −1 actionpack/lib/action_controller.rb
  3. +1 −1 actionpack/lib/action_controller/metal/instrumentation.rb
  4. +3 −3 actionpack/lib/action_view/context.rb
  5. +1 −1 actionpack/lib/action_view/helpers/sanitize_helper.rb
  6. +1 −1 actionpack/lib/action_view/helpers/text_helper.rb
  7. +1 −1 actionpack/test/controller/helper_test.rb
  8. +1 −1 actionpack/test/controller/render_test.rb
  9. +1 −1 activemodel/lib/active_model/lint.rb
  10. +1 −1 activemodel/lib/active_model/naming.rb
  11. +1 −1 activemodel/lib/active_model/validator.rb
  12. +6 −6 activerecord/lib/active_record/association_preload.rb
  13. +2 −2 activerecord/lib/active_record/associations.rb
  14. +6 −6 activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb
  15. +1 −1 activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb
  16. +2 −2 activerecord/lib/active_record/connection_adapters/abstract_adapter.rb
  17. +3 −3 activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb
  18. +1 −1 activerecord/lib/active_record/locale/en.yml
  19. +1 −1 activerecord/test/cases/defaults_test.rb
  20. +1 −1 activeresource/test/cases/base_test.rb
  21. +1 −1 activeresource/test/cases/finder_test.rb
  22. +1 −1 activesupport/lib/active_support/callbacks.rb
  23. +1 −1 activesupport/lib/active_support/xml_mini/rexml.rb
  24. +2 −2 ci/site_config.rb
  25. +1 −1 railties/lib/rails.rb
  26. +1 −1 railties/lib/rails/log_subscriber.rb
  27. +1 −1 railties/lib/rails/log_subscriber/test_helper.rb
  28. +1 −1 railties/lib/rails/railtie.rb
  29. +1 −1 railties/lib/rails/test_unit/testing.rake
  30. +1 −1 railties/test/application/initializers/notifications_test.rb
@@ -209,7 +209,7 @@ module ActionMailer #:nodoc:
#
# <%= image_tag attachments['photo.png'].url -%>
#
- # As we are using ActionView's +image_tag+ method, you can pass in any other options you want:
+ # As we are using Action View's +image_tag+ method, you can pass in any other options you want:
#
# <h1>Please Don't Cringe</h1>
#
@@ -739,7 +739,7 @@ def deprecated_url_options
end
# This module will complain if the user tries to set default_url_options
- # directly instead of through the config object. In ActionMailer's Railtie,
+ # directly instead of through the config object. In Action Mailer's Railtie,
# we include the url_helpers of the router, which will override this module
extend DeprecatedUrlOptions
@@ -67,7 +67,7 @@ module ActionController
require 'action_view'
require 'action_controller/vendor/html-scanner'
-# Common ActiveSupport usage in ActionController
+# Common Active Support usage in Action Controller
require 'active_support/concern'
require 'active_support/core_ext/class/attribute_accessors'
require 'active_support/core_ext/load_error'
@@ -2,7 +2,7 @@
module ActionController
# Adds instrumentation to several ends in ActionController::Base. It also provides
- # some hooks related with process_action, this allows an ORM like ActiveRecord
+ # some hooks related with process_action, this allows an ORM like Active Record
# and/or DataMapper to plug in ActionController and show related information.
#
# Check ActiveRecord::Railties::ControllerRuntime for an example.
@@ -3,8 +3,8 @@ module CompiledTemplates #:nodoc:
# holds compiled template code
end
- # ActionView contexts are supplied to ActionController
- # to render template. The default ActionView context
+ # Action View contexts are supplied to Action Controller
+ # to render template. The default Action View context
# is ActionView::Base.
#
# In order to work with ActionController, a Context
@@ -21,7 +21,7 @@ module CompiledTemplates #:nodoc:
# options<Hash>:: See _render_template_with_layout in ActionView::Base
# partial<Boolean>:: Whether or not the template to render is a partial
#
- # An ActionView context can also mix in ActionView's
+ # An Action View context can also mix in Action View's
# helpers. In order to mix in helpers, a context must
# implement:
#
@@ -4,7 +4,7 @@
module ActionView
module Helpers #:nodoc:
# The SanitizeHelper module provides a set of methods for scrubbing text of undesired HTML elements.
- # These helper methods extend ActionView making them callable within your template files.
+ # These helper methods extend Action View making them callable within your template files.
module SanitizeHelper
# This +sanitize+ helper will html encode all tags and strip all attributes that aren't specifically allowed.
# It also strips href/src tags with invalid protocols, like javascript: especially. It does its best to counter any
@@ -6,7 +6,7 @@ module ActionView
module Helpers #:nodoc:
# The TextHelper module provides a set of methods for filtering, formatting
# and transforming strings, which can reduce the amount of inline Ruby code in
- # your views. These helper methods extend ActionView making them callable
+ # your views. These helper methods extend Action View making them callable
# within your template files.
module TextHelper
# The preferred method of outputting text in your views is to use the
@@ -122,7 +122,7 @@ def test_all_helpers_with_alternate_helper_dir
def test_helper_proxy
methods = AllHelpersController.helpers.methods.map(&:to_s)
- # ActionView
+ # Action View
assert methods.include?('pluralize')
# abc_helper.rb
@@ -275,7 +275,7 @@ def builder_layout_test
render :action => "hello", :layout => "layouts/builder"
end
- # :move: test this in ActionView
+ # :move: test this in Action View
def builder_partial_test
render :action => "hello_world_container"
end
@@ -1,6 +1,6 @@
# == Active Model Lint Tests
#
-# You can test whether an object is compliant with the ActiveModel API by
+# You can test whether an object is compliant with the Active Model API by
# including <tt>ActiveModel::Lint::Tests</tt> in your TestCase. It will include
# tests that tell you whether your object is fully compliant, or if not,
# which aspects of the API are not implemented.
@@ -49,7 +49,7 @@ def human(options={})
# BookCover.model_name.human #=> "Book cover"
#
# Providing the functionality that ActiveModel::Naming provides in your object
- # is required to pass the ActiveModel Lint test. So either extending the provided
+ # is required to pass the Active Model Lint test. So either extending the provided
# method below, or rolling your own is required..
module Naming
# Returns an ActiveModel::Name object for module. It can be
@@ -130,7 +130,7 @@ def validate(record)
# in the options hash invoking the validate_each method passing in the
# record, attribute and value.
#
- # All ActiveModel validations are built on top of this Validator.
+ # All Active Model validations are built on top of this Validator.
class EachValidator < Validator
attr_reader :attributes
@@ -6,7 +6,7 @@ module ActiveRecord
module AssociationPreload #:nodoc:
extend ActiveSupport::Concern
- # Implements the details of eager loading of ActiveRecord associations.
+ # Implements the details of eager loading of Active Record associations.
# Application developers should not use this module directly.
#
# ActiveRecord::Base is extended with this module. The source code in
@@ -18,7 +18,7 @@ module AssociationPreload #:nodoc:
# The first one is by using table joins. This was only strategy available
# prior to Rails 2.1. Suppose that you have an Author model with columns
# 'name' and 'age', and a Book model with columns 'name' and 'sales'. Using
- # this strategy, ActiveRecord would try to retrieve all data for an author
+ # this strategy, Active Record would try to retrieve all data for an author
# and all of its books via a single query:
#
# SELECT * FROM authors
@@ -31,7 +31,7 @@ module AssociationPreload #:nodoc:
# 'books' table is useful; the joined 'authors' data is just redundant, and
# processing this redundant data takes memory and CPU time. The problem
# quickly becomes worse and worse as the level of eager loading increases
- # (i.e. if ActiveRecord is to eager load the associations' associations as
+ # (i.e. if Active Record is to eager load the associations' associations as
# well).
#
# The second strategy is to use multiple database queries, one for each
@@ -45,7 +45,7 @@ module AssociationPreload #:nodoc:
module ClassMethods
protected
- # Eager loads the named associations for the given ActiveRecord record(s).
+ # Eager loads the named associations for the given Active Record record(s).
#
# In this description, 'association name' shall refer to the name passed
# to an association creation method. For example, a model that specifies
@@ -80,7 +80,7 @@ module ClassMethods
# { :author => :avatar }
# [ :books, { :author => :avatar } ]
#
- # +preload_options+ contains options that will be passed to ActiveRecord#find
+ # +preload_options+ contains options that will be passed to ActiveRecord::Base#find
# (which is called under the hood for preloading records). But it is passed
# only one level deep in the +associations+ argument, i.e. it's not passed
# to the child associations when +associations+ is a Hash.
@@ -166,7 +166,7 @@ def set_association_single_records(id_to_record_map, reflection_name, associated
end
end
- # Given a collection of ActiveRecord objects, constructs a Hash which maps
+ # Given a collection of Active Record objects, constructs a Hash which maps
# the objects' IDs to the relevant objects. Returns a 2-tuple
# <tt>(id_to_record_map, ids)</tt> where +id_to_record_map+ is the Hash,
# and +ids+ is an Array of record IDs.
@@ -711,7 +711,7 @@ def association_instance_set(name, association)
#
# The +traps+ association on +Dungeon+ and the the +dungeon+ association on +Trap+ are the inverse of each other and the
# inverse of the +dungeon+ association on +EvilWizard+ is the +evil_wizard+ association on +Dungeon+ (and vice-versa). By default,
- # +ActiveRecord+ doesn't do know anything about these inverse relationships and so no object loading optimisation is possible. For example:
+ # Active Record doesn't know anything about these inverse relationships and so no object loading optimisation is possible. For example:
#
# d = Dungeon.first
# t = d.traps.first
@@ -721,7 +721,7 @@ def association_instance_set(name, association)
#
# The +Dungeon+ instances +d+ and <tt>t.dungeon</tt> in the above example refer to the same object data from the database, but are
# actually different in-memory copies of that data. Specifying the <tt>:inverse_of</tt> option on associations lets you tell
- # +ActiveRecord+ about inverse relationships and it will optimise object loading. For example, if we changed our model definitions to:
+ # Active Record about inverse relationships and it will optimise object loading. For example, if we changed our model definitions to:
#
# class Dungeon < ActiveRecord::Base
# has_many :traps, :inverse_of => :dungeon
@@ -9,7 +9,7 @@ class ConnectionTimeoutError < ConnectionNotEstablished
end
module ConnectionAdapters
- # Connection pool base class for managing ActiveRecord database
+ # Connection pool base class for managing Active Record database
# connections.
#
# == Introduction
@@ -30,12 +30,12 @@ module ConnectionAdapters
# Connections can be obtained and used from a connection pool in several
# ways:
#
- # 1. Simply use ActiveRecord::Base.connection as with ActiveRecord 2.1 and
+ # 1. Simply use ActiveRecord::Base.connection as with Active Record 2.1 and
# earlier (pre-connection-pooling). Eventually, when you're done with
# the connection(s) and wish it to be returned to the pool, you call
# ActiveRecord::Base.clear_active_connections!. This will be the
- # default behavior for ActiveRecord when used in conjunction with
- # ActionPack's request handling cycle.
+ # default behavior for Active Record when used in conjunction with
+ # Action Pack's request handling cycle.
# 2. Manually check out a connection from the pool with
# ActiveRecord::Base.connection_pool.checkout. You are responsible for
# returning this connection to the pool when finished by calling
@@ -265,7 +265,7 @@ def checkout_and_verify(c)
end
# ConnectionHandler is a collection of ConnectionPool objects. It is used
- # for keeping separate connection pools for ActiveRecord models that connect
+ # for keeping separate connection pools for Active Record models that connect
# to different databases.
#
# For example, suppose that you have 5 models, with the following hierarchy:
@@ -285,7 +285,7 @@ def checkout_and_verify(c)
# is not the same as the one used by Book/ScaryBook/GoodBook.
#
# Normally there is only a single ConnectionHandler instance, accessible via
- # ActiveRecord::Base.connection_handler. ActiveRecord models use this to
+ # ActiveRecord::Base.connection_handler. Active Record models use this to
# determine that connection pool that they should use.
class ConnectionHandler
def initialize(pools = {})
@@ -103,7 +103,7 @@ def retrieve_connection
connection_handler.retrieve_connection(self)
end
- # Returns true if +ActiveRecord+ is connected.
+ # Returns true if Active Record is connected.
def connected?
connection_handler.connected?(self)
end
@@ -15,7 +15,7 @@
module ActiveRecord
module ConnectionAdapters # :nodoc:
- # ActiveRecord supports multiple database systems. AbstractAdapter and
+ # Active Record supports multiple database systems. AbstractAdapter and
# related classes form the abstraction layer which makes this possible.
# An AbstractAdapter represents a connection to a database, and provides an
# abstract interface for database-specific functionality such as establishing
@@ -59,7 +59,7 @@ def supports_migrations?
end
# Can this adapter determine the primary key for tables not attached
- # to an ActiveRecord class, such as join tables? Backend specific, as
+ # to an Active Record class, such as join tables? Backend specific, as
# the abstract adapter always returns +false+.
def supports_primary_key?
false
@@ -224,7 +224,7 @@ def active?
if @connection.respond_to?(:status)
@connection.status == PGconn::CONNECTION_OK
else
- # We're asking the driver, not ActiveRecord, so use @connection.query instead of #query
+ # We're asking the driver, not Active Record, so use @connection.query instead of #query
@connection.query 'SELECT 1'
true
end
@@ -258,7 +258,7 @@ def supports_migrations?
true
end
- # Does PostgreSQL support finding primary key on non-ActiveRecord tables?
+ # Does PostgreSQL support finding primary key on non-Active Record tables?
def supports_primary_key? #:nodoc:
true
end
@@ -925,7 +925,7 @@ def configure_connection
# Use standard-conforming strings if available so we don't have to do the E'...' dance.
set_standard_conforming_strings
- # If using ActiveRecord's time zone support configure the connection to return
+ # If using Active Record's time zone support configure the connection to return
# TIMESTAMP WITH ZONE types in UTC.
execute("SET time zone 'UTC'") if ActiveRecord::Base.default_timezone == :utc
end
@@ -4,7 +4,7 @@ en:
#created_at: "Created at"
#updated_at: "Updated at"
- # ActiveRecord models configuration
+ # Active Record models configuration
activerecord:
errors:
messages:
@@ -43,7 +43,7 @@ def test_multiline_default_text
class DefaultsTestWithoutTransactionalFixtures < ActiveRecord::TestCase
# ActiveRecord::Base#create! (and #save and other related methods) will
# open a new transaction. When in transactional fixtures mode, this will
- # cause ActiveRecord to create a new savepoint. However, since MySQL doesn't
+ # cause Active Record to create a new savepoint. However, since MySQL doesn't
# support DDL transactions, creating a table will result in any created
# savepoints to be automatically released. This in turn causes the savepoint
# release code in AbstractAdapter#transaction to fail.
@@ -52,7 +52,7 @@ def setup
:children => [{:name => 'Natacha'}]},
{:name => 'Milena',
:children => []}]}]}.to_xml(:root => 'customer')
- # - resource with yaml array of strings; for ActiveRecords using serialize :bar, Array
+ # - resource with yaml array of strings; for ARs using serialize :bar, Array
@marty = <<-eof.strip
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<person>
@@ -50,7 +50,7 @@ def setup
:children => [{:name => 'Natacha'}]},
{:name => 'Milena',
:children => []}]}]}.to_xml(:root => 'customer')
- # - resource with yaml array of strings; for ActiveRecords using serialize :bar, Array
+ # - resource with yaml array of strings; for ARs using serialize :bar, Array
@marty = <<-eof.strip
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<person>
@@ -445,7 +445,7 @@ def __update_callbacks(name, filters = [], block = nil) #:nodoc:
# Use skip_callback to skip any defined one.
#
# When creating or skipping callbacks, you can specify conditions that
- # are always the same for a given key. For instance, in ActionPack,
+ # are always the same for a given key. For instance, in Action Pack,
# we convert :only and :except conditions into per-key conditions.
#
# before_filter :authenticate, :except => "index"
@@ -11,7 +11,7 @@ module XmlMini_REXML #:nodoc:
# Parse an XML Document string or IO into a simple hash
#
# Same as XmlSimple::xml_in but doesn't shoot itself in the foot,
- # and uses the defaults from ActiveSupport
+ # and uses the defaults from Active Support.
#
# data::
# XML Document string or IO to parse
View
@@ -6,8 +6,8 @@
# EMAIL NOTIFICATION
# ------------------
-# CruiseControl.rb can notify you about build status via email. It uses ActionMailer component of Ruby on Rails
-# framework. Obviously, ActionMailer needs to know how to send out email messages.
+# CruiseControl.rb can notify you about build status via email. It uses the Action Mailer component of Ruby on Rails
+# framework. Obviously, Action Mailer needs to know how to send out email messages.
# If you have an SMTP server on your network, and it needs no authentication, write this in your site_config.rb:
#
ActionMailer::Base.smtp_settings = {
@@ -67,7 +67,7 @@ def logger=(logger)
def backtrace_cleaner
@@backtrace_cleaner ||= begin
- # Relies on ActiveSupport, so we have to lazy load to postpone definition until AS has been loaded
+ # Relies on Active Support, so we have to lazy load to postpone definition until AS has been loaded
require 'rails/backtrace_cleaner'
Rails::BacktraceCleaner.new
end
@@ -6,7 +6,7 @@ module Rails
# on initialization with solely purpose of logging. The log subscriber dispatches
# notifications to a regirested object based on its given namespace.
#
- # An example would be ActiveRecord log subscriber responsible for logging queries:
+ # An example would be Active Record log subscriber responsible for logging queries:
#
# module ActiveRecord
# class Railtie
@@ -3,7 +3,7 @@
module Rails
class LogSubscriber
# Provides some helpers to deal with testing log subscribers by setting up
- # notifications. Take for instance ActiveRecord subscriber tests:
+ # notifications. Take for instance Active Record subscriber tests:
#
# class SyncLogSubscriberTest < ActiveSupport::TestCase
# include Rails::LogSubscriber::TestHelper
@@ -10,7 +10,7 @@ module Rails
# Every major component of Rails (Action Mailer, Action Controller,
# Action View, Active Record and Active Resource) are all Railties, so each of
# them is responsible to set their own initialization. This makes, for example,
- # Rails absent of any ActiveRecord hook, allowing any other ORM framework to hook in.
+ # Rails absent of any Active Record hook, allowing any other ORM framework to hook in.
#
# Developing a Rails extension does _not_ require any implementation of
# Railtie, but if you need to interact with the Rails framework during
@@ -58,7 +58,7 @@ def recent_tests(source_pattern, test_path, touched_since = 10.minutes.ago)
end
-# Recreated here from ActiveSupport because :uncommitted needs it before Rails is available
+# Recreated here from Active Support because :uncommitted needs it before Rails is available
module Kernel
def silence_stderr
old_stderr = STDERR.dup
Oops, something went wrong.

11 comments on commit f17159b

@spovich

probably not worth arguing about, but I don't see the value of this change. This just introduces ambiguity.

@jeremy
Member
jeremy commented on f17159b Jun 16, 2010

It removes ambiguity: proper names have spaces; Ruby module names do not.

@christos
Contributor

I agree with spovich.

And I am worried that google search results for Active(space)Something will not be as relevant as searching for ActiveSomething

@fxn
Member
fxn commented on f17159b Jun 16, 2010

When docrails was born we wrote the API conventions and
since there was little consistency in books we checked with David. David confirmed the proper names of Rails components have a space.

Normalizing that was part of some mass-editions we did in the entire API a couple of years ago.

This particular commit is just a maintenance edit to ensure the last wave follows the API conventions.

@fxn
Member
fxn commented on f17159b Jun 16, 2010

Guys, the full API already uses spaces, it's been consistently using spaces for two years (and it didn't before because nobody was copy-editing the API). Active Record is a Rails component, ActiveRecord is a Ruby module, it is just the way their creator named them.

The API conventions are here by the way: http://wiki.github.com/lifo/docrails/rails-api-documentation-conventions

@spovich

ok. I thought the ruby module name was the proper name. The audience here is programmers, not end users. I agree with christos about search results, but it sounds like this was decided long ago. Thanks.

@fxn
Member
fxn commented on f17159b Jun 16, 2010

@spovich yeah no problem, a lot of people write the names without spaces indeed. It has traditionally lacked consistency out there. My only hope is that by osmosis more and more people are aware of this when time passes.

You know, when someone gives a name to something that has to be respected. Knuth wants TeX to be written exactly like that in ASCII, and there's nothing to argue about it, people just respect his choice for his creation and write TeX.

@justinko
Contributor

This is purely a case of branding. "ActiveRecord" is the symbol we all know.

@fxn
Member
fxn commented on f17159b Jun 17, 2010

@justinko that's just not true.

First of all, let me stress that this commit is not introducing any new convention, Active Record has been the name of the ORM always. This commit is only copy-editing.

You can go to an internet forum of cars, and read "Bmw", "bmw" and what not. But you won't see any official anything from BMW where the name of the brand does not follow that exact spelling.

You will read "Javascript", and "javascript", but a book on JavaScript will be very careful on getting the "S" right. The Perl language has a single spelling: "Perl", no "PERL", no "perl". It is a sign of respect to write it correctly in the community.

Sometimes people just do not take into account these fine details, while other do. It doesn't matter. This is the official API, and this is the place where things are named correctly, same for David's presentations, Rails Guides, AWDwR, etc.

Some people when they realize they didn't know the actual spelling just go and say "ah! will try to remember for my next slides". It is not that much complicated!

@christos
Contributor

@fxn Wasn't aware that the correct spelling for Active Wadus was with a space. Had I reviewed the commit in detail, I would have realised that EVERYWHERE else in the docs the space already existed.

My objection was a moot one anyway, as it would seem that Google is intelligent enough to mostly ignore the space (or lack of).

Thanks for taking the time to clarify this.

(..and belated congratulations for your Hero award)

@fxn
Member
fxn commented on f17159b Jun 17, 2010

@christos excellent, and thank you! :)

Please sign in to comment.