Class: MuckFriends::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/muck-friends/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Returns a new instance of Configuration.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/muck-friends/config.rb', line 18

def initialize
  # Friend Configuration
  # The friend system provides a hybrid friend/follow model.  Either mode can be turned off or both can be enabled
  # If only following is enabled then users will be provided the ability to follow, unfollow, and block
  # If only friending is enabled then users will be provided a 'friend request' link and the ability to accept friend requests
  # If both modes are are enabled then users will be able to follow other users.  A mutual follow results in 'friends'.  An unfollow 
  # leaves the other party as just a follower.
  # Note that at least one mode must be enabled.
  enable_following = true         # Turn on 'following'.  This is similar to the 'follow' functionality on Twitter in that it let's users watch one 
                                  # another's activities without having explicit permission from the user.  A mutual follow essentially becomes a
                                  # friendship.
                                  # If enable_following is true and enable_friending is false then only follow/unfollow links will be shown
                                  # If enable_following is false and enable_friending is true then only friend request and unfriend links will be shown
                                  # If enable_following is true and enable_friending is true then a hybrid model will be used.  Users can follow
                                  # each other without permission but a mutual follow will result in a friendship.  Defriending a user will result in the
                                  # other user becoming a follower
  enable_friending = true         # Turn on friend system.
  enable_friend_activity = true   # If true then friend related activity will show up in the activity feed.  Requires muck-activities gem
end

Instance Attribute Details

#enable_followingObject

Returns the value of attribute enable_following.



14
15
16
# File 'lib/muck-friends/config.rb', line 14

def enable_following
  @enable_following
end

#enable_friend_activityObject

Returns the value of attribute enable_friend_activity.



16
17
18
# File 'lib/muck-friends/config.rb', line 16

def enable_friend_activity
  @enable_friend_activity
end

#enable_friendingObject

Returns the value of attribute enable_friending.



15
16
17
# File 'lib/muck-friends/config.rb', line 15

def enable_friending
  @enable_friending
end