goethe 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 169efb6b4b42556780aeabb970d696b7d966f324
+  data.tar.gz: 5e2305c4ea7fe484696fc4842295ff680c25d9f1
+SHA512:
+  metadata.gz: b392b59a5b0b4b6cd4295fcc1fcabc0e65a1113c2fcfdcf0d7e0767cbb301df8c7db1bc2f75754c6a1a95a4f31ff9727189df3e04e643fb0dc22e113b5f007f8
+  data.tar.gz: 33772e2c75a50fbe2a5c36a06832c4304baf776b3caae853b87a929cd470854d2c6598ad4ad414661b43723e8c38625b98338cece0be743a9f8d965fbff48d1f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.gitlab-ci.yml

@@ -0,0 +1,26 @@
+rspec:
+  script:
+    - http_proxy=http://10.8.15.225:8443 https_proxy=http://10.8.15.225:8443 bundle install 
+    - bundle exec rspec spec
+  tags:
+    - ruby
+    - rspec
+
+# generate-yard-doc:
+#   script:
+#     - http_proxy=http://10.8.15.225:8443 https_proxy=http://10.8.15.225:8443 bundle install --without development production
+#     - bundle exec yard
+#     - rsync -av doc/ deployer@intweb01.jianshu.io:/home/deployer/deploy/docs.jianshu.io/maleskine
+#   only:
+#     - master
+#   tags:
+#     - docs
+#   allow_failure: true
+
+# karma:
+#   script:
+#     - cnpm install
+#     - npm run bs_test
+#   tags:
+#     - javascript
+#     - vue

data/.ruby-gemset

@@ -0,0 +1 @@
+goethe

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://gems.ruby-china.org"
+
+# Specify your gem's dependencies in goethe.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    goethe (0.6.0)
+      nokogiri (~> 1.8.1)
+
+GEM
+  remote: https://gems.ruby-china.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  goethe!
+  rspec (~> 3.7.0)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jjy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+Goethe
+======
+
+歌德 - Text processing library used by Maleskine
+
+### 0.6.0
+
+- 升级 gems
+- 简化，去除现在 Maleskine 没有用到的方法
+
+### 0.5.0
+
+- 给 `Goethe::Utils.remove_html_tags` 添加参数 `replacement` 用以指定替换 HTML Tag 的字符
+
+### 0.4.0
+
+- 去除在 `link` 上添加的 `rel=nofollow`
+- markdown render 时，带 `class=m-footnote` 的 `link` 不添加 `target=_blank`
+- sanitize 白名单针对 `a` 元素添加 `id` 和 `class` 属性

data/goethe.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goethe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "goethe"
+  spec.version       = Goethe::VERSION
+  spec.authors       = ["larryzhao"]
+  spec.email         = ["thehiddendepth@gmail.com"]
+  spec.description   = %q{Goethe - Text processing library.}
+  spec.summary       = %q{Goethe - Text processing library.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
+
+  spec.add_dependency "nokogiri", "~> 1.8.1"
+end

data/goethe.rb

@@ -0,0 +1,3 @@
+require "goethe/version"
+require "goethe/markdown"
+require "goethe/utils"

data/lib/goethe.rb

@@ -0,0 +1,3 @@
+require "goethe/version"
+require "goethe/regex"
+require "goethe/utils"

data/lib/goethe/regex.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module Goethe
+  class Regex
+    REGEXEN = {}
+
+    HTML_TAGS = %w[a abbr address area article aside audio b base bdi bdo blockquote body br button canvas caption cite code col colgroup command data datagrid datalist dd del details dfn div dl font dt em embed eventsource fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header hgroup hr html i iframe img input ins kbd keygen label legend li link mark map menu meta meter nav noscript object ol optgroup option output p param pre progress q ruby rp rt s samp script section select small source span strong style sub summary sup table tbody td textarea tfoot th thead time title tr track u ul var video wbr center]
+    ADDITIONAL_HTML_TAG = %w[  ©]
+
+    REGEXEN[:HTML_TAGS] = /<\/?(#{HTML_TAGS.join('|')}).*?\/?>/im
+    REGEXEN[:ADDITIONAL_HTML_TAG] = /(#{ADDITIONAL_HTML_TAG.join('|')};?)/m
+    REGEXEN[:MARKDOWN] = { :HEADERS => /(^\s*#+\s*)|(^[-=]+$)/m,
+                           :EMPHASIS => /^(\*+|_+)(.*)(\1)$/,
+                           :BLOCKQUOTES => /^\s*>\s*/m,
+                           :LISTS => /^\s{0,3}(-|\*|\+|\d\.)\s+/,
+                           :HRULERS => /^(\*\s{0,3}\*\s{0,3}\*|-\s{0,3}-\s{0,3}-|_\s{0,3}_\s{0,3}_)[\s\*]*$/,
+                           :IMAGES => /!\[.*?\]\(.*?\)/m,
+                           :LINKS => /\[(.*?)\]\(.*?\)/m,
+                           :QUICK_LINKS => /<(.*)>/m,
+                           :COPYRIGHT => /&copy;/i
+                         }
+
+    def self.[](key)
+      REGEXEN[key]
+    end
+  end
+end

data/lib/goethe/utils.rb

@@ -0,0 +1,102 @@
+require "nokogiri"
+
+module Goethe
+  class Utils
+    class << self
+
+      #
+      # 从文本中找到链接，转化为 `<a>` 标签，找到换行符，转换为 `<br>` 标签
+      #
+      # @param [String] str
+      #
+      # @return [String]
+      #
+      def auto_link(str)
+        str = str.dup
+        str.gsub!(/<(S*?)[^>]*>.*?|<.*? \/>/) do |s|
+          s.gsub!(/</, "&lt;")
+          s.gsub!(/>/, "&gt;")
+        end
+
+        str.gsub!(/((https|http|ftp):\/\/)([a-zA-Z0-9.\-_%&=\/\#:\?]+)/i) do
+          protocol, url = $1, $3
+          %Q{<a href="#{protocol}#{url}" rel="nofollow" target="_blank">#{protocol}#{url}</a>}
+        end
+
+        str.gsub!(/\r\n|\n/, "<br>")
+        str
+      end
+
+      #
+      # 替换文本中所有的 HTML 标签，默认替换成空格
+      #
+      # @param [String] str
+      # @param [String] replacement - 替换的字符，默认是空格
+      #
+      # @return [String]
+      #
+      def remove_html_tags(str, replacement: " ")
+        return "" if str.nil?
+        str.gsub(Goethe::Regex[:HTML_TAGS], replacement)
+          .gsub(Goethe::Regex[:ADDITIONAL_HTML_TAG], replacement)
+      end
+
+      #
+      # 移除文本中所有的 Markdown 控制字符
+      #
+      # @param [String] str
+      #
+      # @return [String]
+      #
+      def remove_markdown_symbols(str)
+        return "" if str.nil?
+
+        result = ""
+
+        # HEADERS
+        result = str.gsub(Goethe::Regex[:MARKDOWN][:HEADERS], "")
+        #p "HEADERS: #{result}, #{result.size}"
+
+
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:BLOCKQUOTES], "")
+        #p "BLOCKQUOTES: #{result}, #{result.size}"
+
+
+        # RULERS
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:HRULERS], "") do
+          $2
+        end
+        #p "RULERS: #{result}, #{result.size}"
+
+        # LISTS
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:LISTS], "")
+        #p "LISTS: #{result}, #{result.size}"
+
+        # EMPHASIS
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:EMPHASIS]) do
+          $2
+        end
+
+
+        # IMAGES
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:IMAGES], "")
+
+
+        # LINKs
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:LINKS]) do
+          $1
+        end
+
+        # COPYRIGHT
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:COPYRIGHT], "")
+
+        # <quock_link>
+        result = result.gsub(Goethe::Regex[:MARKDOWN][:QUICK_LINKS]) do
+          " #{$1} "
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/goethe/version.rb

@@ -0,0 +1,3 @@
+module Goethe
+  VERSION = "0.6.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'goethe'

data/spec/utils_spec.rb

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+describe Goethe::Utils do
+  describe ".remove_html_tags" do
+    it "should replace html tags with space" do
+      str = "<p>我爱你</p>"
+      expect(Goethe::Utils.remove_html_tags(str)).to eq(" 我爱你 ")
+    end
+
+    it "should replace html char with space" do
+      str = "<p>hello&nbsp;</p>"
+      expect(Goethe::Utils.remove_html_tags(str)).to eq(" hello  ")
+    end
+
+    it "should replace html elements with given charater" do
+      str = "<p>hello&nbsp;</p>"
+      expect(Goethe::Utils.remove_html_tags(str, :replacement => "**")).to eq("**hello****")
+    end
+  end
+
+  describe ".remove_markdown_symbols" do
+    it "should remove headers" do
+      str = "#abc\n"
+      expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc\n")
+
+      str = " #### abc\n"
+      expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc\n")
+
+      str = "cba #### abc\n"
+      expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("cba #### abc\n")
+
+      str = "abc\n==="
+      expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc\n")
+
+      str = "abc\n---"
+      expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc\n")
+    end
+
+    context "Emphasis" do
+      it "should remove 1 * emphasis" do
+        str = "*abc*"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc")
+      end
+
+      it "should remove 2 * emphasis" do
+        str = "**abc**"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc")
+      end
+
+      it "should remove 3 * emphasis" do
+        str = "***abc***"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc")
+      end
+
+      it "should remove _ emphasis" do
+        str = "_abc_"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc")
+
+        str = "__abc__"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc")
+
+        str = "___abc___"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc")
+      end
+
+      it "should remove uneven emphasis" do
+        str = "***abc**"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("*abc")
+
+        str = "__abc___"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc_")
+      end
+    end
+
+    it "should remove blockquotes" do
+      str = "> abc\n"
+      expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc\n")
+    end
+
+    it "should remove lists" do
+      str = "* abc\n* bbc"
+      expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc\nbbc")
+    end
+
+    context "hrulers" do
+      it "should remove hrulers" do
+        str = "abc\n* * *\nbbc\n***\ncbc\n*****\ndbc\n- - -\nebc\n___"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("abc\n\nbbc\n\ncbc\n\ndbc\n\nebc\n")
+      end
+    end
+
+    context "links" do
+      it "should remove links correctly" do
+        str = "please go to google: [Google](http://www.google.com)"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("please go to google: Google")
+      end
+    end
+
+    context "images" do
+      it "should remove images correctly" do
+        str = "This is ![Alt text](/path/to/img.jpg 'Optional title') an image."
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("This is  an image.")
+      end
+    end
+
+    context "copyright" do
+      it "should remove the copyright sign" do
+        str = "Here is our &copy; brand"
+        expect(Goethe::Utils.remove_markdown_symbols(str)).to eq("Here is our  brand")
+      end
+    end
+  end
+
+  describe "auto_link" do
+    it "should parse correctly" do
+      str = "hellohttp://www.google.com/google"
+      expect(Goethe::Utils.auto_link(str)).to eq(%Q{hello<a href="http://www.google.com/google" rel="nofollow" target="_blank">http://www.google.com/google</a>})
+      str = "hellohttp://www.google.com/ google"
+      expect(Goethe::Utils.auto_link(str)).to eq(%Q{hello<a href="http://www.google.com/" rel="nofollow" target="_blank">http://www.google.com/</a> google})
+    end
+
+    it "should allow params" do
+      str = "hellohttp://www.google.com:8080/?search=google&keyword=google"
+      expect(Goethe::Utils.auto_link(str)).to eq(%Q{hello<a href="http://www.google.com:8080/?search=google&keyword=google" rel="nofollow" target="_blank">http://www.google.com:8080/?search=google&keyword=google</a>})
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: goethe
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- larryzhao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: Goethe - Text processing library.
+email:
+- thehiddendepth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- goethe.gemspec
+- goethe.rb
+- lib/goethe.rb
+- lib/goethe/regex.rb
+- lib/goethe/utils.rb
+- lib/goethe/version.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Goethe - Text processing library.
+test_files:
+- spec/spec_helper.rb
+- spec/utils_spec.rb