thredded 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ce9beaa49ff6dabd99f962836ab829e691de0bf
-  data.tar.gz: a2760f759370094628101ac41ab618a16f358393
+  metadata.gz: 9da3f257731b6397128563a35788225046e8a589
+  data.tar.gz: fc0b9d0117acd6de8c6d21fa1d3ff629e3e463e3
 SHA512:
-  metadata.gz: fa1e55d7ef10e1bfc8404746b7773bd3652c9f78b73ddb6300d698c32dd8f58f5ac09bf4eea6d0a4b84295e4d7d8efb50cbe0f5c6be0dbb28a8de80e89358c1b
-  data.tar.gz: be8da3f5f1ac118215a12b5122069b2c801c5e6941e8d8ec014cef9acdbb31f5ef09afb8185430e8287877983cf9e01bf6ec2daf9f0c26a3baeec06e3f2eca2a
+  metadata.gz: d811130638a892c28e07b2065f05b0c8e6edd8d2aabea59691dd0f5653424818978fd4bb2d0676875aa85110e9b58bacda911efc60c26ce4dd5bb53fefa306c6
+  data.tar.gz: b78b12a3e681153c4b82363b6334a5c09648e86910f17f8d997e4f53dac0cd84555a3141c83d7da20f885b4b532a385913703ad6ff8a36982cc7c4ecc91636d1

data/README.md

@@ -33,6 +33,49 @@ application and not an engine like Thredded.
 
 [Discourse]: http://www.discourse.org/
 
+Table of Contents
+=================
+
+* [Installation](#installation)
+  * [Creating a new Rails app with Thredded](#creating-a-new-rails-app-with-thredded)
+  * [Adding Thredded to an existing Rails app](#adding-thredded-to-an-existing-rails-app)
+  * [Upgrading an existing install](#upgrading-an-existing-install)
+  * [Migrating from Forem](#migrating-from-forem)
+* [Views and other assets](#views-and-other-assets)
+  * [Standalone layout](#standalone-layout)
+  * [Application layout](#application-layout)
+    * [Reference your paths so that Thredded can find them](#reference-your-paths-so-that-thredded-can-find-them)
+    * [Add Thredded styles](#add-thredded-styles)
+    * [Add Thredded JavaScripts](#add-thredded-javascripts)
+      * [jQuery version](#jquery-version)
+  * [User profile page](#user-profile-page)
+  * [Customizing views](#customizing-views)
+    * [View hooks](#view-hooks)
+  * [Theming](#theming)
+    * [Styles](#styles)
+* [Email and other notifications](#email-and-other-notifications)
+  * [Enabling auto-follow](#enabling-auto-follow)
+* [I18n](#i18n)
+* [Permissions](#permissions)
+  * [Permission methods](#permission-methods)
+    * [Reading messageboards](#reading-messageboards)
+    * [Posting to messageboards](#posting-to-messageboards)
+    * [Messaging other users (posting to private topics)](#messaging-other-users-posting-to-private-topics)
+    * [Moderating messageboards](#moderating-messageboards)
+    * [Admin permissions](#admin-permissions)
+  * [Default permissions](#default-permissions)
+  * [Handling "Permission denied" and "Not found" errors](#handling-permission-denied-and-not-found-errors)
+* [Moderation](#moderation)
+  * [Disabling moderation](#disabling-moderation)
+* [Plugins](#plugins)
+* [Development](#development)
+  * [Testing](#testing)
+  * [Ruby](#ruby)
+  * [JavaScript](#javascript)
+  * [Testing with all the databases and Rails versions locally.](#testing-with-all-the-databases-and-rails-versions-locally)
+  * [Developing and Testing with Docker Compose](#developing-and-testing-with-docker-compose)
+
+
 ## Installation
 
 ### Creating a new Rails app with Thredded
@@ -56,7 +99,7 @@ Then, see the rest of this Readme for more information about using and customizi
 Add the gem to your Gemfile:
 
 ```ruby
-gem 'thredded', '~> 0.11.0'
+gem 'thredded', '~> 0.12.0'
 ```
 
 Add the Thredded [initializer] to your parent app by running the install generator.
@@ -105,11 +148,11 @@ rails g thredded:install
 
 But then compare this with the previous version to decide what to keep.
 
-2) To upgrade the database (in this example from v0.9 to v0.10):
+2) To upgrade the database (in this example from v0.10 to v0.11):
 
 ```console
-# Note that for guaranteed best results you will want to run this with the gem checked out with v0.10.0
-cp `bundle show thredded`/db/upgrade_migrations/20170125033319_upgrade_v0_9_to_v0_10.rb db/migrate
+# Note that for guaranteed best results you will want to run this with the gem checked out with v0.11
+cp `bundle show thredded`/db/upgrade_migrations/20170312131417_upgrade_thredded_v0_10_to_v0_11.rb db/migrate
 rake db:migrate
 ```
 
@@ -150,9 +193,6 @@ In your layout you will probably have links to other paths in your app (e.g. nav
 For any url helpers (like `users_path` or `projects_path` or whatever) will need to have `main_app.`
 prefixed to them so that they can be found from thredded (`main_app.users_path` will work from both thredded and your app).
 
-However if you don't want to update your layouts and partials, you can define methods automatically to delegate to the main_app's routes:
-See https://gist.github.com/timdiggins/bf6d09b28828a392198562c93554ad07.
-
 #### Add Thredded styles
 
 In this case, you will also need to include Thredded styles and JavaScript into the application styles and JavaScript.
@@ -261,13 +301,13 @@ To see the complete list of view hooks and their arguments, run:
 grep view_hooks -R --include '*.html.erb' "$(bundle show thredded)"
 ```
 
-## Theming
+### Theming
 
 The engine comes by default with a light and effective implementation of the
 views, styles, and javascript. Once you mount the engine you will be presented
 with a "themed" version of thredded.
 
-### Styles
+#### Styles
 
 Thredded comes with a light Sass theme controlled by a handful of variables that can be found here:
 https://github.com/thredded/thredded/blob/master/app/assets/stylesheets/thredded/base/_variables.scss.
@@ -307,8 +347,18 @@ If you use [Rails Email Preview], you can include Thredded emails into the list
 
 [Rails Email Preview]: https://github.com/glebm/rails_email_preview
 
-You can also turn off the email notifier totally, or add other notifiers (e.g. Pushover, possibly Slack) by adjusting the
- `Thredded.notifiers` configuration in your initializer. See the default initializer for examples.
+You can also turn off the email notifier totally, or add other notifiers (e.g. Pushover, possibly Slack) by adjusting
+the `Thredded.notifiers` configuration in your initializer. See the default initializer for examples.
+
+### Enabling auto-follow
+
+In some cases, you'll want all users to auto-follow new messageboard topics by default. This might be useful
+for a team messageboard or a company announcements board, for example. To enable user auto-follow of new topics,
+run the following migration(s):
+
+```ruby
+change_column_default :thredded_user_preferences, :auto_follow_topics, 1
+```
 
 ## I18n
 
@@ -318,7 +368,7 @@ We welcome PRs adding support for new languages.
 
 Here are the steps to ensure the best support for your language if it isn't English:
 
-1. Add `rails-i18n` to your Gemfile.
+1. Add `rails-i18n` and `kaminari-i18n` to your Gemfile.
 
 2. Require the translations for rails-timeago in your JavaScript before `thredded` but after `jquery.timeago`
    (included in `thredded/dependencies`). E.g. for Brazilian Portuguese:
@@ -504,16 +554,6 @@ To disable moderation, e.g. if you run internal forums that do not need moderati
 change_column_default :thredded_user_details, :moderation_state, 1 # approved
 ```
 
-### Enabling auto-follow
-
-In some cases, you'll want all users to auto-follow new messageboard topics by default. This might be useful
-for a team messageboard or a company announcements board, for example. To enable user auto-follow of new topics,
-run the following migration(s):
-
-```ruby
-change_column_default :thredded_user_preferences, :auto_follow_topics, 1
-```
-
 ## Plugins
 
 The following official plugins are available for Thredded:
@@ -544,12 +584,18 @@ Then, start the dummy app server:
 rake dev:server
 ```
 
+### Testing
+
 To run the tests, just run `rspec`. The test suite will re-create the test database on every run, so there is no need to
 run tasks that maintain the test database.
 
 By default, SQLite is used in development and test. On Travis, the tests will run using SQLite, PostgreSQL, MySQL,
 and all the supported Rails versions.
 
+The test suite requires [PhantomJS](http://phantomjs.org) to be present in the path.
+To install it, run `sudo apt-get install phantomjs` on Ubuntu or Debian, or `brew install phantomjs` on Mac.
+For other operating systems, refer to the [PhantomJS documentation](http://phantomjs.org/download.html).
+
 ### Ruby
 
 Thredded Ruby code formatting is ensured by [Rubocop](https://github.com/bbatsov/rubocop). Run `rubocop -a` to ensure a
@@ -635,7 +681,7 @@ To test all combinations of supported databases and Rails versions, run:
 rake test_all
 ```
 
-## Developing and Testing with [Docker Compose](http://docs.docker.com/compose/)
+### Developing and Testing with [Docker Compose](http://docs.docker.com/compose/)
 
 To quickly try out _Thredded_ with the included dummy app, clone the source and
 start the included docker-compose.yml file with:

data/app/assets/javascripts/thredded/components/post_form.es6

@@ -1,6 +1,6 @@
 //= require ./preview_area
 
-(($) => {
+(($, autosize) => {
   const COMPONENT_SELECTOR = '[data-thredded-post-form]';
 
   class ThreddedPostForm {
@@ -18,11 +18,11 @@
     }
 
     autosize($textarea) {
-      $textarea.autosize()
+      autosize($textarea)
     }
 
     destroy($nodes) {
-      $nodes.find(this.textareaSelector).trigger('autosize.destroy');
+      autosize.destroy($nodes.find(this.textareaSelector));
     }
   }
 
@@ -39,4 +39,4 @@
       new ThreddedPostForm().destroy($nodes);
     }
   });
-})(jQuery);
+})(jQuery, window.autosize);

data/app/assets/javascripts/thredded/components/quote_post.es6

@@ -0,0 +1,45 @@
+(function() {
+  window.Thredded.onPageLoad(() => {
+    Array.prototype.forEach.call(document.querySelectorAll('[data-thredded-quote-post]'), (el) => {
+      el.addEventListener('click', onClick);
+    });
+  });
+
+  function onClick(evt) {
+    // Handle only left clicks with no modifier keys
+    if (evt.button !== 0 || evt.ctrlKey || evt.altKey || evt.metaKey || evt.shiftKey) return;
+    evt.preventDefault();
+    const target = document.getElementById('post_content');
+    target.scrollIntoView();
+    target.value = '...';
+    fetchReply(evt.target.getAttribute('data-thredded-quote-post'), (replyText) => {
+      if (!target.ownerDocument.body.contains(target)) return;
+      target.focus();
+      target.value = replyText;
+
+      const autosizeUpdateEvent = document.createEvent('Event');
+      autosizeUpdateEvent.initEvent('autosize:update', true, false);
+      target.dispatchEvent(autosizeUpdateEvent);
+      // Scroll into view again as the size might have changed.
+      target.scrollIntoView();
+    }, (errorMessage) => {
+      target.value = errorMessage;
+    });
+  }
+
+  function fetchReply(url, onSuccess, onError) {
+    const request = new XMLHttpRequest();
+    request.open('GET', url, /* async */ true);
+    request.onload = () => {
+      if (request.status >= 200 && request.status < 400) {
+        onSuccess(request.responseText);
+      } else {
+        onError(`Error (${request.status}): ${request.statusText} ${request.responseText}`);
+      }
+    };
+    request.onerror = () => {
+      onError('Network Error');
+    };
+    request.send();
+  }
+})();

data/app/assets/javascripts/thredded/components/topic_form.es6

@@ -1,4 +1,4 @@
-(($) => {
+(($, autosize) => {
   const COMPONENT_SELECTOR = '[data-thredded-topic-form]';
   class ThreddedTopicForm {
     constructor() {
@@ -15,7 +15,7 @@
     }
 
     init($nodes) {
-      $nodes.find(this.textareaSelector).autosize();
+      autosize($nodes.find(this.textareaSelector));
       $nodes.each(function() {
         new ThreddedPreviewArea($(this));
       });
@@ -47,7 +47,7 @@
     }
 
     destroy($nodes) {
-      $nodes.find(this.textareaSelector).trigger('autosize.destroy');
+      autosize.destroy($nodes.find(this.textareaSelector));
     }
   }
 
@@ -64,6 +64,6 @@
       new ThreddedTopicForm().destroy($nodes);
     }
   });
-})(jQuery);
+})(jQuery, window.autosize);
 
 

data/app/assets/javascripts/thredded/core/on_page_load.es6

@@ -26,6 +26,14 @@
   };
 
   if (isTurbolinks5) {
+    // In Turbolinks 5.0.1, turbolinks:load may have already fired (before DOMContentLoaded).
+    // If so, add our own DOMContentLoaded listener:
+    // See: https://github.com/turbolinks/turbolinks/commit/69d353ea73d10ee6b25c2866fc5706879ba403e3
+    if (window.Turbolinks.controller.lastRenderedLocation) {
+      document.addEventListener('DOMContentLoaded', () => {
+        triggerOnPageLoad();
+      });
+    }
     document.addEventListener('turbolinks:load', () => {
       triggerOnPageLoad();
     });

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

@@ -2,7 +2,7 @@
 // Require jquery.timeago instead of rails-timeago so that we can control the initialization.
 //= require jquery.timeago
 //= require jquery_ujs
-//= require jquery.autosize
+//= require autosize
 //= require jquery.textcomplete
 //= require select2
 

data/app/assets/stylesheets/thredded/_base.scss

@@ -5,6 +5,7 @@
 
 @import "base/alerts";
 @import "base/buttons";
+@import "base/dropdown-menu";
 @import "base/forms";
 @import "base/lists";
 @import "base/nav";

data/app/assets/stylesheets/thredded/_email.scss

@@ -21,14 +21,13 @@
   margin: 0;
 
   &--author {
-    margin-bottom: 1em;
+    margin-bottom: 2px;
   }
 
   .thredded--post--content {
     font-size: inherit;
-    border-left: solid 5px $thredded-blockquote-border-color;
     margin: 0 0 0.75rem;
-    padding: ($thredded-small-spacing / 2) $thredded-small-spacing;
+    padding-left: 0;
 
     .onebox-wrapper-table {
       width: 100%;

data/app/assets/stylesheets/thredded/base/_dropdown-menu.scss

@@ -0,0 +1,83 @@
+%thredded--dropdown-menu--container {
+  position: relative;
+  display: inline-block;
+  cursor: pointer;
+
+  &:hover {
+    %thredded--dropdown-menu--toggle {
+      color: $thredded-action-hover-color;
+    }
+
+    %thredded--dropdown-menu--actions {
+      transform: scale(1);
+      opacity: 1;
+    }
+  }
+}
+
+%thredded--dropdown-menu--toggle {
+  color: $thredded-action-color;
+}
+
+%thredded--dropdown-menu--actions {
+  position: absolute;
+  background-color: $thredded-overlay-background-color;
+  border-radius: 2px;
+  overflow: hidden;
+  min-width: 8.5rem;
+  z-index: 3;
+  cursor: pointer;
+  box-shadow: $thredded-overlay-box-shadow;
+  transform: scale(0);
+  opacity: 0;
+  transition: transform .3s cubic-bezier(.4, 0, .2, 1), opacity .2s cubic-bezier(.4, 0, .2, 1);
+  will-change: transform;
+}
+
+%thredded--dropdown-menu--actions-bottom-left {
+  @extend %thredded--dropdown-menu--actions;
+  right: 0;
+  transform-origin: 100% 0;
+}
+
+%thredded--dropdown-menu--actions-bottom-right {
+  @extend %thredded--dropdown-menu--actions;
+  left: 0;
+  transform-origin: 0 0;
+}
+
+%thredded--dropdown-menu--actions--item,
+// This specific selector protects from global button rules
+form.button_to > %thredded--dropdown-menu--actions--item {
+  // Override potential global rules
+  background: none;
+  border-radius: 0;
+  border: 0;
+  box-sizing: border-box;
+  font: inherit;
+  margin: 0;
+  text-align: left;
+  transition: none;
+  width: 100%;
+
+  font-size: $thredded-font-size-small;
+  color: $thredded-text-color;
+  text-decoration: none;
+  padding: 1rem 0.75rem;
+  display: block;
+  white-space: nowrap;
+
+  &:active,
+  &:focus,
+  &:hover {
+    background-color: $thredded-button-background;
+    color: $thredded-button-color;
+    text-decoration: none;
+    cursor: pointer;
+  }
+
+  &:active,
+  &:focus {
+    outline: none;
+  }
+}

data/app/assets/stylesheets/thredded/components/_post.scss

@@ -7,6 +7,7 @@
 }
 
 .thredded--post--dropdown--toggle {
+  @extend %thredded--dropdown-menu--toggle;
   fill: currentColor;
   box-sizing: content-box;
   color: $thredded-action-color;
@@ -22,76 +23,20 @@
 }
 
 .thredded--post--dropdown {
-  position: relative;
-  display: inline-block;
+  @extend %thredded--dropdown-menu--container;
   float: right;
-  cursor: pointer;
   @media print {
     display: none;
   }
 }
 
 .thredded--post--dropdown--actions {
-  position: absolute;
+  @extend %thredded--dropdown-menu--actions-bottom-left;
   margin-top: -0.875rem;
-  right: 0;
-  background-color: $thredded-overlay-background-color;
-  border-radius: 2px;
-  overflow: hidden;
-  min-width: 10rem;
-  z-index: 1;
-  cursor: pointer;
-  box-shadow: $thredded-overlay-box-shadow;
-  transform: scale(0);
-  opacity: 0;
-  transform-origin: 100% 0;
-  transition: transform .3s cubic-bezier(.4, 0, .2, 1), opacity .2s cubic-bezier(.4, 0, .2, 1);
-  will-change: transform;
-}
-
-.thredded--post--dropdown--actions--item,
-// This specific selector protects from global button rules
-form.button_to > .thredded--post--dropdown--actions--item {
-  // Override potential global rules
-  background: none;
-  border-radius: 0;
-  border: 0;
-  box-sizing: border-box;
-  font: inherit;
-  margin: 0;
-  text-align: left;
-  transition: none;
-  width: 100%;
-
-  font-size: $thredded-font-size-small;
-  color: $thredded-text-color;
-  text-decoration: none;
-  padding: 1rem 0.75rem;
-  display: block;
-  white-space: nowrap;
-
-  &:active,
-  &:focus,
-  &:hover {
-    background-color: $thredded-button-background;
-    color: $thredded-button-color;
-    text-decoration: none;
-    cursor: pointer;
-  }
-
-  &:active,
-  &:focus {
-    outline: none;
-  }
-}
-
-.thredded--post--dropdown:hover .thredded--post--dropdown--actions {
-  transform: scale(1);
-  opacity: 1;
 }
 
-.thredded--post--dropdown:hover .thredded--post--dropdown--toggle {
-  color: $thredded-action-hover-color;
+.thredded--post--dropdown--actions--item {
+  @extend %thredded--dropdown-menu--actions--item;
 }
 
 .thredded--post--avatar {

data/app/assets/stylesheets/thredded/components/_preferences.scss

@@ -1,6 +1,19 @@
-.thredded--preferences-header {
-  &--title {
-    @extend %thredded--heading;
-    font-size: 1.5rem; // 24px
+.thredded--preferences--title {
+  @extend %thredded--heading;
+  font-size: 1.5rem; // 24px
+}
+
+.thredded--preferences--form {
+  padding-bottom: $thredded-base-spacing;
+}
+
+.thredded--preferences--messageboards-nav {
+  border-top: $thredded-base-border;
+  padding-top: $thredded-base-spacing;
+}
+
+.thredded--preferences--messageboards-nav--item {
+  &.thredded--messageboard {
+    padding: $thredded-small-spacing;
   }
 }

data/app/assets/stylesheets/thredded/layout/_main-navigation.scss

@@ -18,12 +18,15 @@
 
   li {
     display: block;
-    font-weight: bold;
 
     a {
       display: block;
     }
 
+    @include thredded-media-tablet-and-down {
+      font-weight: bold;
+    }
+
     @include thredded-media-mobile {
       a {
         position: relative;

data/app/assets/stylesheets/thredded/layout/_search-navigation.scss

@@ -1,9 +1,10 @@
 .thredded--navigation--search {
-  margin-right: 0;
+  $input-padding-x: 0.75rem;
+
+  margin: 0;
   padding: 0;
   position: absolute;
   top: 0;
-  right: 0;
 
   @include thredded-media-tablet-and-down {
     position: initial;
@@ -20,16 +21,15 @@
 
     @include thredded-media-desktop-and-up {
       $line-height: 1rem;
-      $padding-x: 0.75rem;
       background: transparent;
       border-color: transparent;
       font-size: $thredded-font-size-small;
       line-height: $line-height;
       min-width: 13rem;
-      text-align: right;
       width: auto;
-      padding: 0.9375rem 0.75rem 0.875rem 0.75rem;
-      margin: -1px (-$padding-x) 0 0;
+      padding: 0.9375rem $input-padding-x 0.875rem $input-padding-x;
+      margin-top: -1px;
+      margin-bottom: 0;
 
       &, &:focus {
         transition: background, border-color, box-shadow, min-width 0.15s ease-out 0s;
@@ -39,6 +39,7 @@
         background: $thredded-background-color;
         box-shadow: none;
         margin-right: 0;
+        margin-left: 0;
         min-width: 16rem;
         text-align: left;
       }
@@ -98,4 +99,28 @@
   @media print {
     display: none;
   }
+
+  // On the left:
+  right: auto;
+  left: 0;
+  @include thredded-media-desktop-and-up {
+    input[type="search"] {
+      text-align: left;
+      margin-right: 0;
+      margin-left: -$input-padding-x;
+    }
+  }
+
+  // On the right:
+  &--right {
+    right: 0;
+    left: auto;
+    @include thredded-media-desktop-and-up {
+      input[type="search"] {
+        text-align: right;
+        margin-right: -$input-padding-x;
+        margin-left: 0;
+      }
+    }
+  }
 }

data/app/assets/stylesheets/thredded/layout/_user-navigation.scss

@@ -1,5 +1,6 @@
 .thredded--user-navigation {
   @extend %thredded--nav-tabs;
+  text-align: right;
   @media print {
     display: none;
   }

data/app/controllers/concerns/thredded/new_post_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Thredded
+  # @api private
+  module NewPostParams
+    protected
+
+    def new_post_params
+      params.fetch(:post, {})
+        .permit(:content, :quote_post_id)
+        .merge(ip: request.remote_ip).tap do |p|
+        quote_id = p.delete(:quote_post_id)
+        if quote_id
+          post = Post.find(quote_id)
+          authorize_reading post
+          p[:quote_post] = post
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/thredded/new_private_post_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Thredded
+  # @api private
+  module NewPrivatePostParams
+    protected
+
+    def new_private_post_params
+      params.fetch(:post, {})
+        .permit(:content, :quote_private_post_id)
+        .merge(ip: request.remote_ip).tap do |p|
+        quote_id = p.delete(:quote_private_post_id)
+        if quote_id
+          post = PrivatePost.find(quote_id)
+          authorize_reading post
+          p[:quote_post] = post
+        end
+      end
+    end
+  end
+end