jekyll-hashtags 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '095c38c828b59386d64ccbd146cd436d648dbee0'
-  data.tar.gz: d401e722673026f6de0ab63659fafbc752783a06
+  metadata.gz: b1545e79b465d7005f1e46b7165029d2ff54092d
+  data.tar.gz: 41957d75b14b4986059ecf2c0d5cebeeac20437e
 SHA512:
-  metadata.gz: 88f0763e84d5d8a27641efe4617b4852dae26479602dbbf45a8c2a5e4ce035572a8c62c74fc91b10a59e202b8082bcd048e62eeb63382c7cbedbd6a0aeddbce2
-  data.tar.gz: c49e73b37e070e95f036ac72f4a4e7e05fcb844d8f3d391bd9ee929dad4867044a82a91206ab4595a7223bfba50df5dd90a5436cb3e6c40b0e72b37a29039821
+  metadata.gz: 0d019105cdf73f1d932f93540f3371cd92706b605df374059809bc77491e04bb95df3e8a45b4d848ebd8ac39da816edfa70484191523fe8c1927114abca13e51
+  data.tar.gz: 339a94fee34d0b4cf1ec35a564b32a7ec1f9325db1fc46a8f9e147045c6ab89ecb2cf1c731c5ea7d341fe3c6293602b0588f7cc088ba1cb645948f670061e3b9

data/.gitignore

@@ -7,3 +7,4 @@ bin
 Gemfile.lock
 pkg/*.gem
 .rspec_status
+spec/blog/_site/

data/README.md

@@ -1,6 +1,6 @@
 # Jekyll::Hashtags
 
-#hashtags support for you jekyll site.
+#hashtags support for you jekyll site. 
 
 ## Installation
 
@@ -11,48 +11,53 @@ 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:
+```
 
+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?
+>  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.

data/jekyll-hashtags.gemspec

@@ -32,8 +32,10 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = ">= 2.3.0"
+
   spec.add_dependency "jekyll", "~> 3.0"
+  spec.add_dependency "html-pipeline-hashtag", "~> 0.1.1"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/jekyll-hashtags.rb

@@ -21,9 +21,14 @@ module Jekyll
         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
+          context = {
+              "hashtag_pattern" => get_hashtag_pattern(doc.site.config),
+              "tag_url" => get_tag_url(doc.site.config),
+          }
+          processed_markup = filter_with_hashtag(base_url, context).call(body)[:output].to_html
           doc.output = String.new(head) << opener << processed_markup << rest.join
+        else
+          doc.output = filter_with_hashtag(base_url, context).call(content)[:output].to_html
         end
       end
 
@@ -34,11 +39,9 @@ module Jekyll
         #
         # Returns an HTML::Pipeline instance for the given base URL.
         #
-      def filter_with_hashtag(config = {}, base_url = DEFAULT_HASHTAG_BASE_URL)
+      def filter_with_hashtag(base_url = DEFAULT_HASHTAG_BASE_URL, context = {})
         filters[base_url] ||= HTML::Pipeline.new([HTML::Pipeline::HashtagFilter],
-                                                 :hashtag_pattern => get_hashtag_pattern(config),
-                                                 :tag_url => get_tag_url(config)
-                                                )
+                                                 context)
       end
 
       # Public: Filters hash where the key is the mention base URL.
@@ -61,11 +64,11 @@ module Jekyll
         hashtag_config = config["jekyll-hashtags"]
         case hashtag_config
         when nil, NilClass
-          Regexp.new(HTML::Pipeline::HashtagFilter::HashtagPattern)
+          HTML::Pipeline::HashtagFilter::HashtagPattern
         when String
-          Regexp.new(hashtag_config.to_s)
+          hashtag_config.to_s
         when Hash
-          Regexp.new(hashtag_config.fetch("tag_pattern", DEFAULT_HASHTAG_PATTERN))
+          hashtag_config.fetch("tag_pattern", DEFAULT_HASHTAG_PATTERN)
         else
           raise Class.new(Jekyll::Errors::FatalException),
                 "Your jekyll-hashtag config has to either be a" \
@@ -124,10 +127,20 @@ module Jekyll
             " string or a hash. It's a #{hashtag_config.class} right now."
         end
       end
+
+      # Public: Defines the conditions for a document to be tagable.
+      #
+      # doc - the Jekyll::Document or Jekyll::Page
+      #
+      # Returns true if the doc is written & is HTML.
+      def tagable?(doc)
+        (doc.is_a?(Jekyll::Page) || doc.write?) &&
+            doc.output_ext == ".html" || (doc.permalink&.end_with?("/"))
+      end
     end
   end
 end
 
 Jekyll::Hooks.register %i[pages documents], :post_render do |doc|
-  Jekyll::Hashtags.hashtag_it(doc)
+  Jekyll::Hashtags.hashtag_it(doc) if Jekyll::Hashtags.tagable?(doc)
 end

data/lib/jekyll-hashtags/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-hashtags
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Wei Heng
@@ -11,33 +11,33 @@ cert_chain: []
 date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: html-pipeline-hashtag
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: html-pipeline-hashtag
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="