Converting to Ruby gem

To make this plugin easier to include in Jekyll projects it has been
converted into a gem. This also allows for some testing of more complex
code, which has now been included.

Author: bwillis

.gitignore

@@ -14,6 +14,9 @@
 .repl_history
 build/
 
+## Specific to Rubymine
+.idea/*
+
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
@@ -27,8 +30,8 @@ build/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    jekyll_github_sample (0.1.0)
+      activesupport (~> 4.0)
+      jekyll (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    blankslate (2.1.2.4)
+    classifier (1.3.4)
+      fast-stemmer (>= 1.0.0)
+    colorator (0.1)
+    commander (4.1.6)
+      highline (~> 1.6.11)
+    diff-lcs (1.2.5)
+    fast-stemmer (1.0.2)
+    ffi (1.9.3)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jekyll (1.5.1)
+      classifier (~> 1.3)
+      colorator (~> 0.1)
+      commander (~> 4.1.3)
+      liquid (~> 2.5.5)
+      listen (~> 1.3)
+      maruku (= 0.7.0)
+      pygments.rb (~> 0.5.0)
+      redcarpet (~> 2.3.0)
+      safe_yaml (~> 1.0)
+      toml (~> 0.1.0)
+    json (1.8.1)
+    liquid (2.5.5)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    maruku (0.7.0)
+    minitest (5.3.4)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    posix-spawn (0.3.8)
+    pygments.rb (0.5.4)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.4)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.2)
+      ffi (>= 0.5.0)
+    redcarpet (2.3.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    safe_yaml (1.0.3)
+    thread_safe (0.3.4)
+    toml (0.1.1)
+      parslet (~> 1.5.0)
+    tzinfo (1.2.0)
+      thread_safe (~> 0.1)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jekyll_github_sample!
+  rake
+  rspec

Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

github_sample_tag.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'jekyll_github_sample/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'jekyll_github_sample'
+  s.version     = JekyllGithubSample::VERSION
+  s.license     = 'MIT'
+  s.authors     = ['Ben Willis']
+  s.email       = ['benjamin.willis@gmail.com']
+  s.homepage    = 'http://bwillis.github.io/jekyll-github-sample'
+  s.summary     = %q{Include a sample of a Github repo file.}
+  s.description = %q{Easily reference and include a Github repo file in your post.}
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = `git ls-files -- {spec}/*`.split('\n')
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '~> 4.0'
+  s.add_dependency 'jekyll',        '~> 1.0'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+
+end

jekyll_github_sample.gemspec

@@ -0,0 +1,4 @@
+require 'jekyll_github_sample/text_utils'
+require 'jekyll_github_sample/file_helper'
+require 'jekyll_github_sample/code_tag'
+require 'jekyll_github_sample/reference_tag'

lib/jekyll_github_sample.rb

@@ -0,0 +1,46 @@
+require 'cgi'
+require 'open-uri'
+require 'active_support'
+require 'liquid'
+
+module JekyllGithubSample
+  class CodeTag < ::Liquid::Tag
+
+    include TextUtils
+
+    def initialize(tag_name, params, tokens)
+      github_file_path, @line_start, @line_end = params.split
+      @github_file                             = FileHelper.new(github_file_path)
+      @line_start, @line_end                   = determine_line_numbers(@line_start, @line_end)
+      super
+    end
+
+    def render(context)
+      all_lines = cache.fetch(@github_file.raw_uri) do
+        open(@github_file.raw_uri).readlines
+      end
+      lines     = all_lines[@line_start..@line_end]
+      lines     = remove_common_indentation(lines)
+      lines.join
+    end
+
+    private
+
+    def cache
+      @@cache ||= ActiveSupport::Cache::MemoryStore.new
+    end
+
+    def determine_line_numbers(first, last)
+      if first.nil? && last.nil?
+        first = 0
+        last  = -1
+      elsif last.nil?
+        last = first
+      end
+
+      [first.to_i, last.to_i]
+    end
+  end
+end
+
+Liquid::Template.register_tag('github_sample', JekyllGithubSample::CodeTag)

lib/jekyll_github_sample/code_tag.rb

@@ -0,0 +1,34 @@
+module JekyllGithubSample
+  class FileHelper
+
+    GITHUB_RAW_URI = 'https://raw.githubusercontent.com/'
+    GITHUB_URI     = 'https://github.com/'
+    WEB_URI_PART = 'blob'
+
+    attr_reader :filename, :user, :project_name
+
+    def initialize(path)
+      @path = path
+      parts = @path.split('/').delete_if { |e| e.empty? }
+      if parts.include? WEB_URI_PART
+        @user, @project_name, @blob, @commitish_or_branch = parts[0..3]
+        @filename = File.join(parts[4..-1])
+      else
+        @user, @project_name, @commitish_or_branch = parts[0..2]
+        @filename = File.join(parts[3..-1])
+      end
+    end
+
+    def user_uri
+      File.join(GITHUB_URI, @user)
+    end
+
+    def web_uri
+      File.join(GITHUB_URI, @user, @project_name, WEB_URI_PART, @commitish_or_branch, @filename)
+    end
+
+    def raw_uri
+      File.join(GITHUB_RAW_URI, @user, @project_name, @commitish_or_branch, @filename)
+    end
+  end
+end

lib/jekyll_github_sample/file_helper.rb

@@ -0,0 +1,19 @@
+module JekyllGithubSample
+  class ReferenceTag < CodeTag
+
+    def render(context)
+      <<MARKUP.strip
+<div class="github-sample-reference">
+  <div class="author-info">
+    <a href="#{@github_file.web_uri}">This Github Sample</a> is by <a href="#{@github_file.user_uri}">#{@github_file.user}</a>
+  </div>
+  <div class="meta-info">
+    #{@github_file.filename} <a href="#{@github_file.web_uri}">view</a> <a href="#{@github_file.raw_uri}">raw</a>
+  </div>
+</div>
+MARKUP
+    end
+  end
+end
+
+Liquid::Template.register_tag('github_sample_ref', JekyllGithubSample::ReferenceTag)