jekyll-github-comments 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 931c91d19357feba1e0fae3750f040cf9eab48bd
+  data.tar.gz: 159695c435f8f005dd5e0545d7cef2444cbf3875
+SHA512:
+  metadata.gz: 462bdfa6e6320dd8cfc785128cc7dc80fe39396fd86e7ff62be92acead6daa57208cb377e1038231ab39c98a6f447b6b4bb60c40217ff91e831f454164f5702a
+  data.tar.gz: 651d4fc2517d30dd48521a2ff9612b9f3bbf51123a8527d59f490d51695e4f4abc035c185a44d3022cfbd5b1d5505a40f1fbb4457b67166bbe31e5dbf3f1e984

data/lib/jekyll-github-comments.rb

@@ -0,0 +1,185 @@
+require 'jekyll'
+require 'liquid'
+
+module Jekyll
+  module GitHubComments
+    DEFAULTS = {
+      "branch" => "master",
+      "comments_template" => "comments.html",
+      "comment_template" => "comment.html"
+    }
+
+    class Comments < Liquid::Block
+      def initialize(tag_name, markup, tokens)
+        super
+      end
+
+      def parse(tokens)
+        super
+        @line = tokens[0].line_number
+      end
+
+      def render(context)
+        if context["subcomments"] then
+          context["comments"] = super
+        else
+          context["subcomments"] = true
+          context["comments"] = super
+          context["subcomments"] = false
+        end
+
+        config = DEFAULTS.merge(context["site"]["github_comments"] || {})
+
+        path = context["page"]["path"]
+        line_no = @line + context["page"]["yamlsize"] + 2
+        context["comment_url"] = 
+          "https://github.com/#{ config["repo"] }/edit/#{ config["branch"] }/#{ path }#L#{ line_no }"
+        
+        partial = Jekyll::Tags::IncludeTag.parse("include", config["comments_template"], [], @options)
+
+        context.stack do
+          partial.render(context)
+        end
+      end
+    end
+
+    class Comment < Liquid::Block
+      VALID_SYNTAX = %r!
+      ([\w-]+)\s*=\s*
+        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
+      !x
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @params = markup
+        full_valid_syntax = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
+          unless @params =~ full_valid_syntax
+            raise ArgumentError "Invalid syntax for comment tag: #{@params}"
+        end
+        @tag_name = tag_name
+      end
+
+      # Find threaded replies and store them separately to comment content
+      def parse(tokens)
+        @line = tokens[0].line_number
+
+        @blank = true
+        @nodelist ||= []
+        @nodelist.clear
+        @replylist = []
+
+        while token = tokens.shift
+          begin
+            unless token.empty?
+              case
+              when token.start_with?(TAGSTART)
+                if token =~ FullToken
+
+                  # if we found the proper block delimiter just end parsing here and let the outer block
+                  # proceed
+                  return if block_delimiter == $1
+
+                  if tag = Liquid::Template.tags[$1]
+                    markup = token.is_a?(Liquid::Token) ? token.child($2) : $2
+                    new_tag = tag.parse($1, markup, tokens, @options)
+                    new_tag.line_number = token.line_number if token.is_a?(Liquid::Token)
+                    if "responses" == $1
+                      @replylist << new_tag
+                    else
+                      @blank &&= new_tag.blank?
+                      @nodelist << new_tag
+                    end
+                  else
+                    # this tag is not registered with the system
+                    # pass it to the current block for special handling or error reporting
+                    unknown_tag($1, $2, tokens)
+                  end
+                else
+                  raise SyntaxError.new(options[:locale].t("errors.syntax.tag_termination".freeze, :token => token, :tag_end => TagEnd.inspect))
+                end
+              when token.start_with?(VARSTART)
+                new_var = create_variable(token)
+                new_var.line_number = token.line_number if token.is_a?(Liquid::Token)
+                @nodelist << new_var
+                @blank = false
+              else
+                @nodelist << token
+                @blank &&= (token =~ /\A\s*\z/)
+              end
+            end
+          rescue SyntaxError => e
+            e.set_line_number_from_token(token)
+            raise
+          end
+        end
+      end
+
+      def parse_params(context)
+        params = {}
+        markup = @params
+
+        while (match = VALID_SYNTAX.match(markup))
+          markup = markup[match.end(0)..-1]
+
+          value = if match[2]
+                    match[2].gsub(%r!\\"!, '"')
+                  elsif match[3]
+                    match[3].gsub(%r!\\'!, "'")
+                  elsif match[4]
+                    context[match[4]]
+                  end
+
+          params[match[1]] = value
+        end
+        params
+      end
+
+      # Remove leading whitespace to stop markdown treating it as code
+      def align_left(string)
+        return string if string.strip.size == 0
+
+        relevant_lines = string.split(/\r\n|\r|\n/).select { |line| line.strip.size > 0 }
+        indentation_levels = relevant_lines.map do |line|
+          match = line.match(/^( +)[^ ]+/)
+          match ? match[1].size : 0
+        end
+
+        indentation_level = indentation_levels.min
+        string.gsub! /^#{' ' * indentation_level}/, '' if indentation_level > 0
+        string
+      end
+
+      def render(context)
+        config = DEFAULTS.merge(context["site"]["github_comments"] || {})
+
+        comment = @params ? parse_params(context) : {}
+        comment["content"] = align_left(super)
+        comment["replies"] = render_all(@replylist, context) if @replylist.length 
+
+        path = context["page"]["path"]
+        line_no = @line + context["page"]["yamlsize"] + 2
+        comment["reply_url"] = 
+          "https://github.com/#{ config["repo"] }/edit/#{ config["branch"] }/#{ path }#L#{ line_no }"
+
+        partial = Jekyll::Tags::IncludeTag.parse("include", config["comment_template"], [], @options)
+
+        context.stack do
+          context["comment"] = comment
+          partial.render(context)
+        end
+      end
+    end
+  end
+end
+
+
+Jekyll::Hooks.register [:posts, :pages, :documents], :pre_render do |page, payload|
+  content = File.read(page.path)
+  if content =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+    yaml = Regexp.last_match(1)
+  end
+  payload.page["yamlsize"] = yaml ? yaml.lines.count : 0
+end
+
+Liquid::Template.register_tag('responses', Jekyll::GitHubComments::Comments)
+Liquid::Template.register_tag('response', Jekyll::GitHubComments::Comment)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-github-comments
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Le Roy Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !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: liquid
+  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'
+description: A Jekyll plugin to provide static site comments via Github pull requests.
+email: steve@nourish.je
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-github-comments.rb
+homepage: http://rubygems.org/gems/jekyll-github-comments
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Jekyll Github Comments
+test_files: []