Misterzym
/
wp-github-oembed
mirror of https://github.com/misterzym/wp-github-oembed.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Implement templating

widget
Zeb Walker 6 years ago
parent
6b755a628b
commit
c72532a8a7
5 changed files with 142 additions and 91 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 141
      github-embed.php
  2. 11
      templates/oembed_github_author.view.php
  3. 27
      templates/oembed_github_repo.view.php
  4. 25
      templates/oembed_github_repo_contributors.view.php
  5. 29
      templates/oembed_github_repo_milestone_summary.view.php

141
github-embed.php
Unescape View File

@ -175,42 +175,40 @@ class github_embed {
} }
} }
/**
* Capture then return output of template, provided theme or fallback to plugin default
* @param string $template The template name to process
* @param string $data Array, object, or variable that the template needs
*/
private function process_template( $template, $data ) {
ob_start();
if ( ! locate_template($template, true) ) {
require_once $template;
}
return ob_get_clean();
}
/** /**
* Retrieve a list of contributors for a project * Retrieve a list of contributors for a project
* @param string $owner The owner of the repository * @param string $owner The owner of the repository
* @param string $repository The repository name * @param string $repository The repository name
*/ */
private function oembed_github_repo_contributors( $owner, $repository ) { private function oembed_github_repo_contributors( $owner, $repository ) {
$repo = $this->api->get_repo( $owner, $repository ); $data = [];
$contributors = $this->api->get_repo_contributors( $owner, $repository ); $data['repo'] = $this->api->get_repo( $owner, $repository );
$data['contributors'] = $this->api->get_repo_contributors( $owner, $repository );
$data['gravatar_size'] = apply_filters( 'github_oembed_gravatar_size', 64 );
$data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response = new stdClass(); $response = new stdClass();
$response->type = 'rich'; $response->type = 'rich';
$response->width = '10'; $response->width = '10';
$response->height = '10'; $response->height = '10';
$response->version = '1.0'; $response->version = '1.0';
$response->title = $repo->description; $response->title = $data['repo']->description;
$response->html = $this->process_template(
$gravatar_size = apply_filters( 'github_oembed_gravatar_size', 64 ); 'templates/oembed_github_repo_contributors.view.php', $data);
// @TODO This should all be templated
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response->html = '<div class="github-embed github-embed-repo-contributors ' . $logo_class . '">';
$response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank">';
$response->html .= '<strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
$response->html .= '<span class="github-heading">Contributors: </span>';
$response->html .= '<ul class="github-repo-contributors">';
foreach ( $contributors as $contributor ) {
$response->html .= '<li class="github-repo-contributor">';
$response->html .= '<img class="github-repo-contributor-avatar" src="';
$response->html .= esc_url( add_query_arg( array( 's' => $gravatar_size ), $contributor->author->avatar_url ) );
$response->html .= '" alt="Picture of ' . esc_attr( $contributor->author->login ) . '">';
$response->html .= '<span class="github-repo-contributor-login">';
$response->html .= '<a href="https://github.com/' . esc_attr( $contributor->author->login ) . '">' . esc_attr( $contributor->author->login ) . '</a></span>';
}
$response->html .= '</ul>';
$response->html .= '<div style="clear: both;"></div>';
$response->html .= '</div>';
header( 'Content-Type: application/json' ); header( 'Content-Type: application/json' );
echo json_encode( $response ); echo json_encode( $response );
die(); die();
@ -221,37 +219,19 @@ class github_embed {
* output it as an oembed response * output it as an oembed response
*/ */
private function oembed_github_repo_milestone_summary( $owner, $repository, $milestone ) { private function oembed_github_repo_milestone_summary( $owner, $repository, $milestone ) {
$repo = $this->api->get_repo( $owner, $repository ); $data = [];
$summary = $this->api->get_repo_milestone_summary( $owner, $repository, $milestone ); $data['repo'] = $this->api->get_repo( $owner, $repository );
$data['summary'] = $this->api->get_repo_milestone_summary( $owner, $repository, $milestone );
$data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response = new stdClass(); $response = new stdClass();
$response->type = 'rich'; $response->type = 'rich';
$response->width = '10'; $response->width = '10';
$response->height = '10'; $response->height = '10';
$response->version = '1.0'; $response->version = '1.0';
$response->title = $repo->description; $response->title = $data['repo']->description;
$response->html = $this->process_template(
// @TODO This should all be templated 'templates/oembed_github_repo_milestone_summary.view.php', $data);
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response->html = '<div class="github-embed github-embed-milestone-summary ' . $logo_class . '">';
$response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank"><strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
$response->html .= '<span class="github-heading">Milestone: </span>';
$response->html .= '<span class="github-milestone-title">' . esc_html( $summary->title ) . '</span><br>';
$response->html .= '<span class="github-heading">Issues: </span>';
$response->html .= '<span class="github-milestone-issues">';
$response->html .= esc_html( number_format_i18n( $summary->open_issues ) ) . ' open, ';
$response->html .= esc_html( number_format_i18n( $summary->closed_issues ) ) . ' closed.</span><br>';
if ( ! empty( $summary->due_on ) ) {
$response->html .= '<span class="github-heading">Due: </span>';
$due_date = date_format( date_create( $summary->due_on ), 'jS F Y' );
$response->html .= '<span class="github-milestone-due-date">' . esc_html( $due_date ) . '</span><br>';
}
$response->html .= '<p class="github-milestone-description">' . nl2br( esc_html( $summary->description ) ) . '</p><br>';
$response->html .= '</div>';
header( 'Content-Type: application/json' ); header( 'Content-Type: application/json' );
echo json_encode( $response ); echo json_encode( $response );
@ -264,43 +244,24 @@ class github_embed {
* output it as an oembed response * output it as an oembed response
*/ */
private function oembed_github_repo ( $owner, $repository ) { private function oembed_github_repo ( $owner, $repository ) {
$repo = $this->api->get_repo( $owner, $repository ); $data = [
$commits =$this->api->get_repo_commits( $owner, $repository ); $owner,
$repository,
];
$data['repo'] = $this->api->get_repo( $owner, $repository );
$data['commits'] = $this->api->get_repo_commits( $owner, $repository );
$data['logo_class'] = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-mark' );
$response = new stdClass(); $response = new stdClass();
$response->type = 'rich'; $response->type = 'rich';
$response->width = '10'; $response->width = '10';
$response->height = '10'; $response->height = '10';
$response->version = '1.0'; $response->version = '1.0';
$response->title = $repo->description; $response->title = $data['repo']->description;
$response->html = $this->process_template(
// @TODO This should all be templated 'templates/oembed_github_repo.view.php', $data);
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-mark' );
$response->html = '<div class="github-embed github-embed-repository ' . $logo_class . '">';
$response->html .= '<p><a href="' . esc_attr( $repo->html_url ) . '" target="_blank"><strong>' . esc_html( $repo->description ) . '</strong></a><br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url ) . '" target="_blank">' . esc_html( $repo->html_url ) . '</a><br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url . '/network' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->forks_count ) ) . '</a> forks.<br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url . '/stargazers' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->stargazers_count ) ) . '</a> stars.<br/>';
$response->html .= '<a href="' . esc_attr( $repo->html_url . '/issues' ) . '" target="_blank">' . esc_html( number_format_i18n( $repo->open_issues_count ) ) . '</a> open issues.<br/>';
if ( count( $commits ) ) {
$cnt = 0;
$response->html .= 'Recent commits:';
$response->html .= '<ul class="github_commits">';
foreach ( $commits as $commit ) {
if ( $cnt > 4 ) {
break;
}
$response->html .= '<li class="github_commit">';
$response->html .= '<a href="https://github.com/' . $owner . '/' . $repository . '/commit/' . esc_attr( $commit->sha ) . '" target="_blank">' . esc_html( $commit->commit->message ) . '</a>, ';
$response->html .= esc_html( $commit->commit->committer->name );
$response->html .= '</li>';
$cnt++;
}
$response->html .= '</ul>';
}
$response->html .= '</p>';
$response->html .= '</div>';
header( 'Content-Type: application/json' ); header( 'Content-Type: application/json' );
echo json_encode( $response ); echo json_encode( $response );
die(); die();
@ -311,23 +272,21 @@ class github_embed {
* it as an oembed response * it as an oembed response
*/ */
private function oembed_github_author ( $owner ) { private function oembed_github_author ( $owner ) {
$data = [];
$owner_info = $this->api->get_user( $owner ); $data["owner"] = $owner;
$data["owner_info"] = $this->api->get_user( $owner );
$data["logo_class"] = apply_filters( 'wp_github_oembed_logo_class',
'github-logo-octocat' );
$response = new stdClass(); $response = new stdClass();
$response->type = 'rich'; $response->type = 'rich';
$response->width = '10'; $response->width = '10';
$response->height = '10'; $response->height = '10';
$response->version = '1.0'; $response->version = '1.0';
$response->title = $owner_info->name; $response->title = $data['owner_info']->name;
$response->html = $this->process_template(
// @TODO This should all be templated 'templates/oembed_github_author.view.php', $data);
$logo_class = apply_filters( 'wp_github_oembed_logo_class', 'github-logo-octocat' );
$response->html = '<div class="github-embed github-embed-user ' . $logo_class . '">';
$response->html .= '<p><a href="https://github.com/' . esc_attr( $owner ) . '" target="_blank"><strong>' . esc_html( $owner ) . '</strong></a><br/>';
$response->html .= esc_html( number_format_i18n( $owner_info->public_repos ) ) . ' repositories, ';
$response->html .= esc_html( number_format_i18n( $owner_info->followers ) ) . ' followers.</p>';
$response->html .= '</div>';
header( 'Content-Type: application/json' ); header( 'Content-Type: application/json' );
echo json_encode( $response ); echo json_encode( $response );
die(); die();

11
templates/oembed_github_author.view.php
Unescape View File

@ -0,0 +1,11 @@
<div class="github-embed github-embed-user <?= $data['logo_class'] ?>">
<p>
<a href="https://github.com/<?= esc_attr( $data['owner'] ) ?>" target="_blank">
<strong>
<?= esc_html( $data['owner'] ) ?>
</strong>
</a>
<br>
<?= esc_html( number_format_i18n( $data['owner_info']->public_repos ) ) ?> repositories, <?= esc_html( number_format_i18n( $data['owner_info']->followers ) ) ?> followers.
</p>
</div>

27
templates/oembed_github_repo.view.php
Unescape View File

@ -0,0 +1,27 @@
<div class="github-embed github-embed-repository <?= $data['logo_class'] ?>">
<p>
<a href="<?= esc_attr( $data['repo']->html_url ) ?>" target="_blank">
<strong>
<?= esc_html( $data['repo']->description ) ?>
</strong>
</a>
<br>
<a href="<?= esc_attr( $data['repo']->html_url ) ?>" target="_blank"><?= esc_html( $data['repo']->html_url ) ?></a><br>
<a href="<?= esc_attr( $data['repo']->html_url ) ?>/network" target="_blank"><?= esc_html( number_format_i18n( $data['repo']->forks_count ) ) ?></a> forks.<br>
<a href="<?= esc_attr( $data['repo']->html_url ) ?>/stargazers" target="_blank"><?= esc_html( number_format_i18n( $data['repo']->stargazers_count ) ) ?></a> stars.<br>
<a href="<?= esc_attr( $data['repo']->html_url ) ?>/issues" target="_blank"><?= esc_html( number_format_i18n( $data['repo']->open_issues_count ) ) ?></a> open issues.<br>
Recent commits:
<ul class="github_commits">
<?php
$i = 0;
foreach ( $data['commits'] as $commit ) : ?>
<li class="github_commit">
<a href="https://github.com/<?= $data['owner'] ?>/<?= $data['repository'] ?>/commit/<?= esc_attr( $commit->sha ) ?>" target="_blank"><?= esc_html( $commit->commit->message ) ?></a>, <?= esc_html( $commit->commit->committer->name ); ?>
</li>
<?php
if (++$i == 5) break;
endforeach;
?>
</ul>
</p>
</div>

25
templates/oembed_github_repo_contributors.view.php
Unescape View File

@ -0,0 +1,25 @@
<div class="github-embed github-embed-repo-contributors <?= $data['logo_class'] ?>">
<p>
<a href="<?= esc_attr( $data['repo']->html_url ) ?>" target="_blank">
<strong>
<?= esc_html( $data['repo']->description ) ?>
</strong>
</a>
<br>
<span class="github-heading">Contributors: </span>
<ul class="github-repo-contributors">
<?php foreach ( $data['contributors'] as $contributor ) : ?>
<li class="github-repo-contributor">
<img class="github-repo-contributor-avatar"
src="<?= esc_url( add_query_arg( array( 's' => $data['gravatar_size'] ), $contributor->author->avatar_url ) ); ?>"
alt="Picture of <?= esc_attr( $contributor->author->login ) ?>">
<span class="github-repo-contributor-login">
<a href="https://github.com/<?= esc_attr( $contributor->author->login ) ?>">
<?= esc_attr( $contributor->author->login ) ?>
</a>
</span>
<?php endforeach; ?>
</ul>
<div style="clear: both;"></div>
</p>
</div>

29
templates/oembed_github_repo_milestone_summary.view.php
Unescape View File

@ -0,0 +1,29 @@
<div class="github-embed github-embed-milestone-summary <?= $data['logo_class'] ?>">
<p>
<a href="<?= esc_attr( $data['repo']->html_url ) ?>" target="_blank">
<strong>
<?= esc_html( $data['repo']->description ) ?>
</strong>
</a>
<br>
<span class="github-heading">Milestone: </span>
<span class="github-milestone-title"><?= esc_html( $data['summary']->title ) ?></span>
<br>
<span class="github-heading">Issues: </span>
<span class="github-milestone-issues">
<?= esc_html( number_format_i18n( $data['summary']->open_issues ) ) ?> open, <?= esc_html( number_format_i18n( $data['summary']->closed_issues ) ) ?> closed.
</span>
<br>
<?php if ( ! empty( $data['summary']->due_on ) ) : ?>
<span class="github-heading">Due: </span>
<span class="github-milestone-due-date">
<?= esc_html( date_format( date_create( $data['summary']->due_on ), 'jS F Y' ) ) ?>
</span>
<br>
<?php endif ?>
<p class="github-milestone-description">
<?= nl2br( esc_html( $data['summary']->description ) ) ?>
</p>
<br>
</p>
</div>
Write Preview
Loading…
Cancel
Save