Refactor friendships controller and model

Author: nertc

app/abilities/ability.rb

@@ -42,7 +42,7 @@ def initialize(user)
         can [:create, :subscribe, :unsubscribe], DiaryEntry
         can :update, DiaryEntry, :user => user
         can [:create], DiaryComment
-        can [:make_friend, :remove_friend], Friendship
+        can [:index, :create, :destroy], Follow
         can [:create, :reply, :show, :inbox, :outbox, :muted, :mark, :unmute, :destroy], Message
         can [:close, :reopen], Note
         can [:show, :update], :preference

app/controllers/changesets_controller.rb

@@ -55,7 +55,7 @@ def index
       elsif @params[:bbox]
         changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params))
       elsif @params[:friends] && current_user
-        changesets = changesets.where(:user => current_user.friends.identifiable)
+        changesets = changesets.where(:user => current_user.followings.identifiable)
       elsif @params[:nearby] && current_user
         changesets = changesets.where(:user => current_user.nearby)
       end

app/controllers/diary_entries_controller.rb

@@ -29,7 +29,7 @@ def index
     elsif params[:friends]
       if current_user
         @title = t ".title_followed"
-        entries = DiaryEntry.where(:user => current_user.friends)
+        entries = DiaryEntry.where(:user => current_user.followings)
       else
         require_user
         return

app/controllers/follows_controller.rb

@@ -0,0 +1,61 @@
+class FollowsController < ApplicationController
+  include UserMethods
+
+  layout "site"
+
+  before_action :authorize_web
+  before_action :set_locale
+  before_action :check_database_readable
+
+  authorize_resource
+
+  before_action :check_database_writable, :only => [:create, :destroy, :index]
+  before_action :lookup_friend, :only => [:create, :destroy, :index]
+
+  def index
+    @already_follows = current_user.friends_with?(@friend)
+  end
+
+  def create
+    follow = Follow.new
+    follow.befriender = current_user
+    follow.befriendee = @friend
+    if current_user.friends_with?(@friend)
+      flash[:warning] = t ".already_followed", :name => @friend.display_name
+    elsif current_user.follows.where(:created_at => Time.now.utc - 1.hour..).count >= current_user.max_friends_per_hour
+      flash[:error] = t ".limit_exceeded"
+    elsif follow.save
+      flash[:notice] = t ".success", :name => @friend.display_name
+      UserMailer.friendship_notification(follow).deliver_later
+    else
+      follow.add_error(t(".failed", :name => @friend.display_name))
+    end
+
+    referer = safe_referer(params[:referer]) if params[:referer]
+
+    redirect_to referer || user_path
+  end
+
+  def destroy
+    if current_user.friends_with?(@friend)
+      Follow.where(:befriender => current_user, :befriendee => @friend).delete_all
+      flash[:notice] = t ".success", :name => @friend.display_name
+    else
+      flash[:error] = t ".not_followed", :name => @friend.display_name
+    end
+
+    referer = safe_referer(params[:referer]) if params[:referer]
+
+    redirect_to referer || user_path
+  end
+
+  private
+
+  ##
+  # ensure that there is a "friend" instance variable
+  def lookup_friend
+    @friend = User.active.find_by!(:display_name => params[:display_name])
+  rescue ActiveRecord::RecordNotFound
+    render_unknown_user params[:display_name]
+  end
+end

app/controllers/friendships_controller.rb

@@ -18,9 +18,9 @@
 #  friends_user_id_fkey         (user_id => users.id)
 #
 
-class Friendship < ApplicationRecord
+class Follow < ApplicationRecord
   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
+  belongs_to :befriender, :class_name => "User", :foreign_key => :user_id, :inverse_of => :follows
+  belongs_to :befriendee, :class_name => "User", :foreign_key => :friend_user_id, :inverse_of => :follows
 end

app/models/friendship.rb renamed to app/models/follow.rb

@@ -58,8 +58,8 @@ class User < ApplicationRecord
   has_many :new_messages, -> { where(:to_user_visible => true, :muted => false, :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 :muted_messages, -> { where(:to_user_visible => true, :muted => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :to_user_id
-  has_many :friendships, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
-  has_many :friends, :through => :friendships, :source => :befriendee
+  has_many :follows, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
+  has_many :followings, :through => :follows, :source => :befriendee
   has_many :preferences, :class_name => "UserPreference"
   has_many :changesets, -> { order(:created_at => :desc) }, :inverse_of => :user
   has_many :changeset_comments, :foreign_key => :author_id, :inverse_of => :author
@@ -281,7 +281,7 @@ def distance(nearby_user)
   end
 
   def friends_with?(new_friend)
-    friendships.exists?(:befriendee => new_friend)
+    follows.exists?(:befriendee => new_friend)
   end
 
   ##
@@ -412,7 +412,7 @@ def max_messages_per_hour
   def max_friends_per_hour
     account_age_in_seconds = Time.now.utc - created_at
     account_age_in_hours = account_age_in_seconds / 3600
-    recent_friends = Friendship.where(:befriendee => self).where(:created_at => Time.now.utc - 3600..).count
+    recent_friends = Follow.where(:befriendee => self).where(:created_at => Time.now.utc - 3600..).count
     max_friends = account_age_in_hours.ceil + recent_friends - (active_reports * 10)
     max_friends.clamp(0, Settings.max_friends_per_hour)
   end

app/models/user.rb

@@ -36,9 +36,9 @@
         <li><%= link_to t("users.show.send message"), new_message_path(contact) %></li>
         <li>
           <% if current_user.friends_with?(contact) %>
-            <%= link_to t("users.show.unfollow"), remove_friend_path(:display_name => contact.display_name, :referer => request.fullpath), :method => :post %>
+            <%= link_to t("users.show.unfollow"), follow_path(:display_name => contact.display_name, :referer => request.fullpath), :method => :delete %>
           <% else %>
-            <%= link_to t("users.follow"), make_friend_path(:display_name => contact.display_name, :referer => request.fullpath), :method => :post %>
+            <%= link_to t("users.follow"), follow_path(:display_name => contact.display_name, :referer => request.fullpath), :method => :post %>
           <% end %>
         </li>
       </ul>

app/views/dashboards/_contact.html.erb

@@ -22,7 +22,7 @@
         <%= tag.div "", :id => "map", :class => "content_map border border-secondary-subtle rounded z-0", :data => { :user => user_data } %>
       <% end %>
 
-      <% friends = @user.friends %>
+      <% friends = @user.followings %>
       <% nearby = @user.nearby - friends %>
     </div>
 

app/views/dashboards/show.html.erb

@@ -0,0 +1,8 @@
+<% content_for :heading do %>
+  <h1><%= t(@already_follows ? ".unfollow.heading" : ".follow.heading", :user => @friend.display_name) %></h1>
+<% end %>
+
+<%= link_to t(@already_follows ? ".unfollow.button" : ".follow.button"),
+            follow_path(:display_name => @friend.display_name, :referer => params[:referer]),
+            :method => (@already_follows ? :delete : :post),
+            :class => "btn btn-sm btn-primary" %>

app/views/follows/index.html.erb

@@ -84,9 +84,9 @@
             <% if current_user %>
               <li>
                 <% if current_user.friends_with?(@user) %>
-                  <%= link_to t(".unfollow"), remove_friend_path(:display_name => @user.display_name), :method => :post %>
+                  <%= link_to t(".unfollow"), follow_path(:display_name => @user.display_name), :method => :delete %>
                 <% else %>
-                  <%= link_to t(".follow"), make_friend_path(:display_name => @user.display_name), :method => :post %>
+                  <%= link_to t(".follow"), follow_path(:display_name => @user.display_name), :method => :post %>
                 <% end %>
               </li>
             <% end %>

app/views/friendships/make_friend.html.erb

@@ -651,17 +651,20 @@ en:
     not_found:
       title: File not found
       description: Couldn't find a file/directory/API operation by that name on the OpenStreetMap server (HTTP 404)
-  friendships:
-    make_friend:
-      heading: "Do you want to follow %{user}?"
-      button: "Follow User"
+  follows:
+    index:
+      follow:
+        heading: "Do you want to follow %{user}?"
+        button: "Follow User"
+      unfollow:
+        heading: "Do you want to unfollow %{user}?"
+        button: "Unfollow"
+    create:
       success: "You are now following %{name}!"
       failed: "Sorry, your request to follow %{name} has failed."
       already_followed: "You already follow %{name}."
       limit_exceeded: "You have followed a lot of users recently. Please wait a while before trying to follow any more."
-    remove_friend:
-      heading: "Do you want to unfollow %{user}?"
-      button: "Unfollow"
+    destroy:
       success: "You successfully unfollowed %{name}."
       not_followed: "You are not following %{name}."
   geocoder:

app/views/friendships/remove_friend.html.erb

@@ -280,8 +280,10 @@
   resource :profile, :only => [:edit, :update]
 
   # friendships
-  match "/user/:display_name/make_friend" => "friendships#make_friend", :via => [:get, :post], :as => "make_friend"
-  match "/user/:display_name/remove_friend" => "friendships#remove_friend", :via => [:get, :post], :as => "remove_friend"
+  scope "/user/:display_name" do
+    resource :follow, :only => [:create, :destroy], :path => "follow"
+  end
+  get "/user/:display_name/follow" => "follows#index"
 
   # user lists
   match "/users" => "users#index", :via => [:get, :post]

app/views/users/show.html.erb

@@ -190,7 +190,7 @@ def test_index_user_not_found
   # Checks the display of the friends changesets listing
   def test_index_friends
     private_user = create(:user, :data_public => true)
-    friendship = create(:friendship, :befriender => private_user)
+    friendship = create(:follow, :befriender => private_user)
     changeset = create(:changeset, :user => friendship.befriendee, :num_changes => 1)
     _changeset2 = create(:changeset, :user => create(:user), :num_changes => 1)
 

config/locales/en.yml

@@ -390,7 +390,7 @@ def test_index_user
   def test_index_friends
     user = create(:user)
     other_user = create(:user)
-    friendship = create(:friendship, :befriender => user)
+    friendship = create(:follow, :befriender => user)
     diary_entry = create(:diary_entry, :user => friendship.befriendee)
     _other_entry = create(:diary_entry, :user => other_user)