Rename Friend model to Friendship
authorAndy Allan <git@gravitystorm.co.uk>
Wed, 19 Jun 2019 14:39:25 +0000 (16:39 +0200)
committerAndy Allan <git@gravitystorm.co.uk>
Wed, 19 Jun 2019 14:39:25 +0000 (16:39 +0200)
This better describes what the model represents, which is the relationship
between the two users.

app/controllers/users_controller.rb
app/models/friendship.rb [moved from app/models/friend.rb with 89% similarity]
app/models/user.rb
app/views/users/show.html.erb
test/controllers/changesets_controller_test.rb
test/controllers/diary_entries_controller_test.rb
test/controllers/users_controller_test.rb
test/factories/friendships.rb [moved from test/factories/friends.rb with 83% similarity]
test/models/user_test.rb

index e41330c..d8e8f6d 100644 (file)
@@ -388,16 +388,16 @@ class UsersController < ApplicationController
 
     if @new_friend
       if request.post?
-        friend = Friend.new
-        friend.befriender = current_user
-        friend.befriendee = @new_friend
+        friendship = Friendship.new
+        friendship.befriender = current_user
+        friendship.befriendee = @new_friend
         if current_user.is_friends_with?(@new_friend)
           flash[:warning] = t "users.make_friend.already_a_friend", :name => @new_friend.display_name
-        elsif friend.save
+        elsif friendship.save
           flash[:notice] = t "users.make_friend.success", :name => @new_friend.display_name
-          Notifier.friend_notification(friend).deliver_later
+          Notifier.friend_notification(friendship).deliver_later
         else
-          friend.add_error(t("users.make_friend.failed", :name => @new_friend.display_name))
+          friendship.add_error(t("users.make_friend.failed", :name => @new_friend.display_name))
         end
 
         if params[:referer]
@@ -417,7 +417,7 @@ class UsersController < ApplicationController
     if @friend
       if request.post?
         if current_user.is_friends_with?(@friend)
-          Friend.where(:user_id => current_user.id, :friend_user_id => @friend.id).delete_all
+          Friendship.where(:user_id => current_user.id, :friend_user_id => @friend.id).delete_all
           flash[:notice] = t "users.remove_friend.success", :name => @friend.display_name
         else
           flash[:error] = t "users.remove_friend.not_a_friend", :name => @friend.display_name
similarity index 89%
rename from app/models/friend.rb
rename to app/models/friendship.rb
index 615da10..27b25ae 100644 (file)
@@ -17,7 +17,9 @@
 #  friends_user_id_fkey         (user_id => users.id)
 #
 
-class Friend < ActiveRecord::Base
+class Friendship < ActiveRecord::Base
+  self.table_name = "friends"
+
   belongs_to :befriender, :class_name => "User", :foreign_key => :user_id
   belongs_to :befriendee, :class_name => "User", :foreign_key => :friend_user_id
 end
index 2979b13..36c98ed 100644 (file)
@@ -57,8 +57,8 @@ class User < ActiveRecord::Base
   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
-  has_many :friends, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
-  has_many :friend_users, :through => :friends, :source => :befriendee
+  has_many :friendships, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
+  has_many :friend_users, :through => :friendships, :source => :befriendee
   has_many :tokens, :class_name => "UserToken"
   has_many :preferences, :class_name => "UserPreference"
   has_many :changesets, -> { order(:created_at => :desc) }
@@ -224,7 +224,7 @@ class User < ActiveRecord::Base
   end
 
   def is_friends_with?(new_friend)
-    friends.where(:friend_user_id => new_friend.id).exists?
+    friendships.where(:friend_user_id => new_friend.id).exists?
   end
 
   ##
index 87eb9b4..b9266c8 100644 (file)
       <%= content_tag "div", "", :id => "map", :class => "content_map", :data => { :user => user_data } %>
     <% end %>
 
-    <% friends = @user.friends.collect(&:befriendee) %>
+    <% friends = @user.friend_users %>
     <% nearby = @user.nearby - friends %>
 
   <div class="activity-block column-1">
index fad7a97..4501997 100644 (file)
@@ -130,8 +130,8 @@ class ChangesetsControllerTest < ActionController::TestCase
   # Checks the display of the friends changesets listing
   def test_index_friends
     private_user = create(:user, :data_public => true)
-    friend = create(:friend, :befriender => private_user)
-    create(:changeset, :user => friend.befriendee)
+    friendship = create(:friendship, :befriender => private_user)
+    create(:changeset, :user => friendship.befriendee)
 
     get :index, :params => { :friends => true }
     assert_response :redirect
index fd03758..8414e18 100644 (file)
@@ -528,8 +528,8 @@ class DiaryEntriesControllerTest < ActionController::TestCase
   def test_index_friends
     user = create(:user)
     other_user = create(:user)
-    friend = create(:friend, :befriender => user)
-    diary_entry = create(:diary_entry, :user => friend.befriendee)
+    friendship = create(:friendship, :befriender => user)
+    diary_entry = create(:diary_entry, :user => friendship.befriendee)
     _other_entry = create(:diary_entry, :user => other_user)
 
     # Try a list of diary entries for your friends when not logged in
index 5dbd866..9b7e040 100644 (file)
@@ -988,7 +988,7 @@ class UsersControllerTest < ActionController::TestCase
     # Test a normal user
     user = create(:user, :home_lon => 1.1, :home_lat => 1.1)
     friend_user = create(:user, :home_lon => 1.2, :home_lat => 1.2)
-    create(:friend, :befriender => user, :befriendee => friend_user)
+    create(:friendship, :befriender => user, :befriendee => friend_user)
     create(:changeset, :user => friend_user)
 
     get :show, :params => { :display_name => user.display_name }
@@ -1113,7 +1113,7 @@ class UsersControllerTest < ActionController::TestCase
     friend = create(:user)
 
     # Check that the users aren't already friends
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When not logged in a GET should ask us to login
     get :make_friend, :params => { :display_name => friend.display_name }
@@ -1122,7 +1122,7 @@ class UsersControllerTest < ActionController::TestCase
     # When not logged in a POST should error
     post :make_friend, :params => { :display_name => friend.display_name }
     assert_response :forbidden
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When logged in a GET should get a confirmation page
     get :make_friend, :params => { :display_name => friend.display_name }, :session => { :user => user }
@@ -1132,7 +1132,7 @@ class UsersControllerTest < ActionController::TestCase
       assert_select "input[type='hidden'][name='referer']", 0
       assert_select "input[type='submit']", 1
     end
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When logged in a POST should add the friendship
     assert_difference "ActionMailer::Base.deliveries.size", 1 do
@@ -1142,7 +1142,7 @@ class UsersControllerTest < ActionController::TestCase
     end
     assert_redirected_to user_path(friend)
     assert_match(/is now your friend/, flash[:notice])
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
     email = ActionMailer::Base.deliveries.first
     assert_equal 1, email.to.count
     assert_equal friend.email, email.to.first
@@ -1156,7 +1156,7 @@ class UsersControllerTest < ActionController::TestCase
     end
     assert_redirected_to user_path(friend)
     assert_match(/You are already friends with/, flash[:warning])
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
   end
 
   def test_make_friend_with_referer
@@ -1165,7 +1165,7 @@ class UsersControllerTest < ActionController::TestCase
     friend = create(:user)
 
     # Check that the users aren't already friends
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # The GET should preserve any referer
     get :make_friend, :params => { :display_name => friend.display_name, :referer => "/test" }, :session => { :user => user }
@@ -1175,7 +1175,7 @@ class UsersControllerTest < ActionController::TestCase
       assert_select "input[type='hidden'][name='referer'][value='/test']", 1
       assert_select "input[type='submit']", 1
     end
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When logged in a POST should add the friendship and refer us
     assert_difference "ActionMailer::Base.deliveries.size", 1 do
@@ -1185,7 +1185,7 @@ class UsersControllerTest < ActionController::TestCase
     end
     assert_redirected_to "/test"
     assert_match(/is now your friend/, flash[:notice])
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
     email = ActionMailer::Base.deliveries.first
     assert_equal 1, email.to.count
     assert_equal friend.email, email.to.first
@@ -1203,10 +1203,10 @@ class UsersControllerTest < ActionController::TestCase
     # Get users to work with
     user = create(:user)
     friend = create(:user)
-    create(:friend, :befriender => user, :befriendee => friend)
+    create(:friendship, :befriender => user, :befriendee => friend)
 
     # Check that the users are friends
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When not logged in a GET should ask us to login
     get :remove_friend, :params => { :display_name => friend.display_name }
@@ -1215,7 +1215,7 @@ class UsersControllerTest < ActionController::TestCase
     # When not logged in a POST should error
     post :remove_friend, :params => { :display_name => friend.display_name }
     assert_response :forbidden
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When logged in a GET should get a confirmation page
     get :remove_friend, :params => { :display_name => friend.display_name }, :session => { :user => user }
@@ -1225,29 +1225,29 @@ class UsersControllerTest < ActionController::TestCase
       assert_select "input[type='hidden'][name='referer']", 0
       assert_select "input[type='submit']", 1
     end
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When logged in a POST should remove the friendship
     post :remove_friend, :params => { :display_name => friend.display_name }, :session => { :user => user }
     assert_redirected_to user_path(friend)
     assert_match(/was removed from your friends/, flash[:notice])
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # A second POST should report that the friendship does not exist
     post :remove_friend, :params => { :display_name => friend.display_name }, :session => { :user => user }
     assert_redirected_to user_path(friend)
     assert_match(/is not one of your friends/, flash[:error])
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
   end
 
   def test_remove_friend_with_referer
     # Get users to work with
     user = create(:user)
     friend = create(:user)
-    create(:friend, :user_id => user.id, :friend_user_id => friend.id)
+    create(:friendship, :user_id => user.id, :friend_user_id => friend.id)
 
     # Check that the users are friends
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # The GET should preserve any referer
     get :remove_friend, :params => { :display_name => friend.display_name, :referer => "/test" }, :session => { :user => user }
@@ -1257,13 +1257,13 @@ class UsersControllerTest < ActionController::TestCase
       assert_select "input[type='hidden'][name='referer'][value='/test']", 1
       assert_select "input[type='submit']", 1
     end
-    assert Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
 
     # When logged in a POST should remove the friendship and refer
     post :remove_friend, :params => { :display_name => friend.display_name, :referer => "/test" }, :session => { :user => user }
     assert_redirected_to "/test"
     assert_match(/was removed from your friends/, flash[:notice])
-    assert_nil Friend.where(:user_id => user.id, :friend_user_id => friend.id).first
+    assert_nil Friendship.where(:user_id => user.id, :friend_user_id => friend.id).first
   end
 
   def test_remove_friend_unkown_user
similarity index 83%
rename from test/factories/friends.rb
rename to test/factories/friendships.rb
index 15317ee..4879373 100644 (file)
@@ -1,5 +1,5 @@
 FactoryBot.define do
-  factory :friend do
+  factory :friendship do
     association :befriender, :factory => :user
     association :befriendee, :factory => :user
   end
index a17c30d..42ea9a8 100644 (file)
@@ -105,7 +105,7 @@ class UserTest < ActiveSupport::TestCase
     alice = create(:user, :active)
     bob = create(:user, :active)
     charlie = create(:user, :active)
-    create(:friend, :befriender => alice, :befriendee => bob)
+    create(:friendship, :befriender => alice, :befriendee => bob)
 
     assert alice.is_friends_with?(bob)
     assert_not alice.is_friends_with?(charlie)
@@ -139,7 +139,7 @@ class UserTest < ActiveSupport::TestCase
   def test_friend_users
     norm = create(:user, :active)
     sec = create(:user, :active)
-    create(:friend, :befriender => norm, :befriendee => sec)
+    create(:friendship, :befriender => norm, :befriendee => sec)
 
     assert_equal [sec], norm.friend_users
     assert_equal 1, norm.friend_users.size