thredded-workgroup 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f28a842a59d912a9783e4e78221ac3e69be33e5f1591c1f797775b0b9a484edd
+  data.tar.gz: ffbe48d420241715d23dbaa34d2a6a71734c10c256532454d57d5e178e71ca66
+SHA512:
+  metadata.gz: ce3484294af2edbe09f9bff0952b528c3714dee4b72623c55e7eab7375c25f9ec745a7cd9a7c7f2fcc0dc7bac4c06a4d1653312c5b3c8099ffb8aef41db52594
+  data.tar.gz: f4c04872bbed1da6e80ef89e2d6dafda15ca070b8fc408d0a19f75110bd5eb2841f83c69449ad177cb0a4d3ae654ac05ef608572e80db9768d59a17adf3295b6

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+*.gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+spec/dummy/public/uploads
+spec/dummy/db/schema.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop

@@ -0,0 +1 @@
+-D

data/.rubocop.yml

@@ -0,0 +1,65 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+  - 'spec/dummy/db/**/*'
+  - 'vendor/**/*'
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 125
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ModuleLength:
+  Exclude:
+  - spec/**/*_spec.rb
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/PredicateName:
+  Exclude:
+  - spec/**/*.rb
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+Rails/Date:
+  EnforcedStyle: strict
+
+Rails/FindBy:
+  Enabled: true
+  Include:
+  - app/commands/**/*.rb
+  - app/models/**/*.rb
+  - app/view_models/**/*.rb
+
+Lint/EndAlignment:
+  AutoCorrect: true

data/.travis.yml

@@ -0,0 +1,45 @@
+# use travis defaults from capybara-webkit
+sudo: required
+dist: trusty
+
+addons:
+  apt:
+    sources:
+    - ubuntu-sdk-team
+    packages:
+    - libqt5webkit5-dev
+    - qtdeclarative5-dev
+
+language: ruby
+rvm:
+  - 2.3
+#  - 2.4 # not till rails 4.2.8 is released
+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
+
+env:
+  global:
+    - QMAKE=/usr/lib/x86_64-linux-gnu/qt5/bin/qmake
+  matrix:
+    # Username and password from http://docs.travis-ci.com/user/database-setup/
+    - DB=sqlite3 DBC_VERBOSE=true
+    #  - DB=mysql2     DB_USERNAME=root     DB_PASSWORD=""
+    - DB=postgresql DB_USERNAME=postgres DB_PASSWORD=""
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - env: DB=sqlite3 DBC_VERBOSE=true
+
+before_script:
+  - RAILS_ENV=test bundle exec rake db:create db:migrate
+
+script:
+  - xvfb-run bundle exec rspec
+  - bundle show rubocop
+  - bundle exec rubocop

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tim@red56.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# if you switch rails version gemfile:
+#     bundle update rails json rails-i18n
+eval_gemfile File.expand_path("spec/gemfiles/rails_5_2.gemfile", File.dirname(__FILE__))

data/Guardfile

@@ -0,0 +1,77 @@
+# 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
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# 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
+
+# Guard-Rails supports a lot options with default values:
+# daemon: false                        # runs the server as a daemon.
+# debugger: false                      # enable ruby-debug gem.
+# environment: 'development'           # changes server environment.
+# force_run: false                     # kills any process that's holding the listen port before attempting
+#                                      #   to (re)start Rails.
+# pid_file: 'tmp/pids/[RAILS_ENV].pid' # specify your pid_file.
+# host: 'localhost'                    # server hostname.
+# port: 3000                           # server port number.
+# root: '/spec/dummy'                  # Rails' root path.
+# server: thin                         # webserver engine.
+# start_on_start: true                 # will start the server when starting Guard.
+# timeout: 30                          # waits untill restarting the Rails server, in seconds.
+# zeus_plan: server                    # custom plan in zeus, only works with `zeus: true`.
+# 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
+  watch("Gemfile.lock")
+  watch(%r{^(config|lib)/.*})
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tim Diggins
+
+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.md

@@ -0,0 +1,125 @@
+# Thredded::Workgroup
+
+Extension to [Thredded](http://github.com/thredded/thredded) with features useful to workgroup messaging (Unread,
+Unreplied, Following).
+
+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:
+
+<img width="898" alt="screenshot" src="https://cloud.githubusercontent.com/assets/18395/17519867/a07ca5e8-5e45-11e6-86e1-953fdc399168.png">
+
+
+## Installation
+
+Add this line to your application's Gemfile (along with thredded if you want to specify a specific fork):
+
+```ruby
+gem 'thredded-workgroup'
+```
+
+### Jquery 
+
+Since thredded v0.13.0, thredded doesn't need jquery, but thredded-workgroup (still) does.
+So you need to include jquery and its ujs file, for example in your Gemfile: 
+
+```ruby
+gem "jquery-rails"
+```
+ 
+__NB: (see below for using master vs a released version)__
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thredded-workgroup
+
+## Usage
+
+add to routes.rb (**instead** of mounting Thredded)
+
+```
+  mount Thredded::Workgroup::Engine => "/thredded"
+```
+
+You will also need to follow the guidelines for installing Thredded, see https://github
+.com/thredded/thredded#installation.
+
+If you use an application layout (see Add thredded styles to your `application.scss` (see https://github.com/thredded/thredded#application-layout) below for customizing the styles), you will need to  include thredded **and** thredded-workgroup:
+
+
+```scss
+@import "thredded";
+@import "thredded-workgroup";
+```
+
+Include thredded JavaScripts in your `application.js`:
+
+```js
+//= require thredded
+//= require jquery3  
+//= require jquery_ujs  
+//= require thredded-workgroup
+```
+
+## Master vs Released versions
+
+NB: if you are using the master version rather than a release version
+(and as no release has been made yet you must be! :) ) then you may well need
+also to use the latest master release of thredded. So your gem file may need to say:
+
+```ruby
+ gem 'thredded', github: 'thredded/thredded', branch: 'master'
+ gem 'thredded-workgroup', github: 'red56/thredded-workgroup', branch: 'master'
+```
+
+and you need to update both at the same time: `gem update thredded thredded-workgroup`
+
+In the future we will be releasing thredded-workgroup versions soon after thredded versions.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Then create a database and seed it (this is all very similar to Thredded)
+
+```
+bundle exec rake db:create db:migrate db:seed
+```
+
+Run the server
+
+```
+dummy-rails s -p 3012
+```
+
+### Updating when thredded changes
+
+For now, there are some copied resources from Thredded. When Thredded changes you need to update these too.
+You need to have thredded installed with a github reference (check shared.gemfile)
+
+run `bin/update_from_thredded`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/red56/thredded-workgroup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/RELEASE_CHECKLIST.md

@@ -0,0 +1,19 @@
+The checklist for releasing a new version of Thredded.
+
+Pre-requisites for the releaser:
+
+* The [gem-release gem](https://github.com/svenfuchs/gem-release): `gem install gem-release`.
+* Push access to RubyGems.
+
+Release checklist:
+
+- [ ] Update gem version in `version.rb` and `README.md`.
+- [ ] Update `CHANGELOG.md`. Ensure that the following link points to the future git tag for this version:
+  * [ ] The "See the full list of changes here" link.
+- [ ] Wait for the Travis build to come back green.
+- [ ] Tag the release and push it to rubygems:
+
+  ```bash
+  gem tag && gem release
+  ```
+- [ ] Copy the release notes from the changelog to [GitHub Releases](https://github.com/thredded/thredded/releases).