jekyll-github 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fa8ba69d5a59df8a37ae2605b0529c1582e1705976a872c2b598cbd1ef284e8
+  data.tar.gz: 2c500758db9053f1a13bc632ed2fdb5a8f6ea8c4998808771b0039319edf61d7
+SHA512:
+  metadata.gz: 5a21ccd72463421afc2955c3413427446302a05e7d47eb7dd79216db8ba7bf81111060d2c9930a9ec1452ea1a57c54a7383af0f35f972afb55bca5897e9e9117
+  data.tar.gz: 0f0e08201ed29a474908512cb49274fc9bd54713350f022db35bcc4633c34a332164b2d87904efadd21374598ef9ea30ea01e5f315aeb0f3223f71772ff260c8

data/lib/jekyll-github.rb

@@ -0,0 +1,209 @@
+require 'jekyll'
+
+module Jekyll
+  class Github
+    InvalidJekyllGithubConfig = Class.new(Jekyll::Errors::FatalException)
+
+    GH_COMMAND = 'gh@'
+
+    REGEX_S = {
+      'mention'     => /^[a-zA-Z0-9_.\-]+$/.freeze,
+      'repo'        => /^[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-]+$/.freeze,
+      'repo_branch' => /^[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-]+:[a-zA-Z0-9_.\-]+$/.freeze,
+      'issue_pr'    => /^[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-]+#[1-9][0-9]*$/.freeze,
+      'file'        => /^[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-][a-zA-Z0-9_.\-\/]*$/.freeze,
+      'file_branch' => /^[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-]+:[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-][a-zA-Z0-9_.\-\/]*$/.freeze,
+      'tag'         => /^[a-zA-Z0-9_.\-]+\/[a-zA-Z0-9_.\-]+=[a-zA-Z0-9_.\-]+$/.freeze
+    }.freeze
+
+    FORMAT_VARIABLES = {
+      'user'      => '<user>',
+      'repo'      => '<repo>',
+      'branch'    => '<branch>',
+      'issue_pr'  => '<issue_pr>',
+      'file'      => '<file>',
+      'tag'       => '<tag>',
+      'link'      => '<link>'
+    }
+
+    DEFAULT_CONFIG = {
+      'mention'     => '@<user>',
+      'repo'        => '<user>/<repo>',
+      'repo_branch' => '<user>/<repo>:<branch>',
+      'issue_pr'    => '#<issue_pr>',
+      'file'        => '<repo>/<file>',
+      'file_branch' => '<repo>:<branch>/<file>',
+      'tag'         => '<repo>=<tag>'
+    }
+
+    def initialize(document)
+      @content = document.content
+      @config = DEFAULT_CONFIG
+      configure(document.site.config, document.data)
+    end
+
+    def configure(site_data, doc_data)
+      parse_data(site_data['jekyll-github'])
+      parse_data(doc_data['jekyll-github'])
+    end
+
+    def parse_data(data)
+      case data
+      when nil, NilClass
+        return
+      when Hash
+        write_config(data)
+      else raise InvalidJekyllGithubConfig,
+                 'Only Hash data type accepted as \'jekyll-github\' config'
+      end
+    end
+
+    def write_config(data)
+      data.each { |key, val| @config[key] = val if DEFAULT_CONFIG.key?(key) }
+    end
+
+    def render_content
+      return @content unless @content.include?(GH_COMMAND)
+      i = -1 # as it increments first
+      while i < @content.length do
+        i += 1
+        next unless @content[i, GH_COMMAND.length] == GH_COMMAND
+        s = i
+        while i < @content.length do
+          i += 1
+          break if @content[i].match(/\s/)
+        end
+        e = i
+        word = process_word(@content[s...e])
+        @content = @content[0...s] + word + @content[e...(@content.length)]
+      end
+      return @content
+    end
+
+    def process_word(word)
+      content = word[(GH_COMMAND.length)...(word.length)]
+      REGEX_S.each { |key, val| content.match(val) { return segregate_word(key, content) } }
+      return word
+    end
+
+    def segregate_word(pattern, word)
+      case pattern
+      when 'mention'
+        return process_mention(word)
+      when 'repo'
+        return process_repo(word)
+      when 'repo_branch'
+        return process_repo_branch(word)
+      when 'issue_pr'
+        return process_issue_pr(word)
+      when 'file'
+        return process_file(word)
+      when 'file_branch'
+        return process_file_branch(word)
+      when 'tag'
+        return process_tag(word)
+      end
+    end
+
+    def process_mention(word)
+      text = @config['mention'].gsub(FORMAT_VARIABLES['user'], word)
+      link = "https://github.com/#{word}"
+      text.gsub!(FORMAT_VARIABLES['link'], link)
+      return "[#{text}](#{link})"
+    end
+
+    def process_repo(word)
+      items = word.split('/')
+      user  = items[0]
+      repo  = items[1]
+      text  = @config['repo']
+      text.gsub!(FORMAT_VARIABLES['user'], user)
+      text.gsub!(FORMAT_VARIABLES['repo'], repo)
+      link = "https://github.com/#{user}/#{repo}"
+      text.gsub!(FORMAT_VARIABLES['link'], link)
+      return "[#{text}](#{link})"
+    end
+
+    def process_repo_branch(word)
+      items  = word.split('/')
+      user   = items[0]
+      items  = items[1].split(':')
+      repo   = items[0]
+      branch = items[1]
+      text   = @config['repo_branch']
+      text.gsub!(FORMAT_VARIABLES['user'], user)
+      text.gsub!(FORMAT_VARIABLES['repo'], repo)
+      text.gsub!(FORMAT_VARIABLES['branch'], branch)
+      link = "https://github.com/#{user}/#{repo}/tree/#{branch}"
+      text.gsub!(FORMAT_VARIABLES['link'], link)
+      return "[#{text}](#{link})"
+    end
+
+    def process_issue_pr(word)
+      items    = word.split('/')
+      user     = items[0]
+      items    = items[1].split('#')
+      repo     = items[0]
+      issue_pr = items[1]
+      text     = @config['issue_pr']
+      text.gsub!(FORMAT_VARIABLES['user'], user)
+      text.gsub!(FORMAT_VARIABLES['repo'], repo)
+      text.gsub!(FORMAT_VARIABLES['issue_pr'], issue_pr)
+      link = "https://github.com/#{user}/#{repo}/pull/#{issue_pr}"
+      text.gsub!(FORMAT_VARIABLES['link'], link)
+      return "[#{text}](#{link})"
+    end
+
+    def process_file(word)
+      items = word.split('/')
+      user  = items[0]
+      repo  = items[1]
+      file  = items[2...(items.length)].join('/')
+      text  = @config['file']
+      text.gsub!(FORMAT_VARIABLES['user'], user)
+      text.gsub!(FORMAT_VARIABLES['repo'], repo)
+      text.gsub!(FORMAT_VARIABLES['file'], file)
+      link = "https://github.com/#{user}/#{repo}/tree/master/#{file}"
+      text.gsub!(FORMAT_VARIABLES['link'], link)
+      return "[#{text}](#{link})"
+    end
+
+    def process_file_branch(word)
+      items  = word.split(':')
+      tempi  = items[0].split('/')
+      user   = tempi[0]
+      repo   = tempi[1]
+      items  = items[1].split('/')
+      branch = items[0]
+      file   = items[1...(items.length)].join('/')
+      text   = @config['file_branch']
+      text.gsub!(FORMAT_VARIABLES['user'], user)
+      text.gsub!(FORMAT_VARIABLES['repo'], repo)
+      text.gsub!(FORMAT_VARIABLES['branch'], branch)
+      text.gsub!(FORMAT_VARIABLES['file'], file)
+      link = "https://github.com/#{user}/#{repo}/tree/#{branch}/#{file}"
+      text.gsub!(FORMAT_VARIABLES['link'], link)
+      return "[#{text}](#{link})"
+    end
+
+    def process_tag(word)
+      items = word.split('/')
+      user  = items[0]
+      items = items[1].split('=')
+      repo  = items[0]
+      tag   = items[1]
+      text  = @config['tag']
+      text.gsub!(FORMAT_VARIABLES['user'], user)
+      text.gsub!(FORMAT_VARIABLES['repo'], repo)
+      text.gsub!(FORMAT_VARIABLES['tag'], tag)
+      link = "https://github.com/#{user}/#{repo}/releases/tag/#{tag}"
+      text.gsub!(FORMAT_VARIABLES['link'], link)
+      return "[#{text}](#{link})"
+    end
+  end
+end
+
+Jekyll::Hooks.register [:pages, :documents], :pre_render do |doc|
+  github_doc  = Jekyll::Github.new(doc)
+  doc.content = github_doc.render_content
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-github
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- vrongmeal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-13 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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-github.rb
+homepage: https://github.com/vrongmeal/jekyll-github
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin for Github
+test_files: []