jekyll_github_content 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ddc3f0b418374cc40bb6a884a7e83b3446bcdf6
+  data.tar.gz: ec421a5b60fb89056d179c78ea5d7edd74e2767c
+SHA512:
+  metadata.gz: 6967e667c1a878d016242a6c06f4dbf3e6bd3b66ecb89c5ae392ad53a52ef410c43dc233ff8492ee574295ccfe09f61843c707e9e4eaec132f2622f3ba85705a
+  data.tar.gz: a84420ad01bf82fd62c99b48eaf32bdfdadf7828cf3905ceeb08975ab4ea54e178c891908cbedc0ccdc43088e6c6a3fc605d04120085698d32d4aa563d69276f

data/README.md

@@ -0,0 +1,40 @@
+# JekyllGithubContent
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/github/inserts`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-github-content'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-github-content
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-github-content.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll_github_content"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/jekyll_github_content.rb

@@ -0,0 +1,95 @@
+# 3rd party libs
+require 'open-uri'
+require 'active_support'
+require 'liquid'
+
+module JekyllGithubContent
+
+  class GithubUriParser
+
+    GITHUB_URI_ROOT = 'https://github.com/'
+    GITHUB_RAW_URI_ROOT = 'https://raw.githubusercontent.com'
+
+    attr_reader :user, :repo, :file
+
+    def initialize(path)
+      relative_path = path.sub(/^https?\:\/\//, '').sub(/^github.com/, '')
+      url_chunks = relative_path.split('/').delete_if { |e| e.empty? }
+
+      @user, @repo, blob, @branch = url_chunks[0..3]
+      @file = File.join(url_chunks[4..-1])
+    end
+
+    def get_raw_file_uri
+      File.join(GITHUB_RAW_URI_ROOT, @user, @repo, @branch, @file)
+    end
+
+    def get_user_uri
+      File.join(GITHUB_URI_ROOT, @user)
+    end
+
+    def get_repo_uri
+      File.join(GITHUB_URI_ROOT, @user, @repo)
+    end
+
+  end
+
+  class GithubContentRenderer < ::Liquid::Tag
+
+    def initialize(tag_name, params, tokens)
+      path, @initial_line, @end_line = params.split
+      @github_file = GithubUriParser.new(path)
+      @initial_line, @end_line = parse_line_boundaries(@initial_line, @end_line)
+      super
+    end
+
+    def render(context)
+      file_lines = cache.fetch(@github_file.get_raw_file_uri) do
+        open(@github_file.get_raw_file_uri).readlines
+      end
+      lines_to_print = file_lines[@initial_line..@end_line]
+      lines_to_print.join
+    end
+
+    private # --------------------------------------------------------------------------------------------------------
+
+    def cache
+      @@cache ||= ActiveSupport::Cache::MemoryStore.new
+    end
+
+    def parse_line_boundaries(first_line, last_line)
+      if first_line.nil? && last_line.nil?
+        first_line = 0
+        last_line = -1
+      elsif last_line.nil?
+        last_line = first_line
+      end
+
+      [first_line.to_i, last_line.to_i]
+    end
+  end
+
+  class GithubMetaContentRenderer < GithubContentRenderer
+
+    def render(context)
+      <<DELIMITER.strip
+<div class="github-file">
+  <div class="meta-info">
+    Github file by <a href="#{@github_file.get_user_uri}">#{@github_file.user}</a>
+    <br>
+    Repo: <a href="#{@github_file.get_repo_uri}">#{@github_file.repo}</a>
+    <br>
+    File: #{@github_file.file} <a href="#{@github_file.get_raw_file_uri}">Raw view</a>
+  </div>
+</div>
+DELIMITER
+    end
+  end
+
+end
+
+# Register the tag names in Liquid to allow code & medadata insertion in Jekill markdown files
+# e.g. {% github_file <my_file_url_in_github> [start_line] [end_line] %}
+# e.g. {% github_fileref <my_file_url_in_github> %}
+Liquid::Template.register_tag('github_file', JekyllGithubContent::GithubContentRenderer)
+Liquid::Template.register_tag('github_fileref', JekyllGithubContent::GithubMetaContentRenderer)

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_github_content
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Francisco Perez-Sorrosal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Allows to insert github files in jekyll markdown files
+email:
+- fperezsorrosal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- lib/jekyll_github_content.rb
+homepage: https://github.com/francisco-perez-sorrosal/jekyll-github-content
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Insert github files with jekyll
+test_files: []