thredded 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbf9d4e29edeea27a73efed02c03710eaa1f7530
+  data.tar.gz: a3c14e476dbbe413c60dc52fce7c712152cd5743
+SHA512:
+  metadata.gz: 07f3f002cf28edd4d5a7a30b2f10651eac57327ce22a28481aa07167922a7ad89872df0e1b8b33693b1ce52b034830212f1a6677aed5bb61138c67914f2bba36
+  data.tar.gz: 3d03b68a94ecb9ce235ea772545c930c1b9ed62ea3e2bcbb353bf171a1dd8f63b13c79a46f65ab6d266b81ab6dd48a87478edeb5401fdd4422083140afe8d00a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.mkdn

@@ -0,0 +1,46 @@
+# Thredded (the gem / rails engine)
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'thredded'
+```
+
+Add an initializer to your app: `config/initializers/thredded.rb`
+
+```ruby
+Thredded.user_class = 'User'
+Thredded.email_incoming_host = 'incoming.example.com'
+Thredded.email_from = 'no-reply@example.com'
+Thredded.email_outgoing_prefix = '[Thredded] '
+```
+
+Copy the migrations over to your parent application and migrate:
+
+```
+rake thredded:install:migrations db:migrate db:test:prepare
+```
+
+Mount the thredded engine in your routes file:
+
+```
+mount Thredded::Engine => '/forum'
+```
+
+## Get Your App Ready
+
+There are a few things you need in your app to get things looking just right.
+
+1. Add a to_s method to your user model. The following example assumes a column in my user model called `name`:
+
+```ruby
+class User < ActiveRecord::Base
+  def to_s
+    name
+  end
+end
+```
+
+For more information see [the full-fledged rails app](https://github.com/jayroh/thredded_app)

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Thredded'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/thredded/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/thredded/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/thredded/application_controller.rb

@@ -0,0 +1,50 @@
+module Thredded
+  class ApplicationController < ::ApplicationController
+    helper Thredded::Engine.helpers
+    helper_method :messageboard, :topic, :preferences
+
+    rescue_from CanCan::AccessDenied do |exception|
+      flash[:error] = exception.message
+      redirect_to root_path
+    end
+
+    private
+
+    def current_ability
+      @current_ability ||= Ability.new(current_user)
+    end
+
+    def messageboard
+      if params.key? :messageboard_id
+        @messageboard ||= Messageboard.find(params[:messageboard_id])
+      end
+    end
+
+    def preferences
+      if current_user
+        @preferences ||= UserPreference.where(user_id: current_user.id).first
+      end
+    end
+
+    def topic
+      if messageboard
+        @topic ||= messageboard.topics.find(params[:topic_id])
+      end
+    end
+
+    def ensure_messageboard_exists
+      if messageboard.blank?
+        redirect_to thredded.root_path,
+          flash: { error: 'This messageboard does not exist.' }
+      end
+    end
+
+    def user_messageboard_preferences
+      @user_messageboard_preferences ||=
+        current_user
+          .thredded_messageboard_preferences
+          .where(messageboard_id: messageboard)
+          .first
+    end
+  end
+end

data/app/controllers/thredded/messageboards_controller.rb

@@ -0,0 +1,9 @@
+module Thredded
+  class MessageboardsController < ApplicationController
+    before_filter :messageboard, only: :show
+
+    def index
+      @messageboards = Messageboard.where(closed: false)
+    end
+  end
+end

data/app/controllers/thredded/posts_controller.rb

@@ -0,0 +1,86 @@
+module Thredded
+  class PostsController < ApplicationController
+    include TopicsHelper
+    load_and_authorize_resource only: [:index, :show]
+    before_filter :ensure_topic_exists
+    before_filter :pad_post, only: :create
+    helper_method :messageboard, :topic
+
+    def index
+      authorize! :read, topic
+
+      @post = messageboard.posts.build(topic: topic, filter: post_filter)
+      @posts = Post.where(topic_id: topic).page(page)
+      @read_status = UserTopicRead
+        .find_or_create_by_user_and_topic(current_user, topic, page)
+
+      if not_inside_topic_and_in_an_old_page?
+        redirect_to_later_page and return
+      else
+        UserTopicRead.update_read_status!(current_user, topic, page)
+      end
+    end
+
+    def create
+      topic.posts.create(params[:post])
+      redirect_to :back
+    end
+
+    def edit
+      authorize! :manage, post
+    end
+
+    def update
+      post.update_attributes(params[:post])
+      redirect_to messageboard_topic_posts_url(messageboard, topic)
+    end
+
+    private
+
+    def topic
+      @topic ||= messageboard.topics.find(params[:topic_id])
+    end
+
+    def post
+      @post ||= topic.posts.find(params[:id])
+    end
+
+    def post_filter
+      user_messageboard_preferences.try(:filter) || :markdown
+    end
+
+    def not_inside_topic_and_in_an_old_page?
+      !internal_to_topic? && page == 1 && @read_status.page > 1
+    end
+
+    def page
+      params[:page].nil? ? 1 : params[:page].to_i
+    end
+
+    def extra_data
+      %Q{data-latest-read=#{@read_status.post_id || 0}} if @read_status
+    end
+
+    def internal_to_topic?
+      referer = request.referer || ''
+      referer.include?("#{topic.id}?page=") || (!topic.slug.nil? && referer.include?("#{topic.slug}?page="))
+    end
+
+    def redirect_to_later_page
+      redirect_to messageboard_topic_posts_path(messageboard, topic, page: @read_status.page)
+    end
+
+    def pad_post
+      params[:post][:ip] = request.remote_ip
+      params[:post][:user] = current_user
+      params[:post][:messageboard] = messageboard
+    end
+
+    def ensure_topic_exists
+      if topic.blank?
+        redirect_to default_home,
+          flash: { error: 'This topic does not exist.' }
+      end
+    end
+  end
+end

data/app/controllers/thredded/preferences_controller.rb

@@ -0,0 +1,20 @@
+module Thredded
+  class PreferencesController < ApplicationController
+    helper_method :preference
+
+    def edit
+    end
+
+    def update
+      preference.update_attributes(params[:messageboard_preference])
+
+      redirect_to :back, flash: { notice: 'Your preferences are updated' }
+    end
+
+    def preference
+      @preference ||= MessageboardPreference
+        .where(messageboard_id: messageboard.id, user_id: current_user.id)
+        .first_or_create!
+    end
+  end
+end

data/app/controllers/thredded/private_topics_controller.rb

@@ -0,0 +1,25 @@
+module Thredded
+  class PrivateTopicsController < ApplicationController
+    before_filter :ensure_messageboard_exists
+
+    def new
+      @private_topic = messageboard.private_topics.build
+      @private_topic.posts.build(
+        filter: current_user.try(:post_filter)
+      )
+
+      unless can? :create, @private_topic
+        error = 'Sorry, you are not authorized to post on this messageboard.'
+        redirect_to messageboard_topics_url(messageboard),
+          flash: { error: error }
+      end
+    end
+
+    def create
+      params[:topic][:user_id] << current_user.id
+      merge_default_topics_params
+      @private_topic = PrivateTopic.create(params[:topic])
+      redirect_to messageboard_topics_url(messageboard)
+    end
+  end
+end

data/app/controllers/thredded/setups_controller.rb

@@ -0,0 +1,39 @@
+module Thredded
+  class SetupsController < ApplicationController
+    def new
+      @messageboard = Messageboard.new
+    end
+
+    def create
+      messageboard_params = params[:messageboard]
+      @messageboard = Messageboard.create(messageboard_params)
+
+      if @messageboard.valid?
+        @messageboard.add_member(current_user, 'admin')
+        @messageboard.topics.create(topic_params)
+
+        redirect_to root_path
+      else
+        render action: :new
+      end
+    end
+
+    private
+
+    def topic_params
+      {
+        user: current_user,
+        last_user: current_user,
+        title: "Welcome to your messageboard's very first thread",
+        posts_attributes: {
+          '0' => {
+            content: "There's not a whole lot here for now.",
+            user: current_user,
+            ip: '127.0.0.1',
+            messageboard: @messageboard
+          }
+        }
+      }
+    end
+  end
+end

data/app/controllers/thredded/topics_controller.rb

@@ -0,0 +1,121 @@
+module Thredded
+  class TopicsController < ApplicationController
+    before_filter :ensure_messageboard_exists
+
+    def index
+      if cannot? :read, messageboard
+        error = 'You are not authorized access to this messageboard.'
+        redirect_to default_home, flash: { error: error }
+      end
+
+      @sticky = get_sticky_topics
+      @topics = get_topics
+      @tracked_user_reads = UserTopicRead.statuses_for(current_user, @topics)
+    end
+
+    def search
+      @topics = get_search_results
+      @tracked_user_reads = UserTopicRead.statuses_for(current_user, @topics)
+
+      if @topics.empty?
+        error = 'No topics found for this search.'
+        redirect_to messageboard_topics_path(messageboard), flash: { error: error }
+      end
+    end
+
+    def new
+      @topic = messageboard.topics.build
+      @topic.posts.build( filter: user_messageboard_preferences.try(:filter) )
+
+      unless can? :create, @topic
+        error = 'Sorry, you are not authorized to post on this messageboard.'
+        redirect_to messageboard_topics_url(messageboard),
+          flash: { error: error }
+      end
+    end
+
+    def by_category
+      @sticky = get_sticky_topics
+      @topics = get_topics_by_category params[:category_id]
+      @category_name = Category.find(params[:category_id]).name
+    end
+
+    def create
+      @topic = messageboard.topics.create(topic_params)
+      redirect_to messageboard_topics_path(messageboard)
+    end
+
+    def edit
+      authorize! :update, topic
+    end
+
+    def update
+      params.deep_merge!({
+        topic: {
+          user: current_user,
+          last_user: current_user
+        }
+      })
+
+      topic.update_attributes(params[:topic])
+      redirect_to messageboard_topic_posts_url(messageboard, topic)
+    end
+
+    private
+
+    def topic
+      if messageboard
+        @topic ||= messageboard.topics.find(params[:id])
+      end
+    end
+
+    def topic_params
+      params[:topic].deep_merge!({
+        last_user: current_user,
+        user: current_user,
+        posts_attributes: {
+          '0' => {
+            messageboard: messageboard,
+            ip: request.remote_ip,
+            user: current_user,
+          }
+        }
+      })
+    end
+
+    def get_search_results
+      Topic.full_text_search(params[:q], messageboard)
+    end
+
+    def get_topics_by_category(category_id)
+      topics = Category.find(category_id)
+        .topics
+        .unstuck
+        .for_messageboard(messageboard)
+        .order_by_updated
+        .on_page(params[:page])
+    end
+
+    def get_topics
+      Topic
+        .unstuck
+        .for_messageboard(messageboard)
+        .order_by_updated.on_page(params[:page])
+    end
+
+    def get_sticky_topics
+      if on_first_topics_page?
+        Topic
+          .stuck
+          .for_messageboard(messageboard)
+          .order('id DESC')
+      else
+        []
+      end
+    end
+
+    def on_first_topics_page?
+      params[:page].nil? || params[:page] == '1'
+    end
+  end
+end