jekyll_github_sample 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e15fe8ebc87794c54e191923c1b9de31f3625f3f
+  data.tar.gz: 63f7e2b7fdcf92b69b93d27977f60705da18d500
+SHA512:
+  metadata.gz: 2a2e8c914656e384509428f445dbe201fe38120223fd56d4dc9f24b5e3d0159d51a5b8bf0a7597cfeee40de40787dfe466baaf357f8a3e5336c543f2d1647734
+  data.tar.gz: 717a53467bdd19f5e302896a532f74d671af26c5a740c6202a0c81c0d1bcb4becf5cc46b6db2dc31f0319b6519118df299130e56d8f03eaba0c5e53fa370a4cd

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Specific to Rubymine
+.idea/*
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# 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
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/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

data/README.md

@@ -0,0 +1,39 @@
+jekyll-github-sample
+====================
+
+Two Jekyll Liquid tags to display a code sample from a file in a public Github repo and provide a reference to it.
+
+# Install
+
+Add the github_sample_tag.rb file to your Jekyll project _plugins directory.
+
+# Live Examples
+
+A [write up](https://bwillis.github.io/2014/05/28/include-github-repo-code-in-jekyll/) on my Jekyll blog including samples referencing this repo's code, meta.
+
+# github_sample Usage
+```
+github_sample URL_WITH_USERNAME_REPO_AND_FILE <START_LINE_NUMBER> <END_LINE_NUMBER>
+```
+
+ * URL_WITH_USERNAME_REPO_AND_FILE - the full path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs
+ * START_LINE_NUMBER - (optional) number that is the first line to include (0 based)
+ * END_LINE_NUMBER - (optional) number that is the last line to include, if excluded will read to end of file
+
+# github_reference Usage
+```
+{% github_sample_ref URL_WITH_USERNAME_REPO_AND_FILE %}
+```
+
+ * URL_WITH_USERNAME_REPO_AND_FILE - the full path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs
+
+# Example Usage
+
+This is how you would display, reference and highlight code in your Jekyll post.
+
+```
+{% github_sample_ref /bwillis/versioncake/989237901cb873f96df12be48cbf1239be496bd7/Appraisals %}
+{% highlight ruby %}
+{% github_sample /bwillis/versioncake/989237901cb873f96df12be48cbf1239be496bd7/Appraisals 0 5 %}
+{% endhighlight %}
+```

data/Rakefile

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

data/jekyll_github_sample.gemspec

@@ -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

data/lib/jekyll_github_sample.rb

@@ -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'

data/lib/jekyll_github_sample/code_tag.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)

data/lib/jekyll_github_sample/file_helper.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

data/lib/jekyll_github_sample/reference_tag.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)

data/lib/jekyll_github_sample/text_utils.rb

@@ -0,0 +1,22 @@
+module JekyllGithubSample
+  module TextUtils
+
+    INDEN_REGEX = /^\s+/
+
+    def remove_common_indentation(lines)
+      leading_spaces = []
+      lines.each do |line|
+        next if line.length == 1
+        if indentation_match = line.match(INDEN_REGEX)
+          leading_spaces << indentation_match[0].length
+        else
+          leading_spaces << 0
+        end
+      end
+
+      lines.collect do |line|
+        line.length == 1 ? line : line[leading_spaces.min..-1]
+      end
+    end
+  end
+end

data/lib/jekyll_github_sample/version.rb

@@ -0,0 +1,3 @@
+module JekyllGithubSample
+  VERSION = '0.1.0'
+end

data/spec/lib/jekyll_github_sample/file_helper_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe JekyllGithubSample::FileHelper do
+
+  let(:path) { '/bwillis/versioncake/blob/master/lib/versioncake/configuration.rb' }
+
+  subject { JekyllGithubSample::FileHelper.new(path) }
+
+  context '#initialize' do
+    it 'does not fail to initialize with the path' do
+      expect {
+        subject
+      }.not_to raise_error
+    end
+  end
+
+  its(:user_uri)     { should == 'https://github.com/bwillis' }
+  its(:web_uri)      { should == 'https://github.com/bwillis/versioncake/blob/master/lib/versioncake/configuration.rb' }
+  its(:raw_uri)      { should == 'https://raw.githubusercontent.com/bwillis/versioncake/master/lib/versioncake/configuration.rb' }
+  its(:filename)     { should == 'lib/versioncake/configuration.rb' }
+  its(:user)         { should == 'bwillis' }
+  its(:project_name) { should == 'versioncake' }
+end

data/spec/lib/jekyll_github_sample/text_utils_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe JekyllGithubSample::TextUtils do
+
+  let(:text_utils) { class Tester; include JekyllGithubSample::TextUtils; end.new }
+
+  context '#remove_common_indentation' do
+    let(:lines) {[
+     '   def method',
+     '     a = 1',
+     '   end'
+    ]}
+    subject { text_utils.remove_common_indentation(lines) }
+
+    it 'removes 3 spaces of common indentation' do
+      should =~ [
+        'def method',
+        '  a = 1',
+        'end'
+      ]
+    end
+
+    context 'for lines with no common indentation' do
+      let(:lines) { [
+          'def new_method',
+          '  raise',
+          'end'
+      ] }
+
+      it 'does nothing to the indentation' do
+        should =~ lines
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler.require
+
+require 'jekyll_github_sample'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_github_sample
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Willis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: bundler
+  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: 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'
+description: Easily reference and include a Github repo file in your post.
+email:
+- benjamin.willis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- jekyll_github_sample.gemspec
+- lib/jekyll_github_sample.rb
+- lib/jekyll_github_sample/code_tag.rb
+- lib/jekyll_github_sample/file_helper.rb
+- lib/jekyll_github_sample/reference_tag.rb
+- lib/jekyll_github_sample/text_utils.rb
+- lib/jekyll_github_sample/version.rb
+- spec/lib/jekyll_github_sample/file_helper_spec.rb
+- spec/lib/jekyll_github_sample/text_utils_spec.rb
+- spec/spec_helper.rb
+homepage: http://bwillis.github.io/jekyll-github-sample
+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: Include a sample of a Github repo file.
+test_files: []