jekyll-fetch 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c20c1e9f5f1e7adfb901ebed2f8b8a46433c5873e8900d520c1c7c62c1b6eba7
-  data.tar.gz: dc9d30295267e25d84e64849c412179a909d5d32918114471066ab201da5e493
+  metadata.gz: c5454f6d5abbbd61428289ac94ae2283a5668ace9ec37941d6a333897e70d140
+  data.tar.gz: 295243d723f1b8e149a3ef010d40bff5c7468569937144720a3756a998114612
 SHA512:
-  metadata.gz: 5afa64c5c08176b909052577953722cd5273cf921828c8515fef41813865ce2b7f9844728553f39ae60a6828240a352318395bb9887e2a5bbdc5694cd700bb91
-  data.tar.gz: a2cca41b29546782c888c11ed2a2414e3177d7cc5a6d94e51acb038836091f1088fcef7758859b73b7c58638439d5081c0a2806aa987bab59f5f8f4bbdafdb11
+  metadata.gz: 9c8ca44f9b14fb48ff1662e7ca8e0a901dab63ee028fdccee0dae934af36548a05ec7611945084d44c039be8747313f0632397bbfaf836cf310de128015cc669
+  data.tar.gz: 57fb86f18102e24be963427de16c7a00136da3a90920ec3eafe2cefbb1cccf7110b090fce3c9cff69d3b6e5d61e4937e773e9c9455507dfd869f11f4a852a5b7

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Naming/FileName:
+  Enabled: false

data/README.md

@@ -29,6 +29,38 @@ The example above will render to the raw markdown of this readme. You can chain
 {{ "https://raw.githubusercontent.com/pcouy/jekyll-fetch/main/README.md" | fetch  | markdownify }}
 ```
 
+Additionally, this plugin contains helper filters that help you work with files from GitHub repositories :
+
+```
+{{ "gh_user/repo_name" | github_url }}
+Will render to : https://github.com/gh_user/repo_name
+
+{{ "gh_user/repo_name" | github_readme }}
+Will render to the content of the `README.md` file from the repository
+
+{{ "gh_user/repo_name" | github_file: "path/to/file/in/repo" }}
+Will render to the content of the specified file from the repository
+```
+
+### Specify GitHub branches
+
+You can change the default branch used for retrieving GitHub files from main to the value of your choice by updating `_config.yml` :
+
+```yaml
+fetch: # Config section for the plugin
+  default_github_branch: main # This is the default value but you can use whatever you want
+```
+
+The `github_readme` and `github_file` accept an optional argument for one-time overrides of the branch : 
+
+```
+{{ "gh_user/repo_name" | github_readme: 'branch_name' }}
+Will render to the content of the `README.md` file from the repository
+
+{{ "gh_user/repo_name" | github_file: "path/to/file/in/repo", "branch_name" }}
+Will render to the content of the specified file from the repository
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/jekyll-fetch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllFetch
-  VERSION = "0.1.2"
+  VERSION = '0.2.1'
 end

data/lib/jekyll-fetch.rb

@@ -1,29 +1,91 @@
 # frozen_string_literal: true
 
-require_relative "jekyll-fetch/version"
-require "liquid"
-require "net/https"
+require_relative 'jekyll-fetch/version'
+require 'liquid'
+require 'net/https'
 
 module Jekyll
+  # Filters for transforming URL strings into the content at the URL
   module JekyllFetch
+    CONFIG = {
+      'default_github_branch' => 'main'
+    }.freeze
     class Error < StandardError; end
 
-    def fetch(uri_str, limit = 10)
-      # You should choose better exception.
-      raise ArgumentError, 'HTTP redirect too deep' if limit == 0
-
-      puts uri_str
-      url = URI.parse(uri_str)
-      req = Net::HTTP::Get.new(url.path, { 'User-Agent' => 'Mozilla/5.0 (etc...)' })
-      response = Net::HTTP.start(url.host, url.port, use_ssl: true) { |http| http.request(req) }
-      case response
-      when Net::HTTPSuccess     then response.body.force_encoding("UTF-8")
-      when Net::HTTPRedirection then fetch(response['location'], limit - 1)
-      else
-        response.error!
+    # Helper functions for HTTP requests
+    class Utils
+      class << self
+        def fetch(uri_str, limit = 10)
+          raise ArgumentError, 'Max retries reached' if limit.zero?
+
+          begin
+            unsafe_fetch(uri_str, limit)
+          rescue Errno::ECONNREFUSED
+            Jekyll.logger.warn "Connection refused for #{uri_str}, retrying in 2s..."
+            sleep 2
+            Jekyll.logger.warn "Retrying (#{limit - 1} tries left)"
+            fetch(uri_str, limit - 1)
+          end
+        end
+
+        def config
+          @config ||= CONFIG.merge(JEKYLL_SITE.config['fetch'] || {})
+        end
+
+        private
+
+        def unsafe_fetch(uri_str, limit)
+          raise ArgumentError, 'Max retries reached' if limit.zero?
+
+          response_to_body(
+            uri_to_response(uri_str), limit - 1
+          )
+        end
+
+        def uri_to_response(uri_str)
+          url = URI.parse(uri_str)
+          req = Net::HTTP::Get.new(url.path, { 'User-Agent' => 'Mozilla/5.0 (etc...)' })
+          Net::HTTP.start(url.host, url.port, use_ssl: true) { |http| http.request(req) }
+        end
+
+        def response_to_body(response, limit)
+          case response
+          when Net::HTTPSuccess     then response.body.force_encoding('UTF-8')
+          when Net::HTTPRedirection then fetch(response['location'], limit)
+          else
+            response.error!
+          end
+        end
       end
     end
+
+    def fetch(uri_str, limit = 10)
+      raise ArgumentError, 'HTTP redirect too deep' if limit.zero?
+
+      Jekyll.logger.debug "fetch(#{uri_str})"
+      Utils.fetch(uri_str, limit)
+    end
+
+    def github_url(repo)
+      "https://github.com/#{repo}"
+    end
+
+    def github_readme(repo, branch = nil)
+      branch ||= Utils.config['default_github_branch']
+      Jekyll.logger.debug "github_readme(#{repo}, #{branch})"
+      github_file repo, 'README.md', branch
+    end
+
+    def github_file(repo, file, branch = nil)
+      branch ||= Utils.config['default_github_branch']
+      Jekyll.logger.debug "github_file(#{repo}, #{file}, #{branch})"
+      fetch "#{github_url(repo)}/raw/#{branch}/#{file}"
+    end
   end
 end
 
 Liquid::Template.register_filter(Jekyll::JekyllFetch)
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  Jekyll::JekyllFetch::JEKYLL_SITE = site
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-fetch
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - pcouy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid