qiita-markdown 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff7146b861299953ada5127646c21a9cffb3b2ed
-  data.tar.gz: 1efaba3aa4ded077adec7894e0fc6b22c7377c06
+  metadata.gz: c22f45ccf624ebe29068482764e35d462ab0e633
+  data.tar.gz: 34b99302fce125f03a8418eee4d981e0d19d71b6
 SHA512:
-  metadata.gz: d0d94503283fe41276b338bab864bd0f449adbf1d93417d46ae4187754197e957319bb551e6122a562972545d5313104cb753646239ff2aac9c953f6aae974c0
-  data.tar.gz: 4c67bdc61902c94a21ef233d1725e7e14b4cbac14cf8cbdb24f6700ebaf80449228c7215ee8c2375382459f2be1aa3dcccc938cbd4b41a853c7389fc4d51da1a
+  metadata.gz: 967e0ef2ee7a811af3f175776772a6819578b9ce4c5a28e052bdc79fc41935ffee4c3ed27efd82a207b0d22a6fae178b4d1f029519c9732918b761bca54f6078
+  data.tar.gz: 15a8a37fc61191d93b2f1942208417bd67b68e1fdfb5113b218428c50155858394d07a1a61f9a32230911de7cb715717d9dac60f7200e53e02c5ef6bff7c4bd5

data/.rubocop.yml

@@ -16,6 +16,10 @@ Style/EmptyCaseCondition:
 Style/GuardClause:
   Enabled: false
 
+Style/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/.rubocop_todo.yml

@@ -94,22 +94,6 @@ Style/PerlBackrefs:
   Exclude:
     - 'lib/qiita/markdown/filters/mention.rb'
 
-# Offense count: 13
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
-# NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
-Style/PredicateName:
-  Exclude:
-    - 'spec/**/*'
-    - 'benchmark/heading_anchor_rendering.rb'
-    - 'lib/qiita/markdown/filters/checkbox.rb'
-    - 'lib/qiita/markdown/filters/code.rb'
-    - 'lib/qiita/markdown/filters/mention.rb'
-    - 'lib/qiita/markdown/filters/sanitize.rb'
-    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
-    - 'lib/qiita/markdown/greenmat/heading_rendering.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.13.0
+- Support group mention
+
 ## 0.12.0
 - Add custom emoji support via `:emoji_names` and `:emoji_url_generator` contexts
 

data/lib/qiita/markdown.rb

@@ -12,6 +12,7 @@ require "qiita/markdown/filters/code"
 require "qiita/markdown/filters/emoji"
 require "qiita/markdown/filters/footnote"
 require "qiita/markdown/filters/greenmat"
+require "qiita/markdown/filters/group_mention"
 require "qiita/markdown/filters/image_link"
 require "qiita/markdown/filters/mention"
 require "qiita/markdown/filters/sanitize"

data/lib/qiita/markdown/filters/group_mention.rb

@@ -0,0 +1,99 @@
+module Qiita
+  module Markdown
+    module Filters
+      class GroupMention < HTML::Pipeline::Filter
+        # @note Override
+        def call
+          if context[:group_mention_url_generator]
+            result[:mentioned_groups] ||= []
+            doc.search(".//text()").each do |node|
+              mentionable_node = MentionableNode.new(node, context[:group_mention_url_generator])
+              unless mentionable_node.ignorable?
+                result[:mentioned_groups] |= mentionable_node.groups
+                node.replace(mentionable_node.replaced_html)
+              end
+            end
+          end
+          doc
+        end
+
+        class MentionableNode
+          GROUP_IDENTIFIER_PATTERN = %r{
+            (?:^|\W)
+            @((?>[a-z\d][a-z\d-]{2,31}))
+            \/
+            ([A-Za-z\d][A-Za-z\d-]{0,14}[A-Za-z\d])
+            (?!\/)
+            (?=
+              \.+[ \t\W]|
+              \.+$|
+              [^0-9a-zA-Z_.]|
+              $
+            )
+          }x
+
+          IGNORED_ANCESTOR_ELEMENT_NAMES = %w(
+            a
+            blockquote
+            code
+            pre
+            style
+          ).freeze
+
+          # @param node [Nokogiri::XML::Node]
+          # @param group_mention_url_generator [Proc]
+          def initialize(node, group_mention_url_generator)
+            @group_mention_url_generator = group_mention_url_generator
+            @node = node
+          end
+
+          # @return [Array<Hash>]
+          def groups
+            @groups ||= []
+          end
+
+          # @return [false, true]
+          def ignorable?
+            !has_at_mark? || has_any_ignored_ancestor? || !replaced?
+          end
+
+          # @return [String]
+          def replaced_html
+            @replaced_html ||= html.gsub(GROUP_IDENTIFIER_PATTERN) do |_match|
+              team_url_name = ::Regexp.last_match(1)
+              group_url_name = ::Regexp.last_match(2)
+              group = { group_url_name: group_url_name, team_url_name: team_url_name }
+              groups << group
+              %(<a href="#{@group_mention_url_generator.call(group)}">) +
+                %(@#{team_url_name}/#{group_url_name}</a>)
+            end
+          end
+
+          private
+
+          # @return [false, true]
+          def has_any_ignored_ancestor?
+            @node.ancestors.any? do |node|
+              IGNORED_ANCESTOR_ELEMENT_NAMES.include?(node.name.downcase)
+            end
+          end
+
+          # @return [false, true]
+          def has_at_mark?
+            html.include?("@")
+          end
+
+          # @return [String]
+          def html
+            @html ||= @node.to_html
+          end
+
+          # @return [false, true]
+          def replaced?
+            html != replaced_html
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qiita/markdown/processor.rb

@@ -14,6 +14,7 @@ module Qiita
         Filters::Emoji,
         Filters::SyntaxHighlight,
         Filters::Mention,
+        Filters::GroupMention,
         Filters::Sanitize,
       ]
 

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.12.0"
+    VERSION = "0.13.0"
   end
 end

data/qiita-markdown.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rubocop", "~> 0.29"
+  spec.add_development_dependency "rubocop", "0.40.0"
 end

data/spec/qiita/markdown/processor_spec.rb

@@ -457,6 +457,40 @@ describe Qiita::Markdown::Processor do
       end
     end
 
+    context "with group mention" do
+      let(:markdown) do
+        "@alice/bob"
+      end
+
+      it "does not replace it" do
+        is_expected.to eq <<-EOS.strip_heredoc
+          <p>@alice/bob</p>
+        EOS
+      end
+    end
+
+    context "with group mention" do
+      let(:context) do
+        super().merge(group_mention_url_generator: lambda do |group|
+          "https://#{group[:team_url_name]}.example.com/groups/#{group[:group_url_name]}"
+        end)
+      end
+
+      let(:markdown) do
+        "@alice/bob"
+      end
+
+      it "replaces it with preferred link and updates :mentioned_groups" do
+        is_expected.to eq <<-EOS.strip_heredoc
+          <p><a href="https://alice.example.com/groups/bob">@alice/bob</a></p>
+        EOS
+        expect(result[:mentioned_groups]).to eq [{
+          group_url_name: "bob",
+          team_url_name: "alice",
+        }]
+      end
+    end
+
     context "with normal link" do
       let(:markdown) do
         "[](/example)"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -216,16 +216,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: 0.40.0
 description: 
 email:
 - r7kamura@gmail.com
@@ -252,6 +252,7 @@ files:
 - lib/qiita/markdown/filters/emoji.rb
 - lib/qiita/markdown/filters/footnote.rb
 - lib/qiita/markdown/filters/greenmat.rb
+- lib/qiita/markdown/filters/group_mention.rb
 - lib/qiita/markdown/filters/image_link.rb
 - lib/qiita/markdown/filters/mention.rb
 - lib/qiita/markdown/filters/sanitize.rb
@@ -290,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Qiita-specified markdown processor.