jekyll-disqus-plugin 1.0.0

data/README.md

@@ -0,0 +1,110 @@
+# Jekyll-Disqus
+
+This is a Jekyll plugin that provides the Liquid tags to render the Disqus Javascript codes inside the
+theme template.
+
+It also associates a different *ID* to every *post* using its publishing date and ensures the uniqueness
+of that ID among all the posts.
+
+Although the *ID* can be automatically generated is still possible to declare a custom *ID*, which is 
+mandatory for those pages that don't contain a publishing date but recall one of the Disqus tags in 
+their layouts.
+
+## Installation
+
+Inside the Gemfile add the gem name in the `:jekyll_plugins` group:
+```ruby
+group :jekyll_plugins do
+  ...
+  gem 'jekyll-disqus-plugin'
+end
+```
+
+Then run from the terminal:
+```shell
+$ bundle install
+```
+
+## Configuration
+
+Inside the `_config.yml` file can set up the following fields:
+```yaml
+jekyll-disqus:
+  shortname:
+  id_prefix: 
+  post_selector: 'include.post'
+  ui:
+    layouts:
+    - 'post'
+  counter:
+    layouts:
+    - 'all'
+```
+
+*shortname*
+: It is the same *Shortname* provided by Disqus for each site added.
+
+*id_prefix*
+: It is a code that will be prepended to any *Disqus Id*, just to add another level of customization.
+
+*post_selector*
+: This is how the script will read the post data inside a paginator layout.
+
+*ui.layouts*/*counter.layouts*
+: A list of layouts where the two couple of tags will be printed.
+
+To disable the tags for specific pages or posts, the *no_disqus* field can be set up to true on the front
+matter of the specific post or page itself.
+
+By default, this addon associates a unique *ID* to each *post* using the related publishing date, but
+where needed, a *disqus_id* field can be declared in the front matter of the page. 
+```yaml
+---
+title: ...
+description: ...
+author: ...
+...
+disqus_id: 'CUSTOM_DISQUS_ID'
+...
+```
+
+There is a deep relationship between the *disqus_id* and the related post, so be sure that:
+- The custom disqus_id will remain unique, otherwise an error will be raised at the building time;
+- the custom disqus_id won't change after the page has been published, otherwise all the comments
+    associated with the post will be lost;
+- the publishing date, where the *ID* is not customized, doesn't change, or all the comments associated
+    with the post will be lost.
+
+## Usage
+
+Below are the provided tags:
+
+|            Tag              |                      Description                    | Template |
+|:---------------------------:|-----------------------------------------------------|:--------:|
+| {% disqus_counter %}        |The count of comments for a certain post             |   Post   |
+| {% disqus_script_counter %} |The required Javascript that renders the counter     |  Default |
+| {% disqus_ui %}             |The comment box                                      |   Post   |
+| {% disqus_script_ui %}      |The required Javascript that renders the comment box |  Default |
+
+The *script* tags must be included once for page and, providing a Javascript code, their position should
+be in the bottom part of the main layout, just before the end of the *body* HTML tag.
+
+The *disqus_ui* renders the comment box and should be put in the post or page layout, depending
+where you want to show it, usually after the *content* has been printed.
+
+The *disqus_counter* shows the number of comments for a  post (or page), and it is 
+bound to the specific content through the *disqus_id* aforementioned.
+Usually, it is displayed among the content *data*, just after the title, and it works for the full
+rendered post as well as the paginated content.
+
+In the last case, the plugin will detect the post included in the pagination template using a selector.
+By default, it is `include.post`, but can be changed in the configuration section of the `_config.yml`
+file.
+
+## More Help
+
+- the [project page on the Freeaptitude blog][project_page];
+- the [Jekyll-Disqus Github wiki][jekyll_disqus_wiki].
+
+[project_page]: https://freeaptitude.altervista.org/projects/jekyll-disqus.html "Project page on the Freeaptitude blog"
+[jekyll_disqus_wiki]: https://github.com/fabiomux/jekyll-disqus-plugin/wiki "Jekyll-Disqus wiki page on GitHub"

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/jekyll-disqus-plugin.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/disqus/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-disqus-plugin"
+  spec.version = Jekyll::Disqus::VERSION
+  spec.authors = ["Fabio Mucciante"]
+  spec.email = ["fabio.mucciante@gmail.com"]
+
+  spec.summary = "Jekyll plugin to render the Javascript Disqus codes required."
+  spec.description = "It provides the tags for the comment box, the counter and the related Javascript initializers."
+  spec.homepage = "https://freeaptitude.altervista.org/projects/jekyll-disqus.html"
+  spec.license = "GPL-3.0"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fabiomux/jekyll-disqus-plugin"
+  spec.metadata["changelog_uri"] = "https://freeaptitude.altervista.org/projects/jekyll-disqus.html#changelog"
+  spec.metadata["wiki_uri"] = "https://github.com/fabiomux/jekyll-disqus-plugin/wiki"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jekyll/disqus/helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Jekyll
+  module Disqus
+    #
+    # Contains the methods to calculate the Disqus ID associated to
+    # a post or a page.
+    #
+    module Helper
+      def disabled_tag?(tag, context)
+        return true if context.registers[:page]["no_disqus"]
+        return false if context.registers[:site].config["jekyll-disqus"][tag]["layouts"].include?("all")
+
+        layout = context.registers[:page]["layout"]
+        return false if context.registers[:site].config["jekyll-disqus"][tag]["layouts"].include?(layout)
+
+        true
+      end
+
+      def post_selector(registers)
+        registers[:site].config["jekyll-disqus"]["post_selector"] || "include.post"
+      end
+
+      def page_disqus_id(registers)
+        id = registers[:page]["disqus_id"]
+        raise MissingDisqusId, registers[:page]["url"] if id.nil? && registers[:page]["date"].nil?
+
+        begin
+          id = DateTime.parse(registers[:page]["date"].to_s).to_time.to_i if id.nil?
+        rescue ArgumentError
+          raise InvalidDate, registers[:page]["url"]
+        end
+
+        registers[:site].config["jekyll-disqus"]["id_prefix"].to_s + id.to_s
+      end
+
+      def post_disqus_id(context)
+        selector = post_selector(context.registers)
+        return unless context["#{selector}.title"]
+
+        id = context["#{selector}.disqus_id"]
+        raise MissingDisqusId, registers[:page]["url"] if id.nil? && context["#{selector}.date"].nil?
+
+        begin
+          id = DateTime.parse(context["#{selector}.date"].to_s).to_time.to_i if id.nil?
+        rescue ArgumentError
+          raise InvalidDate, registers[:page]["url"]
+        end
+
+        context.registers[:site].config["jekyll-disqus"]["id_prefix"].to_s + id.to_s
+      end
+    end
+  end
+end

data/lib/jekyll/disqus/tags.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Disqus
+    #
+    # Anchor tag where rendering the comment box.
+    #
+    class UI < Liquid::Tag
+      include Helper
+
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text
+      end
+
+      def render(context)
+        return "" if disabled_tag?("ui", context)
+
+        "<div id=\"disqus_thread\"></div>"
+      end
+    end
+
+    #
+    # Anchor tag where rendering the comment counter.
+    #
+    class Counter < Liquid::Tag
+      include Helper
+
+      def initialize(tag_name, text, tokens)
+        super
+        params = text.scan(/(\w+)=(?:["'])([^'"]+)\K/).to_h
+        @label = params.key("label") || "Comments"
+      end
+
+      def render(context)
+        return "" if disabled_tag?("counter", context)
+
+        id = post_disqus_id(context)
+        id = page_disqus_id(context.registers) if id.nil?
+        return "" if id.nil?
+
+        "<span class=\"disqus-comment-count\" data-disqus-identifier=\"#{id}\">#{@label}</span>"
+      end
+    end
+
+    #
+    # Print the Javascript code to render the counter.
+    #
+    class ScriptCounter < Liquid::Tag
+      include Helper
+
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text
+      end
+
+      def render(context)
+        return "" if disabled_tag?("counter", context)
+
+        "<script
+          id=\"dsq-count-scr\"
+          src=\"//#{context.registers[:site].config["jekyll-disqus"]["shortname"]}.disqus.com/count.js\"
+          async></script>".gsub(/\n/, " ").gsub(/ +/, " ")
+      end
+    end
+
+    #
+    # Print the Javascript code to render the comment box.
+    #
+    class ScriptUI < Liquid::Tag
+      include Helper
+
+      @@ids = {}
+
+      def initialize(tag_name, param, tokens)
+        super
+        @param = param
+      end
+
+      def render(context)
+        return "" if disabled_tag?("ui", context)
+
+        raise MissingShortname unless context.registers[:site].config["jekyll-disqus"]["shortname"]
+
+        id = page_disqus_id(context.registers)
+        url = context.registers[:page]["url"]
+        if @@ids.key?(id) && (@@ids[id] != url)
+          raise DuplicatedDisqusId, { current_url: url, duplicated_url: @@ids[id], id: id }
+        end
+
+        @@ids[id] = url
+        js_string(base_url: context.registers[:site].config["url"],
+                  page_url: url,
+                  disqus_shortname: context.registers[:site].config["jekyll-disqus"]["shortname"],
+                  disqus_id: id)
+      end
+
+      private
+
+      def js_string(args)
+        "<script>
+          var disqus_config = function () {
+            this.page.url = '#{args[:base_url]}#{args[:page_url]}';
+            this.page.identifier = '#{args[:disqus_id]}';
+          };
+          (function() {
+            var d = document, s = d.createElement('script');
+            s.src = '//#{args[:disqus_shortname]}.disqus.com/embed.js';
+            s.setAttribute('data-timestamp', +new Date());
+            (d.head || d.body).appendChild(s);
+          })();
+        </script>
+        <noscript>
+          Please enable JavaScript to view the
+          <a href=\"https://disqus.com/?ref_noscript\">comments powered by Disqus.</a>
+        </noscript>"
+      end
+    end
+  end
+end

data/lib/jekyll/disqus/utils.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Disqus
+    #
+    # Invalid date format.
+    #
+    class InvalidDate < StandardError
+      def initialize(url)
+        super "The page at the URL: #{url} doesn't contains a valid 'date' field!"
+      end
+    end
+
+    #
+    # Missing Disqus ID field error.
+    #
+    class MissingDisqusId < StandardError
+      def initialize(url)
+        super "The page at the URL: #{url} doesn't contains any 'disqus_id' field!"
+      end
+    end
+
+    #
+    # Missing the Shortname param error.
+    #
+    class MissingShortname < StandardError
+      def initialize
+        super "The required Disqus param 'shortname' is missing!"
+      end
+    end
+
+    #
+    # Duplicated Disqus ID among pages and posts.
+    #
+    class DuplicatedDisqusId < StandardError
+      def initialize(args)
+        super "The page at the URL: #{args[:current_url]}
+          has the same Disqus ID of: #{args[duplicated_url]} (#{args[id]})!"
+      end
+    end
+  end
+end

data/lib/jekyll/disqus/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Disqus
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll/disqus.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+require_relative "disqus/helper"
+require_relative "disqus/tags"
+require_relative "disqus/utils"
+
+Liquid::Template.register_tag("disqus_ui", Jekyll::Disqus::UI)
+Liquid::Template.register_tag("disqus_script_ui", Jekyll::Disqus::ScriptUI)
+Liquid::Template.register_tag("disqus_counter", Jekyll::Disqus::Counter)
+Liquid::Template.register_tag("disqus_script_counter", Jekyll::Disqus::ScriptCounter)

data/lib/jekyll-disqus-plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "jekyll/disqus"

data/sig/jekyll/disqus.rbs

@@ -0,0 +1,6 @@
+module Jekyll
+  module Disqus
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-disqus-plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fabio Mucciante
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: It provides the tags for the comment box, the counter and the related
+  Javascript initializers.
+email:
+- fabio.mucciante@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-disqus-plugin.gemspec
+- lib/jekyll-disqus-plugin.rb
+- lib/jekyll/disqus.rb
+- lib/jekyll/disqus/helper.rb
+- lib/jekyll/disqus/tags.rb
+- lib/jekyll/disqus/utils.rb
+- lib/jekyll/disqus/version.rb
+- sig/jekyll/disqus.rbs
+homepage: https://freeaptitude.altervista.org/projects/jekyll-disqus.html
+licenses:
+- GPL-3.0
+metadata:
+  homepage_uri: https://freeaptitude.altervista.org/projects/jekyll-disqus.html
+  source_code_uri: https://github.com/fabiomux/jekyll-disqus-plugin
+  changelog_uri: https://freeaptitude.altervista.org/projects/jekyll-disqus.html#changelog
+  wiki_uri: https://github.com/fabiomux/jekyll-disqus-plugin/wiki
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to render the Javascript Disqus codes required.
+test_files: []