jekyll-github-code 0.1.0

data/lib/jekyll-github-code/code_renderer.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Jekyll
+  module GitHubCode
+    # Renders the code block with syntax highlighting
+    class CodeRenderer
+      LANGUAGE_MAP = {
+        'rb' => 'ruby',
+        'py' => 'python',
+        'js' => 'javascript',
+        'ts' => 'typescript',
+        'yml' => 'yaml',
+        'md' => 'markdown',
+        'sh' => 'bash',
+        'dockerfile' => 'dockerfile',
+        'containerfile' => 'dockerfile'
+      }.freeze
+
+      def initialize(reference, code, options = {})
+        @reference = reference
+        @code = code
+        @options = options
+      end
+
+      def render
+        processed_code = process_line_range(@code)
+        escaped_code = CGI.escapeHTML(processed_code)
+        language = detect_language
+
+        <<~HTML
+          <div class="github-code-block">
+            <div class="github-code-header">
+              <span class="github-code-filename">
+                <svg class="github-icon" viewBox="0 0 16 16" width="16" height="16">
+                  <path fill="currentColor" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"/>
+                </svg>
+                <a href="#{@reference.github_url}" target="_blank" rel="noopener noreferrer">#{@reference.filename}#{line_range_label}</a>
+              </span>
+              <button class="github-code-copy" onclick="copyGitHubCode(this)" title="Copy code">
+                <svg viewBox="0 0 16 16" width="16" height="16">
+                  <path fill="currentColor" d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z"/>
+                  <path fill="currentColor" d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z"/>
+                </svg>
+              </button>
+            </div>
+            <div class="github-code-content">
+              <pre><code class="language-#{language}">#{escaped_code}</code></pre>
+            </div>
+          </div>
+        HTML
+      end
+
+      private
+
+      def process_line_range(code)
+        return code unless @reference.line_range?
+
+        lines = code.lines
+        start_idx = @reference.start_line - 1
+        end_idx = (@reference.end_line || @reference.start_line) - 1
+
+        # Clamp to valid range
+        start_idx = [0, start_idx].max
+        end_idx = [lines.length - 1, end_idx].min
+
+        lines[start_idx..end_idx].join
+      end
+
+      def detect_language
+        ext = @reference.extension.downcase
+        LANGUAGE_MAP[ext] || ext
+      end
+
+      def line_range_label
+        return '' unless @reference.line_range?
+
+        if @reference.end_line
+          " (L#{@reference.start_line}-L#{@reference.end_line})"
+        else
+          " (L#{@reference.start_line})"
+        end
+      end
+    end
+  end
+end
+

data/lib/jekyll-github-code/github_reference.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GitHubCode
+    # Represents a parsed GitHub URL with repository, path, and optional line range
+    class GitHubReference
+      attr_reader :owner, :repo, :branch, :path, :start_line, :end_line
+
+      GITHUB_URL_PATTERN = %r{
+        ^
+        (?:https?://github\.com/)?  # Optional full URL prefix
+        ([^/]+)/                     # Owner
+        ([^/]+)/                     # Repo
+        blob/
+        ([^/]+)/                     # Branch
+        (.+?)                        # File path
+        (?:\#L(\d+)(?:-L(\d+))?)?    # Optional line range
+        $
+      }x.freeze
+
+      def initialize(reference)
+        match = reference.strip.match(GITHUB_URL_PATTERN)
+        raise ArgumentError, "Invalid GitHub reference: #{reference}" unless match
+
+        @owner = match[1]
+        @repo = match[2]
+        @branch = match[3]
+        @path = match[4]
+        @start_line = match[5]&.to_i
+        @end_line = match[6]&.to_i
+      end
+
+      def raw_url
+        "https://raw.githubusercontent.com/#{@owner}/#{@repo}/#{@branch}/#{@path}"
+      end
+
+      def github_url
+        base = "https://github.com/#{@owner}/#{@repo}/blob/#{@branch}/#{@path}"
+        return base unless @start_line
+
+        line_fragment = @end_line ? "L#{@start_line}-L#{@end_line}" : "L#{@start_line}"
+        "#{base}##{line_fragment}"
+      end
+
+      def filename
+        File.basename(@path)
+      end
+
+      def extension
+        File.extname(@path).delete_prefix('.')
+      end
+
+      def line_range?
+        !@start_line.nil?
+      end
+    end
+  end
+end
+

data/lib/jekyll-github-code/tag.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'liquid'
+require 'cgi'
+
+module Jekyll
+  module GitHubCode
+    # The main Liquid tag for embedding GitHub code
+    class Tag < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+        @markup = markup.strip
+      end
+
+      def render(context)
+        # Resolve any Liquid variables in the markup
+        resolved_markup = context[@markup] || @markup
+
+        reference = GitHubReference.new(resolved_markup)
+        code = CodeFetcher.fetch(reference.raw_url)
+        renderer = CodeRenderer.new(reference, code)
+        renderer.render
+      rescue ArgumentError => e
+        error_html("Invalid GitHub reference: #{e.message}")
+      rescue CodeFetcher::FetchError => e
+        error_html("Failed to fetch code: #{e.message}")
+      rescue StandardError => e
+        error_html("Error: #{e.message}")
+      end
+
+      private
+
+      def error_html(message)
+        <<~HTML
+          <div class="github-code-error">
+            <strong>GitHub Code Error:</strong> #{CGI.escapeHTML(message)}
+          </div>
+        HTML
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('github_code', Jekyll::GitHubCode::Tag)
+

data/lib/jekyll-github-code/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GitHubCode
+    VERSION = '0.1.0'
+  end
+end
+

data/lib/jekyll-github-code.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'jekyll-github-code/version'
+require_relative 'jekyll-github-code/github_reference'
+require_relative 'jekyll-github-code/code_fetcher'
+require_relative 'jekyll-github-code/code_renderer'
+require_relative 'jekyll-github-code/tag'
+
+module Jekyll
+  module GitHubCode
+  end
+end
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-github-code
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodolfo Olivieri
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.57'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.57'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+description: Embed code snippets from GitHub repositories directly in your Jekyll
+  blog posts with automatic syntax highlighting, line range support, and clickable
+  links to the source.
+email:
+- rodolfo.olivieri3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- assets/css/github-code.scss
+- assets/js/github-code.js
+- demo.html
+- jekyll-github-code.gemspec
+- lib/jekyll-github-code.rb
+- lib/jekyll-github-code/code_fetcher.rb
+- lib/jekyll-github-code/code_renderer.rb
+- lib/jekyll-github-code/github_reference.rb
+- lib/jekyll-github-code/tag.rb
+- lib/jekyll-github-code/version.rb
+homepage: https://github.com/r0x0d/jekyll-github-code
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/r0x0d/jekyll-github-code/issues
+  changelog_uri: https://github.com/r0x0d/jekyll-github-code/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/r0x0d/jekyll-github-code#readme
+  homepage_uri: https://github.com/r0x0d/jekyll-github-code
+  source_code_uri: https://github.com/r0x0d/jekyll-github-code
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Jekyll plugin to embed code from GitHub repositories
+test_files: []