qiita-markdown 0.11.5 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec6145ad1c4a81c4e3cb46c2d3e6c86e8051ff7b
-  data.tar.gz: 0ac6fc03d26838c7c80ca7a347c17002b33d634d
+  metadata.gz: ff7146b861299953ada5127646c21a9cffb3b2ed
+  data.tar.gz: 1efaba3aa4ded077adec7894e0fc6b22c7377c06
 SHA512:
-  metadata.gz: f81cedd31daa8953dc2514511660f8f55af54acd1ffefefd306a211d4dc102b260f04c9371de7df1a3c6939281efc9fbadbd78308489474ce770ed54ed2d248d
-  data.tar.gz: 3a31ff0761eb73c05b9c5be2951265d91790989a9ac3b3033a4321a7cdcf980d0e1df954e65268a1bdcdd4e21bbad8bf61849b082a030787dce31a136f12e0bb
+  metadata.gz: d0d94503283fe41276b338bab864bd0f449adbf1d93417d46ae4187754197e957319bb551e6122a562972545d5313104cb753646239ff2aac9c953f6aae974c0
+  data.tar.gz: 4c67bdc61902c94a21ef233d1725e7e14b4cbac14cf8cbdb24f6700ebaf80449228c7215ee8c2375382459f2be1aa3dcccc938cbd4b41a853c7389fc4d51da1a

data/.rubocop.yml

@@ -3,10 +3,26 @@ inherit_from: .rubocop_todo.yml
 Metrics/ClassLength:
   Enabled: false
 
+Style/AsciiComments:
+  Exclude:
+    - benchmark/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
-Style/TrailingComma:
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: comma
 
 Style/UnneededPercentQ:

data/.rubocop_todo.yml

@@ -1,20 +1,22 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-03-12 12:56:25 +0900 using RuboCop version 0.29.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-05-25 17:29:05 +0900 using RuboCop version 0.40.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 4
 Metrics/AbcSize:
   Max: 21
 
-# Offense count: 27
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 37
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
 Metrics/LineLength:
-  Max: 122
+  Max: 121
 
-# Offense count: 3
+# Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 20
@@ -22,77 +24,121 @@ Metrics/MethodLength:
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: always, conditionals
 Style/AndOr:
-  Enabled: false
+  Exclude:
+    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
 
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: percent_q, bare_percent
 Style/BarePercentLiterals:
-  Enabled: false
+  Exclude:
+    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
 
 # Offense count: 1
 Style/ConstantName:
-  Enabled: false
-
-# Offense count: 10
-Style/Documentation:
-  Enabled: false
+  Exclude:
+    - 'lib/qiita/markdown/filters/mention.rb'
 
 # Offense count: 3
 Style/DoubleNegation:
-  Enabled: false
+  Exclude:
+    - 'benchmark/heading_anchor_rendering.rb'
+    - 'lib/qiita/markdown/filters/checkbox.rb'
 
 # Offense count: 1
-# Configuration parameters: Exclude.
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
 Style/FileName:
-  Enabled: false
+  Exclude:
+    - 'lib/qiita-markdown.rb'
 
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false
+# Offense count: 11
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/qiita/markdown/filters/checkbox.rb'
+    - 'lib/qiita/markdown/filters/code.rb'
+    - 'lib/qiita/markdown/filters/sanitize.rb'
+    - 'lib/qiita/markdown/filters/simplify.rb'
+    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
+    - 'lib/qiita/markdown/processor.rb'
+    - 'lib/qiita/markdown/summary_processor.rb'
+    - 'lib/qiita/markdown/version.rb'
 
-# Offense count: 1
+# Offense count: 2
+# Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+# SupportedStyles: skip_modifier_ifs, always
 Style/Next:
-  Enabled: false
+  Exclude:
+    - 'lib/qiita/markdown/filters/code.rb'
+    - 'lib/qiita/markdown/filters/image_link.rb'
 
-# Offense count: 9
+# Offense count: 11
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredDelimiters.
 Style/PercentLiteralDelimiters:
-  Enabled: false
+  Exclude:
+    - 'benchmark/heading_anchor_rendering.rb'
+    - 'lib/qiita/markdown/filters/mention.rb'
+    - 'lib/qiita/markdown/filters/sanitize.rb'
+    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
+    - 'spec/qiita/markdown/processor_spec.rb'
+    - 'spec/qiita/markdown/summary_processor_spec.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/PerlBackrefs:
-  Enabled: false
-
-# Offense count: 10
-# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+  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:
-  Enabled: false
+  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: 2
-# Configuration parameters: MaxSlashes.
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
-  Enabled: false
+  Exclude:
+    - 'lib/qiita/markdown/filters/mention.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: only_raise, only_fail, semantic
 Style/SignalException:
-  Enabled: false
+  Exclude:
+    - 'lib/qiita/markdown/greenmat/heading_rendering.rb'
+    - 'spec/qiita/markdown/summary_processor_spec.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
-Style/TrailingComma:
-  Enabled: false
+# SupportedStyles: comma, consistent_comma, no_comma
+Style/TrailingCommaInArguments:
+  Exclude:
+    - 'lib/qiita/markdown/filters/mention.rb'
+    - 'spec/qiita/markdown/processor_spec.rb'
 
-# Offense count: 6
+# Offense count: 9
 # Cop supports --auto-correct.
-# Configuration parameters: WordRegex.
+# Configuration parameters: EnforcedStyle, SupportedStyles, MinSize, WordRegex.
+# SupportedStyles: percent, brackets
 Style/WordArray:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.12.0
+- Add custom emoji support via `:emoji_names` and `:emoji_url_generator` contexts
+
 ## 0.11.5
 - Add a leading newline to `<pre>` elements so that leading newlines inputted by user are properly rendered on browsers
 

data/README.md

@@ -47,14 +47,17 @@ processor.call(text)
 `.new` and `#call` can take optional context as a Hash with following keys:
 
 ```
-:allowed_usernames - A list of usernames allowed to be username. (Array<String>)
-:asset_path        - URL path to link to emoji sprite. (String)
-:asset_root        - Base URL to link to emoji sprite. (String)
-:base_url          - Used to construct links to user profile pages for each. (String)
-:default_language  - Default language used if no language detected from code. (String)
-:language_aliases  - Alias table for some language names. (Hash)
-:rule              - Sanitization rule table. (Hash)
-:script            - A flag to allow to embed script element. (Boolean)
+:allowed_usernames   - A list of usernames allowed to be username. (Array<String>)
+:asset_path          - URL path to link to emoji sprite. (String)
+:asset_root          - Base URL to link to emoji sprite. (String)
+:base_url            - Used to construct links to user profile pages for each. (String)
+:default_language    - Default language used if no language detected from code. (String)
+:emoji_names         - A list of allowed emoji names. (Array<String>)
+:emoji_url_generator - #call'able object that accepts emoji name as argument and returns emoji image URL. (#call)
+                       The original implementation is used when the generator returned a falsey value.
+:language_aliases    - Alias table for some language names. (Hash)
+:rule                - Sanitization rule table. (Hash)
+:script              - A flag to allow to embed script element. (Boolean)
 ```
 
 ```ruby

data/benchmark/heading_anchor_rendering.rb

@@ -171,7 +171,7 @@ module Rendering
             # no-op
           end
 
-          private
+          private # rubocop:disable Lint/UselessAccessModifier
 
           def content
             body

data/lib/qiita/markdown.rb

@@ -9,6 +9,7 @@ require "sanitize"
 
 require "qiita/markdown/filters/checkbox"
 require "qiita/markdown/filters/code"
+require "qiita/markdown/filters/emoji"
 require "qiita/markdown/filters/footnote"
 require "qiita/markdown/filters/greenmat"
 require "qiita/markdown/filters/image_link"

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

@@ -0,0 +1,33 @@
+module Qiita
+  module Markdown
+    module Filters
+      class Emoji < HTML::Pipeline::EmojiFilter
+        # @note Override
+        def validate
+          needs :asset_root unless emoji_url_generator
+        end
+
+        private
+
+        # @note Override
+        def emoji_url(name)
+          url = emoji_url_generator.call(name) if emoji_url_generator
+          url || super
+        end
+
+        def emoji_url_generator
+          context[:emoji_url_generator]
+        end
+
+        # @note Override
+        def emoji_pattern
+          @emoji_pattern ||= /:(#{Regexp.union(emoji_names).source}):/
+        end
+
+        def emoji_names
+          context[:emoji_names] || self.class.emoji_names
+        end
+      end
+    end
+  end
+end

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

@@ -74,7 +74,7 @@ module Qiita
             "script" => [
               "async",
               "src",
-              "type"
+              "type",
             ],
             "td" => [
               "style",

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

@@ -11,7 +11,7 @@ module Qiita
       class Truncate < HTML::Pipeline::Filter
         DEFAULT_OPTIONS = {
           length: 100,
-          omission: "…".freeze
+          omission: "…".freeze,
         }.freeze
 
         def call
@@ -36,7 +36,7 @@ module Qiita
         # since it traverses the node's descendants _before_ the node itself.
         # https://github.com/sparklemotion/nokogiri/blob/v1.6.6.2/lib/nokogiri/xml/node.rb#L571-L574
         def traverse(node, &block)
-          block.call(node)
+          yield(node)
 
           node.children.each do |child_node|
             traverse(child_node, &block)

data/lib/qiita/markdown/greenmat/heading_rendering.rb

@@ -8,7 +8,7 @@ module Qiita
 
         class AbstractHeading
           attr_reader :raw_body, :level, :counter, :escape_html
-          alias_method :escape_html?, :escape_html
+          alias escape_html? escape_html
 
           def initialize(raw_body, level, counter, escape_html = false)
             @raw_body = raw_body

data/lib/qiita/markdown/processor.rb

@@ -11,7 +11,7 @@ module Qiita
         Filters::Footnote,
         Filters::Code,
         Filters::Checkbox,
-        HTML::Pipeline::EmojiFilter,
+        Filters::Emoji,
         Filters::SyntaxHighlight,
         Filters::Mention,
         Filters::Sanitize,

data/lib/qiita/markdown/summary_processor.rb

@@ -7,10 +7,10 @@ module Qiita
       DEFAULT_FILTERS = [
         Filters::Greenmat,
         Filters::Simplify,
-        HTML::Pipeline::EmojiFilter,
+        Filters::Emoji,
         Filters::Mention,
         Filters::Sanitize,
-        Filters::Truncate
+        Filters::Truncate,
       ]
 
       # @note Modify filters if you want.

data/lib/qiita/markdown/version.rb

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

data/spec/qiita/markdown/processor_spec.rb

@@ -537,7 +537,7 @@ describe Qiita::Markdown::Processor do
 
       it "wraps it in a element" do
         should eq '<p><a href="http://example.com/b.png" target="_blank">' +
-          %(<img src="http://example.com/b.png" alt="a"></a></p>\n)
+                  %(<img src="http://example.com/b.png" alt="a"></a></p>\n)
       end
     end
 
@@ -786,5 +786,32 @@ describe Qiita::Markdown::Processor do
         EOS
       end
     end
+
+    context "with emoji_names and emoji_url_generator context" do
+      before do
+        context[:emoji_names] = %w(foo o)
+
+        context[:emoji_url_generator] = proc do |emoji_name|
+          "https://example.com/foo.png" if emoji_name == "foo"
+        end
+      end
+
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          :foo: :o: :x:
+        EOS
+      end
+
+      it "replaces only the specified emoji names with img elements with custom URL" do
+        should include(
+          '<img class="emoji" title=":foo:" alt=":foo:" src="https://example.com/foo.png"',
+          '<img class="emoji" title=":o:" alt=":o:" src="/images/emoji/unicode/2b55.png"'
+        )
+
+        should_not include(
+          '<img class="emoji" title=":x:" alt=":x:"'
+        )
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.12.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -243,13 +243,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- benchmark/.rubocop.yml
 - benchmark/heading_anchor_rendering.rb
 - benchmark/sample.md
 - lib/qiita-markdown.rb
 - lib/qiita/markdown.rb
 - lib/qiita/markdown/filters/checkbox.rb
 - lib/qiita/markdown/filters/code.rb
+- lib/qiita/markdown/filters/emoji.rb
 - lib/qiita/markdown/filters/footnote.rb
 - lib/qiita/markdown/filters/greenmat.rb
 - lib/qiita/markdown/filters/image_link.rb

data/benchmark/.rubocop.yml

@@ -1,4 +0,0 @@
-inherit_from: ../.rubocop.yml
-
-Style/AsciiComments:
-  Enabled: false