octopress-render-code 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbab0868b38b969b758ec3ad8919c56628464e02
+  data.tar.gz: 2dd79c6b5abdce957da74989ff270ec3714c7fb7
+SHA512:
+  metadata.gz: 52f6d3555359efbf36cb741ecb11c2c956024e532250c1d97369f15f9902bb7909191b1d2028747ac8ca995d4ad13ff26ca952e5f387456c88509f3a1da53729
+  data.tar.gz: 36d3cbfee942c04675a4e06cd83fc3a3e49b0e1b967c5e8079986a4af4025d8223d094a08ef06773f6dee61becabd75c3d0f36ebcaeb95ed3564953630aa5724

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.pygments-cache
+_site
+.code-highlighter-cache

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: cd test && bundle exec ruby test.rb

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 1.0.0
+- Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in octopress-codefence.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Mathis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Octopress Render Code
+
+Write beautiful code snippets within any template.
+
+[![Build Status](https://travis-ci.org/octopress/render-code.png?branch=master)](https://travis-ci.org/octopress/render-code)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-render-code'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-render-code
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/lib/octopress-render-code.rb

@@ -0,0 +1,91 @@
+require 'octopress-render-code/version'
+require 'octopress-code-highlighter'
+require 'liquid'
+require 'colorator'
+
+module Octopress
+  module RenderCode
+    class Tag < Liquid::Tag
+
+      FileOnly = /^(\S+)$/
+      FileTitle = /(\S+)\s+(\S.*?)$/i
+      TitleFile = /(\S.*?)\s+(\S+)$/i
+
+      def initialize(tag_name, markup, tokens)
+        @markup = markup
+        super
+      end
+
+      def render(context)
+        @page_path = context.environments.first['page']['path']
+        site = context.registers[:site]
+        config_dir = (site.config['code_dir'] || 'downloads/code').sub(/^\//,'')
+        @code_dir = File.join(site.source, config_dir)
+
+        begin
+          options = get_options
+          code = File.open(@file).read.encode("UTF-8")
+          code = CodeHighlighter.select_lines(code, options)
+
+          highlight(code, options)
+        rescue => e
+          failure(e)
+        end
+      end
+
+      def get_path(file)
+        path = File.join(@code_dir, file)
+
+        if File.symlink?(path)
+          raise "Code directory '#{@code_path}' cannot be a symlink"
+        end
+
+        path if File.exists?(path)
+      end
+
+      def get_options
+        # wrap with {% raw %} tags to prevent addititional processing
+        defaults = { }
+
+        clean_markup = CodeHighlighter.clean_markup(@markup).strip
+
+        if clean_markup =~ FileOnly
+          @file = $1
+        elsif clean_markup =~ FileTitle
+          if @file = get_path($1)
+            defaults[:title] = $2
+          
+          # Allow for deprecated title first syntax
+          #
+          elsif clean_markup =~ TitleFile
+            defaults[:title] = $1
+            @file = get_path($2)
+            puts "\nRenderCode Warning:".red
+            puts "  Passing title before path has been deprecated and will be removed in RenderCode 2.0".red
+            puts "  Update #{@page_path} with {% render_code #{$2} #{$1} ... %}.".yellow
+          end
+        end
+
+        options = CodeHighlighter.parse_markup(@markup, defaults)
+        options[:lang] ||= File.extname(@file).delete('.')
+        options[:link_text] ||= "Raw code"
+        options
+      end
+
+      def failure(message)
+        CodeHighlighter.highlight_failed(message, "{% include_code path/to/file [title] [lang:language] [start:#] [end:#] [range:#-#] [mark:#,#-#] [linenos:false] %}", @markup, '')
+      end
+
+
+      def highlight(code, options)
+        options[:aliases] = @aliases || {}
+        code = CodeHighlighter.highlight(code, options)
+        code = "<notextile>#{code}</notextile>" if File.extname(@page_path).match(/textile/)
+        code
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('render_code', Octopress::RenderCode::Tag)
+Liquid::Template.register_tag('include_code', Octopress::RenderCode::Tag)

data/lib/octopress-render-code/version.rb

@@ -0,0 +1,5 @@
+module Octopress
+  module RenderCode
+    VERSION = "1.0.0"
+  end
+end

data/octopress-render-code.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octopress-render-code/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "octopress-render-code"
+  gem.version       = Octopress::RenderCode::VERSION
+  gem.authors       = ["Brandon Mathis"]
+  gem.email         = ["brandon@imathis.com"]
+  gem.description   = %q{Embed highlighted code snippets from a file.}
+  gem.summary       = %q{Embed highlighted code snippets from a file.}
+  gem.homepage      = "https://github.com/octopress/render-code"
+  gem.license       = "MIT"
+
+  gem.add_runtime_dependency 'jekyll', '~> 2.0.3'
+  gem.add_runtime_dependency 'octopress-code-highlighter', '~> 4.0.1'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+end

data/test/.gitignore

@@ -0,0 +1 @@
+_site

data/test/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'pry-debugger'
+gem 'jekyll'
+gem 'jekyll-page-hooks'
+gem 'octopress-render-code', :path => '../'

data/test/_config.yml

@@ -0,0 +1,9 @@
+name: Your New Jekyll Site
+markdown: redcarpet
+highlighter: pygments
+exclude:
+  - Gemfile*
+  - expected.html
+  - test.rb
+pygments_aliases:
+  abc: ruby

data/test/_plugins/render-code.rb

@@ -0,0 +1 @@
+require 'octopress-render-code'

data/test/downloads/code/tricks.coffee

@@ -0,0 +1,5 @@
+# Given an alphabet:
+alphabet = 'abcdefghijklmnopqrstuvwxyz'
+
+# Iterate over part of the alphabet:
+console.log letter for letter in alphabet[4..8]

data/test/expected.html

@@ -0,0 +1,13 @@
+<figure class='code-highlight-figure'><figcaption class='code-highlight-caption'><span class='code-highlight-caption-title'>Coffeescript Tricks</span></figcaption><div class='code-highlight'><pre class='code-highlight-pre'><div data-line='1' class='code-highlight-row numbered marked-line start-marked-line'><div class='code-highlight-line'># Given an alphabet:</span>
+</div></div><div data-line='2' class='code-highlight-row numbered marked-line end-marked-line'><div class='code-highlight-line'><span class="nv">alphabet = </span><span class="s">&#39;abcdefghijklmnopqrstuvwxyz&#39;</span>
+</div></div><div data-line='3' class='code-highlight-row numbered'><div class='code-highlight-line'> </div></div><div data-line='4' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="c1"># Iterate over part of the alphabet:</span>
+</div></div><div data-line='5' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="nx">console</span><span class="p">.</span><span class="nx">log</span> <span class="nx">letter</span> <span class="k">for</span> <span class="nx">letter</span> <span class="k">in</span> <span class="nx">alphabet</span><span class="p">[</span><span class="mi">4</span><span class="p">..</span><span class="mi">8</span><span class="p">]</span></div></div></pre></div></figure>
+
+<figure class='code-highlight-figure'><figcaption class='code-highlight-caption'><span class='code-highlight-caption-title'>Coffeescript Tricks</span></figcaption><div class='code-highlight'><pre class='code-highlight-pre'><div data-line='1' class='code-highlight-row numbered'><div class='code-highlight-line'># Given an alphabet:</span>
+</div></div><div data-line='2' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="nv">alphabet = </span><span class="s">&#39;abcdefghijklmnopqrstuvwxyz&#39;</span>
+</div></div><div data-line='3' class='code-highlight-row numbered'><div class='code-highlight-line'> </div></div><div data-line='4' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="c1"># Iterate over part of the alphabet:</span>
+</div></div><div data-line='5' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="nx">console</span><span class="p">.</span><span class="nx">log</span> <span class="nx">letter</span> <span class="k">for</span> <span class="nx">letter</span> <span class="k">in</span> <span class="nx">alphabet</span><span class="p">[</span><span class="mi">4</span><span class="p">..</span><span class="mi">8</span><span class="p">]</span></div></div></pre></div></figure>
+
+<figure class='code-highlight-figure'><figcaption class='code-highlight-caption'><span class='code-highlight-caption-title'>Coffeescript Tricks</span></figcaption><div class='code-highlight'><pre class='code-highlight-pre'><div data-line='2' class='code-highlight-row numbered'><div class='code-highlight-line'>alphabet = </span><span class="s">&#39;abcdefghijklmnopqrstuvwxyz&#39;</span>
+</div></div><div data-line='3' class='code-highlight-row numbered'><div class='code-highlight-line'> </div></div><div data-line='4' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="c1"># Iterate over part of the alphabet:</span>
+</div></div><div data-line='5' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="nx">console</span><span class="p">.</span><span class="nx">log</span> <span class="nx">letter</span> <span class="k">for</span> <span class="nx">letter</span> <span class="k">in</span> <span class="nx">alphabet</span><span class="p">[</span><span class="mi">4</span><span class="p">..</span><span class="mi">8</span><span class="p">]</span></div></div></pre></div></figure>

data/test/index.md

@@ -0,0 +1,6 @@
+---
+---
+
+{% render_code Coffeescript Tricks tricks.coffee mark:1,2 %}
+{% render_code tricks.coffee Coffeescript Tricks link_text:"Download"%}
+{% render_code tricks.coffee Coffeescript Tricks range:2-4 %}

data/test/test.rb

@@ -0,0 +1,3 @@
+system('jekyll build')
+diff = `diff _site/index.html expected.html`
+abort "Filed with diff: #{diff}" if diff.size > 0

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: octopress-render-code
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: octopress-code-highlighter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !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'
+description: Embed highlighted code snippets from a file.
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/octopress-render-code.rb
+- lib/octopress-render-code/version.rb
+- octopress-render-code.gemspec
+- test/.gitignore
+- test/Gemfile
+- test/_config.yml
+- test/_plugins/render-code.rb
+- test/downloads/code/tricks.coffee
+- test/expected.html
+- test/index.md
+- test/test.rb
+homepage: https://github.com/octopress/render-code
+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: Embed highlighted code snippets from a file.
+test_files: []