talkie 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82f6715118d4b0022047d97dc002dba51f831e09da19bc374cc0d75ddc2a62aa
-  data.tar.gz: df4af0404f088395e42c5c92c5dfdd55624292dc0759dbb421d18a941a775e1b
+  metadata.gz: 6d5b6edfa12387d4b10f492f9a518f3e4fcbf21b684429a62580c2b2fea20dfb
+  data.tar.gz: efef1cb019c0c484c01f00eeea7a845726345b5d70b350f8f0813e5e5a2d42b4
 SHA512:
-  metadata.gz: 3dea24f754eb1f95328120601f284ef6530f798c1de001ff233963b8bff83becad84d98cf064741df7df74c3541887c11c7d3855f535785b6538b8be11a100cf
-  data.tar.gz: f52e51279684b0fa5266ed13d30d5a5ca29d4ff247f76b32012ffacb41549c0a3598d0de4ca2b6707b75538c08d3d76fecede184aa0afcba34755c1d56ebae47
+  metadata.gz: 8ededccc1c6b9e9e085d1afb9e8593e052e3afa10dacbab0318a6cf3e2f39cb5cc85d60740aec15f177ce3b99f0abebbdf06e3e25367aeb22ee1c24024816c08
+  data.tar.gz: f09bbbf6c55d1cb25b340094961bfa304de3bf91bc49bf782a508541e656586c65d7fce4d0358b55971976986fc06e60542a61f9165b8a57d6bde361144ebf55

data/Gemfile.lock

@@ -3,6 +3,8 @@ PATH
   specs:
     talkie (0.2.0)
       awesome_nested_set (~> 3.1)
+      blueprinter
+      oj
       rails (~> 5.0)
       sassc-rails (~> 2.1)
 
@@ -57,6 +59,7 @@ GEM
     arel (9.0.0)
     awesome_nested_set (3.1.4)
       activerecord (>= 4.0.0, < 5.3)
+    blueprinter (0.18.0)
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
@@ -90,6 +93,7 @@ GEM
     nio4r (2.3.1)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
+    oj (3.7.12)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)

data/README.md

@@ -11,6 +11,7 @@ Talkie is highly customizable comments engine to easily integrate threads to any
   - [Usage](#usage)
     - [Customization](#customization)
       - [Styles](#styles)
+      - [Enabling mentions](#enabling-mentions)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -104,6 +105,30 @@ Talkie is all about customization, so almost every default style provided by the
 @import "talkie/application";
 ```
 
+#### Enabling mentions
+
+Talkie comes with a handy feature that you can toggle in order to
+enable/disable user mentions.
+
+To enable it, just go to you `talkie.rb` initializer file and uncomment
+or add:
+
+```ruby
+config.enable_mentions = true
+```
+
+For customization, check the
+[template](lib/generators/talkie/templates/talkie.rb), you can basically
+override anything to fulfill your needs.
+
+When enabling this module, you need to setup your mailer configuration,
+as with each mentions the commenter subscribes to the comment and
+receives an email, just be aware of that.
+
+If you have a hard time understanding this, you can check the [dummy
+application](spec/dummy) I use for testing or contact
+[me](https://twitter.com/kurenn)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests.

data/app/assets/javascripts/talkie/application.js

@@ -1,5 +1,11 @@
+//= require underscore
+//= require jquery.elastic
+//= require jquery.mentionsinput
+//= require talkie/talkie.mentions
+
 $("body").on("click", ".talkie-comment-reply-link", function(e){
   e.preventDefault();
 
   $(this).parent().parent().find("> .talkie-comments-reply-form-container").toggle();
 });
+

data/app/assets/javascripts/talkie/talkie.mentions.js

@@ -0,0 +1,25 @@
+$( document ).on('ready turbolinks:load', function() {
+  $('textarea.talkie-comment-body-textarea').mentionsInput({
+    showAvatars: false,
+    allowRepeat: true,
+    minChars: 2,
+    onDataRequest: function (mode, query, callback) {
+      $.getJSON('/talkie/mentions',
+        { q: query },
+        function(responseData) {
+          callback.call(this, responseData);
+        });
+    }
+  });
+
+  $("form.talkie-comments-form").on("submit", function(event) {
+    event.stopPropagation();
+
+    $commentsForm = $(this);
+
+    $commentsForm.find('textarea.talkie-comment-body-textarea').mentionsInput('getMentions', function(data) {
+      $commentsForm.find(".comment-mentions").val(JSON.stringify(data));
+    });
+
+  })
+})

data/app/assets/stylesheets/talkie/_form.scss

@@ -1,4 +1,11 @@
 .talkie {
+  &-hint {
+    color: $talkie-hint-color;
+    font-size: $talkie-hint-font-size;
+    font-style: $talkie-hint-font-style;
+    margin: $talkie-hint-margin;
+  }
+
   &-comments-form-container,
   &-comments-reply-form-container {
     border-bottom: $talkie-form-border-bottom;
@@ -15,7 +22,6 @@
       font-size: $talkie-form-textarea-font-size;
       height: $talkie-form-textarea-height;
       line-height: $talkie-form-textarea-line-height;
-      margin-bottom: 10px;
       padding: 10px;
       vertical-align: top;
       width: 100%;

data/app/assets/stylesheets/talkie/_variables.scss

@@ -1,5 +1,10 @@
 // Form variable styles
 
+$talkie-hint-color: #666 !default;
+$talkie-hint-font-size: 14px !default;
+$talkie-hint-font-style: italic !default;
+$talkie-hint-margin: 0 0 10px 0 !default;
+
 $talkie-form-border-bottom: 1px solid #EEE !default;
 $talkie-form-padding-bottom: 10px !default;
 $talkie-form-margin-bottom: 10px !default;
@@ -17,7 +22,7 @@ $talkie-form-submit-border: 1px solid #3079ED !default;
 $talkie-form-submit-color: #FFF !default;
 $talkie-form-submit-border-radius: 2px !default;
 $talkie-form-submit-font-weight: bold !default;
-$talkie-form-submit-margin: 0 8px 6px 0!default;
+$talkie-form-submit-margin: 10px 8px 6px 0 !default;
 $talkie-form-submit-font-size: 11px !default;
 $talkie-form-submit-padding: 10px 12px !default;
 $talkie-form-submit-text-shadow: 0 1px rgba(0,0,0,.1) !default;

data/app/assets/stylesheets/talkie/application.scss

@@ -1,3 +1,5 @@
 @import "variables";
 @import "form";
 @import "comment";
+@import "jquery.mentionsinput";
+

data/app/blueprints/mentionees_blueprint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class MentioneesBlueprint < Blueprinter::Base
+  identifier :id
+
+  fields :email
+
+  field :type do |mentionee, _|
+    "#{mentionee.class.to_s}"
+  end
+
+  field :name do |mentionee, _|
+    "#{Talkie.autocomplete_mention_display.call(mentionee)}"
+  end
+end

data/app/controllers/talkie/comments_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Talkie
   class CommentsController < TalkieController
     before_action :current_comment, only: [:destroy]
@@ -28,7 +30,7 @@ module Talkie
     private
 
     def comment_params
-      params.require(:comment).permit(:body, :commentable_id, :commentable_type)
+      params.require(:comment).permit(:body, :commentable_id, :commentable_type, :mention_tokens)
     end
 
     def reply?

data/app/controllers/talkie/mentions_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Talkie
+  class MentionsController < TalkieController
+    def index
+      if query.size < 2
+        render json: { error: 'Query string is too short (minimum 2 characters)' },
+                       status: :unprocessable_entity
+      else
+        render json: MentioneesBlueprint.render(mentionees)
+      end
+    end
+
+    private
+
+    def query
+      @query ||= params[:q].to_s
+    end
+
+    def mentionees
+      @mentionees ||= current_user.class.mentionees(query)
+    end
+  end
+end

data/app/mailers/talkie/notifications_mailer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Talkie
+  class NotificationsMailer < ActionMailer::Base
+    default from: Talkie.from_mailer_address
+
+    def mentioned
+      @comment = params[:comment]
+      @creator = @comment.creator
+      recipients = params[:recipients]
+      mail to: recipients,
+           subject: t("talkie.mailers.notifications.subject", creator: @creator.email)
+    end
+  end
+end

data/app/models/concerns/talkie/mentionable.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Talkie
+  module Mentionable
+    extend ActiveSupport::Concern
+
+    included do
+      attr_writer :mention_tokens
+
+      before_create :check_for_mentions!, if: :mentions?
+      after_create :notify_mentionees!, if: :enabled_notifications?
+    end
+
+    def check_for_mentions!
+      subscribers.each do |subscriber|
+        self.subscriptions.build(subscriber: subscriber)
+      end
+    end
+
+    def mentions?
+      mention_tokens.present?
+    end
+
+    def notify_mentionees!
+      NotificationsMailer.with(comment: self, recipients: subscribers.pluck(:email)).mentioned.deliver_now
+    end
+
+    def mention_tokens
+      @mention_tokens || Talkie::NilMentionTokens.new.to_s
+    end
+
+    private
+
+    def subscribers
+      @subscribers ||= mentionee_klass.find(subscriber_ids)
+    end
+
+    def subscriber_ids
+      @subscriber_ids ||= mentions.map { |mention| mention["id"] }
+    end
+
+    def mentionee_klass
+      @mentionee_klass ||= mentions.first["type"]&.constantize
+    end
+
+    def mentions
+      @mentions ||= JSON.parse(mention_tokens)
+    end
+
+    def enabled_notifications?
+      Talkie.notifications_mentions_enabled?
+    end
+
+  end
+end

data/app/models/talkie/comment.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Talkie
   class Comment < ActiveRecord::Base
+    include Talkie::Mentionable if Talkie.mentions_enabled?
+
     default_scope Talkie.default_comments_scope
 
     acts_as_nested_set :scope => [:commentable_id, :commentable_type],
@@ -8,6 +12,8 @@ module Talkie
     belongs_to :creator, polymorphic: true, inverse_of: :comments
     belongs_to :commentable, polymorphic: true, inverse_of: :comments
 
+    has_many :subscriptions, dependent: :destroy, inverse_of: :comment
+
     validates :body, :creator, :commentable, presence: true
   end
 end

data/app/models/talkie/subscription.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Talkie
+  class Subscription < ActiveRecord::Base
+    belongs_to :subscriber, polymorphic: true, inverse_of: :subscriptions
+    belongs_to :comment, inverse_of: :subscriptions, class_name: "Talkie::Comment"
+
+    validates_presence_of :subscriber, :comment
+    validates_uniqueness_of :comment, scope: [:subscriber_type, :subscriber_id]
+  end
+end

data/app/views/talkie/comments/_comment.html.erb

@@ -1,4 +1,4 @@
-<div class="talkie-comment-holder">
+<div class="talkie-comment-holder" id="talkie-comment-<%= comment.id %>">
   <% if display_user_avatar? %>
     <div class="talkie-comment-creator-avatar">
       <%= avatar_image_tag comment.creator %>
@@ -32,12 +32,16 @@
           <% end %>
         </div>
         <div class="talkie-comments-reply-form-container" style="display:none">
-          <%= form_for [talkie, Talkie::Comment.new] do |f| %>
+          <%= form_for [talkie, Talkie::Comment.new], html: { class: "talkie-comments-form" } do |f| %>
             <%= f.hidden_field :commentable_id, value: commentable.id %>
             <%= f.hidden_field :commentable_type, value: commentable.class.name %>
             <%= hidden_field_tag :parent_comment_id, comment.id %>
 
-            <%= f.text_area :body, placeholder: t("talkie.comment.form.body_placeholder") %>
+            <%= f.text_area :body, placeholder: t("talkie.comment.form.body_placeholder"), class: "talkie-comment-body-textarea", required: "required" %>
+            <% if Talkie.mentions_enabled? %>
+              <p class="talkie-hint"><%= t("talkie.comments.form.hint_html") %></p>
+              <%= f.hidden_field :mention_tokens, class: "comment-mentions" %>
+            <% end %>
             <%= submit_tag t("talkie.comment.form.reply"), class: 'talkie-comments-form-submit' %>
           <% end %>
         </div>

data/app/views/talkie/comments/_form.html.erb

@@ -1,9 +1,13 @@
 <div class="talkie-comments-form-container">
-  <%= form_for [talkie, Talkie::Comment.new] do |f| %>
+  <%= form_for [talkie, Talkie::Comment.new], html: { class: "talkie-comments-form" } do |f| %>
     <%= f.hidden_field :commentable_id, value: commentable.id %>
     <%= f.hidden_field :commentable_type, value: commentable.class.name %>
 
-    <%= f.text_area :body, placeholder: t("talkie.comments.form.body_placeholder") %>
+    <%= f.text_area :body, placeholder: t("talkie.comments.form.body_placeholder"), class: "talkie-comment-body-textarea", required: "required" %>
+    <% if Talkie.mentions_enabled? %>
+      <p class="talkie-hint"><%= t("talkie.comments.form.hint_html") %></p>
+      <%= f.hidden_field :mention_tokens, class: "comment-mentions" %>
+    <% end %>
     <%= f.submit t("talkie.comments.form.submit"), class: "talkie-comments-form-submit" %>
   <% end %>
 </div>

data/app/views/talkie/notifications_mailer/mentioned.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <h4><%= t("talkie.mailers.notifications.headline") %></h4>
+    <p>
+      <%= t("talkie.mailers.notifications.reason", creator: @creator.email) %>
+    </p>
+    <p>
+      <%= t "talkie.mailers.notifications.to_view_conversation_html", link_to: (link_to t("talkie.mailers.notifications.here"), main_app.polymorphic_url(@comment.commentable, anchor: "talkie-comment-#{@comment.id}")) %>
+    </p>
+  </body>
+</html>

data/app/views/talkie/notifications_mailer/mentioned.text.erb

@@ -0,0 +1,5 @@
+ <%= t("talkie.mailers.notifications.headline") %>
+
+ <%= t("talkie.mailers.notifications.reason", creator: @creator.email) %>
+
+ <%= t "talkie.mailers.notifications.to_view_conversation_html", link_to: (link_to t("talkie.mailers.notifications.here"), main_app.polymorphic_url(@comment.commentable, anchor: "talkie-comment-#{@comment.id}")) %>

data/config/locales/en.yml

@@ -1,6 +1,13 @@
 ---
 en:
   talkie:
+    mailers:
+      notifications:
+        subject: "You have been mentioned by %{creator}"
+        headline: "This is an automatic notification system"
+        reason: "You are receiving this notification because %{creator} mentioned you on a conversation."
+        to_view_conversation_html: "To view the conversation on the site, just click %{link_to}"
+        here: "here"
     controllers:
       comments:
         flash:
@@ -8,6 +15,7 @@ en:
           error: "Something went wrong, blank comments are not allowed."
     comments:
       form:
+        hint_html: "<strong>Hint: </strong> To autocomplete the users, you can add an '@' to activate the autocomplete"
         submit: "Publish"
         body_placeholder: "Write your comment..."
       count:

data/config/locales/es.yml

@@ -1,6 +1,13 @@
 ---
 es:
   talkie:
+    mailers:
+      notifications:
+        subject: "%{creator} te ha mencionado en una conversación"
+        headline: "Esto es un sistema automático de notificación"
+        reason: "Estas recibiendo este correo por que %{creator} te menciono en una conversación."
+        to_view_conversation_html: "Para responder da clic %{link_to}"
+        here: "aquí"
     controllers:
       comments:
         flash:
@@ -8,6 +15,7 @@ es:
           error: "Algo salió mal, tu comentario no puede estar en blanco."
     comments:
       form:
+        hint_html: "<strong>Ayuda: </strong> Para autocompletar a los usuarios, puedes agregar un '@' antes de su nombre"
         submit: "Publicar"
         body_placeholder: "Escribe tu comentario..."
       count:

data/config/routes.rb

@@ -1,3 +1,7 @@
 Talkie::Engine.routes.draw do
   resources :comments, only: [:create, :destroy]
+
+  if Talkie.mentions_enabled?
+    resources :mentions, only: [:index]
+  end
 end

data/lib/generators/talkie/templates/create_talkie_comments.rb

@@ -18,6 +18,20 @@ class CreateTalkieComments < ActiveRecord::Migration[5.0]
     add_index :talkie_comments, :commentable_type
     add_index :talkie_comments, [:creator_id, :creator_type],
               name: 'index_talkie_comments_on_creator_id_and_creator_type'
+
+    create_table :talkie_subscriptions do |t|
+      t.string   :subscriber_type, null: false
+      t.integer  :subscriber_id, null: false
+      t.integer  :comment_id, null: false
+
+      t.timestamps null: false
+    end
+
+    add_index :talkie_subscriptions, [:subscriber_id, :subscriber_type, :comment_id],
+      unique: true,
+      name: 'index_talkie_subscriptions_on_s_id_and_s_type_and_c_id'
+
+    add_index :talkie_subscriptions, :comment_id
   end
 
   def self.down

data/lib/generators/talkie/templates/talkie.rb

@@ -29,7 +29,6 @@ Talkie.configure do |config|
   # The default looks like:
   # config.creator_path = lambda { |user, router| "#" }
 
-
   # ==> Creator avatar url
   # Configure the avatar url for the comment creator
   # By default it will use a http:////api.adorable.io/avatars/40/abott@adorable.png
@@ -43,7 +42,35 @@ Talkie.configure do |config|
   #
   # The default looks like:
   # config.creator_avatar_url = lambda { |user| "//api.adorable.io/avatars/40/abott@adorable.png" }
+
+  # ==> Mentions support
+  # If you decide to enable mentions, be aware on some further configuration
+  # The first thing to do is to just enable it:
+  #
+  # config.enable_mentions = true
+  #
+  # By default it will send an email to notify the mentioned users
+  # but you can override this default configuration like:
+  #
+  # config.enable_mentions_notifications = false
+  #
+  # You can override the query that filter the mentionees
+  # By default the lambda function is
+  # config.mentions_scope_query = lambda { |query| where("email LIKE ?", "#{query}%") }
+  # Just keep in mind that the query variable is what you receive when the user
+  # types '@' on the textarea, so maybe kurenn@icalialabs.com or so
+  # You can change to obey a username column, like so:
+  #
+  # config.mentions_scope_query = lambda { |query| where("username ILIKE ?", "%#{query}%") }
+  #
+  # There is another configuration for the mention module you may want to look at it
+  # The autocomplete text, which is by default the email, but probably that would look nasty,
+  # you can override this and use any method or attribute you want for your talker class:
+  #
+  # config.autocomplete_mention_display = lambda { |mentionee| mentionee.username }
   #
+  # Or maybe something more complex
+  # config.autocomplete_mention_display = lambda { |mentionee| "#{mentionee.first_name} #{mentionee.last_name}" }
 
   # ==> Redirect for comments controller
   # There are sometimes you want to redirect to different locations

data/lib/generators/talkie/views_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Talkie
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../app/views/talkie', __FILE__)
+
+      def copy_views
+        directory "notifications_mailer", "app/views/talkie/notifications_mailer"
+      end
+    end
+  end
+end

data/lib/talkie/acts_as_talker.rb

@@ -13,6 +13,13 @@ module Talkie
                               class_name: 'Talkie::Comment',
                               inverse_of: :creator
 
+          has_many :subscriptions, as: :subscriber,
+                                   class_name: 'Talkie::Subscription',
+                                   dependent: :destroy,
+                                   inverse_of: :subscriber
+
+          scope :mentionees, Talkie.mentions_scope_query if Talkie.mentions_enabled?
+
           def owns_comment?(comment)
             self == comment.creator
           end

data/lib/talkie/blueprinter.rb

@@ -0,0 +1,5 @@
+require 'oj'
+
+Blueprinter.configure do |config|
+  config.generator = Oj # default is JSON
+end

data/lib/talkie/nil_mention_tokens.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Talkie
+  class NilMentionTokens
+
+    def self.find(ids = [])
+      []
+    end
+
+    def to_s
+      %Q{#{[
+        {
+          type: self.class.to_s
+        }
+      ].to_json}}
+    end
+  end
+end

data/lib/talkie/permission.rb

@@ -2,12 +2,12 @@
 
 module Talkie
   class Permission < Struct.new(:user)
-    def allow?(action, comment)
+    def allow?(action, comment = Talkie::Comment.new)
       action = action.to_s
 
       if user
-        return true if action.in? %w[create]
-        return true if user.owns_comment?(comment) && action.in?(%w[destroy])
+        return true if action.in? %w[create index]
+        return true if action.in?(%w[destroy]) && user.owns_comment?(comment)
       end
 
       false

data/lib/talkie/subscription_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Talkie
+  class SubscriptionError < StandardError
+  end
+end

data/lib/talkie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Talkie
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/talkie.rb

@@ -3,6 +3,7 @@
 require "talkie/version"
 require "talkie/engine"
 require "awesome_nested_set"
+require "blueprinter"
 
 module Talkie
 
@@ -24,6 +25,30 @@ module Talkie
   mattr_accessor :fail_redirect_to,
                  default: lambda { |router| router.root_url }
 
+  mattr_accessor :enable_mentions,
+                 default: false
+
+  mattr_accessor :mentions_scope_query,
+                 default: lambda { |query| where("email LIKE ?", "#{query}%") }
+
+
+  mattr_accessor :enable_mentions_notifications,
+                  default: true
+
+  mattr_accessor :from_mailer_address,
+                 default: "no-reply@change-me-to-your-domain.com"
+
+  mattr_accessor :autocomplete_mention_display,
+                 default: lambda { |mentionee| mentionee.email }
+
+  def self.mentions_enabled?
+    @@enable_mentions
+  end
+
+  def self.notifications_mentions_enabled?
+    @@enable_mentions_notifications
+  end
+
   def self.configure
     yield self
   end
@@ -34,3 +59,6 @@ require "talkie/acts_as_commentable"
 require "talkie/permission"
 require "talkie/controller"
 require "talkie/renderer_helper"
+require "talkie/subscription_error"
+require "talkie/blueprinter"
+require "talkie/nil_mention_tokens"

data/talkie.gemspec

@@ -38,4 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails", "~> 5.0"
   spec.add_dependency "sassc-rails", "~> 2.1"
   spec.add_dependency "awesome_nested_set", "~> 3.1"
+  spec.add_dependency "blueprinter", "~> 0.18.0"
+  spec.add_dependency "oj", "~> 3.17"
 end