jekyll-hashtags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '095c38c828b59386d64ccbd146cd436d648dbee0'
+  data.tar.gz: d401e722673026f6de0ab63659fafbc752783a06
+SHA512:
+  metadata.gz: 88f0763e84d5d8a27641efe4617b4852dae26479602dbbf45a8c2a5e4ce035572a8c62c74fc91b10a59e202b8082bcd048e62eeb63382c7cbedbd6a0aeddbce2
+  data.tar.gz: c49e73b37e070e95f036ac72f4a4e7e05fcb844d8f3d391bd9ee929dad4867044a82a91206ab4595a7223bfba50df5dd90a5436cb3e6c40b0e72b37a29039821

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle
+/*.gem
+/tmp
+vendor/
+.idea/
+bin
+Gemfile.lock
+pkg/*.gem
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.rspec_status

@@ -0,0 +1,9 @@
+example_id                            | status | run_time        |
+------------------------------------- | ------ | --------------- |
+./spec/jekyll/hashtags_spec.rb[1:1]   | passed | 0.00816 seconds |
+./spec/jekyll/hashtags_spec.rb[1:2]   | passed | 0.01133 seconds |
+./spec/jekyll/hashtags_spec.rb[1:3]   | passed | 0.00876 seconds |
+./spec/jekyll/hashtags_spec.rb[1:4]   | passed | 0.33524 seconds |
+./spec/jekyll/hashtags_spec.rb[1:5:1] | passed | 0.00738 seconds |
+./spec/jekyll/hashtags_spec.rb[1:5:2] | passed | 0.00604 seconds |
+./spec/jekyll/hashtags_spec.rb[1:5:3] | passed | 0.0059 seconds  |

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-hashtags.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Mynux
+
+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,68 @@
+# Jekyll::Hashtags
+
+#hashtags support for you jekyll site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-hashtags'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-hashtags
+
+## Usage
+
+
+Add the following to your site's Gemfile
+
+gem 'jekyll-hashtags'
+And add the following to your site's _config.yml
+
+plugins:
+  - jekyll-hashtags
+Note: if jekyll --version is less than 3.5 use:
+
+gems:
+  - jekyll-hashtags
+  
+In any page or post, use @hashtags as you would normally, e.g.
+
+Hey #TradeWar, what do you think of this?
+
+## Configuration
+Have your own social network? No problem. We allow you to configure the base URL of all the hashtags.
+
+To change it, add the following to your Jekyll configuration:
+
+jekyll-hashtags:
+  base_url: https://hengwei.me
+
+An example of Twitter hashtags using jekyll-hashtags:
+
+plugins:
+  - jekyll-hashtags
+
+jekyll-hashtags:
+  base_url: https://hengwei.me
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mynux/jekyll-hashtags.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/jekyll-hashtags.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-hashtags/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-hashtags"
+  spec.version       = JekyllHashtags::VERSION
+  spec.authors       = ["Wei Heng"]
+  spec.email         = ["jj@hengwei.me"]
+
+  spec.summary       = %q{#hashtag support for your Jekyll site}
+  spec.description   = %q{#hashtag support for your Jekyll site with twitter-like feature.}
+  spec.homepage      = "https://github.com/mynux/jekyll-hashtags"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "html-pipeline-hashtag", "~> 0.1.1"
+  spec.add_dependency "jekyll", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jekyll-hashtags.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'html/pipeline/hashtag/hashtag_filter'
+
+module Jekyll
+  class Hashtags
+    HASH_TAG_SYMBOL = '#'
+    DEFAULT_HASHTAG_BASE_URL = ''
+    DEFAULT_HASHTAG_URL = '/tags/%{tag}'
+    DEFAULT_HASHTAG_PATTERN = '/#([\p{L}\w\-]+)/'
+    BODY_START_TAG = '<body'
+    OPENING_BODY_TAG_REGEX = %r!<body(.*)>\s*!
+    BODY_END_TAG = '</body>'
+
+    class << self
+      def hashtag_it(doc)
+        content = doc.output
+        return unless content.include?(HASH_TAG_SYMBOL)
+        base_url = get_base_url(doc.site.config)
+        if content.include? BODY_START_TAG
+          head, opener, tail = content.partition(OPENING_BODY_TAG_REGEX)
+          body, *rest = tail.partition(BODY_END_TAG)
+          return unless body =~ get_hashtag_pattern(doc.site.config)
+          processed_markup = filter_with_hashtag(doc.site.config, base_url).call(body)[:output].to_s
+          doc.output = String.new(head) << opener << processed_markup << rest.join
+        end
+      end
+
+        # Public: Create or fetch the filter for the given {{src}} base URL.
+        #
+        # :doc
+        # :base_url - the base URL (e.g. http://mynux.cn)
+        #
+        # Returns an HTML::Pipeline instance for the given base URL.
+        #
+      def filter_with_hashtag(config = {}, base_url = DEFAULT_HASHTAG_BASE_URL)
+        filters[base_url] ||= HTML::Pipeline.new([HTML::Pipeline::HashtagFilter],
+                                                 :hashtag_pattern => get_hashtag_pattern(config),
+                                                 :tag_url => get_tag_url(config)
+                                                )
+      end
+
+      # Public: Filters hash where the key is the mention base URL.
+      # Effectively a cache.
+      def filters
+        @filters ||= {}
+      end
+
+        # Public: Calculate the tag pattern to use for hashtag.
+        # The custom tag patter can be defined in the config as
+        # jekyll-hashtag.tag_pattern or jekyll-hashtags, and must
+        # be a valid regex.
+        #
+        # config - the hash-like configuration of the document's site
+        #
+        # Returns a regex valid string to use as the tag pattern for hashtags.
+        # Defaults is #{DEFAULT_HASHTAG_PATTERN}
+        #
+      def get_hashtag_pattern(config = {})
+        hashtag_config = config["jekyll-hashtags"]
+        case hashtag_config
+        when nil, NilClass
+          Regexp.new(HTML::Pipeline::HashtagFilter::HashtagPattern)
+        when String
+          Regexp.new(hashtag_config.to_s)
+        when Hash
+          Regexp.new(hashtag_config.fetch("tag_pattern", DEFAULT_HASHTAG_PATTERN))
+        else
+          raise Class.new(Jekyll::Errors::FatalException),
+                "Your jekyll-hashtag config has to either be a" \
+            " string or a hash. It's a #{hashtag_config.class} right now."
+        end
+      end
+
+        # Public: Calculate the base URL to use for hashtag.
+        # The custom base URL can be defined in the config as
+        # jekyll-hashtag.base_url or jekyll-hashtags, and must
+        # be a valid URL (i.e. it must include a protocol and valid domain)
+        # It should _not_ have a trailing slash.
+        #
+        # config - the hash-like configuration of the document's site
+        #
+        # Returns a URL to use as the base URL for hashtags.
+        # Defaults is blank.
+        #
+      def get_base_url(config = {})
+        hashtag_config = config["jekyll-hashtags"]
+        case hashtag_config
+        when nil, NilClass
+          DEFAULT_HASHTAG_BASE_URL
+        when String
+          hashtag_config.to_s
+        when Hash
+          hashtag_config.fetch("base_url", DEFAULT_HASHTAG_BASE_URL)
+        else
+          raise Class.new(Jekyll::Errors::FatalException),
+                "Your jekyll-hashtag config has to either be a" \
+            " string or a hash. It's a #{hashtag_config.class} right now."
+        end
+      end
+
+        # Public: Calculate the default tag url to use for hashtag.
+        # The custom tag patter can be defined in the config as
+        # jekyll-hashtag.tag_url or jekyll-hashtags.
+        #
+        # config - the hash-like configuration of the document's site
+        #
+        # Returns a regex valid string to use as the tag pattern for hashtags.
+        # Defaults is #{DEFAULT_HASHTAG_URL}
+        #
+      def get_tag_url(config = {})
+        hashtag_config = config["jekyll-hashtags"]
+        case hashtag_config
+        when nil, NilClass
+          DEFAULT_HASHTAG_URL
+        when String
+          hashtag_config.to_s
+        when Hash
+          hashtag_config.fetch("tag_url", DEFAULT_HASHTAG_BASE_URL)
+        else
+          raise Class.new(Jekyll::Errors::FatalException),
+                "Your jekyll-hashtag config has to either be a" \
+            " string or a hash. It's a #{hashtag_config.class} right now."
+        end
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register %i[pages documents], :post_render do |doc|
+  Jekyll::Hashtags.hashtag_it(doc)
+end

data/lib/jekyll-hashtags/version.rb

@@ -0,0 +1,3 @@
+module JekyllHashtags
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-hashtags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wei Heng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-pipeline-hashtag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "#hashtag support for your Jekyll site with twitter-like feature."
+email:
+- jj@hengwei.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rspec_status"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-hashtags.gemspec
+- lib/jekyll-hashtags.rb
+- lib/jekyll-hashtags/version.rb
+homepage: https://github.com/mynux/jekyll-hashtags
+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: "#hashtag support for your Jekyll site"
+test_files: []