Class: Stream::Aspect

Inherits:
Base
  • Object
show all
Defined in:
lib/stream/aspect.rb

Overview

Copyright © 2010-2011, Diaspora Inc. This file is

licensed under the Affero General Public License version 3 or later.  See
the COPYRIGHT file.

Constant Summary

Constants inherited from Base

Base::TYPES_OF_POST_IN_STREAM

Instance Attribute Summary

Attributes inherited from Base

#max_time, #order, #publisher, #user

Instance Method Summary collapse

Methods inherited from Base

#post_from_group, #stream_posts

Constructor Details

#initialize(user, inputted_aspect_ids, opts = {}) ⇒ void

Parameters:

  • user (User)
  • inputted_aspect_ids (Array<Integer>)

    Ids of aspects for given stream

  • aspect_ids (Array<Integer>)

    Aspects this stream is responsible for


15
16
17
18
# File 'lib/stream/aspect.rb', line 15

def initialize(user, inputted_aspect_ids, opts={})
  super(user, opts)
  @inputted_aspect_ids = inputted_aspect_ids
end

Instance Method Details

#aspectAspect, Symbol

Note:

aspects.first is used for mobile. NOTE(this is a hack and should be fixed)

The first aspect in #aspects, given the stream is not for all aspects, or #aspects size is 1

Returns:


57
58
59
60
61
# File 'lib/stream/aspect.rb', line 57

def aspect
  if !for_all_aspects? || aspects.size == 1
    aspects.first
  end
end

#aspectsActiveRecord::Association<Aspect>

Filters aspects given the stream's aspect ids on initialization and the user. Will disclude aspects from inputted aspect ids if user is not associated with their target aspects.

Returns:

  • (ActiveRecord::Association<Aspect>)

    Filtered aspects given the stream's user


25
26
27
28
29
30
31
# File 'lib/stream/aspect.rb', line 25

def aspects
  @aspects ||= lambda do
    a = user.aspects
    a = a.where(:id => @inputted_aspect_ids) if @inputted_aspect_ids.any?
    a
  end.call
end

#can_comment?(post) ⇒ Boolean

This is perfomance optimization, as everyone in your aspect stream you have a contact.

Parameters:

Returns:

  • (Boolean)

88
89
90
# File 'lib/stream/aspect.rb', line 88

def can_comment?(post)
  true
end

#for_all_aspects?Boolean

Determine whether or not the stream is displaying across all of the user's aspects.

Returns:

  • (Boolean)

79
80
81
# File 'lib/stream/aspect.rb', line 79

def for_all_aspects?
  @all_aspects ||= aspects.size == user.aspects.size
end

Returns URL.

Returns:


50
51
52
# File 'lib/stream/aspect.rb', line 50

def link(opts={})
  Rails.application.routes.url_helpers.aspects_path(opts)
end

#peopleActiveRecord::Association<Person>

Returns AR association of people within stream's given aspects.

Returns:

  • (ActiveRecord::Association<Person>)

    AR association of people within stream's given aspects


45
46
47
# File 'lib/stream/aspect.rb', line 45

def people
  @people ||= Person.unique_from_aspects(aspect_ids, user).includes(:profile)
end

#postsActiveRecord::Association<Post>

Returns AR association of posts.

Returns:

  • (ActiveRecord::Association<Post>)

    AR association of posts


34
35
36
37
38
39
40
41
42
# File 'lib/stream/aspect.rb', line 34

def posts
  # NOTE(this should be something like Post.all_for_stream(@user, aspect_ids, {}) that calls visible_shareables
  @posts ||= user.visible_shareables(Post, :all_aspects? => for_all_aspects?,
                                           :by_members_of => aspect_ids,
                                           :type => TYPES_OF_POST_IN_STREAM,
                                           :order => "#{order} DESC",
                                           :max_time => max_time
                 )
end

#titleString

The title that will display at the top of the stream's publisher box.

Returns:


67
68
69
70
71
72
73
# File 'lib/stream/aspect.rb', line 67

def title
  if self.for_all_aspects?
    I18n.t('streams.aspects.title')
  else
    self.aspects.to_sentence
  end
end