html-pipeline-hashtag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99e9948fdc73821d691dff56564bd95ba226cb22
+  data.tar.gz: 1376e1747eb940625c622414ee3f461cdfb533df
+SHA512:
+  metadata.gz: fdffdae4b8dfda259d5b0cff90f0ac8463325ba17af51a3ead9570824c0a36475ac1344c1ec97c46735299bb85da0dc10a1c4a2c5f119e7817e9cca5863b1902
+  data.tar.gz: 8eb869e289967a69541a1944b641539e86624a83da12f01182f5ed17c90d0d84f2956ba5dcb2b8040dfee88c3c1aaefa47e2678313b8f9370e27adb528bba8c7

data/.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html-pipeline-hashtag.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 German Antsiferov
+
+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,62 @@
+# Hashtag filter for html-pipeline
+
+An [HTML::Pipeline](https://github.com/jch/html-pipeline) filter for [hashtags](https://en.wikipedia.org/wiki/Hashtag).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-pipeline-hashtag'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html-pipeline-hashtag
+
+## Usage
+
+Example:
+
+```ruby
+require 'html/pipeline'
+require 'html/pipeline/hashtag/hashtag_filter'
+
+filters = [
+  HTML::Pipeline::MarkdownFilter,
+  HTML::Pipeline::HashtagFilter
+]
+
+pipeline = HTML::Pipeline.new filters
+
+input = "Hello #world!"
+
+context = {
+  :tag_url => '/tags/%{tag}'
+}
+
+pipeline.call(input, context)
+# => <p>Hello <a href="/tags/world" target="_blank" class="hashtag">#world</a>!</p> 
+
+```
+
+```ruby
+def extract_tags(*args)
+  tags = []
+  HTML::Pipeline::HashtagFilter.hashtags_in(*args) { |hashtag, tag| tags << tag }
+
+  tags
+end
+
+extract_tags("Hello #world! #welcome")
+# => ["world", "welcome"]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mr-dxdy/html-pipeline-hashtag.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/html-pipeline-hashtag.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html/pipeline/hashtag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html-pipeline-hashtag"
+  spec.version       = Html::Pipeline::Hashtag::VERSION
+  spec.authors       = ["German Antsiferov"]
+  spec.email         = ["dxdy@bk.ru"]
+
+  spec.summary       = %q{HTML Pipeline filter that replaces hashtags with links.}
+  spec.description   = %q{HTML Pipeline filter that replaces hashtags with links.}
+  spec.homepage      = "https://github.com/mr-dxdy/html-pipeline-hashtag"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'html-pipeline', '~> 1.11.0'
+  spec.add_development_dependency "rspec", '~> 3.2.0'
+end

data/lib/html/pipeline/hashtag.rb

@@ -0,0 +1,2 @@
+require 'html/pipeline/hashtag/hashtag_filter'
+require 'html/pipeline/hashtag/version'

data/lib/html/pipeline/hashtag/hashtag_filter.rb

@@ -0,0 +1,70 @@
+require 'set'
+
+require 'html/pipeline'
+
+module HTML
+  class Pipeline
+    # HTML filter that replaces @hashtag with link. Hashtags within <pre>,
+    # <code>, and <a> elements are ignored.
+    #
+    # Context options:
+    #   :tag_url - Used to construct links to search by hashtag.
+    #                  Example: http://localhost/search?q=%{tag}
+    #   :hashtag_pattern - Used to provide a custom regular expression to
+    #                      indentify hashtags
+    #
+    class HashtagFilter < Filter
+      def self.hashtags_in(text, hashtag_pattern = HashtagPattern)
+        text.gsub hashtag_pattern do |match|
+          tag = $1
+          yield match, tag
+        end
+      end
+
+      HashtagPattern = /#([\p{L}\w\-]+)/
+
+      IGNORE_PARENTS = %w(pre code a style).to_set
+
+      def call
+        search_text_nodes(doc).each do |node|
+          content = node.to_html
+
+          next if !content.include?('#')
+          next if has_ancestor?(node, IGNORE_PARENTS)
+
+          html = hashtag_link_filter(content, hashtag_pattern)
+          node.replace(html)
+        end
+
+        doc
+      end
+
+      def tag_url
+        context[:tag_url] || default_tag_url
+      end
+
+      def default_tag_url
+        '/tags/%{tag}'
+      end
+
+      def hashtag_pattern
+        context[:hashtag_pattern] || HashtagPattern
+      end
+
+      def hashtag_link_filter(text, hashtag_pattern)
+        self.class.hashtags_in(text, hashtag_pattern) do |match, tag|
+          link_to_hashtag(tag)
+        end
+      end
+
+      def link_to_hashtag(tag)
+        url = tag_url % { tag: tag }
+        link_pattern % { url: url, tag: tag }
+      end
+
+      def link_pattern
+        "<a href='%{url}' target='_blank' class='hashtag'>#%{tag}</a>"
+      end
+    end
+  end
+end

data/lib/html/pipeline/hashtag/version.rb

@@ -0,0 +1,7 @@
+module Html
+  module Pipeline
+    module Hashtag
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: html-pipeline-hashtag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- German Antsiferov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: HTML Pipeline filter that replaces hashtags with links.
+email:
+- dxdy@bk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- html-pipeline-hashtag.gemspec
+- lib/html/pipeline/hashtag.rb
+- lib/html/pipeline/hashtag/hashtag_filter.rb
+- lib/html/pipeline/hashtag/version.rb
+homepage: https://github.com/mr-dxdy/html-pipeline-hashtag
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: HTML Pipeline filter that replaces hashtags with links.
+test_files: []