mm-jekyll-prism 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cef1a527f0b11c63cc360ece4cda070460d86855
+  data.tar.gz: 1d1c623f56c5a65c5c7ae09f436e227baae4c8c0
+SHA512:
+  metadata.gz: f98451286797e4006d392ae3b238482a91a40b53a3f7a5093ea97e747235b9285baaab0ec5c84178a3d666fb8341812c3f74cf9742e3b59c33e2d2c4f81f7c12
+  data.tar.gz: b45c0acd5dbc45d57b76d77b62a0878a21fd6f56798d63175bf517bdce691a26846852cb0e0d832f2c78b85a672e658a745d28d2271845d3ab357bb70f8c09d5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    jekyll-prism (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    blankslate (2.1.2.4)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    classifier-reborn (2.0.1)
+      fast-stemmer (~> 1.0)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.7.1)
+    colorator (0.1)
+    diff-lcs (1.2.5)
+    execjs (2.2.1)
+    fast-stemmer (1.0.2)
+    ffi (1.9.3)
+    jekyll (2.3.0)
+      classifier-reborn (~> 2.0)
+      colorator (~> 0.1)
+      jekyll-coffeescript (~> 1.0)
+      jekyll-gist (~> 1.0)
+      jekyll-paginate (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 2.6.1)
+      mercenary (~> 0.3.3)
+      pygments.rb (~> 0.6.0)
+      redcarpet (~> 3.1)
+      safe_yaml (~> 1.0)
+      toml (~> 0.1.0)
+    jekyll-coffeescript (1.0.0)
+      coffee-script (~> 2.2)
+    jekyll-gist (1.1.0)
+    jekyll-paginate (1.0.0)
+    jekyll-sass-converter (1.2.0)
+      sass (~> 3.2)
+    jekyll-watch (1.1.0)
+      listen (~> 2.7)
+    kramdown (1.4.1)
+    liquid (2.6.1)
+    listen (2.7.9)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    mercenary (0.3.4)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    posix-spawn (0.3.9)
+    pygments.rb (0.6.0)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.1.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    safe_yaml (1.0.3)
+    sass (3.4.1)
+    timers (1.1.0)
+    toml (0.1.1)
+      parslet (~> 1.5.0)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  jekyll (~> 2.0)
+  jekyll-prism!
+  rake
+  rspec
+  rspec-mocks

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tim Oram
+
+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,105 @@
+# Jekyll Prisim Plugin
+
+A Prism plugin for Jekyll with support included for the official plugins. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem jekyll-prism
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-prism
+
+## Usage
+
+These instructions assume you are familiar with using Prism. If not please read the [Prisim documentation](http://prismjs.com/index.html) from the Prism website. This plugin does not install prism but allows for easy inclusion of Prism code blocks in your Jekyll website.
+
+To start using this plugin replace your `<pre><code class="language-*">...</code></pre>` block with `{% prism myLanguage %}...{% endprism %}` replacing `myLanguage` with any language supported by Prisim.
+
+### Plugins
+
+#### Line Highlighting
+
+__Help document__: http://prismjs.com/plugins/line-highlight/
+
+To use line highlighting provide the __highlight__ option with the values for the line-highlight plugin as specified on the plugins help page. The value is passed verbatim to the _data-line_ attribute used by Prism. 
+
+###### Example
+
+    {% prism javascript highlight="1-5,7,10-13" %}
+    // ...
+    {% endprism %}
+
+#### Line Numbering
+__Help document__: http://prismjs.com/plugins/line-numbers/
+
+To use line numbering add the option __numbering__. To offset line numbering provide a value to the __numbering__ option as specified in the help page for the plugin. The value is passed verbatim to the _data-start_ attribute used by Prism.
+
+###### Example
+__No  offset__
+
+    {% prism javascript numbering %}
+    // ...
+    {% endprism %}
+    
+__With  offset__
+
+    {% prism javascript numbering=10 %}
+    // ...
+    {% endprism %}
+
+#### Show invisibles
+__Help document__: http://prismjs.com/plugins/show-invisibles/
+
+Works without any further configuration assuming the plugin is installed.
+
+#### Autolinker
+__Help document__: http://prismjs.com/plugins/autolinker/
+
+Works without any further configuration assuming the plugin is installed.
+
+#### WebPlatform Docs
+__Help document__: http://prismjs.com/plugins/wpd/
+
+Works without any further configuration assuming the plugin is installed.
+
+#### File Highlight
+__Help document__: http://prismjs.com/plugins/file-highlight/
+
+To use file highlighting add the option __file__ with the path to the file. See the help document for further information. There is no need to specifiy a language when using __File Highlight__ but you can provide one. The value is passed verbatim to the _data-src_ attribute used by Prism. Other plugins may not function with this plugin; this is a limitation of the Prism plugin.
+
+###### Example
+__No  language__
+
+    {% prism file="myfile.js" %}
+    // ...
+    {% endprism %}
+    
+__With  offset__
+
+    {% prism javascript file="myfile.js" %}
+    // ...
+    {% endprism %}
+
+
+#### Show Language
+__Help document__: http://prismjs.com/plugins/show-language/
+
+Works without any further configuration assuming the plugin is installed.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/mitmaro/jekyll-prism-plugin/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jekyll_prism_plugin.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "mm-jekyll-prism"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Tim Oram"]
+  spec.email         = ["mitmaro@gmail.com"]
+  spec.summary       = %q{Prism plugin for Jekyll}
+  spec.description   = %q{Provides support for prisim in Jekyll, including plugin support.}
+  spec.homepage      = "https://github.com/mitmaro/jekyll-prism-plugin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "jekyll", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+
+end

data/lib/jekyll-prism.rb

@@ -0,0 +1,108 @@
+module Jekyll
+
+	class Prism < Liquid::Block
+		include Liquid::StandardFilters
+
+		LANGUAGE = /^[a-z\-]+$/
+		OPTION_PARAMS = /(file|highlight|numbering|language)(?:\s*=\s*("[a-zA-Z0-9.,\-\/\s]*"|\-?[0-9]+))?/
+		
+		@language = nil
+		@file = nil
+		@numbering = false
+		@highlight = false
+
+		def initialize(tag_name, markup, tokens)
+			super
+			
+			markup = markup.strip
+			
+			tmp = markup.split(/\s+/, 2)
+			
+			if tmp.count >= 1 then
+				param = tmp[0].strip.downcase
+				if LANGUAGE =~ param then
+					@language = param
+					if tmp.count == 2 then
+						markup = tmp[1]
+					else
+						return
+					end
+				elsif not param.start_with? "file" then
+					syntax_error
+				end
+			end
+			
+			
+			params = markup.strip.scan(OPTION_PARAMS).to_a
+			
+			params.each { |x|
+				if x.count == 1 || x[1] == nil then
+					name = x[0]
+					
+					if name.eql? "numbering" then
+						@numbering = true
+					else
+						syntax_error
+					end
+				elsif x.count == 2 then
+					name = x[0]
+					value = x[1]
+					if name.eql? "file" then
+						@file = value.tr('"', '')
+					elsif name.eql? "highlight" then
+						@highlight = value.tr('"', '')
+					elsif name.eql? "numbering" then
+						@numbering = value.to_i
+					end
+				else
+					syntax_error
+				end
+			}
+		end
+
+
+		def syntax_error
+			raise SyntaxError.new(
+				"Syntax Error in 'prism' - Valid syntax: prism <lang> [<option>(=<value>)] or prism file=path/to/file [<option>(=<value>)]"
+			)
+		end
+		
+		def render(context)
+			code = super.to_s.strip
+			dataline = ""
+			
+			linenumber = ""
+			datastart = ""
+			
+			language = ""
+			
+			class_attr = ""
+			
+			unless @language.nil? then
+				class_attr = class_attr + " language-" + @language + " "
+			end
+			
+			if not @numbering.nil? then
+				class_attr = class_attr + " line-numbers "
+			end
+			
+			if @numbering.is_a? Numeric then
+				datastart = "data-start='#{@numbering}'"
+			end
+			
+			unless @highlight.nil? then
+				dataline = "data-line='#{@highlight}'"
+			end
+			
+			if @file.nil?
+				"<pre class=\"#{class_attr}\" #{datastart} #{dataline}><code>#{code}</code></pre>"
+			else
+				"<pre class='#{class_attr}' #{datastart} #{dataline} data-src='#{@file}'></pre>"
+			end
+			
+		end
+	end
+
+end
+
+Liquid::Template.register_tag('prism', Jekyll::Prism)

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rspec

data/spec/jekyll_prism_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+RSpec.describe Jekyll::Prism do
+
+	let(:doc) { doc_with_content(content) }
+	let(:content)  { '{% prism javascript %} My Code {% endprism %}' }
+	let(:output) do
+		doc.content = content
+		doc.output  = Jekyll::Renderer.new(doc.site, doc).run
+	end
+	context "valid parameters" do
+		it "Understands how to get a language parameter" do
+			prism = Jekyll::Prism.new("prism", 'javascript ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@language)).to eql("javascript")
+			prism = Jekyll::Prism.new("prism", 'javascript numbering ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@language)).to eql("javascript")
+		end
+	
+		it "Understands how to accept a file parameter" do
+			prism = Jekyll::Prism.new("prism", 'file="path/to/file.js" ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@file)).to eql("path/to/file.js")
+			prism = Jekyll::Prism.new("prism", 'javascript file="path/to/file.js" ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@file)).to eql("path/to/file.js")
+			prism = Jekyll::Prism.new("prism", 'javascript file="path/to/file.js" highlight=10', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@file)).to eql("path/to/file.js")
+		end
+	
+		it "Understands how to accept a highlight parameter" do
+			prism = Jekyll::Prism.new("prism", 'javascript highlight="1-2,4,5-9" ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@highlight)).to eql("1-2,4,5-9")
+		end
+	
+		it "Understands how to accept a numbering parameter" do
+			prism = Jekyll::Prism.new("prism", 'javascript numbering ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@numbering)).to eql(true)
+			prism = Jekyll::Prism.new("prism", 'javascript numbering=10 ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@numbering)).to eql(10)
+			prism = Jekyll::Prism.new("prism", 'javascript numbering=-10 ', ["{% endprism %}"]);
+			expect(prism.instance_variable_get(:@numbering)).to eql(-10)
+		end
+	end
+	
+	context "Valid render from code with all options" do
+		
+		let(:content)  { '{% prism cpp numbering=5 highlight="1,2-5,10" %} My Code {% endprism %}' }
+		
+		it "Understands how to render code from code block" do
+			expect(output).to match("<pre class=\" language-cpp  line-numbers \" data-start=\"5\" data-line=\"1,2-5,10\"><code>My Code</code></pre>")
+		end
+	end
+	
+	context "Valid render from file with all options" do
+		
+		let(:content)  { '{% prism cpp file="path/to/file.cpp" numbering=5 highlight="1,2-5,10" %}{% endprism %}' }
+		
+		it "Understands how to render code from code block" do
+			expect(output).to match("<pre class=\" language-cpp  line-numbers \" data-start=\"5\" data-line=\"1,2-5,10\" data-src=\"path/to/file.cpp\"></pre>")
+		end
+	end
+	
+	context "Valid render from file with all options without language" do
+		
+		let(:content)  { '{% prism file="path/to/file.cpp" numbering=5 highlight="1,2-5,10" %}{% endprism %}' }
+		
+		it "Understands how to render code from code block" do
+			expect(output).to match("<pre class=\" line-numbers \" data-start=\"5\" data-line=\"1,2-5,10\" data-src=\"path/to/file.cpp\"></pre>")
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+TEST_DIR = File.dirname(__FILE__)
+TMP_DIR  = File.expand_path("../tmp", TEST_DIR)
+
+require 'jekyll'
+require File.expand_path("../lib/jekyll-prism.rb", TEST_DIR)
+
+Jekyll.logger.log_level = :error
+STDERR.reopen(test(?e, '/dev/null') ? '/dev/null' : 'NUL:')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  def tmp_dir(*files)
+    File.join(TMP_DIR, *files)
+  end
+
+  def source_dir(*files)
+    tmp_dir('source', *files)
+  end
+
+  def dest_dir(*files)
+    tmp_dir('dest', *files)
+  end
+
+  def doc_with_content(content, opts = {})
+    my_site = site
+    Jekyll::Document.new(source_dir('_test/doc.md'), {site: my_site, collection: collection(my_site)})
+  end
+
+  def collection(site, label = 'test')
+    Jekyll::Collection.new(site, label)
+  end
+
+  def site(opts = {})
+    conf = Jekyll::Utils.deep_merge_hashes(Jekyll::Configuration::DEFAULTS, opts.merge({
+      "source"      => source_dir,
+      "destination" => dest_dir
+    }))
+    Jekyll::Site.new(conf)
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mm-jekyll-prism
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tim Oram
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-28 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides support for prisim in Jekyll, including plugin support.
+email:
+- mitmaro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jekyll_prism_plugin.gemspec
+- lib/jekyll-prism.rb
+- script/bootstrap
+- script/cibuild
+- spec/_test/doc.md
+- spec/jekyll_prism_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mitmaro/jekyll-prism-plugin
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Prism plugin for Jekyll
+test_files:
+- spec/_test/doc.md
+- spec/jekyll_prism_spec.rb
+- spec/spec_helper.rb