thredded 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdc0bf6e1d3f247baed2faa7a7a4250f28d8f86a
-  data.tar.gz: f0b738be8742980e4758c9f4514eb75439f77e2c
+  metadata.gz: 2c6816b0184d085f43b52bbccd55cb54423d3533
+  data.tar.gz: 8a454d07c634eb9fa25836a8722c4a340b1a078d
 SHA512:
-  metadata.gz: 7e2d79cc9507fe73ce4fd3c373bb0517da2e4cd1147a347a16c2653453a903f4d7de8ae0ee4ea070cc3004afea220de682ae489a964ffe98669b351368fbf553
-  data.tar.gz: 07cf1575cd4cf81cd5eb601a709ce556183cf0e54f3f03f67d58bfbe4b43a43fb2aa50eab19650fea02d8910237e2654759c5a7bd1fc5d3aa79fcff69bd939c0
+  metadata.gz: b81ea1816ea5cf2d24b45636336bd47565e7dd7197ed89f365ae845502b5050784b8ff02506ad6cc4a678fd2bf3c214cd689387233aa98aa575110a856a026f8
+  data.tar.gz: f5ff0cfccb540a68da5670085b0f380b988edc37b05aee2f3fc35099ff123cca1f88ea67dd91db391f77fc62bc938fa08851b9317ac6ce3e176d65b64a5541ce

data/CHANGELOG.mkdn

@@ -1,5 +1,68 @@
 # MASTER
 
+## Fixed
+
+* TBD
+
+## Added
+
+* TBD
+
+## Changed
+
+* TBD
+
+
+# 0.3.0 - 2016-04-22
+
+Thredded now supports Rails 4.2+ only.
+
+Thredded now also fully supports the latest Rails 5 beta, but currently this requires using master versions of certain
+gems. See [rails_5_0.gemfile](https://github.com/thredded/thredded/blob/master/spec/gemfiles/rails_5_0.gemfile)
+for more information.
+
+## Fixed
+
+* (Private)Topic slugs re-generate at appropriate time
+  [28c09f4](https://github.com/thredded/thredded/commit/28c09f40804d3a71bbc12c56819a8acab3c94f2d)
+* Editing topics and private message subjects. [#235](https://github.com/thredded/thredded/pull/235)
+* Require login for `PrivateTopicsController`.
+  [5739f5](https://github.com/thredded/thredded/commit/5739f50a513377392205a41958b5a2d3ca25dc10)
+* Current user method now configurable via initializer.
+  [#234](https://github.com/thredded/thredded/pull/234)
+* Pagination and possible route conflicts throughout. [#202](https://github.com/thredded/thredded/pull/202)
+* Redirects to the correct page after posting a reply. [#205](https://github.com/thredded/thredded/pull/205)
+* Search with special `by:user` and `in:category` qualifiers. [#206](https://github.com/thredded/thredded/pull/206)
+* Private topics now validate presence of at least one user other than the creator. [#207](https://github.com/thredded/thredded/pull/207)
+* "Not found" and "Permission denied" errors now render with the correct response codes. [#208](https://github.com/thredded/thredded/pull/208)
+* Thredded user associations are now correctly nullified / destroyed when a user is destroyed in the parent app.
+
+## Added
+
+* Dummy App renamed to "Thredded Demo" and demo deployed to Heroku
+* Added vimeo and youtube auto-embed support. [#216](https://github.com/thredded/thredded/pull/216)
+* Ability to delete posts. [#214](https://github.com/thredded/thredded/pull/214)
+* Global search across all messageboards. [#215](https://github.com/thredded/thredded/pull/215)
+* Global notification settings, message notification settings. [#210](https://github.com/thredded/thredded/pull/210)
+* Private topic user select now looks prettier and loads the user via AJAX, instead of generating a huge select with all
+  the users. [#199](https://github.com/thredded/thredded/pull/199).
+* The theme is now more customizable thanks to a number of fixes and new variables. [#197](https://github.com/thredded/thredded/pull/197)
+* The topic read state is now visually updated on click. [#198](https://github.com/thredded/thredded/pull/198)
+* Email preview classes are now provided. [#196](https://github.com/thredded/thredded/pull/196).
+* I18n'd a *bunch* of static copy. (Thanks @glebm!)
+
+## Changed
+
+* Navigation layout/design updated [ec699fd](https://github.com/thredded/thredded/commit/ec699fd)
+* Changed from using Bbcode OR Markdown to *both*, simultaneously.
+  [#221](https://github.com/thredded/thredded/pull/221)
+* Removed Timecop in favor of built-in rails `travel_to` helper.
+  [#226](https://github.com/thredded/thredded/pull/226)
+* Moved from CanCanCan to Pundit. [#228](https://github.com/thredded/thredded/pull/228)
+* Renamed "Private Topics" to "Private Messages"
+* Renamed `$thredded-base-font-color` to `$thredded-text-color`.
+* Renamed `$thredded-base-background-color` to `$thredded-background-color`.
+
 # 0.2.2 - 2016-04-04
 
 ## Fixed

data/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -C ./spec/dummy/config/puma.heroku.rb

data/README.mkdn

@@ -1,6 +1,6 @@
-# Thredded [![Code Climate](https://codeclimate.com/github/thredded/thredded/badges/gpa.svg)](https://codeclimate.com/github/thredded/thredded) [![Travis-CI](https://api.travis-ci.org/thredded/thredded.svg?branch=master)](https://travis-ci.org/thredded/thredded/) [![Test Coverage](https://codeclimate.com/github/thredded/thredded/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded/coverage) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/thredded/thredded?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# Thredded [![Code Climate](https://codeclimate.com/github/thredded/thredded/badges/gpa.svg)](https://codeclimate.com/github/thredded/thredded) [![Travis-CI](https://api.travis-ci.org/thredded/thredded.svg?branch=master)](https://travis-ci.org/thredded/thredded/) [![Test Coverage](https://codeclimate.com/github/thredded/thredded/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded/coverage) [![Gitter](https://badges.gitter.im/thredded/thredded.svg)](https://gitter.im/thredded/thredded?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Stories in Ready](https://badge.waffle.io/thredded/thredded.svg?label=ready&title=waffle.io)](http://waffle.io/thredded/thredded)
 
-_Thredded_ is a Rails 4.1+ forum/messageboard engine. Its goal is to be as simple and feature rich as possible.
+_Thredded_ is a Rails 4.2+ forum/messageboard engine. Its goal is to be as simple and feature rich as possible.
 
 Some of the features currently in Thredded:
 
@@ -22,8 +22,15 @@ Planned features:
 
 <img src="http://emoji.fileformat.info/gemoji/point_up.png" width="24"> If you are so inclined, donating to the project will help aid in its development
 
-[Discourse]: http://www.discourse.org/
-[Forem]: https://www.github.com/radar/forem
+
+| ![screenshot-messageboards] | ![screenshot-topics] |
+|----------------------------|----------------------------|
+| ![screenshot-topic]  | ![screenshot-new-private-topic-dark] |
+
+[screenshot-messageboards]: https://cloud.githubusercontent.com/assets/216339/14379803/d608d782-fd73-11e5-9d8e-1f282ea66fab.png
+[screenshot-topics]: https://cloud.githubusercontent.com/assets/216339/14379804/d77db060-fd73-11e5-9a4a-9376ca409756.png
+[screenshot-topic]: https://cloud.githubusercontent.com/assets/216339/14379805/d8ecf32a-fd73-11e5-8734-b7faa8b264ee.png 
+[screenshot-new-private-topic-dark]: https://cloud.githubusercontent.com/assets/216339/14379806/da716a1e-fd73-11e5-90f1-6dbdb708d3d5.png
 
 Thredded works with SQLite, MySQL (v5.6.4+), and PostgreSQL. Thredded has no infrastructure
 dependencies other than the database and, if configured in the parent application, the ActiveJob
@@ -33,6 +40,9 @@ support JRuby and Rubinius as well.
 If you're looking for variations on a theme - see [Forem] and [Discourse]. Forem is also an engine,
 while Discourse is a full app.
 
+[Discourse]: http://www.discourse.org/
+[Forem]: https://github.com/rubysherpas/forem
+
 ## Installation
 
 Add the gem to your Gemfile:
@@ -80,8 +90,24 @@ Include thredded JavaScripts in your `application.js`:
 //= require thredded
 ```
 
+You also may want to add an index to the user name column in your users table.
+Thredded uses it to find @-mentions and perform name prefix autocompletion on the private topic form.
+Add the index in a migration like so:
+
+```ruby
+DbTextSearch::CaseInsensitive.add_index(
+    connection, Thredded.user_class.table_name, Thredded.user_name_column, unique: true)
+```
+
 [initializer]: https://github.com/thredded/thredded/blob/master/lib/generators/thredded/install/templates/initializer.rb
 
+### Migrating from Forem
+
+Using [Forem]? Thredded provides [a migration][forem-to-thredded] to copy all your existing forums from Forem over
+to Thredded.
+
+[forem-to-thredded]: https://github.com/thredded/thredded/wiki/Migrate-from-Forem
+
 ## Theming
 
 The engine comes by default with a light and effective implementation of the
@@ -139,6 +165,14 @@ Whenever possible, use the styles and i18n to customize Thredded to your needs.
 Thredded views also provide two content_tags available to yield - `:thredded_page_title` and `:thredded_page_id`.
 The views within Thredded pass those up through to your layout if you would like to use them.
 
+### Emails
+
+Thredded sends several notification emails to the users. You can override in the same way as the views.
+If you use [Rails Email Preview], you can include Thredded emails into the list of previews by adding
+`Thredded::BaseMailerPreview.preview_classes` to the [Rails Email Preview] `preview_classes` config option.
+
+[Rails Email Preview]: https://github.com/glebm/rails_email_preview
+
 ## Permissions
 
 Thredded comes with a flexible permissions system that can be configured per messageboard/user.
@@ -259,7 +293,7 @@ Below is an overview of the default permissions, with links to the implementatio
   <td align="center"><a href="https://github.com/thredded/thredded/blob/master/app/models/thredded/user_permissions/write/none.rb">
     ❌ No
   </a></td>
-  <td align="center"><a href="https://github.com/thredded/thredded/blob/master/app/models/thredded/user_permissions/message/none.rb">
+  <td align="center"><a href="https://github.com/thredded/thredded/blob/master/app/models/thredded/user_permissions/message/readers_of_writeable_boards.rb">
     ❌ No
   </a></td>
   <td align="center"><a href="https://github.com/thredded/thredded/blob/master/app/models/thredded/user_permissions/moderate/none.rb">
@@ -274,7 +308,7 @@ Below is an overview of the default permissions, with links to the implementatio
 
 ### Handling "Permission denied"
 
-Thredded defines a number of Exception classes that you can `[rescue_from]` in your `ApplicationController`
+Thredded defines a number of Exception classes that you can [`rescue_from`][rescue_from] in your `ApplicationController`
 to handle permission denied errors.
 
 These are:
@@ -290,17 +324,6 @@ Currently, the default behaviour is to redirect to the forums root page with a f
 
 [rescue_from]: http://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html
 
-## Rails 4.1 and ActiveJob Support
-
-If you're currently using Rails 4.1 make sure to add ...
-
-```ruby
-gem 'activejob_backport'
-```
-
-... to your Gemfile. ActiveJob is now the main background job abstraction layer in Thredded. 
-It was not introduced to rails until 4.2 so you'll need the backport to provide the support for it.
-
 ## Development
 
 To be more clear - this is the for when you are working on *this* gem.
@@ -310,9 +333,8 @@ First, to get started, migrate and seed the database (SQLite by default):
 
 ```bash
 bundle
-rake db:migrate
-# Seed the development database with fake forum users, topics, and posts:
-rake dev:seed
+# Create, migrate, and seed the development database with fake forum users, topics, and posts:
+rake db:create db:migrate db:seed
 ```
 
 Then, start the dummy app server:

data/app/assets/images/thredded/private-messages.svg

@@ -0,0 +1,4 @@
+<svg height="32" viewBox="0 0 24 24" width="32" xmlns="http://www.w3.org/2000/svg">
+    <path d="M0 0h24v24H0z" fill="none"/>
+    <path d="M20 4H4c-1.1 0-1.99.9-1.99 2L2 18c0 1.1.9 2 2 2h16c1.1 0 2-.9 2-2V6c0-1.1-.9-2-2-2zm0 14H4V8l8 5 8-5v10zm-8-7L4 6h16l-8 5z"/>
+</svg>

data/app/assets/images/thredded/settings.svg

@@ -0,0 +1,4 @@
+<svg height="48" viewBox="0 0 24 24" width="32" xmlns="http://www.w3.org/2000/svg">
+    <path d="M0 0h24v24H0z" fill="none"/>
+    <path d="M19.43 12.98c.04-.32.07-.64.07-.98s-.03-.66-.07-.98l2.11-1.65c.19-.15.24-.42.12-.64l-2-3.46c-.12-.22-.39-.3-.61-.22l-2.49 1c-.52-.4-1.08-.73-1.69-.98l-.38-2.65C14.46 2.18 14.25 2 14 2h-4c-.25 0-.46.18-.49.42l-.38 2.65c-.61.25-1.17.59-1.69.98l-2.49-1c-.23-.09-.49 0-.61.22l-2 3.46c-.13.22-.07.49.12.64l2.11 1.65c-.04.32-.07.65-.07.98s.03.66.07.98l-2.11 1.65c-.19.15-.24.42-.12.64l2 3.46c.12.22.39.3.61.22l2.49-1c.52.4 1.08.73 1.69.98l.38 2.65c.03.24.24.42.49.42h4c.25 0 .46-.18.49-.42l.38-2.65c.61-.25 1.17-.59 1.69-.98l2.49 1c.23.09.49 0 .61-.22l2-3.46c.12-.22.07-.49-.12-.64l-2.11-1.65zM12 15.5c-1.93 0-3.5-1.57-3.5-3.5s1.57-3.5 3.5-3.5 3.5 1.57 3.5 3.5-1.57 3.5-3.5 3.5z"/>
+</svg>

data/app/assets/javascripts/thredded.es6

@@ -1,10 +1,2 @@
-// We are not currently using any features that require the Babel polyfill
-// Enable this if we do:
-//- require babel/polyfill
-
-//= require jquery
-//= require jquery_ujs
-//= require jquery.autosize
-//= require rails-timeago
-//= require select2
-//= require_tree ./thredded
+//= require thredded/dependencies
+//= require thredded/thredded

data/app/assets/javascripts/thredded/{topic_form.es6 → components/topic_form.es6}

@@ -2,7 +2,7 @@
   const COMPONENT_SELECTOR = '[data-thredded-topic-form]';
   class ThreddedTopicForm {
     constructor() {
-      this.titleSelector = '[data-thredded-topic-form-title]';
+      this.titleSelector = '[name$="topic[title]"]';
       this.textareaSelector = 'textarea';
       this.compactSelector = 'form.thredded--is-compact';
       this.expandedSelector = 'form.thredded--is-expanded';

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

@@ -0,0 +1,37 @@
+(function($) {
+  const COMPONENT_SELECTOR = '[data-thredded-topics]';
+
+  const TOPIC_SELECTOR = 'article';
+  const TOPIC_LINK_SELECTOR = 'h1 a';
+  const TOPIC_UNREAD_CLASS = 'thredded--topic-unread';
+  const TOPIC_READ_CLASS = 'thredded--topic-read';
+  const POSTS_COUNT_SELECTOR = '.thredded--topics--posts-count';
+  const POSTS_PER_PAGE = 50;
+
+  function pageNumber(url) {
+    const match = url.match(/\/page-(\d)$/);
+    return match ? +match[1] : 1;
+  }
+
+  function totalPages(numPosts) {
+    return Math.ceil(numPosts / POSTS_PER_PAGE);
+  }
+
+  class ThreddedTopics {
+    init($nodes) {
+      $nodes.on('click', TOPIC_LINK_SELECTOR, (evt) => {
+        const $topic = $(evt.target).closest(TOPIC_SELECTOR);
+        if (pageNumber($topic.find('a').prop('href')) == totalPages(+$topic.find(POSTS_COUNT_SELECTOR).text())) {
+          $topic.addClass(TOPIC_READ_CLASS).removeClass(TOPIC_UNREAD_CLASS);
+        }
+      });
+    }
+  }
+
+  $(function() {
+    var $nodes = $(COMPONENT_SELECTOR);
+    if ($nodes.length) {
+      new ThreddedTopics().init($nodes);
+    }
+  });
+})(jQuery);

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

@@ -0,0 +1,45 @@
+(function($) {
+  const COMPONENT_SELECTOR = '[data-thredded-user-preferences-form]';
+  const NOTIFY_ON_MENTION_SELECTOR = ':checkbox[name="user_preferences_form[notify_on_mention]"]';
+  const MESSAGEBOARD_NOTIFY_ON_MENTION_SELECTOR = '[name="user_preferences_form[messageboard_notify_on_mention]"]';
+
+  class UserPreferencesForm {
+    constructor(form) {
+      this.$form = $(form);
+      this.$notifyOnMention = this.$form.find(NOTIFY_ON_MENTION_SELECTOR);
+      this.$messageboardNotifyOnMention = this.$form.find(MESSAGEBOARD_NOTIFY_ON_MENTION_SELECTOR);
+
+      this.messageboardNotifyOnMentionCheckedWas = this.$messageboardNotifyOnMention.prop('checked');
+      this.$messageboardNotifyOnMention.on('change', () => {
+        this.rememberMessageboardNotifyOnMentionChecked();
+      });
+      this.rememberMessageboardNotifyOnMentionChecked();
+
+      this.$notifyOnMention.on('change', () => {
+        this.updateMessageboardNotifyOnMention();
+      });
+      this.updateMessageboardNotifyOnMention();
+    }
+
+    rememberMessageboardNotifyOnMentionChecked() {
+      this.messageboardNotifyOnMentionCheckedWas =
+        this.$messageboardNotifyOnMention.filter(':checkbox').prop('checked');
+    }
+
+    updateMessageboardNotifyOnMention() {
+      const enabled = this.$notifyOnMention.prop('checked');
+      this.$messageboardNotifyOnMention
+        .prop('disabled', !enabled)
+        .filter(':checkbox').prop('checked', enabled ? this.messageboardNotifyOnMentionCheckedWas : false);
+    }
+  }
+
+  $(function() {
+    const $forms = $(COMPONENT_SELECTOR);
+    if ($forms.length) {
+      $forms.each(function() {
+        new UserPreferencesForm(this);
+      });
+    }
+  });
+})(jQuery);

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

@@ -0,0 +1,56 @@
+($ => {
+  const COMPONENT_SELECTOR = '[data-thredded-users-select]';
+
+
+  let formatUser = (user, container, query, escapeHtml) => {
+    if (user.loading) return user.text;
+    return "<div class='thredded--select2-user-result'>" +
+      `<img class='thredded--select2-user-result__avatar' src='${escapeHtml(user.avatar_url)}' >` +
+      `<span class='thredded--select2-user-result__name'>${escapeHtml(user.name)}</span>` +
+      '</div>';
+  };
+
+  let formatUserSelection = (user, container, escapeHtml) => {
+    return `<span class='thredded--select2-user-selection'>` +
+      `<img class='thredded--select2-user-selection__avatar' src='${escapeHtml(user.avatar_url)}' >` +
+      `<span class='thredded--select2-user-selection__name'>${escapeHtml(user.name)}</span>` +
+      '</span>';
+  };
+
+  let initSelection = ($el, callback) => {
+    let ids = ($el.val() || '').split(',');
+    if (ids.length && ids[0] != '') {
+      $.ajax(`${$el.data('autocompleteUrl')}?ids=${ids.join(',')}`, {dataType: 'json'}).done(data => callback(data.results));
+    } else {
+      callback([]);
+    }
+  };
+
+  let init = $el => {
+    $el.select2({
+      ajax: {
+        cache: true,
+        data: query => ({q: query}),
+        results: data => data,
+        dataType: 'json',
+        url: $el.data('autocompleteUrl')
+      },
+      containerCssClass: 'thredded--select2-container',
+      dropdownCssClass: 'thredded--select2-drop',
+      initSelection: initSelection,
+      minimumInputLength: 2,
+      multiple: true,
+      formatResult: formatUser,
+      formatSelection: formatUserSelection
+    });
+  };
+
+  $(function() {
+    var $nodes = $(COMPONENT_SELECTOR);
+    if ($nodes.length) {
+      $nodes.each(function() {
+        init($(this));
+      });
+    }
+  });
+})(jQuery);

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

@@ -0,0 +1,9 @@
+//= require jquery
+//= require jquery_ujs
+//= require jquery.autosize
+//= require rails-timeago
+//= require select2
+
+// We are not currently using any features that require the Babel polyfill
+// Enable this if we do:
+//- require babel/polyfill

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

@@ -0,0 +1 @@
+//= require_tree ./components

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

@@ -3,9 +3,10 @@
 @import "base/variables";
 
 @import "base/alerts";
-@import "base/grid";
-@import "base/typography";
 @import "base/buttons";
 @import "base/forms";
+@import "base/grid";
 @import "base/lists";
+@import "base/nav";
 @import "base/tables";
+@import "base/typography";

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

@@ -6,10 +6,13 @@
 
   @import "layout/main-container";
   @import "layout/main-navigation";
-  @import "layout/topic-navigation";
+  @import "layout/search-navigation";
   @import "layout/user-navigation";
+  @import "layout/navigation";
 
   @import "components/base";
+  @import "components/alerts";
+  @import "components/icons";
   @import "components/currently-online";
   @import "components/empty";
   @import "components/flash-message";

data/app/assets/stylesheets/thredded/base/_buttons.scss

@@ -20,7 +20,8 @@
   &:hover,
   &:focus {
     background-color: $thredded-button-hover-background;
-    color: #fff;
+    color: $thredded-button-hover-color;
+    text-decoration: none;
   }
 
   &:focus {

data/app/assets/stylesheets/thredded/base/_forms.scss

@@ -1,6 +1,27 @@
+%thredded--form--input {
+  background: $thredded-form-background;
+  border: $thredded-form-border;
+  box-shadow: $thredded-form-box-shadow;
+  color: $thredded-form-color;
+  font-family: $thredded-base-font-family;
+  font-size: $thredded-base-font-size;
+  padding: $thredded-small-spacing;
+  transition: border-color;
+
+  &:hover {
+    border-color: $thredded-form-border-hover-color;
+  }
+
+  &:focus {
+    border-color: $thredded-form-border-focus-color;
+    box-shadow: $thredded-form-box-shadow, 0 0 3px $thredded-action-color;
+    outline: none;
+  }
+}
+
 %thredded--form {
   fieldset {
-    background-color: lighten($thredded-base-border-color, 10%);
+    background-color: $thredded-background-color;
     border: $thredded-base-border;
     margin: 0 0 $thredded-small-spacing;
     padding: $thredded-base-spacing;
@@ -30,25 +51,9 @@
   [type='color'], [type='date'], [type='datetime'], [type='datetime-local'], [type='email'], [type='month'],
   [type='number'], [type='password'], [type='search'], [type='tel'], [type='text'], [type='time'], [type='url'],
   [type='week'], input:not([type]), textarea, select[multiple=multiple] {
-    background-color: $thredded-base-background-color;
-    border: $thredded-form-border;
-    box-shadow: $thredded-form-box-shadow;
+    @extend %thredded--form--input;
     box-sizing: border-box;
-    font-family: $thredded-base-font-family;
-    font-size: $thredded-base-font-size;
-    padding: $thredded-small-spacing;
-    transition: border-color;
     width: 100%;
-
-    &:hover {
-      border-color: darken($thredded-base-border-color, 10%);
-    }
-
-    &:focus {
-      border-color: $thredded-action-color;
-      box-shadow: $thredded-form-box-shadow, 0 0 3px $thredded-action-color;
-      outline: none;
-    }
   }
 
   textarea {