thredded 0.1.0 → 0.2.2

data/app/models/thredded/topic.rb

@@ -0,0 +1,104 @@
+require 'thredded/search_sql_builder'
+
+module Thredded
+  class Topic < ActiveRecord::Base
+    include TopicCommon
+
+    scope :for_messageboard, -> messageboard { where(messageboard_id: messageboard.id) }
+
+    extend FriendlyId
+    friendly_id :title, use: [:history, :scoped], scope: :messageboard
+
+    belongs_to :messageboard,
+               counter_cache: true,
+               touch: true
+    validates_presence_of :messageboard_id
+
+    belongs_to :user_detail,
+               primary_key:   :user_id,
+               foreign_key:   :user_id,
+               inverse_of:    :topics,
+               counter_cache: :topics_count
+
+    has_many :posts,
+             class_name:  'Thredded::Post',
+             foreign_key: :postable_id,
+             inverse_of:  :postable,
+             dependent:   :destroy
+    has_many :topic_categories, dependent: :destroy
+    has_many :categories, through: :topic_categories
+    has_many :user_topic_reads, dependent: :destroy
+
+    def self.stuck
+      where(sticky: true)
+    end
+
+    def self.unstuck
+      where(sticky: false)
+    end
+
+    def self.order_by_updated_time
+      order('thredded_topics.updated_at DESC')
+    end
+
+    def self.order_by_stuck_and_updated_time
+      order('thredded_topics.sticky DESC, thredded_topics.updated_at DESC')
+    end
+
+    def self.search(query, messageboard)
+      results = find_by_sql(SearchSqlBuilder.new(query, messageboard).build)
+      fail(Thredded::Errors::EmptySearchResults, query) if results.empty?
+      results
+    end
+
+    def self.find_by_slug_with_user_topic_reads!(slug)
+      includes(:user_topic_reads).friendly.find(slug)
+    rescue ActiveRecord::RecordNotFound
+      raise Thredded::Errors::TopicNotFound
+    end
+
+    def decorate
+      TopicDecorator.new(self)
+    end
+
+    def public?
+      true
+    end
+
+    # rubocop:disable all
+    def self.inherited(child)
+      child.instance_eval do
+        def model_name
+          Topic.model_name
+        end
+      end
+
+      super
+    end
+    # rubocop:enable all
+
+    def self.select_options
+      subclasses.map(&:to_s).sort
+    end
+
+    def self.recent
+      limit(10)
+    end
+
+    def updating?
+      id.present?
+    end
+
+    def categories_to_sentence
+      categories.map(&:name).to_sentence if categories.any?
+    end
+
+    def users_to_sentence
+      []
+    end
+
+    def should_generate_new_friendly_id?
+      title_changed?
+    end
+  end
+end

data/app/models/thredded/topic_category.rb

@@ -0,0 +1,6 @@
+module Thredded
+  class TopicCategory < ActiveRecord::Base
+    belongs_to :category
+    belongs_to :topic
+  end
+end

data/app/models/thredded/user_detail.rb

@@ -0,0 +1,26 @@
+module Thredded
+  class UserDetail < ActiveRecord::Base
+    belongs_to :user, class_name: Thredded.user_class
+    validates :user_id, presence: true
+
+    has_many :topics, class_name: 'Thredded::Topic', foreign_key: :user_id, primary_key: :user_id
+    has_many :posts, class_name: 'Thredded::Post', foreign_key: :user_id, primary_key: :user_id
+    has_many :private_posts, class_name: 'Thredded::PrivatePost', foreign_key: :user_id, primary_key: :user_id
+
+    scope :recently_active, -> { where(arel_table[:last_seen_at].gt(Thredded.active_user_threshold.ago)) }
+
+    # Find or create and return a {UserDetail} for a given user.
+    # @param user [Thredded.user_class]
+    # @return [Thredded::UserDetail] a persisted UserDetail.
+    def self.for_user(user)
+      for_user_id(user.id)
+    end
+
+    # Find or create and return a {UserDetail} for a given user ID.
+    # @param user_id [Fixnum, String]
+    # @return [Thredded::UserDetail] a persisted UserDetail.
+    def self.for_user_id(user_id)
+      where(user_id: user_id).first_or_create!
+    end
+  end
+end

data/app/models/thredded/user_extender.rb

@@ -0,0 +1,33 @@
+require_relative './user_permissions/read/all'
+require_relative './user_permissions/write/all'
+require_relative './user_permissions/message/readers_of_writeable_boards'
+require_relative './user_permissions/moderate/if_moderator_column_true'
+require_relative './user_permissions/admin/if_admin_column_true'
+
+module Thredded
+  module UserExtender
+    extend ActiveSupport::Concern
+
+    include ::Thredded::UserPermissions::Read::All
+    include ::Thredded::UserPermissions::Write::All
+    include ::Thredded::UserPermissions::Message::ReadersOfWriteableBoards
+    include ::Thredded::UserPermissions::Moderate::IfModeratorColumnTrue
+    include ::Thredded::UserPermissions::Admin::IfAdminColumnTrue
+
+    included do
+      has_many :thredded_notification_preferences, class_name: 'Thredded::NotificationPreference', foreign_key: 'user_id'
+      has_many :thredded_posts, class_name: 'Thredded::Post', foreign_key: 'user_id'
+      has_many :thredded_private_topics, through: :thredded_private_users, class_name: 'Thredded::PrivateTopic', source: :private_topic
+      has_many :thredded_private_users, class_name: 'Thredded::PrivateUser', foreign_key: 'user_id'
+      has_many :thredded_topics, class_name: 'Thredded::Topic', foreign_key: 'user_id'
+      has_many :thredded_read_topics, class_name: 'Thredded::UserTopicRead', foreign_key: 'user_id'
+
+      has_one :thredded_user_detail, class_name: 'Thredded::UserDetail', foreign_key: 'user_id'
+      has_one :thredded_user_preference, class_name: 'Thredded::UserPreference', foreign_key: 'user_id'
+    end
+
+    def thredded_anonymous?
+      false
+    end
+  end
+end

data/app/models/thredded/user_permissions/admin/if_admin_column_true.rb

@@ -0,0 +1,12 @@
+module Thredded
+  module UserPermissions
+    module Admin
+      module IfAdminColumnTrue
+        # @return [boolean] Whether this user has full admin rights on Thredded.
+        def thredded_admin?
+          send(Thredded.admin_column)
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_permissions/admin/none.rb

@@ -0,0 +1,12 @@
+module Thredded
+  module UserPermissions
+    module Admin
+      module None
+        # @return [boolean] Whether this user has full admin rights on Thredded.
+        def thredded_admin?
+          false
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_permissions/message/readers_of_writeable_boards.rb

@@ -0,0 +1,13 @@
+module Thredded
+  module UserPermissions
+    module Message
+      module ReadersOfWriteableBoards
+        # @return [ActiveRecord::Relation<Thredded.user_class>] the users this user can include in a private topic
+        def thredded_can_message_users
+          # By default, return everyone who can read the messageboards this user can post in
+          Thredded.user_class.thredded_messageboards_readers(thredded_can_write_messageboards)
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_permissions/moderate/if_moderator_column_true.rb

@@ -0,0 +1,25 @@
+module Thredded
+  module UserPermissions
+    module Moderate
+      module IfModeratorColumnTrue
+        extend ActiveSupport::Concern
+        included { extend ClassMethods }
+
+        # @return [ActiveRecord::Relation<Thredded::Messageboard>] messageboards that the user can moderate
+        def thredded_can_moderate_messageboards
+          send(Thredded.moderator_column) ? Thredded::Messageboard.all : Thredded::Messageboard.none
+        end
+
+        module ClassMethods
+          # Users that can moderate the given messageboards.
+          #
+          # @param _messageboards [Array<Thredded::Messageboard>]
+          # @return [ActiveRecord::Relation<Thredded.user_class>] users that can moderate the given messageboards
+          def thredded_messageboards_moderators(_messageboards)
+            where(Thredded.moderator_column => true)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_permissions/moderate/none.rb

@@ -0,0 +1,25 @@
+module Thredded
+  module UserPermissions
+    module Moderate
+      module None
+        extend ActiveSupport::Concern
+        included { extend ClassMethods }
+
+        # @return [ActiveRecord::Relation<Thredded::Messageboard>] messageboards that the user can moderate
+        def thredded_can_moderate_messageboards
+          Thredded::Messageboard.none
+        end
+
+        module ClassMethods
+          # Users that can moderate the given messageboards.
+          #
+          # @param _messageboards [Array<Thredded::Messageboard>]
+          # @return [ActiveRecord::Relation<Thredded.user_class>] users that can moderate the given messageboards
+          def thredded_messageboards_moderators(_messageboards)
+            none
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_permissions/read/all.rb

@@ -0,0 +1,25 @@
+module Thredded
+  module UserPermissions
+    module Read
+      module All
+        extend ActiveSupport::Concern
+        included { extend ClassMethods }
+
+        # @return [ActiveRecord::Relation<Thredded::Messageboard>] messageboards that the user can read
+        def thredded_can_read_messageboards
+          Thredded::Messageboard.all
+        end
+
+        module ClassMethods
+          # Users that can read the given messageboards.
+          #
+          # @param _messageboards [Array<Thredded::Messageboard>]
+          # @return [ActiveRecord::Relation<Thredded.user_class>] users that can read the given messageboards
+          def thredded_messageboards_readers(_messageboards)
+            all
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_permissions/write/all.rb

@@ -0,0 +1,25 @@
+module Thredded
+  module UserPermissions
+    module Write
+      module All
+        extend ActiveSupport::Concern
+        included { extend ClassMethods }
+
+        # @return [ActiveRecord::Relation<Thredded::Messageboard>] messageboards that the user can post in
+        def thredded_can_write_messageboards
+          Thredded::Messageboard.all
+        end
+
+        module ClassMethods
+          # Users that can post to the given messageboards.
+          #
+          # @param _messageboards [Array<Thredded::Messageboard>]
+          # @return [ActiveRecord::Relation<Thredded.user_class>] users that can post to the given messageboards
+          def thredded_messageboards_writers(_messageboards)
+            all
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_permissions/write/none.rb

@@ -0,0 +1,25 @@
+module Thredded
+  module UserPermissions
+    module Write
+      module None
+        extend ActiveSupport::Concern
+        included { extend ClassMethods }
+
+        # @return [ActiveRecord::Relation<Thredded::Messageboard>] messageboards that the user can post in
+        def thredded_can_write_messageboards
+          Thredded::Messageboard.none
+        end
+
+        module ClassMethods
+          # Users that can post to the given messageboards.
+          #
+          # @param _messageboards [Array<Thredded::Messageboard>]
+          # @return [ActiveRecord::Relation<Thredded.user_class>] users that can post to the given messageboards
+          def thredded_messageboards_writers(_messageboards)
+            none
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/thredded/user_preference.rb

@@ -0,0 +1,6 @@
+module Thredded
+  class UserPreference < ActiveRecord::Base
+    belongs_to :user, class_name: Thredded.user_class
+    validates :user_id, presence: true
+  end
+end

data/app/models/thredded/user_topic_read.rb

@@ -0,0 +1,10 @@
+module Thredded
+  class UserTopicRead < ActiveRecord::Base
+    belongs_to :topic
+    belongs_to :user, class_name: Thredded.user_class
+    belongs_to :farthest_post,
+      class_name: 'Thredded::Post', foreign_key: 'post_id'
+    validates :user_id, uniqueness: { scope: :topic }
+    belongs_to :post
+  end
+end

data/app/views/layouts/thredded/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Thredded | <%= yield :thredded_page_title %></title>
+    <meta content='width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0' name='viewport' />
+    <%= stylesheet_link_tag 'thredded' %>
+    <%= csrf_meta_tag %>
+    <%= javascript_include_tag 'thredded' %>
+    <%== Gravatar.prefetch_dns %>
+    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/thredded/categories/_category.html.erb

@@ -0,0 +1 @@
+<li class="<%= category.name.underscore %>"><%= category.name %></li>

data/app/views/thredded/kaminari/_first_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "First" page
+  - available local variables
+    url:           url to the first page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="first">
+  <%= link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, :remote => remote %>
+</span>

data/app/views/thredded/kaminari/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page gap"><%= t('views.pagination.truncate').html_safe %></span>

data/app/views/thredded/kaminari/_last_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Last" page
+  - available local variables
+    url:           url to the last page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="last">
+  <%= link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, :remote => remote %>
+</span>

data/app/views/thredded/kaminari/_next_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="next">
+  <%= link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, :rel => 'next', :remote => remote %>
+</span>

data/app/views/thredded/kaminari/_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page<%= ' current' if page.current? %>">
+  <%= link_to_unless page.current?, page, url, {:remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>
+</span>

data/app/views/thredded/kaminari/_paginator.html.erb

@@ -0,0 +1,23 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%= paginator.render do -%>
+  <nav class="pagination thredded--pagination">
+    <%= first_page_tag unless current_page.first? %>
+    <%= prev_page_tag unless current_page.first? %>
+    <% each_page do |page| -%>
+      <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
+        <%= page_tag page %>
+      <% elsif !page.was_truncated? -%>
+        <%= gap_tag %>
+      <% end -%>
+    <% end -%>
+    <%= next_page_tag unless current_page.last? %>
+    <%= last_page_tag unless current_page.last? %>
+  </nav>
+<% end -%>

data/app/views/thredded/kaminari/_prev_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="prev">
+  <%= link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, :rel => 'prev', :remote => remote %>
+</span>

data/app/views/thredded/messageboards/_messageboard.html.erb

@@ -0,0 +1,15 @@
+<% if current_ability.can? :read, messageboard.original %>
+  <%= link_to messageboard_topics_path(messageboard), class: 'thredded--messageboard' do %>
+    <header>
+      <h2 class="thredded--messageboard--title"><%= messageboard.name %></h2>
+      <h3 class="thredded--messageboard--meta"><%= messageboard.meta %></h3>
+    </header>
+
+    <p class="thredded--messageboard--description"><%= messageboard.description %></p>
+
+    <p class="thredded--messageboard--byline">
+      Updated <%= time_ago messageboard.latest_topic.updated_at %>
+      <cite>by <%= messageboard.latest_user %></cite>
+    </p>
+  <% end %>
+<% end %>

data/app/views/thredded/messageboards/index.html.erb

@@ -0,0 +1,20 @@
+<% content_for :thredded_page_title, 'Messageboards' %>
+<% content_for :thredded_page_id, 'thredded--messageboards-index' %>
+<% content_for :thredded_breadcrumbs do %>
+  <ul class="thredded--navigation-breadcrumbs">
+    <li>
+      <%= link_to 'All Message Boards', messageboards_path %>
+    </li>
+  </ul>
+<% end %>
+<%= thredded_page do %>
+  <section class="thredded--main-section thredded--messageboards">
+    <%= render @messageboards %>
+  </section>
+
+  <% if current_ability.can? :create, Thredded::Messageboard %>
+    <div class="thredded--messageboard--create">
+      <a class="thredded--button" href="<%= new_messageboard_path %>">Create a New Messageboard</a>
+    </div>
+  <% end %>
+<% end %>

data/app/views/thredded/messageboards/new.html.erb

@@ -0,0 +1,18 @@
+<% content_for :thredded_page_title, 'Create a New Messageboard' %>
+<% content_for :thredded_page_id, 'thredded--messageboards-new' %>
+<%= thredded_page do %>
+  <%= form_for @messageboard, class: 'thredded--form' do |f| %>
+    <ul class="thredded--form-list">
+      <li>
+        <%= f.label :name %>
+        <%= f.text_field :name %>
+      </li>
+      <li>
+        <%= f.label :description %>
+        <%= f.text_field :description %>
+      </li>
+
+      <li><%= f.submit 'Create New Messageboard', class: 'thredded--form--submit' %></li>
+    </ul>
+  <% end %>
+<% end %>

data/app/views/thredded/post_mailer/at_notification.html.erb

@@ -0,0 +1,14 @@
+<%= @post.filtered_content(self) %>
+
+<hr />
+
+<p>
+  This email was sent to you because <%= @post.user %> mentioned you in
+  "<%= link_to @post.postable.title, messageboard_topic_posts_url(@post.messageboard, @post.postable, anchor: "post_#{@post.id}") %>".
+  <%= link_to 'View the conversation here.', messageboard_topic_posts_url(@post.messageboard, @post.postable) %>
+</p>
+
+<p>
+  To unsubscribe from these emails, update your
+  <%= link_to 'preferences', edit_messageboard_preferences_url(@post.messageboard) %>.
+</p>

data/app/views/thredded/post_mailer/at_notification.text.erb

@@ -0,0 +1,10 @@
+<%= @post.content %>
+
+---
+
+This email was sent to you because <%= @post.user %> mentioned you in
+"<%= @post.postable.title %>". Go here to view the conversation:
+<%= messageboard_topic_posts_url @post.messageboard, @post.postable, anchor: "post_#{@post.id}" %>
+
+To unsubscribe from these emails, update your preferences here:
+  <%= edit_messageboard_preferences_url @post.messageboard %>

data/app/views/thredded/posts/_content_field.html.erb

@@ -0,0 +1,4 @@
+<li>
+  <%= form.label :content %>
+  <%= form.text_area :content, { rows: 5, required: true }  %>
+</li>

data/app/views/thredded/posts/_form.html.erb

@@ -0,0 +1 @@
+<%= render 'thredded/posts_common/form', topic: topic, post: post, button_text: button_text %>

data/app/views/thredded/posts/_post.html.erb

@@ -0,0 +1 @@
+<%= render 'thredded/posts_common/post', post: post %>

data/app/views/thredded/posts/_user.html.erb

@@ -0,0 +1,3 @@
+<span class="posts_count">
+  <%= post.user_posts_count %> posts
+</span>

data/app/views/thredded/posts/edit.html.erb

@@ -0,0 +1,13 @@
+<% content_for :thredded_page_title, 'Edit Post' %>
+<% content_for :thredded_page_id, 'thredded--edit-post' %>
+<%= thredded_page do %>
+  <section class="thredded--main-section">
+    <h3 class="thredded--post-form--title">Edit Post</h3>
+
+    <%= render 'thredded/posts/form',
+               messageboard: messageboard,
+               topic:        topic,
+               post:         @post,
+               button_text:  'Update Post' %>
+  </section>
+<% end %>

data/app/views/thredded/posts_common/_form.html.erb

@@ -0,0 +1,10 @@
+<%= form_for (post.private_topic_post? ? [topic, post] : [messageboard, topic, post]), as: :post,
+             html: { class: 'thredded--form thredded--post-form', 'data-thredded-post-form' => true } do |form| %>
+  <ul class="thredded--form-list">
+    <%= render 'thredded/posts/content_field', form: form %>
+
+    <li>
+      <%= form.submit button_text, class: 'thredded--form--submit' %>
+    </li>
+  </ul>
+<% end %>

data/app/views/thredded/posts_common/_post.html.erb

@@ -0,0 +1,20 @@
+<% post = Thredded::PostDecorator.new(post) %>
+
+<%= content_tag_for :article, post, class: 'thredded--post' do %>
+  <header>
+    <%= image_tag post.avatar_url, class: 'thredded--post--avatar' unless post.user_anonymous? %>
+    <h2 class="thredded--post--user"><%= user_link post.user %></h2>
+    <p class="thredded--post--created-at"><%= time_ago post.created_at %></p>
+
+  </header>
+
+  <div class="thredded--post--content">
+    <% cache [post, 'content'] do %>
+      <%= post.filtered_content(self) %>
+    <% end %>
+  </div>
+
+  <% if current_ability.can? :edit, post.original %>
+    <%= link_to 'Edit Post', edit_post_path(post.original), class: 'thredded--post--edit' %>
+  <% end %>
+<% end %>