thredded-workgroup 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f28a842a59d912a9783e4e78221ac3e69be33e5f1591c1f797775b0b9a484edd
-  data.tar.gz: ffbe48d420241715d23dbaa34d2a6a71734c10c256532454d57d5e178e71ca66
+  metadata.gz: 9a0ab82d41aae76941edf568459bf45471392759127d829d60888928533a4172
+  data.tar.gz: 403e83fd21a8474449b76603a2e5b440a31d9343342e49d5c1d6b73c4e453203
 SHA512:
-  metadata.gz: ce3484294af2edbe09f9bff0952b528c3714dee4b72623c55e7eab7375c25f9ec745a7cd9a7c7f2fcc0dc7bac4c06a4d1653312c5b3c8099ffb8aef41db52594
-  data.tar.gz: f4c04872bbed1da6e80ef89e2d6dafda15ca070b8fc408d0a19f75110bd5eb2841f83c69449ad177cb0a4d3ae654ac05ef608572e80db9768d59a17adf3295b6
+  metadata.gz: 22785389999e14d50d95690d6ee294eb42d3c4aed6a7b5178ac7c6bbd8b6dda2647cb1b2639ac53f6eef4ea087f6650288a9b7d1bb27f5955fa553e4f43ae067
+  data.tar.gz: d14a0f0b1462ee26104ec6159bfbea68de2495004754e99176b2cc8b9376a653d6dfaa04a037bf283771f64e79fd706dc0c57559a847768d6d5077f467d9517a

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from:
+  - .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.3
   Exclude:
@@ -10,6 +12,9 @@ Metrics/AbcSize:
 Metrics/ClassLength:
   Max: 125
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/factories/*'
 Metrics/LineLength:
   Max: 120
 
@@ -29,10 +34,10 @@ Style/CollectionMethods:
 Style/Documentation:
   Enabled: false
 
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Style/PredicateName:
+Naming/PredicateName:
   Exclude:
   - spec/**/*.rb
 
@@ -42,7 +47,10 @@ Style/SignalException:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
   Enabled: false
 
 Style/TrailingCommaInArguments:
@@ -61,5 +69,5 @@ Rails/FindBy:
   - app/models/**/*.rb
   - app/view_models/**/*.rb
 
-Lint/EndAlignment:
+Layout/EndAlignment:
   AutoCorrect: true

data/.rubocop_todo.yml

@@ -0,0 +1,170 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-10-11 18:46:51 +0100 using RuboCop version 0.59.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/OrderedGems:
+  Exclude:
+    - 'shared.gemfile'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'thredded-workgroup.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'spec/dummy/app/controllers/application_controller.rb'
+    - 'spec/dummy/app/controllers/concerns/store_location_fullpath.rb'
+    - 'spec/support/features/fake_content.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/LeadingCommentSpace:
+  Exclude:
+    - 'shared.gemfile'
+
+# Offense count: 1
+# Configuration parameters: MaximumRangeSize.
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'thredded-workgroup.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/UnneededCopDisableDirective:
+  Exclude:
+    - 'thredded-workgroup.gemspec'
+
+# Offense count: 11
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 169
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Rails/ApplicationRecord:
+  Exclude:
+    - 'spec/dummy/app/models/user.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: slashes, arguments
+Rails/FilePath:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: app/controllers/**/*.rb
+Rails/LexicallyScopedActionFilter:
+  Exclude:
+    - 'app/controllers/thredded/workgroup/navs_controller.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: compact, expanded
+Style/EmptyMethod:
+  Exclude:
+    - 'spec/support/authentication_support.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'thredded-workgroup.gemspec'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'Rakefile'
+    - 'bin/rails.rb'
+    - 'spec/gemfiles/rails_5_0.gemfile'
+    - 'spec/gemfiles/rails_5_1.gemfile'
+    - 'spec/gemfiles/rails_5_2.gemfile'
+    - 'spec/spec_helper.rb'
+    - 'thredded-workgroup.gemspec'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'shared.gemfile'
+    - 'spec/gemfiles/rails_5_0.gemfile'
+    - 'spec/gemfiles/rails_5_1.gemfile'
+    - 'spec/gemfiles/rails_5_2.gemfile'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'spec/features/user_clicks_to_follow_unfollow_topic_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'Guardfile'
+    - 'Rakefile'
+    - 'lib/thredded/workgroup/engine.rb'
+    - 'spec/dummy/config/application.rb'
+    - 'spec/dummy/config/initializers/assets.rb'
+    - 'spec/dummy/config/routes.rb'
+    - 'spec/dummy/lib/themes.rb'
+    - 'spec/factories/thredded.rb'
+    - 'spec/support/features/fake_content.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
+# Whitelist: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/features/user_adds_post_and_is_redirected_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/StderrPuts:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 50
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'shared.gemfile'
+    - 'spec/gemfiles/rails_5_0.gemfile'
+    - 'spec/gemfiles/rails_5_1.gemfile'
+    - 'spec/gemfiles/rails_5_2.gemfile'
+    - 'thredded-workgroup.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/spec_helper.rb'

data/.travis.yml

@@ -12,12 +12,10 @@ addons:
 
 language: ruby
 rvm:
-  - 2.3
-#  - 2.4 # not till rails 4.2.8 is released
+  - 2.5
 cache: bundler
 bundler_args: --path ../../vendor/bundle --without debug
 gemfile:
-  - spec/gemfiles/rails_4_2.gemfile
   - spec/gemfiles/rails_5_0.gemfile
   - spec/gemfiles/rails_5_1.gemfile
   - spec/gemfiles/rails_5_2.gemfile
@@ -43,3 +41,5 @@ script:
   - xvfb-run bundle exec rspec
   - bundle show rubocop
   - bundle exec rubocop
+  - cp $BUNDLE_GEMFILE Gemfile.lock
+  - bundle exec bundle-audit check --update -v

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.2.1
+
+Support sprockets 4
+
+This version supports:
+ 
+ * thredded v0.16.0+
+ * rails 4.2 - 5.2
+
 # v0.2.0
 
 It's the first actual release (the theoretical v0.1.0 was only on github and never released as a gem)

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # if you switch rails version gemfile:

data/Guardfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # More info at https://github.com/guard/guard#readme
 
 ## Uncomment and set this to only include directories you want to watch
@@ -15,44 +16,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-guard "livereload" do
-  extensions = {
-    css: :css,
-    scss: :css,
-    sass: :css,
-    js: :js,
-    coffee: :js,
-    html: :html,
-    png: :png,
-    gif: :gif,
-    jpg: :jpg,
-    jpeg: :jpeg,
-    # less: :less, # uncomment if you want LESS stylesheets done in browser
-  }
-
-  rails_view_exts = %w(erb haml slim)
-
-  # file types LiveReload may optimize refresh for
-  compiled_exts = extensions.values.uniq
-  watch(%r{public/.+\.(#{compiled_exts * '|'})})
-
-  extensions.each do |ext, type|
-    watch(%r{
-          (?:app|vendor)
-          (?:/assets/\w+/(?<path>[^.]+) # path+base without extension
-           (?<ext>\.#{ext})) # matching extension (must be first encountered)
-          (?:\.\w+|$) # other extensions
-          }x) do |m|
-      path = m[1]
-      "/assets/#{path}.#{type}"
-    end
-  end
-
-  # file needing a full reload of the page anyway
-  watch(%r{app/views/.+\.(#{rails_view_exts * '|'})$})
-  watch(%r{app/helpers/.+\.rb})
-  watch(%r{config/locales/.+\.yml})
-end
+interactor :off unless ENV["GUARD_USE_INTERACTOR"]
 
 # Guard-Rails supports a lot options with default values:
 # daemon: false                        # runs the server as a daemon.
@@ -71,7 +35,20 @@ end
 # zeus: false                          # enables zeus gem.
 # CLI: 'rails server'                  # customizes runner command. Omits all options except `pid_file`!
 
-guard "rails", port: 3012, root: "spec/dummy" do
+host = ENV["UNSAFE_DEV"] ? "0.0.0.0" : "localhost"
+port = ENV["RAILS_S_PORT"]&.to_i || 3012
+guard "rails", host: host, port: port, root: "spec/dummy" do
   watch("Gemfile.lock")
   watch(%r{^(config|lib)/.*})
 end
+
+guard "livereload", port: ENV["LIVERELOAD_PORT"]&.to_i || 35_734 do
+  watch(%r{app/views/.+\.(erb|haml|slim)$})
+  watch(%r{app/helpers/.+\.rb})
+  watch(%r{public/.+\.(css|js|html)})
+  watch(%r{config/locales/.+\.yml})
+  # Rails Assets Pipeline
+  watch(%r{(app|vendor)/assets/\w+/(.+\.(js|html)).*}) { |m| "/assets/#{m[2]}" }
+  watch(%r{(app|vendor)/assets/\w+/(.+)\.scss.*}) { |m| "/assets/#{m[2]}.css" }
+  watch(%r{spec/javascripts/(.+\.js)}) { |m| "/assets/#{m[1]}" }
+end

data/README.md

@@ -1,22 +1,25 @@
 # Thredded::Workgroup
 
-Extension to [Thredded](http://github.com/thredded/thredded) with features useful to workgroup messaging (Unread,
-Unreplied, Following).
-
+Extension to [Thredded](http://github.com/thredded/thredded) with features useful to workgroup messaging.
+ 
+The point of Thredded-workgroup is to enable migration of workgroup communication from non-shared email to shared opt-in communications -- everyone can see any of the workgroup communications.
+     
 originated in https://github.com/thredded/thredded/issues/347
 
 Out the box enables a homepage with a top-level nav menu consisting of:
 
 * Unread: a list of unread topics (ordered by last post) across all messageboards
-* Following: a list of followed topics (ordered by last post) across all messageboards
 * Awaiting reply: a list of all topics you follow where yours is the last post
-* All topics: a list of all topics (ordered by last post) across all messageboards
-* All messageboards: a list of messageboards (as present)
-
-It adds a navbar like this:
+* Following: a list of followed topics (ordered by last post) across all messageboards
+* All: a list of all topics (ordered by last post) across all messageboards
+* Messageboards: a list of messageboards (as Thredded's normal home page)
 
-<img width="898" alt="screenshot" src="https://cloud.githubusercontent.com/assets/18395/17519867/a07ca5e8-5e45-11e6-86e1-953fdc399168.png">
+![Screenshot of navbar](docs/navbar.png)
 
+It also shows you the followers of the current topic before you post, and allows you to remove unneeded followers. (The logic for this is that (unlike a social forum) you need to broadcast as little as possible (because the aim is to reduce unnecessary noise, because people can find messages they need to). When you are adding to a topic it may become less relevant to existing followers. The person adding the message is able to adjust followers,
+like you might adjust the cc-list of conversation).
+     
+![Screenshot of post form](docs/followers-above-post.png)
 
 ## Installation
 
@@ -73,6 +76,19 @@ Include thredded JavaScripts in your `application.js`:
 //= require thredded-workgroup
 ```
 
+### Configuration
+
+**Reveal on hover?** The last topic shown in the thredded workflow top level pages is by default condensed when too long and revealed by click. You can also have it reveal on hover. This requires adding a data attribute in the layout (e.g. the body, or another high container element), as <div data-thredded-condensable-hover="reveal">. You can preview this behaviour in the demo, by adding `?hover=reveal` to the url.
+
+### View hooks
+
+Thredded::Workgroup augments Thredded with some extra view hooks (see https://github.com/thredded/thredded/#view-hooks) for customization.
+
+To see the extra view hooks provided by Thredded::Workgroup (with their arguments), run:
+
+```bash
+grep view_hooks -R --include '*.html.erb' "$(bundle show thredded-workgroup)"
+```
 ## Master vs Released versions
 
 NB: if you are using the master version rather than a release version
@@ -104,8 +120,9 @@ bundle exec rake db:create db:migrate db:seed
 Run the server
 
 ```
-dummy-rails s -p 3012
+guard
 ```
+(you can alternatively run `dummy-rails s -p 3012` but guard runs livereload for you too, which makes development much more pleasant)
 
 ### Updating when thredded changes
 

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 begin
   require "bundler/setup"
   require "bundler/gem_tasks"

data/app/assets/config/thredded_workgroup_manifest.js

@@ -0,0 +1,3 @@
+//= link thredded-workgroup.js
+//= link thredded-workgroup.scss
+//= link_tree ../images/ .svg

data/app/assets/images/thredded/workgroup/envelope-o.svg

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<svg width="1792" height="1792" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1664 1504v-768q-32 36-69 66-268 206-426 338-51 43-83 67t-86.5 48.5-102.5 24.5h-2q-48 0-102.5-24.5t-86.5-48.5-83-67q-158-132-426-338-37-30-69-66v768q0 13 9.5 22.5t22.5 9.5h1472q13 0 22.5-9.5t9.5-22.5zm0-1051v-24.5l-.5-13-3-12.5-5.5-9-9-7.5-14-2.5h-1472q-13 0-22.5 9.5t-9.5 22.5q0 168 147 284 193 152 401 317 6 5 35 29.5t46 37.5 44.5 31.5 50.5 27.5 43 9h2q20 0 43-9t50.5-27.5 44.5-31.5 46-37.5 35-29.5q208-165 401-317 54-43 100.5-115.5t46.5-131.5zm128-37v1088q0 66-47 113t-113 47h-1472q-66 0-113-47t-47-113v-1088q0-66 47-113t113-47h1472q66 0 113 47t47 113z"/></svg>

data/app/assets/images/thredded/workgroup/envelope-open-o.svg

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<svg width="1792" height="1792" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path d="M1474 913l39 51q8 11 6.5 23.5t-11.5 20.5q-43 34-126.5 98.5t-146.5 113-67 51.5q-39 32-60 48t-60.5 41-76.5 36.5-74 11.5h-2q-37 0-74-11.5t-76-36.5-61-41.5-60-47.5q-5-4-65-50.5t-143.5-111-122.5-94.5q-11-8-12.5-20.5t6.5-23.5l37-52q8-11 21.5-13t24.5 7q94 73 306 236 5 4 43.5 35t60.5 46.5 56.5 32.5 58.5 17h2q24 0 58.5-17t56.5-32.5 60.5-46.5 43.5-35q258-198 313-242 11-8 24-6.5t21 12.5zm190 719v-928q-90-83-159-139-91-74-389-304-3-2-43-35t-61-48-56-32.5-59-17.5h-2q-24 0-59 17.5t-56 32.5-61 48-43 35q-215 166-315.5 245.5t-129.5 104-82 74.5q-14 12-21 19v928q0 13 9.5 22.5t22.5 9.5h1472q13 0 22.5-9.5t9.5-22.5zm128-928v928q0 66-47 113t-113 47h-1472q-66 0-113-47t-47-113v-928q0-56 41-94 123-114 350-290.5t233-181.5q36-30 59-47.5t61.5-42 76-36.5 74.5-12h2q37 0 74.5 12t76 36.5 61.5 42 59 47.5q43 36 156 122t226 177 201 173q41 38 41 94z"/></svg>

data/app/assets/javascripts/thredded-workgroup.js

@@ -1,13 +1 @@
-// 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 any plugin's vendor/assets/javascripts directory 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
-// compiled file.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree ./thredded/workgroup
+//= require thredded/workgroup

data/app/assets/javascripts/thredded/workgroup/components/followers.es6

@@ -0,0 +1,24 @@
+(($) => {
+  function removeFollower($followerSelector) {
+    $followerSelector.remove();
+  }
+
+  function clickRemoveFollower(e) {
+    e.preventDefault();
+    e.stopPropagation();
+    var $this = $(this);
+    var $followerSelector = $this.closest('.thredded--follower');
+    var path = $this.data('kickPath');
+    $.ajax({
+      url: path, type: "POST", success: function (data) {
+        removeFollower($followerSelector);
+      }
+    });
+  }
+
+  const Thredded = window.Thredded;
+
+  Thredded.onPageLoad(() => {
+    $('.thredded--follower--remove').click(clickRemoveFollower);
+  });
+})(jQuery);