Hashtags Feature applied to Proposals #3959

isaacmg410 · Aug 3, 2018

🎩 What? Why?

This functionality will consist of the development of a new feature Hashtags provide a flexible way to search and filter content.

📌 Related Issues

Related to #2458

📋 Subtasks

Add CHANGELOG entry
Add hashtags features to proposals
Add documentation regarding the feature
Add tests

📷 Screenshots (optional)

isaacmg410 · Aug 3, 2018

@decidim/lot-core I would appreciate a pre-review of this PR.
I will try to make more smaller PRs for a better 😄

mrcasals · Aug 6, 2018

mrcasals reviewed Aug 6, 2018

View changes

mrcasals · Aug 6, 2018

decidim-core/db/migrate/20180726112553_create_decidim_hashtagggings.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateDecidimHashtagggings < ActiveRecord::Migration[5.2]


Looks like there's an extra g here

mrcasals · Aug 6, 2018

decidim-core/app/types/decidim/core/hashtag_type.rb

+      description "hashtags list"
+
+      interfaces [
+        -> { Decidim::Core::HashtagInterface }


Will this interface be used by other types? If it won't, then I suggest putting the fields definition directly to the type to reduce complexity.

mrcasals · Aug 6, 2018

decidim-core/db/migrate/20180726112553_create_decidim_hashtagggings.rb

+      t.references :decidim_hashtag, index: true
+      t.references :decidim_hashtaggable, polymorphic: true, index: { name: "idx_hashtaggins_on_hashtaggable_type_and_hashtaggable_id" }
+    end
+    add_index :decidim_hashtaggings, %w(decidim_hashtaggable_id decidim_hashtaggable_type),


Isn't this a duplicate from the index in line 7?

mrcasals · Aug 6, 2018

decidim-core/lib/decidim/api/hashtag_interface.rb

+      name "HashtagInterface"
+      description "A hashtag"
+
+      field :name, !types.String, "The hashtag's name"


I suggest moving this to the HashtagType and deleting this file.

mrcasals · Aug 6, 2018

decidim-core/lib/decidim/content_parsers/hashtag_parser.rb

+      # hashtag with a global id.
+      #
+      # @return [String] the content with the hashtags replaced by a global id
+


Remove extra white line

mrcasals · Aug 6, 2018

decidim-core/spec/content_parsers/decidim/hashtag_parser_spec.rb

+
+    context "when hashtagging a non created hashtag" do
+      let(:hashtag3) { create(:hashtag, organization: organization) }
+      let(:content) { "This text hashtagiing a non created hashtag: ##{hashtag3.name}" }


hashtag3 does exist in the DB, so this test is wrong.

mrcasals · Aug 6, 2018

decidim-meetings/app/commands/decidim/meetings/admin/create_meeting.rb

-            title: @form.title,
-            description: @form.description,
+            # title: @form.title,
+            title: parser.parse(@form.title),


Can titles have hashtags? Won't this be weird when rendering?

a long time ago, @xabier said that fields were title and body...
Maybe @decidim/product can clarify

mrcasals · Aug 6, 2018

decidim-proposals/app/commands/decidim/proposals/admin/create_proposal.rb

+          # parsed_title = Decidim::ContentProcessor.parse(form.title, current_organization: current_organization).rewrite
+          # parsed_body = Decidim::ContentProcessor.parse(form.body, current_organization: current_organization).rewrite
+
+          parsed_title = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.title, current_organization: current_organization).rewrite


Move these 2 lines inside the attributes method and you won't need to pass those as params

mrcasals · Aug 6, 2018

decidim-proposals/app/presenters/decidim/proposals/proposal_presenter.rb

+        renderer.render.html_safe
+      end
+
+      # This methods return the plain title


mrcasals · Aug 6, 2018

decidim-proposals/app/views/decidim/proposals/admin/proposals/_proposal-tr.html.erb

@@ -6,7 +6,7 @@
    <%= proposal.id %><br />
  </td>
  <td>
-    <%= proposal.title %><br />


Missing <br />? Don't know if it's intended though.

oriolgual · Aug 6, 2018

oriolgual requested changes Aug 6, 2018

View changes

oriolgual · Aug 6, 2018

decidim-core/app/assets/javascripts/decidim/input_hashtags.js.es6

+    }).fail(function() {
+      cb([])
+    }).always(() => {
+      // This function runs Tribute every single time you type somthing


s/somthing/something 🤓

oriolgual · Aug 6, 2018

decidim-core/app/assets/javascripts/decidim/input_hashtags.js.es6

+        if ($(this.current.element).hasClass("editor-container")) {
+          let quill = this.current.element.__quill;
+          quill.insertText(cursor - 1, `#${item.original.name} `, Quill.sources.API);
+          // cursor position + nickname length + "@" sign + space


Nickname or hashtag?

oriolgual · Aug 6, 2018

decidim-core/app/assets/javascripts/decidim/input_hashtags.js.es6

+    }
+  });
+
+  function remoteSearch(text, cb) {


Duplicated function?

oriolgual · Aug 6, 2018

decidim-core/app/resolvers/decidim/hashtags_resolver.rb

+    end
+
+    def hashtags
+      Decidim::Hashtag.where(organization: @organization).where("name like ?", "#{@term}%")


Why use like?

to collect hashtags with the names thah begin with 'bla' for example

Then don't we need something like "name like ?%"?

Oh, I didn't see the % at the end, sorry.

Don't worry 😄

oriolgual · Aug 6, 2018

decidim-core/lib/decidim/api/hashtag_interface.rb

+      name "HashtagInterface"
+      description "A hashtag"
+
+      field :name, !types.String, "The hashtag's name"


Since this interface won't be used anywhere else, you can drop it and move the field to the type

oriolgual · Aug 6, 2018

decidim-core/lib/decidim/content_renderers/hashtag_renderer.rb

+    #
+    # @see BaseRenderer Examples of how to use a content renderer
+    class HashtagRenderer < BaseRenderer
+      # Matches a global id representing a Decidim::User


s/User/Hashtag

oriolgual · Aug 6, 2018

decidim-core/lib/decidim/hashtag.rb

+    HASHTAG_REGEX = /(^|\s)#([a-zA-Z0-9]\w*)/i
+
+    def hashtaggables
+      decidim_hashtaggings.includes(:decidim_hashtaggable).collect(&:decidim_hashtaggable)


Should we memoize this?

oriolgual · Aug 6, 2018

decidim-core/lib/decidim/hashtag.rb

+      decidim_hashtaggings.includes(:decidim_hashtaggable).collect(&:decidim_hashtaggable)
+    end
+
+    def hashtagged_types


These methods aren't used

oriolgual · Aug 6, 2018

decidim-proposals/app/commands/decidim/proposals/admin/create_proposal.rb

@@ -40,17 +40,23 @@ def call
        attr_reader :form, :proposal, :attachment

        def create_proposal
+          # parsed_title = Decidim::ContentProcessor.parse(form.title, current_organization: current_organization).rewrite


Remove this?

oriolgual · Aug 6, 2018

decidim-proposals/app/commands/decidim/proposals/admin/create_proposal.rb

+          # parsed_title = Decidim::ContentProcessor.parse(form.title, current_organization: current_organization).rewrite
+          # parsed_body = Decidim::ContentProcessor.parse(form.body, current_organization: current_organization).rewrite
+
+          parsed_title = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.title, current_organization: current_organization).rewrite


Isn't a bit weird to allow hashtags at titles?

@decidim/product clarify this please.

@isaacmg410 @oriolgual I have checked the conversation in the original issue and we agreed to ignore the hashtags in the title: #2458 (comment)

so that is what we are doing.
Show the hashtag on title ignoring the link 😄

oriolgual · Aug 27, 2018

oriolgual requested changes Aug 27, 2018

View changes

oriolgual · Aug 27, 2018

decidim-meetings/app/models/decidim/meetings/meeting.rb

@@ -17,6 +17,7 @@ class Meeting < Meetings::ApplicationRecord
      include Decidim::Searchable
      include Decidim::Traceable
      include Decidim::Loggable
+      include Decidim::Hashtaggable


Shouldn't this be in another PR?

You are right!

isaacmg410 · Aug 29, 2018

@oriolgual requested changes applied, ready to review and merge

oriolgual · Aug 29, 2018

oriolgual approved these changes Aug 29, 2018

View changes

isaacmg410 added some commits Aug 2, 2018

initial commit working on hashtags system

5a65ea4

applying hashtags on proposals

293b5cd

rebase master and solve conflicts

Loading status checks…

df6c420

wafflebot bot assigned isaacmg410 Aug 3, 2018

wafflebot bot added the status: WIP label Aug 3, 2018

isaacmg410 changed the title from [WIP] Hashtags Feature applied to Proposals to Hashtags Feature applied to Proposals Aug 27, 2018

isaacmg410 added in-review and removed status: WIP labels Aug 28, 2018

Merge branch 'master' into 2458_hashtags

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

b80a7d0

wafflebot bot assigned oriolgual Aug 29, 2018

wafflebot bot added the status: WIP label Aug 29, 2018

mrcasals removed the status: WIP label Aug 30, 2018

mrcasals deleted the 2458_hashtags branch Aug 30, 2018

This was referenced Sep 5, 2018

Merged

Apply hashtags to meetings #4080

Merged

Fix hashtags on title when showing proposals related #4081

isaacmg410 referenced this pull request Sep 13, 2018
Merged
[backport] Fix hashtags on title when showing proposals related #4107
3 of 3 tasks complete

decidim/decidim

Join GitHub today

Hashtags Feature applied to Proposals #3959

Conversation

isaacmg410 commented Aug 3, 2018 • edited

🎩 What? Why?

📌 Related Issues

📋 Subtasks

📷 Screenshots (optional)

isaacmg410 added some commits Aug 2, 2018

wafflebot bot assigned isaacmg410 Aug 3, 2018

wafflebot bot added the status: WIP label Aug 3, 2018

This comment has been minimized.

isaacmg410 commented Aug 3, 2018

mrcasals reviewed Aug 6, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

oriolgual requested changes Aug 6, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

isaacmg410 added some commits Aug 20, 2018

isaacmg410 changed the title from [WIP] Hashtags Feature applied to Proposals to Hashtags Feature applied to Proposals Aug 27, 2018

isaacmg410 added some commits Aug 27, 2018

oriolgual requested changes Aug 27, 2018 View changes

This comment has been minimized.

This comment has been minimized.

isaacmg410 added some commits Aug 27, 2018

isaacmg410 added in-review and removed status: WIP labels Aug 28, 2018

This comment has been minimized.

isaacmg410 commented Aug 29, 2018

wafflebot bot assigned oriolgual Aug 29, 2018

wafflebot bot added the status: WIP label Aug 29, 2018

oriolgual approved these changes Aug 29, 2018 View changes

mrcasals removed the status: WIP label Aug 30, 2018

Hide details View details mrcasals merged commit 006a084 into master Aug 30, 2018 27 of 28 checks passed

27 of 28 checks passed

mrcasals deleted the 2458_hashtags branch Aug 30, 2018

This was referenced Sep 5, 2018

isaacmg410 referenced this pull request Sep 13, 2018

isaacmg410 commented Aug 3, 2018 •

edited

mrcasals reviewed Aug 6, 2018

View changes

oriolgual requested changes Aug 6, 2018

View changes

oriolgual requested changes Aug 27, 2018

View changes

oriolgual approved these changes Aug 29, 2018

View changes

mrcasals merged commit `006a084` into master Aug 30, 2018
27 of 28 checks passed