jekyll-github-metadata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7118e76a45b88b13ed74056081b4f8c770afe7eb
+  data.tar.gz: 4c68fc503a1c8d070ec518af2c3cece4d21bd642
+SHA512:
+  metadata.gz: 1f392cde09024155ffd90de399a77ff4a58b9ce9d631b25c07c42c0dad43efa649b620a2285eadc92f956a49a35a4d0efbaf34317568d321000e50e26d85a71d
+  data.tar.gz: 3347b15c29ebea89267d5388ae89b4b1be87a87b7f61e7686b69841a384389dea2df1818daaebc404508c5ca2696b49b7a9d091bb0bcf024401c03f43260ef4f

data/lib/jekyll-github-metadata.rb

@@ -0,0 +1,86 @@
+module Jekyll
+  module GitHubMetadata
+    autoload :Client,     'jekyll-github-metadata/client'
+    autoload :Pages,      'jekyll-github-metadata/pages'
+    autoload :Repository, 'jekyll-github-metadata/repository'
+    autoload :Sanitizer,  'jekyll-github-metadata/sanitizer'
+    autoload :Value,      'jekyll-github-metadata/value'
+    autoload :VERSION,    'jekyll-github-metadata/version'
+
+    class << self
+      attr_accessor :repository
+
+      def environment
+        Jekyll.env || Pages.env || 'development'
+      end
+
+      def client
+        @client ||= Client.new
+      end
+
+      def values
+        @values ||= Hash.new
+      end
+
+      def clear_values!
+        @values = Hash.new
+      end
+
+      def [](key)
+        values[key.to_s]
+      end
+
+      def to_h
+        values
+      end
+
+      def to_liquid
+        to_h
+      end
+
+      def register_value(key, value)
+        values[key.to_s] = Value.new(value)
+      end
+    end
+
+    # Environment-Specific
+    register_value('environment', proc { environment })
+    register_value('hostname', proc { Pages.github_url })
+    register_value('pages_hostname', proc { Pages.pages_hostname })
+    register_value('api_url', proc { Pages.api_url })
+
+    register_value('versions', proc {
+      begin
+        require 'github-pages'
+        GitHubPages.versions
+      rescue LoadError; Hash.new end
+    })
+
+    # The Juicy Stuff
+    register_value('public_repositories',  proc { |c,r| c.list_repos(r.owner, "type" => "public") })
+    register_value('organization_members', proc { |c,r| c.organization_public_members(owner) if r.organization_repository? })
+    register_value('build_revision',       proc { `git rev-parse HEAD`.strip })
+    register_value('project_title',        proc { |_,r| r.name })
+    register_value('project_tagline',      proc { |_,r| r.tagline })
+    register_value('owner_name',           proc { |_,r| r.owner })
+    register_value('owner_url',            proc { |_,r| r.owner_url })
+    register_value('owner_gravatar_url',   proc { |_,r| r.owner_gravatar_url })
+    register_value('repository_url',       proc { |_,r| r.repository_url })
+    register_value('repository_nwo',       proc { |_,r| r.nwo })
+    register_value('repository_name',      proc { |_,r| r.name})
+    register_value('zip_url',              proc { |_,r| r.zip_url })
+    register_value('tar_url',              proc { |_,r| r.tar_url })
+    register_value('clone_url',            proc { |_,r| r.repo_clone_url })
+    register_value('releases_url',         proc { |_,r| r.releases_url })
+    register_value('issues_url',           proc { |_,r| r.issues_url })
+    register_value('wiki_url',             proc { |_,r| r.wiki_url })
+    register_value('language',             proc { |_,r| r.language })
+    register_value('is_user_page',         proc { |_,r| r.user_page? })
+    register_value('is_project_page',      proc { |_,r| r.project_page? })
+    register_value('show_downloads',       proc { |_,r| r.show_downloads? })
+    register_value('url',                  proc { |_,r| r.pages_url })
+    register_value('contributors',         proc { |c,r| c.contributors(r.nwo) })
+  end
+end
+
+require_relative 'jekyll-github-metadata/ghp_metadata_generator'

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

@@ -0,0 +1,52 @@
+module Jekyll
+  module GitHubMetadata
+    class Client
+      def initialize(options = nil)
+        require 'octokit'
+        @client = build_octokit_client(options)
+      end
+
+      def safe_require(gem_name)
+        require gem_name
+        true
+      rescue LoadError
+        false
+      end
+
+      def build_octokit_client(options = nil)
+        options = options || Hash.new
+        if ENV['JEKYLL_GITHUB_TOKEN']
+          options.merge!(:access_token => ENV['JEKYLL_GITHUB_TOKEN'])
+        elsif File.exist?(File.join(ENV['HOME'], '.netrc')) && safe_require('netrc')
+          options.merge!(:netrc => true)
+        else
+          Jekyll.logger.warn "GitHubMetadata:", "No GitHub API authentication could be found." +
+            " Some fields may be missing or have incorrect data."
+        end
+        Octokit::Client.new(options)
+      end
+
+      def method_missing(meth, *args, &block)
+        if @client.respond_to?(meth)
+          instance_variable_get(:"@#{meth}") ||
+            instance_variable_set(:"@#{meth}", save_from_errors { @client.send(meth, *args, &block) })
+        else
+          super(meth, *args, &block)
+        end
+      end
+
+      def save_from_errors(default = false, &block)
+        if block.arity == 1
+          block.call(@client)
+        else
+          block.call
+        end
+      rescue Faraday::Error::ConnectionFailed,
+        Octokit::NotFound,
+        Octokit::Unauthorized,
+        Octokit::TooManyRequests
+        default
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require 'jekyll'
+
+module Jekyll
+  module GitHubMetadata
+    class GHPMetadataGenerator < Jekyll::Generator
+      def generate(site)
+        GitHubMetadata.repository = GitHubMetadata::Repository.new(site.config.fetch('repository'))
+        site.config['github'] = GitHubMetadata.to_liquid
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Jekyll
+  module GitHubMetadata
+    class Pages
+      class << self
+        def env
+          ENV.fetch('PAGES_ENV', 'dotcom')
+        end
+
+        def api_url
+          'https://api.github.com'
+        end
+
+        def github_url
+          'github.com'
+        end
+
+        def pages_hostname
+          'github.io'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+module Jekyll
+  module GitHubMetadata
+    class Repository
+      attr_reader :nwo, :owner, :name
+      def initialize(name_with_owner)
+        @nwo   = name_with_owner
+        @owner = nwo.split("/").first
+        @name  = nwo.split("/").last
+      end
+
+      def organization_repository?
+        !!GitHubMetadata.client.organization(owner)
+      end
+
+      def git_ref
+        user_page? ? 'master' : 'gh-pages'
+      end
+
+      def repo_info
+        @repo_into ||= (Value.new(proc { |c| c.repository(nwo) }).render || Hash.new)
+      end
+
+      def language
+        repo_info["language"]
+      end
+
+      def tagline
+        repo_info["description"]
+      end
+
+      def owner_url
+        "#{Pages.github_url}/#{owner}"
+      end
+
+      def owner_gravatar_url
+        "#{owner_url}.png"
+      end
+
+      def repo_clone_url
+        "#{repository_url}.git"
+      end
+
+      def repository_url
+        "#{Pages.github_url}/#{nwo}"
+      end
+
+      def zip_url
+        "#{repository_url}/zipball/#{git_ref}"
+      end
+
+      def tar_url
+        "#{repository_url}/tarball/#{git_ref}"
+      end
+
+      def releases_url
+        "#{repository_url}/releases"
+      end
+
+      def issues_url
+        "#{repository_url}/issues" if repo_info["has_issues"]
+      end
+
+      def wiki_url
+        "#{repository_url}/wiki" if repo_info["has_wiki"]
+      end
+
+      def show_downloads?
+        !!repo_info["has_downloads"]
+      end
+
+      def user_page?
+        primary?
+      end
+
+      def project_page?
+        !primary?
+      end
+
+      def primary?
+        user_page_domains.include? name.downcase
+      end
+
+      def github_repo?
+        owner.eql?('github')
+      end
+
+      def default_user_domain
+        if github_repo?
+          "#{owner}.#{Pages.github_hostname}".downcase
+        else
+          "#{owner}.#{Pages.pages_hostname}".downcase
+        end
+      end
+
+      def user_page_domains
+        [
+          default_user_domain,
+          "#{owner}.github.com".downcase # legacy
+        ]
+      end
+
+      def pages_url
+        if cname || primary?
+          "http://#{domain}"
+        else
+          File.join("http://#{domain}", name)
+        end
+      end
+
+      def cname
+        @cname ||= (Value.new(proc { |c| c.pages(nwo) }).render || {'cname' => nil})['cname']
+      end
+
+      def domain
+        cname || default_user_domain
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Jekyll
+  module GitHubMetadata
+    module Sanitizer
+      extend self
+      # Sanitize an object.
+      # When the resource is either `false`, `true`, `nil` or a number,
+      #   it returns the resource as-is. When the resource is an array,
+      #   it maps over the entire array, sanitizing each of its values.
+      #   When the resource responds to the #to_hash method, it returns
+      #   the value of #sanitize_resource (see below). If none of the
+      #   aforementioned conditions are met, the return value of #to_s
+      #   is used.
+      #
+      # resource - an Object
+      #
+      # Returns the sanitized resource.
+      def sanitize(resource)
+        case resource
+        when Array
+          resource.map { |item| sanitize(item) }
+        when Numeric
+          resource
+        when FalseClass
+          false
+        when TrueClass
+          true
+        when NilClass
+          nil
+        else
+          if resource.respond_to?(:to_hash)
+            sanitize_resource(resource)
+          else
+            resource.to_s
+          end
+        end
+      end
+
+      # Sanitize the Sawyer Resource or Hash
+      # Note: the object must respond to :to_hash for this to work.
+      # Consider using #sanitize instead of this method directly.
+      #
+      # resource - an Object which responds to :to_hash
+      #
+      # Returns the sanitized sawyer resource or hash as a hash.
+      def sanitize_resource(resource)
+        resource.to_hash.inject({}) do |result, (k, v)|
+          result[k.to_s] = sanitize(v)
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'json'
+
+module Jekyll
+  module GitHubMetadata
+    class Value
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def render
+        @value = if @value.respond_to?(:call)
+          case @value.arity
+          when 0
+            @value.call
+          when 1
+            @value.call(GitHubMetadata.client)
+          when 2
+            @value.call(GitHubMetadata.client, GitHubMetadata.repository)
+          else
+            raise ArgumentError.new("Whoa, arity of 0, 1, or 2 please in your procs.")
+          end
+        else
+          @value
+        end
+        @value = Sanitizer.sanitize(@value)
+      end
+
+      def to_s
+        render.to_s
+      end
+
+      def to_json(*)
+        render.to_json
+      end
+
+      def to_liquid
+        case render
+        when String, Numeric, Array
+          render
+        else
+          to_json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Jekyll
+  module GitHubMetadata
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-github-metadata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Parker Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- parkrmoore@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-github-metadata.rb
+- lib/jekyll-github-metadata/client.rb
+- lib/jekyll-github-metadata/ghp_metadata_generator.rb
+- lib/jekyll-github-metadata/pages.rb
+- lib/jekyll-github-metadata/repository.rb
+- lib/jekyll-github-metadata/sanitizer.rb
+- lib/jekyll-github-metadata/value.rb
+- lib/jekyll-github-metadata/version.rb
+homepage: https://github.com/parkr/github-metadata
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: The site.github namespace
+test_files: []