use Rails' base_class

ccutrer · ccutrer · commit 95ecf20e731c · 2014-09-30T21:14:22.000Z
and remove base_ar_class, that does the same thing Change-Id: Id76a2dcc375cfea397ff4b4853f50d660b6b044c Reviewed-on: https://gerrit.instructure.com/41783 Tested-by: Jenkins <jenkins@instructure.com> Reviewed-by: Nick Cloward <ncloward@instructure.com> Product-Review: Cody Cutrer <cody@instructure.com> QA-Review: Cody Cutrer <cody@instructure.com>
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
@@ -266,7 +266,7 @@ def named_context_url(context, name, *opts)
     if context.is_a?(UserProfile)
       name = name.to_s.sub(/context/, "profile")
     else
-      klass = context.class.base_ar_class
+      klass = context.class.base_class
       name = name.to_s.sub(/context/, klass.name.underscore)
       opts.unshift(context)
     end
@@ -1341,7 +1341,7 @@ def safe_domain_file_url(attachment, host_and_shard=nil, verifier = nil, downloa
         opts[:inline] = 1
       end
 
-      if @context && Attachment.relative_context?(@context.class.base_ar_class) && @context == attachment.context
+      if @context && Attachment.relative_context?(@context.class.base_class) && @context == attachment.context
         # so yeah, this is right. :inline=>1 wants :download=>1 to go along with
         # it, so we're setting :download=>1 *because* we want to display inline.
         opts[:download] = 1 unless download
diff --git a/app/controllers/external_tools_controller.rb b/app/controllers/external_tools_controller.rb
@@ -318,7 +318,7 @@ def show
         raise(ActiveRecord::RecordNotFound, "Couldn't find external tool with API id '#{params[:external_tool_id]}'")
       end
     else
-      selection_type = params[:launch_type] || "#{@context.class.base_ar_class.to_s.downcase}_navigation"
+      selection_type = params[:launch_type] || "#{@context.class.base_class.to_s.downcase}_navigation"
       if find_tool(params[:id], selection_type)
 
         @return_url = external_content_success_url('external_tool_redirect')
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
@@ -114,7 +114,7 @@ def full_url(path)
   end
 
   def url_helper_context_from_object(context)
-    (context ? context.class.base_ar_class : context.class).name.underscore
+    (context ? context.class.base_class : context.class).name.underscore
   end
 
   def message_user_path(user, context = nil)
diff --git a/app/messages/announcement_created_by_you.email.erb b/app/messages/announcement_created_by_you.email.erb
@@ -1,5 +1,5 @@
 <% define_content :link do -%>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 <% define_content :subject do -%>
   <%= before_label asset.title %> <%= asset.context.name %>
@@ -10,6 +10,6 @@ You created this Announcement:
 <%= html_to_text(asset.message, :base_url => "#{HostUrl.protocol}://#{HostUrl.context_host(asset.context)}") %>
 
 <% if asset.attachment %><%= before_label :file_included, "File Included" %> <%= asset.attachment.display_name %> - <%= asset.attachment.readable_size %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download<% end %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download<% end %>
 
 <%= content :link %>
diff --git a/app/messages/announcement_created_by_you.email.html.erb b/app/messages/announcement_created_by_you.email.html.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 
 <% define_content :subject do %>
@@ -21,7 +21,7 @@ You created this Announcement:
   <p style="margin: 0px;"><%= t :attached_file, "Attached File" %></p>
   <ul style="padding-left: 20px;">
     <li><%= asset.attachment.display_name %> - <%= asset.attachment.readable_size %>
-        <a href="<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download">[<%= t :download, "download" %>]</a></li>
+        <a href="<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download">[<%= t :download, "download" %>]</a></li>
   </ul>
 </div>
 <% end %>
diff --git a/app/messages/announcement_created_by_you.facebook.erb b/app/messages/announcement_created_by_you.facebook.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 
 <%= t :body, "You created this Announcement: %{title}, %{course}", :title => %{<b><a href="#{ content :link }">#{h asset.title}</a></b>}.html_safe, :course => asset.context.name %>
diff --git a/app/messages/announcement_created_by_you.summary.erb b/app/messages/announcement_created_by_you.summary.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 
 <% define_content :subject do %>
diff --git a/app/messages/announcement_created_by_you.twitter.erb b/app/messages/announcement_created_by_you.twitter.erb
@@ -1,4 +1,4 @@
 <% define_content :link do -%>
-<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end -%>
 <%= t :body, "Canvas Alert - You created this Announcement: %{title}, %{course}.", :title => asset.title, :course => asset.context.name %>
diff --git a/app/messages/collaboration_invitation.email.erb b/app/messages/collaboration_invitation.email.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
 <% end %>
 
 <% define_content :subject do %>
diff --git a/app/messages/collaboration_invitation.email.html.erb b/app/messages/collaboration_invitation.email.html.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
 <% end %>
 
 <% define_content :subject do %>
diff --git a/app/messages/collaboration_invitation.facebook.erb b/app/messages/collaboration_invitation.facebook.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
 <% end %>
 
 <%= t :body, <<-BODY, :document => %{<b><a href="#{content(:link)}">#{h asset.collaboration.title}</a></b>}.html_safe, :course_or_group => asset.collaboration.context.name, :service => asset.collaboration.service_name unless asset.collaboration.user
diff --git a/app/messages/collaboration_invitation.summary.erb b/app/messages/collaboration_invitation.summary.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.collaboration.context) %>/<%= asset.collaboration.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.collaboration.context_id %>/collaborations/<%= asset.collaboration.id %>
 <% end %>
 
 <% define_content :subject do %>
diff --git a/app/messages/new_announcement.email.erb b/app/messages/new_announcement.email.erb
@@ -1,12 +1,12 @@
 <% define_content :link do -%>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 <% define_content :subject do -%>
   <%= before_label asset.title %> <%= asset.context.name %>
 <% end %>
 <%= html_to_text(asset.message, :base_url => "#{HostUrl.protocol}://#{HostUrl.context_host(asset.context)}") %>
 
 <% if asset.attachment %><%= before_label :file_included, "File Included" %> <%= asset.attachment.display_name %> - <%= asset.attachment.readable_size %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download<% end %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download<% end %>
 
 <%= content :link %>
diff --git a/app/messages/new_announcement.email.html.erb b/app/messages/new_announcement.email.html.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 
 <% define_content :subject do %>
@@ -19,7 +19,7 @@
   <p style="margin: 0px;"><%= t :attached_file, "Attached File" %></p>
   <ul style="padding-left: 20px;">
     <li><%= asset.attachment.display_name %> - <%= asset.attachment.readable_size %>
-        <a href="<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download">[<%= t :download, "download" %>]</a></li>
+        <a href="<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/files/<%= asset.attachment_id %>/download">[<%= t :download, "download" %>]</a></li>
   </ul>
 </div>
 <% end %>
diff --git a/app/messages/new_announcement.facebook.erb b/app/messages/new_announcement.facebook.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 
 <%= t :body, "New Announcement: %{title}, %{course}", :title => %{<b><a href="#{ content :link }">#{h asset.title}</a></b>}.html_safe, :course => asset.context.name %>
diff --git a/app/messages/new_announcement.summary.erb b/app/messages/new_announcement.summary.erb
@@ -1,5 +1,5 @@
 <% define_content :link do %>
-  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+  <%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end %>
 
 <% define_content :subject do %>
diff --git a/app/messages/new_announcement.twitter.erb b/app/messages/new_announcement.twitter.erb
@@ -1,4 +1,4 @@
 <% define_content :link do -%>
-<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_ar_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
+<%= HostUrl.protocol %>://<%= HostUrl.context_host(asset.context) %>/<%= asset.context.class.base_class.to_s.downcase.pluralize %>/<%= asset.context_id %>/announcements/<%= asset.id %>
 <% end -%>
 <%= t :body, "Canvas Alert - Announcement: %{title}, %{course}.", :title => asset.title, :course => asset.context.name %>
diff --git a/app/models/appointment_group.rb b/app/models/appointment_group.rb
@@ -325,7 +325,7 @@ def participant_table
   end
 
   def eligible_participant?(participant)
-    return false unless participant && participant.class.base_ar_class.name == participant_type
+    return false unless participant && participant.class.base_class.name == participant_type
     codes = participant.appointment_context_codes
     return false unless (codes[:primary] & appointment_group_contexts.map(&:context_code)).present?
     return false unless sub_context_codes.empty? || (codes[:secondary] & sub_context_codes).present?
diff --git a/app/models/delayed_message.rb b/app/models/delayed_message.rb
@@ -67,7 +67,7 @@ def formatted_summary
     when CommunicationChannel
       where(:communication_channel_id => context)
     else
-      where(:context_id => context, :context_type => context.class.base_ar_class.to_s)
+      where(:context_id => context, :context_type => context.class.base_class.to_s)
     end
   }
   
diff --git a/app/models/message.rb b/app/models/message.rb
@@ -132,7 +132,7 @@ class Message < ActiveRecord::Base
   # Named scopes
   scope :for_asset_context_codes, lambda { |context_codes| where(:asset_context_code => context_codes) }
 
-  scope :for, lambda { |context| where(:context_type => context.class.base_ar_class.to_s, :context_id => context) }
+  scope :for, lambda { |context| where(:context_type => context.class.base_class.to_s, :context_id => context) }
 
   scope :after, lambda { |date| where("messages.created_at>?", date) }
 
diff --git a/app/models/web_conference.rb b/app/models/web_conference.rb
@@ -427,7 +427,7 @@ def self.conference_types
     plugins.map{ |plugin|
       next unless plugin.enabled? &&
           (klass = (plugin.base || "#{plugin.id.classify}Conference").constantize rescue nil) &&
-          klass < self.base_ar_class
+          klass < self.base_class
       plugin.settings.merge(
         :conference_type => plugin.id.classify,
         :class_name => (plugin.base || "#{plugin.id.classify}Conference"),
diff --git a/app/models/wiki_page.rb b/app/models/wiki_page.rb
@@ -262,11 +262,11 @@ def set_as_front_page!
   end
 
   def context_module_tag_for(context)
-    @tag ||= self.context_module_tags.where(context_id: context, context_type: context.class.base_ar_class.name).first
+    @tag ||= self.context_module_tags.where(context_id: context, context_type: context.class.base_class.name).first
   end
 
   def context_module_action(user, context, action)
-    self.context_module_tags.where(context_id: context, context_type: context.class.base_ar_class.name).each do |tag|
+    self.context_module_tags.where(context_id: context, context_type: context.class.base_class.name).each do |tag|
       tag.context_module_action(user, action)
     end
   end
diff --git a/config/initializers/active_record.rb b/config/initializers/active_record.rb
@@ -20,7 +20,7 @@ def serializable_hash(options = nil)
       end
     end
     if options && options[:include_root]
-      result = {self.class.base_ar_class.model_name.element => result}
+      result = {self.class.base_class.model_name.element => result}
     end
     result
   end
@@ -118,7 +118,7 @@ def global_asset_string
 
   # little helper to keep checks concise and avoid a db lookup
   def has_asset?(asset, field = :context)
-    asset.id == send("#{field}_id") && asset.class.base_ar_class.name == send("#{field}_type")
+    asset.id == send("#{field}_id") && asset.class.base_class.name == send("#{field}_type")
   end
 
   def context_string(field = :context)
@@ -254,7 +254,7 @@ def as_json(options = nil)
     hash = serializable_hash(options)
 
     if options[:permissions]
-      obj_hash = options[:include_root] ? hash[self.class.base_ar_class.model_name.element] : hash
+      obj_hash = options[:include_root] ? hash[self.class.base_class.model_name.element] : hash
       if self.respond_to?(:filter_attributes_for_user)
         self.filter_attributes_for_user(obj_hash, options[:permissions][:user], options[:permissions][:session])
       end
@@ -280,12 +280,8 @@ def sanitize_sql(*args)
     self.class.send :sanitize_sql_for_conditions, *args
   end
 
-  def self.base_ar_class
-    class_of_active_record_descendant(self)
-  end
-
   def self.reflection_type_name
-    base_ar_class.name.underscore
+    base_class.name.underscore
   end
 
   def wildcard(*args)
@@ -877,7 +873,7 @@ def polymorphic_where(args)
 
     sql = (["(#{column}_id=? AND #{column}_type=?)"] * values.length).join(" OR ")
     sql << " OR (#{column}_id IS NULL AND #{column}_type IS NULL)" if values.length < original_length
-    where(sql, *values.map { |value| [value, value.class.base_ar_class.name] }.flatten)
+    where(sql, *values.map { |value| [value, value.class.base_class.name] }.flatten)
   end
 end
 
diff --git a/spec/mocha_extensions.rb b/spec/mocha_extensions.rb
@@ -36,7 +36,7 @@ def self.reset_any_instantiation!
 
   def self.add_any_instantiation(ar_obj)
     raise(ArgumentError, "need to save first") if ar_obj.new_record?
-    @@any_instantiation[ [ar_obj.class.base_ar_class, ar_obj.id] ] = ar_obj
+    @@any_instantiation[ [ar_obj.class.base_class, ar_obj.id] ] = ar_obj
     # calling any_instantiation is likely to be because you're stubbing it,
     # and to later be cached inadvertently from code that *thinks* it
     # has a non-stubbed object. So let it dump, but not load (i.e.
@@ -50,7 +50,7 @@ def ar_obj.marshal_dump
   end
 
   def self.instantiate_with_any_instantiation(a)
-    if obj = @@any_instantiation[[base_ar_class, a['id'].to_i]]
+    if obj = @@any_instantiation[[base_class, a['id'].to_i]]
       obj
     else
       instantiate_without_any_instantiation(a)
diff --git a/spec/models/general_model_spec.rb b/spec/models/general_model_spec.rb
@@ -33,16 +33,6 @@ def protect_attributes
 end
 
 describe 'Models' do
-
-  context "config/initializers/active_record.rb" do
-
-    it "should return the first descendant of ActiveRecord::Base when calling base_ar_class" do
-      Account.base_ar_class.should == Account
-      Group.base_ar_class.should == Group
-      TeacherEnrollment.base_ar_class.should == Enrollment
-    end
-  end
-
   it "should use attr_accessible or attr_protected" do
     ignore_classes = [
         ActiveRecord::Base,
