Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent loading all GH data on reset #245

Merged
merged 5 commits into from
Feb 17, 2023
Merged

Prevent loading all GH data on reset #245

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9fa02ad
Make sure repos is always an array
dunkmann00 Jan 5, 2023
2c265a5
Prevent loading all GH data on reset
dunkmann00 Jan 7, 2023
eced31d
Add test for preventing load data on reset
dunkmann00 Feb 15, 2023
a910c3c
Check rendered site, add uninject test comments
dunkmann00 Feb 16, 2023
39e44c3
Fix for Rubocop
dunkmann00 Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lib/jekyll-github-metadata/repository.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ def owner_public_repositories
:accept => "application/vnd.github.mercy-preview+json",
}
memoize_value :@owner_public_repositories, Value.new("owner_public_repositories", proc do |c|
c.list_repos(owner, options).map do |r|
repos = c.list_repos(owner, options) || []
repos.map do |r|
r[:releases] = Value.new("owner_public_repositories_releases", proc { c.releases(r[:full_name]) })
r[:contributors] = Value.new("owner_public_repositories_contributors", proc { c.contributors(r[:full_name]) })
r
Expand Down
15 changes: 12 additions & 3 deletions lib/jekyll-github-metadata/site_github_munger.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class << self

def initialize(site)
Jekyll::GitHubMetadata.site = site
@original_config = site.config["github"]
end

def munge!
Expand All @@ -28,16 +29,20 @@ def inject_metadata!(payload)
payload.site["github"] = github_namespace
end

def uninject_metadata!(payload)
payload.site["github"] = @original_config
end

private

def github_namespace
case site.config["github"]
case @original_config
when nil
drop
when Hash
Jekyll::Utils.deep_merge_hashes(drop, site.config["github"])
drop.merge(@original_config)
else
site.config["github"]
@original_config
end
end

Expand Down Expand Up @@ -94,5 +99,9 @@ def should_warn_about_site_name?
Jekyll::Hooks.register :site, :pre_render do |_site, payload|
SiteGitHubMunger.global_munger.inject_metadata!(payload)
end

Jekyll::Hooks.register :site, :post_render do |_site, payload|
SiteGitHubMunger.global_munger.uninject_metadata!(payload)
end
end
end
23 changes: 23 additions & 0 deletions spec/site_github_munger_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,4 +231,27 @@
end.to raise_error(Jekyll::GitHubMetadata::Client::BadCredentialsError)
end
end

context "render the 'uninject' fixture test site" do
let(:source) { File.expand_path("test-site-uninject", __dir__) }
let(:dest) { File.expand_path("../tmp/test-site-uninject-build", __dir__) }

it "process site twice (simulate reset), check API calls" do
config = Jekyll::Configuration.from({"source" => source, "destination" => dest})
site = Jekyll::Site.new(config)
site.process
expect_api_call "/repos/jekyll/github-metadata"
expect_api_call "/repos/jekyll/github-metadata/releases/latest"
expect_api_call "/orgs/jekyll"
site.process
expect_api_call "/repos/jekyll/github-metadata"
expect_api_call "/repos/jekyll/github-metadata/releases/latest"
expect_api_call "/orgs/jekyll"

not_expect_api_call "/repos/jekyll/github-metadata/pages"
not_expect_api_call "/repos/jekyll/github-metadata/contributors?per_page=100"
not_expect_api_call "/orgs/jekyll/public_members?per_page=100"
not_expect_api_call "/users/jekyll/repos?per_page=100&type=public"
end
end
end
5 changes: 5 additions & 0 deletions spec/spec_helpers/web_mock_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ def expect_api_call(path)
.with(:headers => request_headers).once
end

def not_expect_api_call(path)
expect(WebMock).to have_requested(:get, url(path))
.with(:headers => request_headers).times(0)
end

def request_headers
REQUEST_HEADERS.merge(
"Authorization" => "token #{ENV.fetch("JEKYLL_GITHUB_TOKEN", "1234abc")}"
Expand Down
9 changes: 9 additions & 0 deletions spec/test-site-uninject/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
repository: jekyll/github-metadata
github:
in_your_config:
setting_your: keyz
plugins:
- jekyll-github-metadata
# remove this once we drop support for Jekyll v3.4 and below
gems:
- jekyll-github-metadata
16 changes: 16 additions & 0 deletions spec/test-site-uninject/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
---

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Page Title</title>
</head>
<body>
<h1>{{ site.github.project_title }}</h1>
<h2>{{ site.github.project_tagline }}</h2>
<h2>Owner: {{ site.github.owner_name }}</h2>
<h3>Latest Release: {{ site.github.latest_release }}</h3>
</body>
</html>
4 changes: 4 additions & 0 deletions spec/test-site-uninject/subvalues.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

owner: {{ site.github.owner }}