jekyll-fetch 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4434d6eccdd7106706ea9bc830e1112398ad65a2aeba36784b2329e910a2ff1
-  data.tar.gz: bfc916463dc0571bc8796bb40c7f561cc0ac1fe14726517a8b158d7c21ecd824
+  metadata.gz: c5454f6d5abbbd61428289ac94ae2283a5668ace9ec37941d6a333897e70d140
+  data.tar.gz: 295243d723f1b8e149a3ef010d40bff5c7468569937144720a3756a998114612
 SHA512:
-  metadata.gz: 224200bbc378ba973f547545ec1a6cb382184ac79aec98d03b17da34b5bbabf8b90051cf3c003a233b37ce47a21ab487c06c557d38f1a1afc3ad50e4454223c5
-  data.tar.gz: 67f3dd59fa6215fcf957715fd451f9bd6385e7adf98b2569f04178f43716388e015e31526a6273021d2053a8f14ba96537f9433547cf43157ad1e37b7e918594
+  metadata.gz: 9c8ca44f9b14fb48ff1662e7ca8e0a901dab63ee028fdccee0dae934af36548a05ec7611945084d44c039be8747313f0632397bbfaf836cf310de128015cc669
+  data.tar.gz: 57fb86f18102e24be963427de16c7a00136da3a90920ec3eafe2cefbb1cccf7110b090fce3c9cff69d3b6e5d61e4937e773e9c9455507dfd869f11f4a852a5b7

data/README.md

@@ -42,6 +42,25 @@ Will render to the content of the `README.md` file from the repository
 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.2.0'
+  VERSION = '0.2.1'
 end

data/lib/jekyll-fetch.rb

@@ -7,6 +7,9 @@ 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
 
     # Helper functions for HTTP requests
@@ -25,6 +28,10 @@ module Jekyll
           end
         end
 
+        def config
+          @config ||= CONFIG.merge(JEKYLL_SITE.config['fetch'] || {})
+        end
+
         private
 
         def unsafe_fetch(uri_str, limit)
@@ -63,16 +70,22 @@ module Jekyll
       "https://github.com/#{repo}"
     end
 
-    def github_readme(repo)
-      Jekyll.logger.debug "github_readme(#{repo})"
-      github_file repo, 'README.md'
+    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)
-      Jekyll.logger.debug "github_file(#{repo}, #{file})"
-      fetch "#{github_url(repo)}/raw/main/#{file}"
+    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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-fetch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - pcouy