html-pipeline 2.11.1 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6247333ffe74b1a26211f5563ceea18e43b355aa8b8fe5b0474355f7efa81f93
-  data.tar.gz: 0f29d8cae966aa24960a57e874a73693e50040444d3f98d2c505b6bb6161c9e9
+  metadata.gz: d08ceab233a694f9315d1733a1ab2a9509adcb5ab6845a28ba5aa09865e110d9
+  data.tar.gz: 6b8eef1085941d9e65ea9747ed402f519c886b54d393a5cd66326d1f01d1d433
 SHA512:
-  metadata.gz: 19b69c57d6b7df1efa7ad35c754b283242d46d61a6b8a8313ca27ea2929511934eecf4c019e744cd640704455a0ac0ec06f52bcb2929425f58153320b2e47be2
-  data.tar.gz: 9fb8ca18eeb49d3150e7b88e024b89da94e88e8723861964e49a8873e0045e8886b49745deff0973b3cd731fb2488283a96fad7b23dec7d3fd9f424a087a75f9
+  metadata.gz: 825524c21337d775d83c8cd4b99a353b0c295d49b2447d2dfc6f4f7b762f43c4b69891f608813ad2e8402b739b904878b13f948d8910f04c8e14e42d3c4a4cd6
+  data.tar.gz: e5e2b9740e9915e6054404dcd28f86aa8f931b4585647380f6e2d4c5b4bff75644549b27d77080c9d95b87596bb4a55ebf759855c9f9ca2dc0cbe80ec2b0e3fa

data/README.md

@@ -153,6 +153,7 @@ EmojiPipeline = Pipeline.new [
 ## Filters
 
 * `MentionFilter` - replace `@user` mentions with links
+* `TeamMentionFilter` - replace `@org/team` mentions with links
 * `AbsoluteSourceFilter` - replace relative image urls with fully qualified versions
 * `AutolinkFilter` - auto_linking urls in HTML
 * `CamoFilter` - replace http image urls with [camo-fied](https://github.com/atmos/camo) https versions

data/lib/html/pipeline.rb

@@ -38,6 +38,7 @@ module HTML
     autoload :ImageMaxWidthFilter,   'html/pipeline/image_max_width_filter'
     autoload :MarkdownFilter,        'html/pipeline/markdown_filter'
     autoload :MentionFilter,         'html/pipeline/@mention_filter'
+    autoload :TeamMentionFilter,     'html/pipeline/@team_mention_filter'
     autoload :PlainTextInputFilter,  'html/pipeline/plain_text_input_filter'
     autoload :SanitizationFilter,    'html/pipeline/sanitization_filter'
     autoload :SyntaxHighlightFilter, 'html/pipeline/syntax_highlight_filter'

data/lib/html/pipeline/@team_mention_filter.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module HTML
+  class Pipeline
+    # HTML filter that replaces @org/team mentions with links. Mentions within
+    # <pre>, <code>, <a>, <style>, and <script> elements are ignored.
+    #
+    # Context options:
+    #   :base_url - Used to construct links to team profile pages for each
+    #               mention.
+    #   :team_pattern - Used to provide a custom regular expression to
+    #                       identify team names
+    #
+    class TeamMentionFilter < Filter
+      # Public: Find @org/team mentions in text.  See
+      # TeamMentionFilter#team_mention_link_filter.
+      #
+      #   TeamMentionFilter.mentioned_teams_in(text) do |match, org, team|
+      #     "<a href=...>#{team}</a>"
+      #   end
+      #
+      # text - String text to search.
+      #
+      # Yields the String match, org name, and team name.  The yield's
+      # return replaces the match in the original text.
+      #
+      # Returns a String replaced with the return of the block.
+      def self.mentioned_teams_in(text, team_pattern = TeamPattern)
+        text.gsub team_pattern do |match|
+          org = $1
+          team = $2
+          yield match, org, team
+        end
+      end
+
+      # Default pattern used to extract team names from text. The value can be
+      # overridden by providing the team_pattern variable in the context. To
+      # properly link the mention, should be in the format of /@(1)\/(2)/.
+      TeamPattern = /
+        (?<=^|\W)                  # beginning of string or non-word char
+        @([a-z0-9][a-z0-9-]*)      # @organization
+          \/                       # dividing slash
+          ([a-z0-9][a-z0-9\-_]*)   # team
+          \b
+      /ix
+
+      # Don't look for mentions in text nodes that are children of these elements
+      IGNORE_PARENTS = %w[pre code a style script].to_set
+
+      def call
+        result[:mentioned_teams] ||= []
+
+        doc.search('.//text()').each do |node|
+          content = node.to_html
+          next unless content.include?('@')
+          next if has_ancestor?(node, IGNORE_PARENTS)
+          html = mention_link_filter(content, base_url, team_pattern)
+          next if html == content
+          node.replace(html)
+        end
+        doc
+      end
+
+      def team_pattern
+        context[:team_pattern] || TeamPattern
+      end
+
+      # Replace @org/team mentions in text with links to the mentioned team's
+      # page.
+      #
+      # text      - String text to replace @mention team names in.
+      # base_url  - The base URL used to construct team page URLs.
+      # team_pattern  - Regular expression used to identify teams in text
+      #
+      # Returns a string with @team mentions replaced with links. All links have a
+      # 'team-mention' class name attached for styling.
+      def mention_link_filter(text, _base_url = '/', team_pattern = TeamPattern)
+        self.class.mentioned_teams_in(text, team_pattern) do |match, org, team|
+          link = link_to_mentioned_team(org, team)
+
+          link ? match.sub("@#{org}/#{team}", link) : match
+        end
+      end
+
+      def link_to_mentioned_team(org, team)
+        result[:mentioned_teams] |= [team]
+
+        url = base_url.dup
+        url << '/' unless url =~ /[\/~]\z/
+        
+        "<a href='#{url << org}/#{team}' class='team-mention'>" \
+          "@#{org}/#{team}" \
+          '</a>'
+      end
+    end
+  end
+end

data/lib/html/pipeline/version.rb

@@ -2,6 +2,6 @@
 
 module HTML
   class Pipeline
-    VERSION = '2.11.1'.freeze
+    VERSION = '2.12.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-pipeline
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.12.0
 platform: ruby
 authors:
 - Ryan Tomayko
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,6 +62,7 @@ files:
 - html-pipeline.gemspec
 - lib/html/pipeline.rb
 - lib/html/pipeline/@mention_filter.rb
+- lib/html/pipeline/@team_mention_filter.rb
 - lib/html/pipeline/absolute_source_filter.rb
 - lib/html/pipeline/autolink_filter.rb
 - lib/html/pipeline/body_content.rb