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.
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
Add support for lazy-loading by requiring octokit/lazy
, rather than just octokit
#1431
Open
timrogers
wants to merge
1
commit into
main
Choose a base branch
from
lazy
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+93
−56
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,4 +42,4 @@ group :test, :development do | |
gem 'rubocop' | ||
end | ||
|
||
gemspec | ||
gemspec require: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Ruby toolkit for the GitHub API | ||
# | ||
# NOTE: The `Octokit` module is defined here, rather than in `lib/octokit.rb`, to allow | ||
# the gem to include a lazy-loaded version where dependencies are required as needed, | ||
# as well as a default where everything is required together. | ||
module Octokit | ||
# These autoload statements won't do anything if the module has already been loaded, as | ||
# will happen if the gem is required in the normal, automatic way. They will only come | ||
# into affect if the user requires `octokit/lazy`. | ||
autoload(:Client, File.join(__dir__, 'client')) | ||
autoload(:EnterpriseAdminClient, File.join(__dir__, 'enterprise_admin_client')) | ||
autoload(:EnterpriseManagementConsoleClient, File.join(__dir__, 'enterprise_management_console_client')) | ||
|
||
class << self | ||
include Octokit::Configurable | ||
|
||
# API client based on configured options {Configurable} | ||
# | ||
# @return [Octokit::Client] API wrapper | ||
def client | ||
return @client if defined?(@client) && @client.same_options?(options) | ||
@client = Octokit::Client.new(options) | ||
end | ||
|
||
# EnterpriseAdminClient client based on configured options {Configurable} | ||
# | ||
# @return [Octokit::EnterpriseAdminClient] API wrapper | ||
def enterprise_admin_client | ||
return @enterprise_admin_client if defined?(@enterprise_admin_client) && @enterprise_admin_client.same_options?(options) | ||
@enterprise_admin_client = Octokit::EnterpriseAdminClient.new(options) | ||
end | ||
|
||
# EnterpriseManagementConsoleClient client based on configured options {Configurable} | ||
# | ||
# @return [Octokit::EnterpriseManagementConsoleClient] API wrapper | ||
def enterprise_management_console_client | ||
return @enterprise_management_console_client if defined?(@enterprise_management_console_client) && @enterprise_management_console_client.same_options?(options) | ||
@enterprise_management_console_client = Octokit::EnterpriseManagementConsoleClient.new(options) | ||
end | ||
|
||
private | ||
|
||
def respond_to_missing?(method_name, include_private=false) | ||
client.respond_to?(method_name, include_private) || | ||
enterprise_admin_client.respond_to?(method_name, include_private) || | ||
enterprise_management_console_client.respond_to?(method_name, include_private) | ||
end | ||
|
||
def method_missing(method_name, *args, &block) | ||
if client.respond_to?(method_name) | ||
return client.send(method_name, *args, &block) | ||
elsif enterprise_admin_client.respond_to?(method_name) | ||
return enterprise_admin_client.send(method_name, *args, &block) | ||
elsif enterprise_management_console_client.respond_to?(method_name) | ||
return enterprise_management_console_client.send(method_name, *args, &block) | ||
end | ||
|
||
super | ||
end | ||
|
||
end | ||
end | ||
|
||
Octokit.setup |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
require 'octokit/default' | ||
require 'octokit/configurable' | ||
require 'octokit/base' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have to manually require Faraday because, if we end up requiring the "lazy" version of Octokit above, then Faraday won't have been loaded when we try to look at its version later in this file.