simple_discussion 0.9.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 834ccd97ab1cd0bbbe2aeade6fd0ca57dbbb9239
-  data.tar.gz: cdba66f70c1574b9cfca22c31d97f8004994ffd8
+SHA256:
+  metadata.gz: a6d8a256590a5124e9207664dbe478583fb9cf184f14f84703e147cbe5772d8f
+  data.tar.gz: 0d75642a89aeadb6157d20c2a7825b1c780d76edc165fc03010afc7eaaf1632f
 SHA512:
-  metadata.gz: 2efe0ca3c21542774ee8398cfaec7c5e3c03674c0976c42146769bc1762237f8d2d70dbd9700f25f6d11663665b8423e15903e2e4ef8a6d87b9fb75495514f4d
-  data.tar.gz: 0bd0377abdf023db1527498d353d819d30de644f19ff909cc6b3e74d774aa53119418f0677fd77cf64c13b83e817060b398511a13143dbeda7c9d74258405924
+  metadata.gz: a731f814d38e2b48455a0239745e2d896a7369c19fbeb595de4d60a003eac9238ecfbbe1674ce4c655bd85f7aaea68d88d0f9de542282af50469a378c58575bc
+  data.tar.gz: 150c26dc9b91a30c2e497bc01d72637ab8b75f3f7d4c6fe5ba644e21c86d001a5e1b4f232ea1484e76c82edd7aa95649b6476ce7b86cf46a38626dace2a2bc80

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [excid3] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+jobs:
+  sqlite:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0']
+        gemfile:
+          - rails_5_2
+          - rails_6
+          - rails_6_1
+          - rails_master
+        exclude:
+          - ruby: '3.0'
+            gemfile: 'rails_5_2'
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_PATH_RELATIVE_TO_CWD: true
+
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+      - name: StandardRb check
+        run: bundle exec standardrb
+      - name: Run tests
+        env:
+          DATABASE_URL: "sqlite3:noticed_test"
+          STRIPE_PRIVATE_KEY: ${{ secrets.STRIPE_PRIVATE_KEY }}
+        run: |
+          bin/rails db:test:prepare
+          bin/rails test

data/Appraisals

@@ -0,0 +1,16 @@
+appraise "rails-5-2" do
+  gem "rails", "~> 5.2.0"
+end
+
+appraise "rails-6" do
+  gem "rails", "~> 6.0.0"
+end
+
+appraise "rails-6-1" do
+  gem "rails", "~> 6.1.0"
+end
+
+appraise "rails-master" do
+  gem "rails", github: "rails/rails", branch: "main"
+  gem "devise", github: "ghiculescu/devise", branch: "patch-2"
+end

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+### Unreleased
+
+### 1.3.0
+
+* Drop gravatar dependency
+* Test against Rails 5.2, 6.0, 6.1, and Rails master
+* Fix nested layout rendering
+* Add dummy app for testing
+* Relax Font Awesome dependency
+
+### 1.2.0
+
+* Update to require Font Awesome 5.x+

data/Gemfile

@@ -1,6 +1,13 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in simple_discussion.gemspec
 gemspec
+
+gem "appraisal"
+gem "standardrb"
+
+gem "devise"
+gem "puma"
+gem "sqlite3"

data/README.md

@@ -1,8 +1,10 @@
-# SimpleDiscussion
+# SimpleDiscussion - Forum engine for Ruby on Rails
 
-SimpleDiscussion is a Rails forum gem extracting the [forum from GoRails](https://gorails.com/forum). It includes categories, simple moderation, the ability to mark threads as solved, and more.
+[![Build Status](https://github.com/excid3/simple_discussion/workflows/Tests/badge.svg)](https://github.com/excid3/simple_discussion/actions) [![Gem Version](https://badge.fury.io/rb/simple_discussion.svg)](https://badge.fury.io/rb/simple_discussion)
 
-Out of the box, SimpleDiscussion comes with styling for Boostrap v4 but you're free to customize the UI as much as you like by installing the views and tweaking the HTML.
+SimpleDiscussion is a Rails forum gem extracting the [GoRails forum](https://gorails.com/forum). It includes categories, simple moderation, the ability to mark threads as solved, and more.
+
+Out of the box, SimpleDiscussion comes with styling for Bootstrap v4 but you're free to customize the UI as much as you like by installing the views and tweaking the HTML.
 
 [![GoRails Forum](https://d3vv6lp55qjaqc.cloudfront.net/items/3j2p3o1j0d1O0R1w2j1Y/Screen%20Shot%202017-08-08%20at%203.12.01%20PM.png?X-CloudApp-Visitor-Id=51470&v=d439dcae)](https://d3vv6lp55qjaqc.cloudfront.net/items/3j2p3o1j0d1O0R1w2j1Y/Screen%20Shot%202017-08-08%20at%203.12.01%20PM.png?X-CloudApp-Visitor-Id=51470&v=d439dcae)
 

data/Rakefile

@@ -1,10 +1,32 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
 require "bundler/gem_tasks"
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "SimpleDiscussion"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
 end
 
-task :default => :test
+task default: :test

data/app/assets/stylesheets/simple_discussion.scss

@@ -20,8 +20,28 @@
 
 /* Formatting for the forum threads */
 .forum-thread {
-  h4 a {
-    color: #222;
+  margin-bottom: -20px;
+
+  h4 {
+    margin-bottom: 4px;
+
+    a {
+      color: #222;
+      font-size: 16px;
+      font-weight: normal;
+      line-height: 1.1;
+    }
+  }
+}
+
+.forum-thread-filters a {
+  color: #555555;
+  display: block;
+
+  &:hover {
+    color: #222222;
+    font-weight: bold;
+    text-decoration: none
   }
 }
 
@@ -45,6 +65,11 @@
     font-weight: 300;
     line-height: 1em;
   }
+
+  &:hover {
+    color: #222;
+    text-decoration: none;
+  }
 }
 
 /* Formatting for the forum posts themselves */
@@ -64,3 +89,16 @@
     border: 2px solid #5cb85c;
   }
 }
+
+/* Formatting for the forum hr to match card border */
+.simple_discussion hr {
+  border: 0;
+  border-top: 1px solid rgba(0, 0, 0, 0.125);
+  margin: 24px -20px;
+}
+
+.simple_discussion .text-muted {
+  color: #999;
+  margin-top: 6px;
+  font-size: 13px;
+}

data/app/controllers/simple_discussion/application_controller.rb

@@ -2,7 +2,7 @@ class SimpleDiscussion::ApplicationController < ::ApplicationController
   layout "simple_discussion"
 
   def page_number
-    page = params.fetch(:page, '').gsub(/[^0-9]/, '').to_i
+    page = params.fetch(:page, "").gsub(/[^0-9]/, "").to_i
     page = "1" if page.zero?
     page
   end
@@ -17,9 +17,21 @@ class SimpleDiscussion::ApplicationController < ::ApplicationController
   end
   helper_method :is_moderator?
 
-  def require_moderator_or_author!
+  def require_mod_or_author_for_post!
+    unless is_moderator_or_owner?(@forum_post)
+      redirect_to_root
+    end
+  end
+
+  def require_mod_or_author_for_thread!
     unless is_moderator_or_owner?(@forum_thread)
-      redirect_to simple_discussion.root_path, alert: "You aren't allowed to do that."
+      redirect_to_root
     end
   end
+
+  private
+
+  def redirect_to_root
+    redirect_to simple_discussion.root_path, alert: "You aren't allowed to do that."
+  end
 end

data/app/controllers/simple_discussion/forum_categories_controller.rb

@@ -9,9 +9,9 @@ class SimpleDiscussion::ForumCategoriesController < SimpleDiscussion::Applicatio
 
   private
 
-    def set_category
-      @category = ForumCategory.friendly.find(params[:id])
-    rescue ActiveRecord::RecordNotFound
-      redirect_to simple_discussion.forum_threads_path
-    end
+  def set_category
+    @category = ForumCategory.friendly.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    redirect_to simple_discussion.forum_threads_path
+  end
 end

data/app/controllers/simple_discussion/forum_posts_controller.rb

@@ -1,8 +1,9 @@
 class SimpleDiscussion::ForumPostsController < SimpleDiscussion::ApplicationController
   before_action :authenticate_user!
   before_action :set_forum_thread
-  before_action :set_forum_post, only: [:edit, :update]
-  before_action :require_moderator_or_author!, only: [:edit, :update, :solved, :unsolved]
+  before_action :set_forum_post, only: [:edit, :update, :destroy]
+  before_action :require_mod_or_author_for_post!, only: [:edit, :update, :destroy]
+  before_action :require_mod_or_author_for_thread!, only: [:solved, :unsolved]
 
   def create
     @forum_post = @forum_thread.forum_posts.new(forum_post_params)
@@ -27,6 +28,11 @@ class SimpleDiscussion::ForumPostsController < SimpleDiscussion::ApplicationCont
     end
   end
 
+  def destroy
+    @forum_post.destroy!
+    redirect_to simple_discussion.forum_thread_path(@forum_thread)
+  end
+
   def solved
     @forum_post = @forum_thread.forum_posts.find(params[:id])
 
@@ -48,19 +54,19 @@ class SimpleDiscussion::ForumPostsController < SimpleDiscussion::ApplicationCont
 
   private
 
-    def set_forum_thread
-      @forum_thread = ForumThread.friendly.find(params[:forum_thread_id])
-    end
+  def set_forum_thread
+    @forum_thread = ForumThread.friendly.find(params[:forum_thread_id])
+  end
 
-    def set_forum_post
-      if is_moderator?
-        @forum_post = @forum_thread.forum_posts.find(params[:id])
-      else
-        @forum_post = current_user.forum_posts.find(params[:id])
-      end
+  def set_forum_post
+    @forum_post = if is_moderator?
+      @forum_thread.forum_posts.find(params[:id])
+    else
+      current_user.forum_posts.find(params[:id])
     end
+  end
 
-    def forum_post_params
-      params.require(:forum_post).permit(:body)
-    end
+  def forum_post_params
+    params.require(:forum_post).permit(:body)
+  end
 end

data/app/controllers/simple_discussion/forum_threads_controller.rb

@@ -1,7 +1,7 @@
 class SimpleDiscussion::ForumThreadsController < SimpleDiscussion::ApplicationController
   before_action :authenticate_user!, only: [:mine, :participating, :new, :create]
   before_action :set_forum_thread, only: [:show, :edit, :update]
-  before_action :require_moderator_or_author!, only: [:edit, :update]
+  before_action :require_mod_or_author_for_thread!, only: [:edit, :update]
 
   def index
     @forum_threads = ForumThread.pinned_first.sorted.includes(:user, :forum_category).paginate(page: page_number)
@@ -23,7 +23,7 @@ class SimpleDiscussion::ForumThreadsController < SimpleDiscussion::ApplicationCo
   end
 
   def participating
-    @forum_threads = ForumThread.includes(:user, :forum_category).joins(:forum_posts).where(forum_posts: { user_id: current_user.id }).distinct(forum_posts: :id).sorted.paginate(page: page_number)
+    @forum_threads = ForumThread.includes(:user, :forum_category).joins(:forum_posts).where(forum_posts: {user_id: current_user.id}).distinct(forum_posts: :id).sorted.paginate(page: page_number)
     render action: :index
   end
 
@@ -39,7 +39,7 @@ class SimpleDiscussion::ForumThreadsController < SimpleDiscussion::ApplicationCo
 
   def create
     @forum_thread = current_user.forum_threads.new(forum_thread_params)
-    @forum_thread.forum_posts.each{ |post| post.user_id = current_user.id }
+    @forum_thread.forum_posts.each { |post| post.user_id = current_user.id }
 
     if @forum_thread.save
       SimpleDiscussion::ForumThreadNotificationJob.perform_later(@forum_thread)
@@ -54,7 +54,7 @@ class SimpleDiscussion::ForumThreadsController < SimpleDiscussion::ApplicationCo
 
   def update
     if @forum_thread.update(forum_thread_params)
-      redirect_to simple_discussion.forum_thread_path(@forum_thread), notice: "Your changes were saved."
+      redirect_to simple_discussion.forum_thread_path(@forum_thread), notice: I18n.t("your_changes_were_saved")
     else
       render action: :edit
     end
@@ -62,11 +62,11 @@ class SimpleDiscussion::ForumThreadsController < SimpleDiscussion::ApplicationCo
 
   private
 
-    def set_forum_thread
-      @forum_thread = ForumThread.friendly.find(params[:id])
-    end
+  def set_forum_thread
+    @forum_thread = ForumThread.friendly.find(params[:id])
+  end
 
-    def forum_thread_params
-      params.require(:forum_thread).permit(:title, :forum_category_id, forum_posts_attributes: [:body])
-    end
+  def forum_thread_params
+    params.require(:forum_thread).permit(:title, :forum_category_id, forum_posts_attributes: [:body])
+  end
 end

data/app/controllers/simple_discussion/notifications_controller.rb

@@ -13,7 +13,7 @@ class SimpleDiscussion::NotificationsController < SimpleDiscussion::ApplicationC
 
   private
 
-    def set_forum_thread
-      @forum_thread = ForumThread.friendly.find(params[:forum_thread_id])
-    end
+  def set_forum_thread
+    @forum_thread = ForumThread.friendly.find(params[:forum_thread_id])
+  end
 end

data/app/helpers/simple_discussion/forum_posts_helper.rb

@@ -1,7 +1,7 @@
 module SimpleDiscussion::ForumPostsHelper
   # Override this to use avatars from other places than Gravatar
   def avatar_tag(email)
-    gravatar_image_tag(email, gravatar: { size: 40 }, class: "rounded avatar")
+    image_tag gravatar_url_for(email, size: 40), class: "rounded avatar"
   end
 
   def category_link(category)
@@ -26,4 +26,10 @@ module SimpleDiscussion::ForumPostsHelper
       content_tag :span, "Mod", class: "badge badge-default"
     end
   end
+
+  def gravatar_url_for(email, **options)
+    hash = Digest::MD5.hexdigest(email&.downcase || "")
+    options.reverse_merge!(default: :mp, rating: :pg, size: 48)
+    "https://secure.gravatar.com/avatar/#{hash}.png?#{options.to_param}"
+  end
 end

data/app/helpers/simple_discussion/forum_threads_helper.rb

@@ -1,13 +1,13 @@
 module SimpleDiscussion::ForumThreadsHelper
   # Used for flagging links in the navbar as active
-  def forum_link_to(path, opts={}, &block)
+  def forum_link_to(path, opts = {}, &block)
     link_to path, class: forum_link_class(path, opts), &block
   end
 
-  def forum_link_class(matches, opts={})
+  def forum_link_class(matches, opts = {})
     case matches
     when Array
-      "active" if matches.any?{ |m| request.path.starts_with?(m) }
+      "active" if matches.any? { |m| request.path.starts_with?(m) }
     when String
       "active" if opts.fetch(:exact, false) ? request.path == matches : request.path.starts_with?(matches)
     end
@@ -22,7 +22,7 @@ module SimpleDiscussion::ForumThreadsHelper
   #
   def parent_layout(layout)
     @view_flow.set(:layout, output_buffer)
-    output = render(file: "layouts/#{layout}")
+    output = render(template: "layouts/#{layout}")
     self.output_buffer = ActionView::OutputBuffer.new(output)
   end
 end