GitHub edit link tag #108

benbalter · 2017-08-17T15:21:37Z

This PR exposes a github_edit_link tag that generates links to edit the current page on GitHub.

To generate a link

<p>This site is open source. {% github_edit_link "Improve this page" %}</p>

Produces:

<p>This site is open source. <a href="https://github.com/benbalter/jekyll-edit-link/edit/master/README.md">Improve this page</a></p>

To generate a path

If you'd prefer to build your own link, simply don't pass link text

<p>This site is open source. <a href="{% github_edit_link %}">Improve this page</a></p>

Produces:

<p>This site is open source. <a href="https://github.com/benbalter/jekyll-edit-link/edit/master/README.md">Improve this page</a></p>

In order to add the tag, I made to related changes:

Broke the various spec helpers into spec/spec_helpers/foo_helper.rb to keep spec/spec_helpers.rb more managable
Broke the README into individual documents, and moved to the docs/ folder since adding the edit tag docs made the README a bit unwieldy.

parkr

Sweet! Just a handful of comments here. 😄

parkr · 2017-08-22T16:33:50Z

lib/jekyll-github-metadata/edit-link-tag.rb

+      # Returns a symbol representing the instance method
+      def self.def_hash_delegator(hash_method, key, method, default = nil)
+        define_method(method) do
+          hash = send(hash_method)


Can we use public_send here instead of send?

If we did, we'd have to make site, site_github, source, and page public.

parkr · 2017-08-22T17:40:26Z

lib/jekyll-github-metadata/edit-link-tag.rb

+      end
+
+      def remove_leading_slash(part)
+        part.sub(%r!\A/!, "")


What do you think about part.start_with?("/") ? part[1..-1] : part?

>> path = "/lol" => "/lol" >> Benchmark.ips do |x| ?> x.report ("sub") { path.sub(%r!\A/!, "") } >> x.report ("[1..-1]") { path.start_with?("/") ? path[1..-1] : path } >> x.compare! >> end Warming up -------------------------------------- sub 134.174k i/100ms [1..-1] 185.434k i/100ms Calculating ------------------------------------- sub 1.995M (± 5.5%) i/s - 10.063M in 5.058157s [1..-1] 3.626M (± 6.7%) i/s - 18.173M in 5.035788s Comparison: [1..-1]: 3626032.7 i/s sub: 1995248.9 i/s - 1.82x slower

parkr · 2017-08-22T17:42:53Z

lib/jekyll-github-metadata/edit-link-tag.rb

+      def parts_normalized
+        @parts_normalized ||= parts.map.with_index do |part, index|
+          part = remove_leading_slash(part.to_s)
+          part = ensure_trailing_slash(part) unless index == parts.length - 1


What does this unless mean?

If the url is https://github.com/foo/bar/edit/master/page.md, we don't want the last element page.md to be given a trailing slash (and can't rely on the extension, because the repo might be, foo.js).

Could you leave a comment in the code to that effect or give it a tiny helper method which explains that?

parkr · 2017-08-22T17:44:15Z

lib/jekyll-github-metadata/edit-link-tag.rb

+      end
+
+      def link
+        "<a href=\"#{uri.normalize}\">#{link_text}</a>"


You call uri.normalize but you return a "" in an error state. I don't see a String#normalize, so normalize will have to be called in uri instead of here.

parkr · 2017-08-23T14:15:09Z

docs/README.md

+
+## What it does
+
+* Propegates the `site.github` namespace with [repository metadata](https://help.github.com/articles/repository-metadata-on-github-pages/)


Propagates

?

parkr · 2017-08-23T15:12:46Z

docs/authentication.md

+
+### 2. `~/.netrc`
+
+If you prefer to use the good ol' `~/.netrc` file, just make sure the `netrc` gem is bundled and run `jekyll` like normal. So if I were to add it, I'd add `gem 'netrc'` to my `Gemfile`, run `bundle install`, then run `bundle exec jekyll build`. The `machine` directive should be `api.github.com`.


Maybe I should include an example...

machine api.github.com login github-username password 123abc-your-token

parkr · 2017-08-23T15:16:34Z

spec/spec_helpers/env_helper.rb

@@ -0,0 +1,29 @@
+


empty space!

parkr · 2017-08-23T15:17:04Z

spec/spec_helpers/fixture_helper.rb

+    }
+  end
+
+  def make_page(options = {})


why not call this data or page_data if it's only every being used as page.data?

It's used both in the fixture helper and in the edit link tag spec to create the context, which needs the page object, not the page data.

Ah, I meant the argument. s/options/data/. Sorry for the confusion!

parkr · 2017-08-23T15:17:39Z

spec/spec_helpers/fixture_helper.rb

+  end
+
+  def make_page(options = {})
+    page = Jekyll::Page.new site, config_defaults["source"], "", "page.md"


parens around the 4 arguments to .new would help readability here 👀

parkr · 2017-08-23T15:18:19Z

spec/spec_helpers/fixture_helper.rb

+
+  def make_page(options = {})
+    page = Jekyll::Page.new site, config_defaults["source"], "", "page.md"
+    page.data = options


you could use .tap

Jekyll::Page.new(site, config_defaults["source"], "", "page.md").tap { |page| page.data = data }

returns the Page object

benbalter · 2017-08-24T18:53:28Z

@parkr thanks for the feedback. I believe I've implemented your suggestions and answered your questions to the best of my ability. Mind taking another look? 😄

benbalter · 2017-08-28T17:33:13Z

@jekyllbot: merge

DirtyF · 2017-08-28T23:49:38Z

I host my blog on Netllify. My default branch is master, my _config.ymlalso has branch:masterand here is the link that gets generated when testing on my machine:

`https://github.com/DirtyF/frank.taillandier.me/edit/gh-pages/_posts/2017-05-21-sept-ans-de-sud-web.md``

It has gh-pages branch instead of master 🤔

benbalter · 2017-08-29T19:30:28Z

@DirtyF I believe the following should work in your config:

github:
  source:
    branch: master

DirtyF · 2017-08-29T20:03:00Z

I hoped so but something is wrong:

GitHub API is returning master

$ http --body https://api.github.com/repos/DirtyF/frank.taillandier.me/branches
[
    {
        "commit": {
            "sha": "15a70597f9aee29fcb4c7ae354489b0b560230e8",
            "url": "https://api.github.com/repos/DirtyF/frank.taillandier.me/commits/15a70597f9aee29fcb4c7ae354489b0b560230e8"
        },
        "name": "master"
    }
]

Whether {{ site.github.source.branch }} is returning gh-pages. 😲

benbalter · 2017-08-29T20:52:15Z

The tag uses site.github.source.branch which comes from https://github.com/jekyll/github-metadata/blob/master/lib/jekyll-github-metadata/metadata_drop.rb#L61, which itself is delegated to https://github.com/jekyll/github-metadata/blob/master/lib/jekyll-github-metadata/repository.rb#L125-L127 which will either be the source as returned from the pages endpoint, or if it can't hit that endpoint, gh-pages for user pages.

If site.github is a hash, we merge the drop (the logic above) with the user-supplied value. It could be that Jekyll's deep_merge_hashes isn't recursive enough, but in theory, if you supply site.github.source.branch it should prefer that over the calculated value.

DirtyF · 2017-08-29T22:02:31Z

Thanks for taking the time to explain how this works under the hood. 🔧

in theory, if you supply site.github.source.branch it should prefer that over the calculated value.

Well, as I said, In my case, it returns the default value gh-pages, even with the values manually added in the _config.yml.

benbalter · 2017-08-29T22:23:15Z

@DirtyF You found a 🐛 🐞! Fix in progress via #110.

benbalter added 4 commits August 17, 2017 10:48

add github edit link

bf1a19a

update spec expectations

b706e31

document github_edit_link

37eddf4

break docs into files

787313c

benbalter self-assigned this Aug 17, 2017

benbalter requested a review from parkr August 17, 2017 15:21

dont double normalize the URI in case it is just a string

3e2f1f0

parkr reviewed Aug 23, 2017

View reviewed changes

benbalter added 4 commits August 24, 2017 14:47

use [1..-1] over sub to remove leading slash

c93ee73

minor documentation improvements

cf4a784

add parens to Jekyll::Page.new for readability

d84aeef

use tap to create fixture pages

7273bcc

Merge branch 'master' into github-edit-link

59bb641

parkr approved these changes Aug 28, 2017

View reviewed changes

update path to dest dir

c66124c

jekyllbot merged commit e195c17 into master Aug 28, 2017

jekyllbot deleted the github-edit-link branch August 28, 2017 17:33

jekyllbot added a commit that referenced this pull request Aug 28, 2017

Update history to reflect merge of #108 [ci skip]

31da84f

benbalter mentioned this pull request Aug 29, 2017

Allow user values to override drop-determined values #110

Merged

benbalter mentioned this pull request Aug 30, 2017

Alias Drop#invoke_drop to Drop#[] jekyll/jekyll#6338

Merged

jekyll locked and limited conversation to collaborators Apr 28, 2019

jekyllbot added the frozen-due-to-age label Apr 28, 2019


		## What it does

		* Propegates the `site.github` namespace with [repository metadata](https://help.github.com/articles/repository-metadata-on-github-pages/)


		### 2. `~/.netrc`

		If you prefer to use the good ol' `~/.netrc` file, just make sure the `netrc` gem is bundled and run `jekyll` like normal. So if I were to add it, I'd add `gem 'netrc'` to my `Gemfile`, run `bundle install`, then run `bundle exec jekyll build`. The `machine` directive should be `api.github.com`.

Uh oh!

GitHub edit link tag #108

GitHub edit link tag #108

Uh oh!

Conversation

benbalter commented Aug 17, 2017

To generate a link

To generate a path

Uh oh!

parkr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benbalter commented Aug 24, 2017

Uh oh!

benbalter commented Aug 28, 2017

Uh oh!

DirtyF commented Aug 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benbalter commented Aug 29, 2017

Uh oh!

DirtyF commented Aug 29, 2017

Uh oh!

benbalter commented Aug 29, 2017

Uh oh!

DirtyF commented Aug 29, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benbalter commented Aug 29, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DirtyF commented Aug 28, 2017 •

edited

Loading

DirtyF commented Aug 29, 2017 •

edited

Loading