jekyll-github-metadata 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd19cc5c1797ac829abde53d1008003675fcabaf6d4e2370f76342faea43ee5
-  data.tar.gz: e2d6401feb3be9354eb7829b187e864aecce0c615e9f1f0f3e384888e8d1f382
+  metadata.gz: 634131021fac3ff8f89c40c56551db5712c6b3b15242c14568b882e5b3298074
+  data.tar.gz: 97a704bc78b18f8166fd1cbced32d152ab908082bfa7b294f4219dc82fd9e3ad
 SHA512:
-  metadata.gz: df04b9684967e06a748632a32ebaed6238e9e7102fc66709de61b834445cabcd0eeba12772fe0928101ffa108b00d028fdbf6bc3f69020713b96aea686ac38f7
-  data.tar.gz: a9b2d3f6cfb0bc2e620d7b4ffcd6da85db038425ba0649f8af06d058fe87079acb5efe8e3005c455e527c29b9de2f9ce0fc4cebf26deccd620eaff9fd245ece0
+  metadata.gz: e51527e42561bab7081a48b3664371ee363115a83ce0cc90ec70c115519f2faa57b29238995e435f8a4b83a10d92ba55744c3b3c7fbbd557bbbd4f2b19a8aa1d
+  data.tar.gz: efbc51075fda949e9965d567895a50d9bcf017496174faba940f3eb386dd5c8be2877ca38102e2fd4097a6c0e6c3f5be2098e4fefad5ee1d2925a25b5a6d31cf

data/lib/jekyll-github-metadata.rb

@@ -17,6 +17,7 @@ module Jekyll
     autoload :Client,           "jekyll-github-metadata/client"
     autoload :EditLinkTag,      "jekyll-github-metadata/edit-link-tag"
     autoload :MetadataDrop,     "jekyll-github-metadata/metadata_drop"
+    autoload :Owner,            "jekyll-github-metadata/owner"
     autoload :Pages,            "jekyll-github-metadata/pages"
     autoload :Repository,       "jekyll-github-metadata/repository"
     autoload :RepositoryFinder, "jekyll-github-metadata/repository_finder"
@@ -27,9 +28,7 @@ module Jekyll
 
     NoRepositoryError = RepositoryFinder::NoRepositoryError
 
-    if Jekyll.const_defined? :Site
-      require_relative "jekyll-github-metadata/site_github_munger"
-    end
+    require_relative "jekyll-github-metadata/site_github_munger" if Jekyll.const_defined? :Site
 
     class << self
       attr_reader :repository_finder

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

@@ -12,6 +12,7 @@ module Jekyll
       API_CALLS = Set.new(%w(
         repository
         organization
+        user
         repository?
         pages
         contributors
@@ -42,9 +43,7 @@ module Jekyll
 
       def build_octokit_client(options = nil)
         options ||= {}
-        unless options.key? :access_token
-          options.merge! pluck_auth_method
-        end
+        options.merge!(pluck_auth_method) unless options.key?(:access_token)
         Octokit::Client.new(default_octokit_options.merge(options))
       end
 
@@ -118,6 +117,7 @@ module Jekyll
         end
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def pluck_auth_method
         if ENV["JEKYLL_GITHUB_TOKEN"] || Octokit.access_token
           { :access_token => ENV["JEKYLL_GITHUB_TOKEN"] || Octokit.access_token }
@@ -129,6 +129,7 @@ module Jekyll
           {}.freeze
         end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def cache_key(method, *args)
         Digest::SHA1.hexdigest(method.to_s + args.join(", "))

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

@@ -26,8 +26,8 @@ module Jekyll
         end
       end
 
-      MISSING_DATA_MSG = "Cannot generate edit URLs due to missing site.github data".freeze
-      LINK_TEXT_REGEX = %r!(?:\"(.*)\"|'(.*)')!
+      MISSING_DATA_MSG = "Cannot generate edit URLs due to missing site.github data"
+      LINK_TEXT_REGEX = %r!(?:\"(.*)\"|'(.*)')!.freeze
 
       extend Forwardable
       private def_hash_delegator :site,        :github,         :site_github, {}

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

@@ -15,6 +15,7 @@ module Jekyll
       def key?(key)
         return false if key.nil?
         return true if self.class.mutable? && @mutations.key?(key)
+
         respond_to?(key) || fallback_data.key?(key)
       end
 
@@ -45,6 +46,7 @@ module Jekyll
       def_delegator :repository, :organization_public_members, :organization_members
       def_delegator :repository, :name,                        :project_title
       def_delegator :repository, :tagline,                     :project_tagline
+      def_delegator :repository, :owner_metadata,              :owner
       def_delegator :repository, :owner,                       :owner_name
       def_delegator :repository, :owner_url,                   :owner_url
       def_delegator :repository, :owner_gravatar_url,          :owner_gravatar_url
@@ -71,11 +73,13 @@ module Jekyll
       def_delegator :repository, :source,                      :source
 
       def versions
-        @versions ||= begin
+        return @versions if defined?(@versions)
+
+        begin
           require "github-pages"
-          GitHubPages.versions
+          @versions = GitHubPages.versions
         rescue LoadError
-          {}
+          @versions = {}
         end
       end
 

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GitHubMetadata
+    class Owner
+      extend Forwardable
+
+      # Defines an instance method that delegates to a hash's key
+      #
+      # hash   - 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
+      #
+      # Returns a symbol representing the instance method
+      def self.def_hash_delegators(hash, *methods)
+        content_methods.concat(methods)
+        methods.each do |method|
+          define_method(method) do
+            send(hash)[method.to_s]
+          end
+        end
+      end
+
+      def self.content_methods
+        @content_methods ||= []
+      end
+
+      # List of whitelisted keys.
+      def_hash_delegators :owner_info,
+                          :avatar_url,
+                          :bio,
+                          :blog,
+                          :collaborators,
+                          :company,
+                          :created_at,
+                          :description,
+                          :email,
+                          :followers,
+                          :following,
+                          :has_organization_projects,
+                          :has_repository_projects,
+                          :hireable,
+                          :html_url,
+                          :id,
+                          :is_verified,
+                          :location,
+                          :login,
+                          :name,
+                          :node_id,
+                          :public_gists,
+                          :public_gists,
+                          :public_repos,
+                          :public_repos,
+                          :type,
+                          :updated_at
+
+      attr_reader :owner_login
+
+      def initialize(owner_login)
+        @owner_login = owner_login
+      end
+
+      def to_s
+        require "json"
+        JSON.pretty_generate to_h
+      end
+      alias_method :to_str, :to_s
+
+      def to_h
+        self.class.content_methods.each_with_object({}) { |method, hash| hash[method] = public_send(method) }
+      end
+
+      private
+
+      def owner_info
+        @owner_info ||= begin
+          Value.new(
+            proc do |c|
+              (c.organization(owner_login) || c.user(owner_login) || {}).to_h
+            end
+          ).render || {}
+        end
+      end
+    end
+  end
+end

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

@@ -5,13 +5,13 @@ module Jekyll
     class Pages
       class << self
         DEFAULTS = {
-          "PAGES_ENV"              => "development".freeze,
-          "PAGES_API_URL"          => "https://api.github.com".freeze,
-          "PAGES_HELP_URL"         => "https://help.github.com".freeze,
-          "PAGES_GITHUB_HOSTNAME"  => "github.com".freeze,
-          "PAGES_PAGES_HOSTNAME"   => "github.io".freeze,
-          "SSL"                    => "false".freeze,
-          "SUBDOMAIN_ISOLATION"    => "false".freeze,
+          "PAGES_ENV"              => "development",
+          "PAGES_API_URL"          => "https://api.github.com",
+          "PAGES_HELP_URL"         => "https://help.github.com",
+          "PAGES_GITHUB_HOSTNAME"  => "github.com",
+          "PAGES_PAGES_HOSTNAME"   => "github.io",
+          "SSL"                    => "false",
+          "SUBDOMAIN_ISOLATION"    => "false",
           "PAGES_PREVIEW_HTML_URL" => nil,
           "PAGE_BUILD_ID"          => nil,
         }.freeze
@@ -32,13 +32,21 @@ module Jekyll
           env_var("SUBDOMAIN_ISOLATION").eql? "true"
         end
 
-        def test?;        env == "test" end
+        def test?
+          env == "test"
+        end
 
-        def dotcom?;      env == "dotcom" end
+        def dotcom?
+          env == "dotcom"
+        end
 
-        def enterprise?;  env == "enterprise" end
+        def enterprise?
+          env == "enterprise"
+        end
 
-        def development?; env == "development" end
+        def development?
+          env == "development"
+        end
 
         def custom_domains_enabled?
           dotcom? || test?
@@ -54,7 +62,7 @@ module Jekyll
 
         def github_url
           if dotcom? || github_hostname == "github.com"
-            "https://github.com".freeze
+            "https://github.com"
           else
             "#{scheme}://#{github_hostname}"
           end
@@ -89,6 +97,7 @@ module Jekyll
         end
 
         private
+
         def env_var(key, intermediate_default = nil)
           !ENV[key].to_s.empty? ? ENV[key] : (intermediate_default || DEFAULTS[key])
         end

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

@@ -62,6 +62,10 @@ module Jekyll
         end
       end
 
+      def owner_metadata
+        @owner_metadata ||= Jekyll::GitHubMetadata::Owner.new(owner)
+      end
+
       def owner_url
         "#{Pages.github_url}/#{owner}"
       end
@@ -163,6 +167,7 @@ module Jekyll
 
       def cname
         return nil unless Pages.custom_domains_enabled?
+
         repo_pages_info["cname"]
       end
 
@@ -178,10 +183,19 @@ module Jekyll
         uri.dup.tap { |u| u.path = "" }.to_s
       end
 
+      def stargazers_count
+        repo_pages_info["stargazers_count"] || 0
+      end
+
+      def forks_count
+        repo_pages_info["forks_count"] || 0
+      end
+
       private
 
       def memoize_value(var_name, value)
         return instance_variable_get(var_name) if instance_variable_defined?(var_name)
+
         instance_variable_set(var_name, value.render)
       end
     end

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

@@ -28,6 +28,7 @@ module Jekyll
         repo.user_page_domains.each do |user_repo|
           candidate_nwo = "#{repo.owner}/#{user_repo}"
           next unless Jekyll::GitHubMetadata.client.repository?(candidate_nwo)
+
           domain = Jekyll::GitHubMetadata::Repository.new(candidate_nwo).repo_compat.domain
         end
         domain

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

@@ -42,7 +42,7 @@ module Jekyll
 
       def nwo_from_config
         repo = site.config["repository"]
-        repo if repo && repo.is_a?(String) && repo.include?("/")
+        repo if repo&.is_a?(String) && repo&.include?("/")
       end
 
       def git_remotes
@@ -61,6 +61,7 @@ module Jekyll
 
       def nwo_from_git_origin_remote
         return unless Jekyll.env == "development" || Jekyll.env == "test"
+
         matches = git_remote_url.chomp(".git").match github_remote_regex
         matches[2..3].join("/") if matches
       end

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

@@ -16,11 +16,12 @@ module Jekyll
       # resource - an Object
       #
       # Returns the sanitized resource.
+      # rubocop:disable Metrics/CyclomaticComplexity
       def sanitize(resource)
         case resource
         when Array
           resource.map { |item| sanitize(item) }
-        when Numeric
+        when Numeric, Time
           resource
         when FalseClass
           false
@@ -36,6 +37,7 @@ module Jekyll
           end
         end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Sanitize the Sawyer Resource or Hash
       # Note: the object must respond to :to_hash for this to work.

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

@@ -44,6 +44,7 @@ module Jekyll
       def add_url_and_baseurl_fallbacks!
         site.config["url"] ||= Value.new("url", proc { |_c, r| r.url_without_path })
         return unless should_set_baseurl?
+
         site.config["baseurl"] = Value.new("baseurl", proc { |_c, r| r.baseurl })
       end
 

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

@@ -25,6 +25,7 @@ module Jekyll
 
       def render
         return @rendered if defined? @rendered
+
         @rendered = @value = Sanitizer.sanitize(call_or_value)
       rescue RuntimeError, NameError => e
         Jekyll::GitHubMetadata.log :error, "Error processing value '#{key}':"
@@ -46,6 +47,7 @@ module Jekyll
       # or returns the raw value if it's a literal
       def call_or_value
         return value unless value.respond_to?(:call)
+
         case value.arity
         when 0
           value.call

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GitHubMetadata
-    VERSION = "2.10.0".freeze
+    VERSION = "2.11.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-metadata
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -48,16 +48,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: netrc
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,19 +115,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 0.5.0
 description: 
 email:
 - parkrmoore@gmail.com
@@ -139,6 +139,7 @@ files:
 - 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/owner.rb
 - lib/jekyll-github-metadata/pages.rb
 - lib/jekyll-github-metadata/repository.rb
 - lib/jekyll-github-metadata/repository_compat.rb