octopress-escape-code 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 265a17b0eb6c9ba1a4cbbaa1f01a456e958b0e8d
+  data.tar.gz: 65cbeed0d373060db77e0e08d9e81bbed0289574
+SHA512:
+  metadata.gz: 94351ffb99649c83c509be109dbef8fcb95cd18890c66ab951625746e45bacfb9826e8849b6cee5de53e4c88746fbc4f99d6f23dc50204f32a14d95057c822e8
+  data.tar.gz: 8e608f4cd8974d0a473a2f1e4aba255913b5249ef2af06d652e429fb51956b9e22a8989d5bf801adc1baa79e27f90231335df2a260065d1e4a2c91d76b1baa84

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+_site
+.code-highlighter-cache

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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,94 @@
+# Octopress Escape Code
+
+Automatically escape code blocks so you can use liquid tags
+without worry having to surround them with unsightly `{% raw %}` and
+`{% endraw %}` tags.
+
+[![Build Status](https://travis-ci.org/octopress/escape-code.svg)](https://travis-ci.org/octopress/escape-code)
+[![Gem Version](http://img.shields.io/gem/v/octopress-escape-code.svg)](https://rubygems.org/gems/octopress-escape-code)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://octopress.mit-license.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-escape-code'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-escape-code
+
+Next add it to your gems list in Jekyll's `_config.yml`
+
+    gems:
+      - octopress-escape-code
+
+## Usage
+
+### Code plugins
+
+Before Jekyll parses your pages and posts through Liquid, code is automatically wrapped with `{% raw %}` blocks,
+ensuring that their contents aren't parsed by Liquid. For example, a `{% highlight %}` block's contents are wrapped like this.
+
+    {% highlight html %}{% raw %}
+    <article>{{ post.content }}</article>
+    {% endraw %}{% endhighlight %}
+
+The `{% highlight %}` block is still interpreted by Liquid, but the contents are escaped. This will also escape the 
+[Octopress code block](https://github.com/octopress/code-block) plugin.
+
+Some Markdown processors and the [Octopress codefence](https://github.com/octopress/code-block) plugin render code blocks which are
+surrounded by three back ticks. These are also wrapped with `{% raw %}` tags.
+
+    {% raw %}
+    ```html
+    <article>{{ post.content }}</article>
+    ```
+    {% endraw %}
+
+Liquid sees the raw tags and ignores the contents, but the code fences are still interpreted.
+
+### Standard Markdown code
+
+If you are using Markdown, you may create a code blocks by indenting four spaces or a single tab. These code blocks are escaped like this.
+
+```
+{% raw %}
+    <article>{{ post.content }}</article>
+{% endraw %}
+```
+
+You can also define in-line code tags by surrounding text with back ticks, like this ```some code``` which are automatically escaped as
+well.
+
+    This inline {% raw %}`<code>`{% endraw %} tag is escaped.
+
+This works with double back tick code tags as well.
+
+### Disable Automatic escaping
+
+Adding this gem will automatically enable code escaping for your entire site. To disable code escaping for a single page, add this to the
+page's YAML front-matter.
+
+    escape_code: fasle
+
+If you prefer, you can enable it on a per page basis, by turning off automatic code escaping in your site's configuration.
+
+    // in Jekyll's _config.yml
+    escape_code: false
+
+Then, to enable code escaping on a single page simply add `escape_code: true` to the page's YAML front-matter.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/escape-code/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,2 @@
+require "bundler/gem_tasks"
+

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

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

data/lib/octopress-escape-code.rb

@@ -0,0 +1,67 @@
+require "octopress-escape-code/version"
+require 'jekyll-page-hooks'
+
+module Jekyll
+  class EscapeCode < PageHooks
+    def pre_render(page)
+      site_config = page.site.config['escape_code']
+      site_config = true if site_config.nil?
+
+      page_config = page.data['escape_code']
+      page_config = site_config if page_config.nil?
+
+      enabled = page_config
+
+      if enabled
+        page.content = Octopress::EscapeCode.escape(page.content, page.ext)
+      end
+    end
+  end
+end
+
+module Octopress
+  module EscapeCode
+    def self.escape(content, ext)
+      ext = ext.downcase
+      content.encode!("UTF-8")
+      md_ext = %w{.markdown .mdown .mkdn .md .mkd .mdwn .mdtxt .mdtext}
+
+      # Escape codefenced codeblocks
+      content = content.gsub /^(`{3}.+?`{3})/m do
+        "{% raw %}\n#{$1}\n{% endraw %}"
+      end
+
+      # Escape markdown style code blocks
+      if md_ext.include?(ext)
+
+        # Escape four space indented code blocks
+        content = content.gsub /^(\s{4}.+?)\n($|[^\s{4}])/m do
+          "{% raw %}\n#{$1}\n{% endraw %}\n#{$2}"
+        end
+        
+        # Escape tab indented code blocks
+        content = content.gsub /^(\t.+?)\n($|[^\t])/m do
+          "{% raw %}\n#{$1}\n{% endraw %}\n#{$2}"
+        end
+
+        # Escape in-line code backticks
+        content = content.gsub /(`{1,2}[^`\n]+?`{1,2})/ do
+          "{% raw %}#{$1}{% endraw %}"
+        end
+
+      end
+
+      # Escape codeblock tag contents
+      content = content.gsub /^({%\s*codeblock.+?%})(.+?)({%\s*endcodeblock\s*%})/m do
+        "#{$1}{% raw %}#{$2}{% endraw %}#{$3}"
+      end
+
+      # Escape highlight tag contents
+      content = content.gsub /^({%\s*highlight.+?%})(.+?)({%\s*endhighlight\s*%})/m do
+        "#{$1}{% raw %}#{$2}{% endraw %}#{$3}"
+      end
+
+      content
+    end
+  end
+end

data/octopress-escape-code.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octopress-escape-code/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "octopress-escape-code"
+  spec.version       = Octopress::EscapeCode::VERSION
+  spec.authors       = ["Brandon Mathis"]
+  spec.email         = ["brandon@imathis.com"]
+  spec.summary       = %q{Return tag renders a variable with some nice features}
+  spec.description   = %q{Return tag renders a variable with some nice features}
+  spec.homepage      = "https://github.com/octopress/escape-code"
+  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_runtime_dependency 'jekyll-page-hooks', '~> 1.1'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "clash"
+  spec.add_development_dependency "octopress-codeblock"
+end

data/test/.clash.yml

@@ -0,0 +1,2 @@
+build: true
+compare: _expected _site

data/test/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'octopress-escape-code', path: '../'
+gem 'pry-debugger'
+gem 'clash'
+gem 'octopress-codeblock'

data/test/_config.yml

@@ -0,0 +1,16 @@
+# Site settings
+title: Your awesome title
+email: your-email@domain.com
+baseurl: ""
+url: "http://yourdomain.com"
+timezone: UTC
+escape_code: true
+
+exclude:
+  - Gemfile*
+
+# Build settings
+markdown: redcarpet
+gems:
+  - octopress-escape-code
+  - octopress-codeblock

data/test/_expected/index.html

@@ -0,0 +1,22 @@
+<p>Some text</p>
+<div class="highlight"><pre><code class="language-text" data-lang="text">Some kind of example:
+{% some tag that should break %}
+Stuff!
+</code></pre></div>
+<p>guys!</p>
+
+<p>Testing the <code>dobule ` type</code> of code thing.</p>
+
+<p>So here&#39;s a <code>{% nonexistant tag %}</code> that should be escaped.</p>
+
+<div class="highlight"><pre><code class="language-html" data-lang="html">Some kind of example:
+{% some tag that should break %}
+Stuff!</code></pre></div>
+
+<figure class='code-highlight-figure'><figcaption class='code-highlight-caption'><span class='code-highlight-caption-title'>html</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'>Some kind of example:
+</div></div><div data-line='2' class='code-highlight-row numbered'><div class='code-highlight-line'>&#x7b;% some tag that should break %&#x7d;
+</div></div><div data-line='3' class='code-highlight-row numbered'><div class='code-highlight-line'>Stuff!</div></div></pre></div></figure>
+<div class="highlight"><pre><code class="language-text" data-lang="text">stuff
+asdfadsf
+</code></pre></div>
+<p>some text</p>

data/test/index.md

@@ -0,0 +1,34 @@
+---
+escape_code: true
+---
+
+Some text
+
+```
+Some kind of example:
+{% some tag that should break %}
+Stuff!
+```
+guys!
+
+Testing the ``dobule ` type`` of code thing.
+
+So here's a `{% nonexistant tag %}` that should be escaped.
+
+{% highlight html %}
+Some kind of example:
+{% some tag that should break %}
+Stuff!
+{% endhighlight %}
+
+
+{% codeblock html %}
+Some kind of example:
+{% some tag that should break %}
+Stuff!
+{% endcodeblock %}
+
+    stuff
+    asdfadsf
+
+some text

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: octopress-escape-code
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll-page-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: clash
+  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: octopress-codeblock
+  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: Return tag renders a variable with some nice features
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/octopress-escape-code.rb
+- lib/octopress-escape-code/version.rb
+- octopress-escape-code.gemspec
+- test/.clash.yml
+- test/Gemfile
+- test/_config.yml
+- test/_expected/index.html
+- test/index.md
+homepage: https://github.com/octopress/escape-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: Return tag renders a variable with some nice features
+test_files:
+- test/.clash.yml
+- test/Gemfile
+- test/_config.yml
+- test/_expected/index.html
+- test/index.md