jekyll-github-metadata 2.8.0 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05f4959dbacc7ebac3d2b1cf7a4fb1519435a152
-  data.tar.gz: 455bde265c66f2a7186c3044888732c71fac386e
+  metadata.gz: f30ae34c0ecef4f7a5ef2cb3669d9c1f9204ff17
+  data.tar.gz: 7f81b7ca161a562b966012f6aae369ef2957e88c
 SHA512:
-  metadata.gz: 941b07182ad3d4173d0fdb54a43cfc2e045188d6ef93efa2a125a301e75c05df4c898de2c28103e06757546a0a8c25d1bd98022d4f325cbc4e0db178d45b78c6
-  data.tar.gz: cff03608fe4bdbaafa1b6dc9b9eaaa00130a5541b72cd67e699dd9a2f5d83c0a35f54e1aeb05c1107ce5d4706ddd809fd1b784e8353c55107e47cd1e062017d1
+  metadata.gz: d898b20ea3034666929654dc6e1a437f29dbce86e5a18b14dc948024d60505c7a7b7c5dddaedd6bf91ae11b8c1f9fff2dc0e3a758e1f06998da6bd5c2c1d23f9
+  data.tar.gz: e1a149c71cb64d2369e61490409518e291cdbabae217271b5c7f706144303b81f6457d3b76ca9e133455cd4d77cb68d82ac853581722b811bc9051cd417a59c5

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

@@ -0,0 +1,102 @@
+module Jekyll
+  module GitHubMetadata
+    class EditLinkTag < Liquid::Tag
+      attr_reader :context
+
+      # Defines an instance method that delegates to a hash's key
+      #
+      # hash_method -  a symbol representing the instance method to delegate to. The
+      #                instance method should return a hash or respond to #[]
+      # key         - the key to call within the hash
+      # method      - (optional) the instance method the key should be aliased to.
+      #               If not specified, defaults to the hash key
+      # default     - (optional) value to return if value is nil (defaults to nil)
+      #
+      # 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)
+          if hash.respond_to? :[]
+            hash[key.to_s] || default
+          else
+            default
+          end
+        end
+      end
+
+      MISSING_DATA_MSG = "Cannot generate edit URLs due to missing site.github data".freeze
+      LINK_TEXT_REGEX = %r!(?:\"(.*)\"|'(.*)')!
+
+      extend Forwardable
+      private def_hash_delegator :site,        :github,         :site_github, {}
+      private def_hash_delegator :site_github, :repository_url, :repository_url
+      private def_hash_delegator :site_github, :source,         :source, {}
+      private def_hash_delegator :source,      :branch,         :branch
+      private def_hash_delegator :source,      :path,           :source_path
+      private def_hash_delegator :page,        :path,           :page_path
+
+      def render(context)
+        @context = context
+        if link_text
+          link
+        else
+          uri.to_s
+        end
+      end
+
+      private
+
+      def link_text
+        @link_text ||= begin
+          matches = @markup.match LINK_TEXT_REGEX
+          matches[1] || matches[2] if matches
+        end
+      end
+
+      def link
+        "<a href=\"#{uri}\">#{link_text}</a>"
+      end
+
+      def uri
+        if parts.any?(&:nil?)
+          Jekyll.logger.warn "JekyllEditLink: ", MISSING_DATA_MSG
+          ""
+        else
+          Addressable::URI.join(*parts_normalized).normalize
+        end
+      end
+
+      def parts
+        @parts ||= [repository_url, "edit/", branch, source_path, page_path]
+      end
+
+      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
+          ensure_not_just_a_slash(part)
+        end
+      end
+
+      def page
+        @page ||= context.registers[:page]
+      end
+
+      def site
+        @site ||= context.registers[:site].site_payload["site"]
+      end
+
+      def remove_leading_slash(part)
+        part.start_with?("/") ? part[1..-1] : part
+      end
+
+      def ensure_trailing_slash(part)
+        part.end_with?("/") ? part : "#{part}/"
+      end
+
+      def ensure_not_just_a_slash(part)
+        part == "/" ? "" : part
+      end
+    end
+  end
+end

data/lib/jekyll-github-metadata/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module GitHubMetadata
-    VERSION = "2.8.0".freeze
+    VERSION = "2.9.1".freeze
   end
 end

data/lib/jekyll-github-metadata.rb

@@ -1,4 +1,5 @@
 require "octokit"
+require "liquid"
 require "logger"
 
 if defined?(Jekyll) && Jekyll.respond_to?(:env) && Jekyll.env == "development"
@@ -19,6 +20,7 @@ module Jekyll
 
   module GitHubMetadata
     autoload :Client,           "jekyll-github-metadata/client"
+    autoload :EditLinkTag,      "jekyll-github-metadata/edit-link-tag"
     autoload :MetadataDrop,     "jekyll-github-metadata/metadata_drop"
     autoload :Pages,            "jekyll-github-metadata/pages"
     autoload :Repository,       "jekyll-github-metadata/repository"
@@ -83,3 +85,5 @@ module Jekyll
     end
   end
 end
+
+Liquid::Template.register_tag("github_edit_link", Jekyll::GitHubMetadata::EditLinkTag)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-metadata
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.1
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -123,6 +123,7 @@ extra_rdoc_files: []
 files:
 - lib/jekyll-github-metadata.rb
 - lib/jekyll-github-metadata/client.rb
+- lib/jekyll-github-metadata/edit-link-tag.rb
 - lib/jekyll-github-metadata/metadata_drop.rb
 - lib/jekyll-github-metadata/pages.rb
 - lib/jekyll-github-metadata/repository.rb