thredded-workgroup 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5efefc1d7010c94166f28b7c5eef2f1068aed1e7695b7b322e39a51456b6b46b
-  data.tar.gz: 7557fd4b245b16ccabfc6e2c1bacd5d93e2688ba222ddb424330774cbe38d9a8
+  metadata.gz: e900db2dd2e7b571e3d3fcb4fac889dbdb8d40d96902a2952b97cbf6bb09704f
+  data.tar.gz: 22794ff545fa54b6e0b26680ee53dacb5a472ccbe8658413534ea327344ddf47
 SHA512:
-  metadata.gz: b7c4da998f27f48915f3cc3c55fb85d34f62d754d9adb14e579faa9a88cf24b5932a2d270521955968a8557e3bb33f573f9f75f8fadce867248040a699075ec5
-  data.tar.gz: 4f596f4e2fe49ac827056557a7ec902f7686684ccde0db38c21470726118d12d6ecada6d0857e8906aaad26f00e66c59c4e29a8775b8aef21f726579c5de5342
+  metadata.gz: 67d6def354e8949bf6cff37ddbd360a96a6a9a40a01260ebb7691e400d806796815ab017355ce778de415c368edb7eecefc2fe34f4fbb8b50127b68917e9fc91
+  data.tar.gz: dc65476c53d44b297f13e5c1ca62309c6ec6436d9cfa90ee7f62e43d75b1b300226cae7b79a6be21f55617adaafea15192d6cab60943aeb7f41954161c62b08d

data/.gitignore

@@ -8,6 +8,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/node_modules
+yarn.lock
 log/*.log
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log

data/.travis.yml

@@ -2,11 +2,9 @@ dist: bionic
 
 language: ruby
 rvm:
-  - 2.6
+  - 2.7
 cache: bundler
 bundler_args: --path ../../vendor/bundle --without debug
-gemfile:
-  - spec/gemfiles/rails_5_2.gemfile
 
 jobs:
   fast_finish: true
@@ -14,21 +12,24 @@ jobs:
     - env: DB=sqlite3 DBC_VERBOSE=true
   include:
     - name: audit
-      gemfile: spec/gemfiles/rails_5_2.gemfile
+      gemfile: spec/gemfiles/rails_6_0.gemfile
       before_script: ""
       script:
         - bundle show rubocop
         - bundle exec rubocop
         - cp $BUNDLE_GEMFILE Gemfile.lock
         - bundle exec bundle-audit check --update -v
-    - gemfile: spec/gemfiles/rails_5_2.gemfile
-      rvm: 2.6
+    - gemfile: spec/gemfiles/rails_6_0.gemfile
+      rvm: 2.7
       env: DB=postgresql DB_USERNAME=postgres DB_PASSWORD=""
       services: postgresql
-    - gemfile: spec/gemfiles/rails_5_2.gemfile
-      rvm: 2.6
+    - gemfile: spec/gemfiles/rails_6_0.gemfile
+      rvm: 2.7
       env: DB=sqlite3 DBC_VERBOSE=true
 
+env:
+  global:
+    - THREDDED_TESTAPP_SPROCKETS_JS=1
 
 before_script:
   - RAILS_ENV=test bundle exec rake db:create db:migrate

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.4.0
+
+This version supports:
+
+* thredded v1.0 +
+* rails 6.0 (with zeitwerk)
+
 # v0.3.0, v0.3.1
 
 This version supports:

data/Gemfile

@@ -4,4 +4,4 @@ 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__))
+eval_gemfile File.expand_path("spec/gemfiles/rails_6_0.gemfile", File.dirname(__FILE__))

data/README.md

@@ -38,7 +38,7 @@ So you need to include jquery and its ujs file, for example in your Gemfile:
 gem "jquery-rails"
 ```
  
-__NB: (see below for using master vs a released version)__
+__NB: (see below for using main branch vs a released version)__
 
 And then execute:
 
@@ -89,15 +89,16 @@ To see the extra view hooks provided by Thredded::Workgroup (with their argument
 ```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
+## Main vs Released versions
+
+NB: if you are using the main branch 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:
+also to use the latest main branch 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'
+ gem 'thredded', github: 'thredded/thredded', branch: 'main'
+ gem 'thredded-workgroup', github: 'red56/thredded-workgroup', branch: 'main'
 ```
 
 and you need to update both at the same time: `gem update thredded thredded-workgroup`

data/app/controllers/concerns/thredded/workgroup/application_controller_retaining.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Thredded
+  module Workgroup
+    module ApplicationControllerRetaining
+      def topics_scope
+        return super if messageboard_or_nil
+
+        all_topics_scope
+      end
+
+      def unread_followed_topics_count
+        return super if messageboard_or_nil
+
+        all_unread_followed_topics_count
+      end
+    end
+  end
+end

data/app/controllers/concerns/thredded/workgroup/posts_controller_which_redirects.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Thredded
+  module Workgroup
+    module PostsControllerWhichRedirects
+      def create
+        @post_form = Thredded::PostForm.new(
+          user: thredded_current_user, topic: parent_topic, post_params: new_post_params
+        )
+        authorize_creating @post_form.post
+
+        if @post_form.save
+          # TODO: extract as a hook on thredded#posts_controller `after_create(post)`
+          redirect_after_create(@post_form.post)
+        else
+          render :new
+        end
+      end
+
+      private
+
+      def after_mark_as_unread
+        if post.private_topic_post?
+          redirect_to private_topics_path
+        else
+          redirect_to thredded_workgroup.unread_nav_path
+        end
+      end
+
+      def redirect_after_create(post)
+        UserTopicReadState.touch!(thredded_current_user.id, post)
+        if params[:post_referer].present?
+          redirect_to params[:post_referer], notice: generate_flash_for(post)
+        else
+          redirect_to thredded_workgroup.unread_nav_path, notice: generate_flash_for(post)
+        end
+      end
+
+      def generate_flash_for(post)
+        path_to_post = thredded.messageboard_topic_path(parent_topic.messageboard, parent_topic,
+                                                        anchor: "post_#{post.id}")
+        # rubocop:disable Rails/OutputSafety
+        "Successfully replied to #{view_context.link_to(parent_topic.title, path_to_post)}".html_safe
+        # rubocop:enable Rails/OutputSafety
+      end
+    end
+  end
+end

data/app/view_hooks/thredded/workgroup/view_hooks.rb

@@ -3,11 +3,8 @@
 module Thredded
   module Workgroup
     module ViewHooks
-      attr_reader :topic_with_last_post
-
-      def initialize
-        super
-        @topic_with_last_post = TopicWithLastPost.new
+      def topic_with_last_post
+        @topic_with_last_post ||= TopicWithLastPost.new
       end
 
       # View hooks for a Topic when displaying last post.

data/app/view_models/thredded/workgroup/topics_page_view_with_last_post.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Thredded
+  module Workgroup
+    module TopicsPageViewWithLastPost
+      protected
+
+      def refine_scope(topics_page_scope)
+        super.includes(:last_post)
+      end
+    end
+  end
+end

data/app/views/thredded/workgroup/topics/_topics_with_last_post.html.erb

@@ -6,7 +6,7 @@
   <% end %>
 
   <%= button_to t("thredded.nav.mark_all_read"),
-      mark_all_topics_read_path,
+      thredded_workgroup.mark_all_topics_read_path,
       class: 'thredded--button thredded--button-light thredded--button-wide',
       method: :put -%>
 

data/lib/overrides/thredded/all_view_hooks_override.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Thredded::AllViewHooks.class_eval do
+  include Thredded::Workgroup::ViewHooks
+end

data/lib/overrides/thredded/application_controller_override.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Thredded::ApplicationController.class_eval do
+  Rails.logger.debug "I am being evaled Thredded::ApplicationController"
+  include Thredded::Workgroup::AllUnreadFollowedTopics
+
+  prepend ::Thredded::Workgroup::ApplicationControllerRetaining
+end

data/lib/overrides/thredded/posts_controller_override.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Thredded::PostsController.class_eval do
+  prepend ::Thredded::Workgroup::PostsControllerWhichRedirects
+end

data/lib/overrides/thredded/topic_view_override.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Thredded::TopicView.class_eval do
+  def path
+    anchor = if @read_state.first_unread_post_page
+               "unread"
+             elsif @topic.last_post
+               "post_#{@topic.last_post.id}"
+             end
+    page = @read_state.first_unread_post_page || @read_state.last_read_post_page
+    Thredded::UrlsHelper.topic_path(@topic, page: page, anchor: anchor)
+  end
+
+  def reply_path
+    Thredded::UrlsHelper.topic_path(@topic, page: last_page, anchor: "new_post")
+  end
+
+  def mark_as_unread_path
+    Thredded::UrlsHelper.mark_as_unread_post_path(id: last_post.id, format: :json)
+  end
+
+  def mark_as_read_path
+    Thredded::UrlsHelper.mark_as_read_post_path(id: last_post.id, format: :json)
+  end
+
+  def last_page
+    (@topic.posts_count / Thredded.posts_per_page.to_f).ceil # TODO: doesn't account for visibility
+  end
+end

data/lib/overrides/thredded/topics_page_view_override.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Thredded::TopicsPageView.class_eval do
+  prepend ::Thredded::Workgroup::TopicsPageViewWithLastPost
+end

data/lib/thredded/workgroup/engine.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
 require "thredded/engine"
-require "thredded/workgroup/thredded_route_delegator"
-require "thredded/workgroup/route_delegator"
+
 module Thredded
   module Workgroup
     class Engine < ::Rails::Engine
       isolate_namespace Thredded::Workgroup
 
-      %w(app/controllers app/jobs app/view_models lib).each do |path|
-        config.autoload_paths << File.expand_path("../../#{path}", File.dirname(__FILE__))
+      # https://guides.rubyonrails.org/engines.html#overriding-models-and-controllers
+      overrides = root.join("lib/overrides")
+      # Rails::autoloaders.main.ignore(overrides)
+      config.to_prepare do
+        Dir.glob("#{overrides}/**/*_override.rb").each do |override|
+          Rails.logger.debug { "overriding: #{override}" }
+          load override
+        end
       end
 
       config.to_prepare do
         Rails.application.reload_routes!
-        ::Thredded::Workgroup::ThreddedRouteDelegator.add_thredded_proxies
-        ::Thredded::Workgroup::RouteDelegator.add_my_proxies_to_thredded
 
         Thredded::ApplicationController.module_eval do
           Thredded.view_hooks.post_form.content_text_area.config.before do |form:, **_args|

data/lib/thredded/workgroup/version.rb

@@ -2,6 +2,6 @@
 
 module Thredded
   module Workgroup
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/shared.gemfile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 gem "rake"
-gem "thredded", github: "thredded/thredded", branch: "master"
+gem "thredded", github: "thredded/thredded", branch: "main"
 
 unless ENV["TRAVIS"]
   group :development do
@@ -9,6 +9,8 @@ unless ENV["TRAVIS"]
     gem "guard-rails"
     gem "guard-livereload"
     gem "rack-livereload"
+    # TODO: drop this when launchy 2.5.2 is released (needed to get to Addressable 2.8)
+    gem "launchy", github: "copiousfreetime/launchy", branch: "main"
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thredded-workgroup
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Tim Diggins
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-26 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thredded
@@ -440,19 +440,15 @@ files:
 - app/assets/stylesheets/thredded/workgroup/_overflow.scss
 - app/assets/stylesheets/thredded/workgroup/_topics.scss
 - app/controllers/concerns/thredded/workgroup/all_unread_followed_topics.rb
-- app/controllers/thredded/application_controller.rb
-- app/controllers/thredded/posts_controller.rb
+- app/controllers/concerns/thredded/workgroup/application_controller_retaining.rb
+- app/controllers/concerns/thredded/workgroup/posts_controller_which_redirects.rb
 - app/controllers/thredded/workgroup/application_controller.rb
 - app/controllers/thredded/workgroup/navs_controller.rb
 - app/controllers/thredded/workgroup/read_states_controller.rb
 - app/controllers/thredded/workgroup/topics_controller.rb
-- app/helpers/thredded/application_helper.rb
-- app/helpers/thredded/workgroup/application_helper.rb
 - app/jobs/thredded/workgroup/mark_all_topics_read_job.rb
-- app/view_hooks/thredded/all_view_hooks.rb
 - app/view_hooks/thredded/workgroup/view_hooks.rb
-- app/view_models/thredded/topic_view.rb
-- app/view_models/thredded/topics_page_view.rb
+- app/view_models/thredded/workgroup/topics_page_view_with_last_post.rb
 - app/views/layouts/thredded/workgroup/application.html.erb
 - app/views/thredded/posts_common/form/_after_content.html.erb
 - app/views/thredded/shared/_header.html.erb
@@ -479,10 +475,13 @@ files:
 - config/routes.rb
 - docs/followers-above-post.png
 - docs/navbar.png
+- lib/overrides/thredded/all_view_hooks_override.rb
+- lib/overrides/thredded/application_controller_override.rb
+- lib/overrides/thredded/posts_controller_override.rb
+- lib/overrides/thredded/topic_view_override.rb
+- lib/overrides/thredded/topics_page_view_override.rb
 - lib/thredded/workgroup.rb
 - lib/thredded/workgroup/engine.rb
-- lib/thredded/workgroup/route_delegator.rb
-- lib/thredded/workgroup/thredded_route_delegator.rb
 - lib/thredded/workgroup/version.rb
 - script/create-db-users
 - script/dummy-console
@@ -507,7 +506,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Extension to Thredded with features for workgroup messaging (Unread, Unreplied,

data/app/controllers/thredded/application_controller.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require_dependency File.expand_path("../../app/controllers/thredded/application_controller",
-                                    Thredded::Engine.called_from)
-
-module Thredded
-  module ApplicationControllerRetaining
-    def topics_scope
-      return super if messageboard_or_nil
-      all_topics_scope
-    end
-
-    def unread_followed_topics_count
-      return super if messageboard_or_nil
-      all_unread_followed_topics_count
-    end
-  end
-  class ApplicationController
-    include Thredded::Workgroup::AllUnreadFollowedTopics
-
-    prepend ::Thredded::ApplicationControllerRetaining
-  end
-end

data/app/controllers/thredded/posts_controller.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require_dependency File.expand_path("../../app/controllers/thredded/posts_controller", Thredded::Engine.called_from)
-
-module Thredded
-  module PostsControllerWhichRedirects
-    def create
-      @post_form = Thredded::PostForm.new(
-        user: thredded_current_user, topic: parent_topic, post_params: new_post_params
-      )
-      authorize_creating @post_form.post
-
-      if @post_form.save
-        # TODO: extract as a hook on thredded#posts_controller `after_create(post)`
-        redirect_after_create(@post_form.post)
-      else
-        render :new
-      end
-    end
-
-    private
-
-    def after_mark_as_unread
-      if post.private_topic_post?
-        redirect_to private_topics_path
-      else
-        redirect_to thredded_workgroup.unread_nav_path
-      end
-    end
-
-    def redirect_after_create(post)
-      UserTopicReadState.touch!(thredded_current_user.id, post)
-      if params[:post_referer].present?
-        redirect_to params[:post_referer], notice: generate_flash_for(post)
-      else
-        redirect_to unread_nav_path, notice: generate_flash_for(post)
-      end
-    end
-
-    def generate_flash_for(post)
-      path_to_post = messageboard_topic_path(parent_topic.messageboard, parent_topic, anchor: "post_#{post.id}")
-      # rubocop:disable Rails/OutputSafety
-      "Successfully replied to #{view_context.link_to(parent_topic.title, path_to_post)}".html_safe
-      # rubocop:enable Rails/OutputSafety
-    end
-  end
-
-  class PostsController
-    prepend ::Thredded::PostsControllerWhichRedirects
-  end
-end

data/app/helpers/thredded/application_helper.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_dependency File.expand_path("../../app/helpers/thredded/application_helper", Thredded::Engine.called_from)
-module Thredded
-  module ApplicationHelper
-    #     include Thredded::Engine.routes.url_helpers
-    #     include Thredded::Workgroup::Engine.routes.url_helpers
-    #
-  end
-end

data/app/helpers/thredded/workgroup/application_helper.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Thredded
-  module Workgroup
-    module ApplicationHelper
-    end
-  end
-end

data/app/view_hooks/thredded/all_view_hooks.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require_dependency File.expand_path("../../app/view_hooks/thredded/all_view_hooks", Thredded::Engine.called_from)
-
-module Thredded
-  class AllViewHooks
-    prepend ::Thredded::Workgroup::ViewHooks
-  end
-end

data/app/view_models/thredded/topic_view.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_dependency File.expand_path("../../app/view_models/thredded/topic_view", Thredded::Engine.called_from)
-module Thredded
-  class TopicView < Thredded::BaseTopicView
-    def path
-      anchor = if @read_state.first_unread_post_page
-                 "unread"
-               elsif @topic.last_post
-                 "post_#{@topic.last_post.id}"
-               end
-      page = @read_state.first_unread_post_page || @read_state.last_read_post_page
-      Thredded::UrlsHelper.topic_path(@topic, page: page, anchor: anchor)
-    end
-
-    def reply_path
-      Thredded::UrlsHelper.topic_path(@topic, page: last_page, anchor: "new_post")
-    end
-
-    def mark_as_unread_path
-      Thredded::UrlsHelper.mark_as_unread_post_path(id: last_post.id, format: :json)
-    end
-
-    def mark_as_read_path
-      Thredded::UrlsHelper.mark_as_read_post_path(id: last_post.id, format: :json)
-    end
-
-    def last_page
-      (@topic.posts_count / Thredded.posts_per_page.to_f).ceil # TODO: doesn't account for visibility
-    end
-  end
-end

data/app/view_models/thredded/topics_page_view.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_dependency File.expand_path("../../app/view_models/thredded/topics_page_view", Thredded::Engine.called_from)
-module Thredded
-  module TopicsPageViewWithLastPost
-    protected
-
-    def refine_scope(topics_page_scope)
-      super.includes(:last_post)
-    end
-  end
-
-  class TopicsPageView
-    prepend ::Thredded::TopicsPageViewWithLastPost
-  end
-end

data/lib/thredded/workgroup/route_delegator.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# This includes this module into Thredded Application Controller so we can use
-# url helpers from Thredded PN like unread_nav_path in controllers.
-module Thredded
-  module Workgroup
-    module RouteDelegator
-      def self.add_my_proxies_to_thredded
-        thredded_methods = Thredded::Engine.routes.url_helpers.methods
-        my_route_helpers = Thredded::Workgroup::Engine.routes.url_helpers
-        path_methods = my_route_helpers.methods.select { |s| s.to_s.ends_with?("_path", "_url") }
-          .reject { |s| thredded_methods.include?(s) }
-        path_methods.each do |method_name|
-          send(:define_method, method_name) do |*args|
-            my_route_helpers.send(method_name, *args)
-          end
-        end
-        ::Thredded::ApplicationController.send(:include,
-                                               ::Thredded::Workgroup::RouteDelegator)
-        # if we need to use in views, then we add
-        # ::Thredded::ApplicationController.helper(::Thredded::Workgroup::RouteDelegator)
-      end
-    end
-  end
-end

data/lib/thredded/workgroup/thredded_route_delegator.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Thredded
-  module Workgroup
-    module ThreddedRouteDelegator
-      def self.add_thredded_proxies
-        thredded = Thredded::Engine.routes.url_helpers
-        path_methods = thredded.methods.select { |s| s.to_s.ends_with?("_path", "_url") }
-        path_methods.each do |method_name|
-          send(:define_method, method_name) do |*args|
-            thredded.send(method_name, *args)
-          end
-        end
-        ::Thredded::Workgroup::ApplicationController.helper(
-          ::Thredded::Workgroup::ThreddedRouteDelegator
-        )
-      end
-    end
-  end
-end