thredded 0.1.0 → 0.2.2

data/app/models/concerns/thredded/post_common.rb

@@ -0,0 +1,105 @@
+module Thredded
+  module PostCommon
+    extend ActiveSupport::Concern
+    included do
+      paginates_per 50
+
+      belongs_to :user, class_name: Thredded.user_class
+      delegate :email, to: :user, prefix: true, allow_nil: true
+
+      has_many :post_notifications, as: :post, dependent: :destroy
+
+      validates :content, presence: true
+
+      after_create :update_parent_last_user_and_timestamp
+      after_commit :notify_at_users, on: [:create, :update]
+
+      extend ClassMethods
+    end
+
+    def avatar_url
+      Thredded.avatar_url.call(user)
+    end
+
+    def user_anonymous?
+      user.try(:thredded_anonymous?)
+    end
+
+    # @param view_context [Object] the context of the rendering view.
+    def filtered_content(view_context)
+      pipeline = HTML::Pipeline.new(
+        [
+          html_filter_for_pipeline,
+          HTML::Pipeline::SanitizationFilter,
+          HTML::Pipeline::AtMentionFilter,
+          HTML::Pipeline::EmojiFilter,
+          HTML::Pipeline::AutolinkFilter,
+        ], context_options)
+
+      result = pipeline.call(content, view_context: view_context)
+      result[:output].to_s.html_safe
+    end
+
+    private
+
+    def context_options
+      {
+        asset_root: Rails.application.config.action_controller.asset_host || '',
+        post:       self,
+        whitelist:  sanitize_whitelist
+      }
+    end
+
+    def sanitize_whitelist
+      HTML::Pipeline::SanitizationFilter::WHITELIST.deep_merge(
+        attributes:   {
+          'code'       => ['class'],
+          'img'        => %w(src class width height),
+          'blockquote' => ['class'],
+        },
+        transformers: [(lambda do |env|
+          node      = env[:node]
+          node_name = env[:node_name]
+
+          return if env[:is_whitelisted] || !node.element?
+          return if node_name != 'iframe'
+          return if (node['src'] =~ %r{\A(https?:)?//(?:www\.)?youtube(?:-nocookie)?\.com/}).nil?
+
+          Sanitize.node!(
+            node,
+            elements:   %w(iframe),
+            attributes: {
+              'iframe' => %w(allowfullscreen frameborder height src width)
+            }
+          )
+
+          { node_whitelist: [node] }
+        end)]
+      )
+    end
+
+    def html_filter_for_pipeline
+      if filter == 'bbcode'
+        HTML::Pipeline::BbcodeFilter
+      else
+        HTML::Pipeline::MarkdownFilter
+      end
+    end
+
+    def update_parent_last_user_and_timestamp
+      return unless postable && user
+
+      postable.update!(last_user: user, updated_at: Time.zone.now)
+    end
+
+    def notify_at_users
+      AtNotifierJob.perform_later(self.class.name, id)
+    end
+
+    module ClassMethods
+      def filters
+        %w(bbcode markdown)
+      end
+    end
+  end
+end

data/app/models/concerns/thredded/topic_common.rb

@@ -0,0 +1,48 @@
+module Thredded
+  module TopicCommon
+    extend ActiveSupport::Concern
+    included do
+      paginates_per 50 if self.respond_to?(:paginates_per)
+
+      belongs_to :user,
+                 class_name: Thredded.user_class
+      belongs_to :last_user,
+                 class_name: Thredded.user_class,
+                 foreign_key: 'last_user_id'
+
+      scope :order_latest_first, -> { order(updated_at: :desc, id: :desc) }
+      scope :on_page, -> page_num { page(page_num).per(30) }
+
+      validates_presence_of :hash_id
+      validates_presence_of :last_user_id
+      validates_numericality_of :posts_count
+      validates_uniqueness_of :hash_id
+
+      before_validation do
+        self.hash_id = SecureRandom.hex(10) if hash_id.nil?
+      end
+
+      delegate :name, :name=, :email, :email=, to: :user, prefix: true
+    end
+
+    def user
+      super || NullUser.new
+    end
+
+    def last_user
+      super || NullUser.new
+    end
+
+    def private?
+      !public?
+    end
+
+    module ClassMethods
+      def decorate
+        all.map do |topic|
+          TopicDecorator.new(topic)
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/ability.rb

@@ -0,0 +1,60 @@
+module Thredded
+  class Ability
+    include ::CanCan::Ability
+
+    def initialize(user)
+      user ||= Thredded::NullUser.new
+      user_details = user.thredded_user_detail
+
+      can :manage, :all if user.thredded_admin?
+
+      can :read, Thredded::Messageboard do |messageboard|
+        Thredded::MessageboardUserPermissions.new(messageboard, user).readable?
+      end
+
+      can :admin, Thredded::Topic do |topic|
+        Thredded::TopicUserPermissions.new(topic, user, user_details).adminable?
+      end
+
+      can :edit, Thredded::Topic do |topic|
+        Thredded::TopicUserPermissions.new(topic, user, user_details).editable?
+      end
+
+      can :update, Thredded::Topic do |topic|
+        Thredded::TopicUserPermissions.new(topic, user, user_details).editable?
+      end
+
+      can :read, Thredded::Topic do |topic|
+        Thredded::TopicUserPermissions.new(topic, user, user_details).readable?
+      end
+
+      can :create, Thredded::Topic do |topic|
+        Thredded::TopicUserPermissions.new(topic, user, user_details).creatable?
+      end
+
+      can :manage, Thredded::PrivateTopic do |private_topic|
+        Thredded::PrivateTopicUserPermissions.new(private_topic, user, user_details).manageable?
+      end
+
+      can :create, Thredded::PrivateTopic do |private_topic|
+        Thredded::PrivateTopicUserPermissions.new(private_topic, user, user_details).creatable?
+      end
+
+      can :read, Thredded::PrivateTopic do |private_topic|
+        Thredded::PrivateTopicUserPermissions.new(private_topic, user, user_details).readable?
+      end
+
+      can :edit, Thredded::Post do |post|
+        Thredded::PostUserPermissions.new(post, user, user_details).editable?
+      end
+
+      can :manage, Thredded::Post do |post|
+        Thredded::PostUserPermissions.new(post, user, user_details).manageable?
+      end
+
+      can :create, Thredded::Post do |post|
+        Thredded::PostUserPermissions.new(post, user, user_details).creatable?
+      end
+    end
+  end
+end

data/app/models/thredded/category.rb

@@ -0,0 +1,12 @@
+module Thredded
+  class Category < ActiveRecord::Base
+    extend FriendlyId
+    belongs_to :messageboard
+    has_many :topic_categories
+    has_many :topics, through: :topic_categories
+    friendly_id :name, use: [:history, :scoped], scope: :messageboard
+
+    validates :name, presence: true
+    validates :messageboard_id, presence: true
+  end
+end

data/app/models/thredded/messageboard.rb

@@ -0,0 +1,50 @@
+module Thredded
+  class Messageboard < ActiveRecord::Base
+    FILTERS = %w(markdown bbcode)
+
+    extend FriendlyId
+    friendly_id :name, use: :slugged
+
+    validates :filter, inclusion: { in: FILTERS }, presence: true
+    validates :name, uniqueness: true, length: { maximum: 60 }, presence: true
+    validates :slug, exclusion: { in: %w(private-topics) }
+    validates :topics_count, numericality: true
+
+    has_many :categories, dependent: :destroy
+    has_many :notification_preferences, dependent: :destroy
+    has_many :posts, dependent: :destroy
+    has_many :topics, dependent: :destroy
+    has_many :user_details, through: :posts
+
+    has_many :messageboard_users,
+             class_name: 'Thredded::MessageboardUser',
+             inverse_of: :messageboard,
+             foreign_key: :thredded_messageboard_id
+    has_many :recently_active_user_details,
+             -> { merge(Thredded::MessageboardUser.recently_active) },
+             class_name: 'Thredded::UserDetail',
+             through: :messageboard_users,
+             source: :user_detail
+    has_many :recently_active_users,
+             class_name: Thredded.user_class,
+             through: :recently_active_user_details,
+             source: :user
+
+    default_scope { where(closed: false).order(topics_count: :desc) }
+
+    def self.decorate
+      all.map do |messageboard|
+        MessageboardDecorator.new(messageboard)
+      end
+    end
+
+    def preferences_for(user)
+      @preferences_for ||=
+        notification_preferences.where(user_id: user).first_or_create
+    end
+
+    def decorate
+      MessageboardDecorator.new(self)
+    end
+  end
+end

data/app/models/thredded/messageboard_user.rb

@@ -0,0 +1,12 @@
+module Thredded
+  # The state of a user with regards to a messageboard, such as the last time the user was active (visited)
+  # the messageboard.
+  class MessageboardUser < ActiveRecord::Base
+    belongs_to :messageboard,
+               class_name:  'Thredded::Messageboard',
+               foreign_key: :thredded_messageboard_id,
+               inverse_of:  :messageboard_users
+    belongs_to :user_detail, class_name: 'Thredded::UserDetail', foreign_key: :thredded_user_detail_id
+    scope :recently_active, -> { where(arel_table[:last_seen_at].gt(Thredded.active_user_threshold.ago)) }
+  end
+end

data/app/models/thredded/notification_preference.rb

@@ -0,0 +1,17 @@
+module Thredded
+  class NotificationPreference < ActiveRecord::Base
+    belongs_to :user
+    belongs_to :messageboard
+
+    validates :user_id, presence: true
+    validates :messageboard_id, presence: true
+
+    def self.for(user)
+      where(user_id: user.id)
+    end
+
+    def self.in(messageboard)
+      where(messageboard_id: messageboard.id)
+    end
+  end
+end

data/app/models/thredded/null_preference.rb

@@ -0,0 +1,11 @@
+module Thredded
+  class NullPreference
+    def notify_on_mention
+      true
+    end
+
+    def notify_on_message
+      true
+    end
+  end
+end

data/app/models/thredded/null_topic.rb

@@ -0,0 +1,15 @@
+module Thredded
+  class NullTopic
+    def updated_at
+      nil
+    end
+
+    def user
+      Thredded::NullUser.new
+    end
+
+    def last_user
+      Thredded::NullUser.new
+    end
+  end
+end

data/app/models/thredded/null_topic_read.rb

@@ -0,0 +1,19 @@
+module Thredded
+  class NullTopicRead
+    def page
+      1
+    end
+
+    def post_id
+      0
+    end
+
+    def posts_count
+      0
+    end
+
+    def farthest_post
+      Post.new
+    end
+  end
+end

data/app/models/thredded/null_user.rb

@@ -0,0 +1,51 @@
+require_relative './user_permissions/read/all'
+require_relative './user_permissions/write/none'
+require_relative './user_permissions/message/readers_of_writeable_boards'
+require_relative './user_permissions/moderate/none'
+require_relative './user_permissions/admin/none'
+
+module Thredded
+  class NullUser
+    include ::Thredded::UserPermissions::Read::All
+    include ::Thredded::UserPermissions::Write::None
+    include ::Thredded::UserPermissions::Message::ReadersOfWriteableBoards
+    include ::Thredded::UserPermissions::Moderate::None
+    include ::Thredded::UserPermissions::Admin::None
+
+    def thredded_private_topics
+      Thredded::PrivateTopic.none
+    end
+
+    def id
+      0
+    end
+
+    def member_of?(_)
+      false
+    end
+
+    def name
+      'Anonymous User'
+    end
+
+    def to_s
+      name
+    end
+
+    def valid?
+      false
+    end
+
+    def thredded_anonymous?
+      true
+    end
+
+    def thredded_user_detail
+      Thredded::UserDetail.new
+    end
+
+    def thredded_user_preference
+      Thredded::UserPreference.new
+    end
+  end
+end

data/app/models/thredded/post.rb

@@ -0,0 +1,37 @@
+module Thredded
+  class Post < ActiveRecord::Base
+    include PostCommon
+
+    belongs_to :messageboard,
+               counter_cache: true
+    belongs_to :postable,
+               class_name:    'Thredded::Topic',
+               inverse_of:    :posts,
+               counter_cache: true
+    belongs_to :user_detail,
+               inverse_of:    :posts,
+               primary_key:   :user_id,
+               foreign_key:   :user_id,
+               counter_cache: true
+
+    validates :messageboard_id, presence: true
+    before_validation :set_filter_from_messageboard
+
+    def private_topic_post?
+      false
+    end
+
+    # @return [ActiveRecord::Relation<Thredded.user_class>] users from the list of user names that can read this post.
+    def readers_from_user_names(user_names)
+      DbTextSearch::CaseInsensitiveEq
+        .new(Thredded.user_class.thredded_messageboards_readers([messageboard]), Thredded.user_name_column)
+        .find(user_names)
+    end
+
+    private
+
+    def set_filter_from_messageboard
+      self.filter = messageboard.filter if messageboard
+    end
+  end
+end

data/app/models/thredded/post_notification.rb

@@ -0,0 +1,17 @@
+module Thredded
+  # Keeps track of post notifications that have been sent already.
+  class PostNotification < ActiveRecord::Base
+    belongs_to :post, polymorphic: true
+    # Specific post type associations for joins
+    belongs_to :non_private_post,
+               foreign_key:  'post_id',
+               foreign_type: 'Thredded::Post',
+               class_name:   'Thredded::Post'
+    belongs_to :private_post,
+               foreign_key:  'post_id',
+               foreign_type: 'Thredded::PrivatePost',
+               class_name:   'Thredded::PrivatePost'
+    validates :email, presence: true
+    validates :post, presence: true
+  end
+end

data/app/models/thredded/private_post.rb

@@ -0,0 +1,25 @@
+module Thredded
+  class PrivatePost < ActiveRecord::Base
+    include PostCommon
+
+    belongs_to :postable,
+               class_name:    'Thredded::PrivateTopic',
+               inverse_of:    :posts,
+               counter_cache: :posts_count
+    belongs_to :user_detail,
+               inverse_of:  :private_posts,
+               primary_key: :user_id,
+               foreign_key: :user_id
+
+    def private_topic_post?
+      true
+    end
+
+    # @return [ActiveRecord::Relation<Thredded.user_class>] users from the list of user names that can read this post.
+    def readers_from_user_names(user_names)
+      DbTextSearch::CaseInsensitiveEq
+        .new(postable.users, Thredded.user_name_column)
+        .find(user_names)
+    end
+  end
+end

data/app/models/thredded/private_topic.rb

@@ -0,0 +1,60 @@
+module Thredded
+  class PrivateTopic < ActiveRecord::Base
+    include TopicCommon
+    extend FriendlyId
+    friendly_id :title, use: :history
+
+    has_many :posts,
+             class_name:  'Thredded::PrivatePost',
+             foreign_key: :postable_id,
+             inverse_of:  :postable,
+             dependent:   :destroy
+    has_many :private_users
+    has_many :users, through: :private_users
+
+    def self.find_by_slug(slug)
+      friendly.find(slug)
+    rescue ActiveRecord::RecordNotFound
+      raise Thredded::Errors::PrivateTopicNotFound
+    end
+
+    def decorate
+      TopicDecorator.new(self)
+    end
+
+    def user_topic_reads
+      []
+    end
+
+    def categories
+      []
+    end
+
+    def self.for_user(user)
+      joins(:private_users)
+        .where(thredded_private_users: { user_id: user.id })
+    end
+
+    def add_user(user)
+      if String == user.class
+        user = Thredded.user_class.find_by_name(user)
+      end
+
+      users << user
+    end
+
+    def public?
+      false
+    end
+
+    def user_id=(ids)
+      return unless ids.size > 0
+
+      self.users = Thredded.user_class.where(id: ids.uniq)
+    end
+
+    def users_to_sentence
+      users.map { |user| user.to_s.capitalize }.to_sentence
+    end
+  end
+end

data/app/models/thredded/private_user.rb

@@ -0,0 +1,6 @@
+module Thredded
+  class PrivateUser < ActiveRecord::Base
+    belongs_to :private_topic
+    belongs_to :user, class_name: Thredded.user_class
+  end
+end

data/app/models/thredded/stats.rb

@@ -0,0 +1,37 @@
+module Thredded
+  class Stats
+    include ActionView::Helpers::NumberHelper
+
+    class << self
+      def messageboards_count
+        new.messageboards_count
+      end
+
+      def topics_count
+        new.topics_count
+      end
+
+      def posts_count
+        new.posts_count
+      end
+    end
+
+    def messageboards_count
+      messageboards.count
+    end
+
+    def topics_count
+      number_to_human(messageboards.map(&:topics_count).sum, precision: 4)
+    end
+
+    def posts_count
+      number_to_human(messageboards.map(&:posts_count).sum, precision: 5)
+    end
+
+    private
+
+    def messageboards
+      @messageboards ||= Messageboard.all
+    end
+  end
+end