octopress-escape-code 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 080cc036a9e132f9d0b5f6c4c7531e59e63d134a
-  data.tar.gz: 447d073260a2e42364acb4b929edd8749c2e67a0
+  metadata.gz: 4781e02240e67f367bed8d7ea219bd5087915b28
+  data.tar.gz: 875502e016e25e1ff6228221b8fc9fa8144735cb
 SHA512:
-  metadata.gz: 64a4526d32f633c54b0fc7635b675d588ee5c32ffbb00073b9d1c29d396c975649cc2288e9b1bac5b5854b3ce95c949bb91ce51fbbbb99a416321e9340f91e03
-  data.tar.gz: 131b1115d49a0f29ad0c63be42f41a5930bece31344ce4766f9610e15125bc9f49ecdbb4d42e26c4507e70b495d2be63c514da1c7a52ab17b136052240e7c0dc
+  metadata.gz: 6d7a1b6d6bca0d9b5dc5332699682d12cd1186e49762198f2fe98216ec632676643869571cdcccf45fc2daa985f376bd064b4fb63acc8cd99eba1989645c679e
+  data.tar.gz: 6ba3c05c61ae02c72acdc3c87af69ca63a9518f2307a55dbb1014e5a0e5f500c336dbf0dc6b90c1510300cd1862c0e9e3bb0db9104f6f66fc4a63148f9b4cac8

data/CHANGELOG.md

@@ -1,7 +1,10 @@
 # Changelog
 
-### 1.0.3 - 2014-12-10
+### 1.0.4 - 2014-12-10
+- Added support for documentation in Octopress docs.
+- Now preserving hand written raw tags inside of code blocks.
 
+### 1.0.3 - 2014-12-10
 Fixes:
 - Random tabs don't trigger escapes.
 - Raw tags inside of code fences are properly stripped.

data/README.md

@@ -1,3 +1,6 @@
+<!---
+escape_raw: true
+--->
 # Octopress Escape Code
 
 Automatically escape code blocks so you can use liquid tags without worry having to surround them with unsightly 
@@ -62,7 +65,7 @@ If you are using Markdown, you may create a code blocks by indenting four spaces
 {% endraw %}
 ```
 
-You can also define in-line code tags by surrounding text with back ticks, like this ```some code``` which are automatically escaped as
+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.
@@ -82,7 +85,6 @@ If you prefer, you can enable it on a per page basis, by turning off automatic c
 
 Then, add `escape_code: true` to the page's YAML front-matter to enable code escaping for a single page.
 
-
 ## Contributing
 
 1. Fork it ( https://github.com/octopress/escape-code/fork )

data/lib/octopress-escape-code.rb

@@ -7,34 +7,54 @@ module Octopress
     class EscapePage < Octopress::Hooks::Page
       def pre_render(page)
         if Octopress::EscapeCode.escape_enabled?(page)
-          page.content = Octopress::EscapeCode.escape(page.content, page.ext)
+          page.content = Octopress::EscapeCode.escape(page)
         end
       end
+
+      def post_render(page)
+        Octopress::EscapeCode.unescape_raw(page)
+      end
     end
 
     class EscapePost < Octopress::Hooks::Post
       def pre_render(page)
         if Octopress::EscapeCode.escape_enabled?(page)
-          page.content = Octopress::EscapeCode.escape(page.content, page.ext)
+          page.content = Octopress::EscapeCode.escape(page)
         end
       end
+
+      def post_render(page)
+        Octopress::EscapeCode.unescape_raw(page)
+      end
+    end
+
+    def self.unescape_raw(page)
+      page.output.gsub!(/\*-(end)?raw-\*/, '% \1raw %')
     end
 
     def self.escape_enabled?(page)
-      site_config = page.site.config['escape_code']
-      site_config = true if site_config.nil?
+      get_config(page, 'escape_code', true)
+    end
 
-      page_config = page.data['escape_code']
+    def self.get_config(page, config, default = true)
+      site_config = page.site.config[config]
+      site_config = default if site_config.nil?
+
+      page_config = page.data[config]
       page_config = site_config if page_config.nil?
 
-      enabled = page_config
+      page_config
     end
 
-    def self.escape(content, ext)
-      ext = ext.downcase
-      content.encode!("UTF-8")
+    def self.escape(page)
+      ext = page.ext.downcase
+      content = page.content.encode!("UTF-8")
       md_ext = %w{.markdown .mdown .mkdn .md .mkd .mdwn .mdtxt .mdtext}
 
+      # Escape existing raw tags
+      #
+      content = content.gsub(/% (end)?raw %/, '*-\1raw-*')
+
       # Escape markdown style code blocks
       if md_ext.include?(ext)
 
@@ -58,6 +78,18 @@ module Octopress
           "{% raw %}#{$1}{% endraw %}"
         end
 
+        content = content.gsub /^( {4}[^\n].+?)\n($|\S)/m do
+          c1 = $1
+          c2 = $2
+          "#{c1.gsub(/{% (end)?raw %}/, '')}\n#{c2}"
+        end
+
+        # Escape tab indented code blocks
+        content = content.gsub /^(\t[^\n].+?)\n($|\S)/m do
+          c1 = $1
+          c2 = $2
+          "#{c1.gsub(/{% (end)?raw %}/, '')}\n#{c2}"
+        end
       end
 
       # Escape codefenced codeblocks
@@ -87,3 +119,13 @@ module Octopress
     end
   end
 end
+
+# Add documentation for this plugin
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Escape Code",
+    description: "Automatically escape code with {% raw %} blocks, preventing internal Liquid processing.",
+    source_url:  "https://github.com/octopress/escape-code",
+    path:         File.expand_path(File.join(File.dirname(__FILE__), "../"))
+  })
+end

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

@@ -1,5 +1,5 @@
 module Octopress
   module EscapeCode
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

data/test/_expected/index.html

@@ -6,7 +6,7 @@ Stuff!
 </code></pre></div>
 <p>guys!</p>
 
-<p>Testing the <code>dobule {% _guys_ seriously? %} ` type</code> of code thing.</p>
+<p>Testing the <code>double {% _guys_ seriously? %} ` type</code> of code thing.</p>
 
 <p>The random tab character below shouldn&#39;t trigger an escape.</p>
 
@@ -24,3 +24,10 @@ Stuff!</code></pre></div>
 {% foo %}
 </code></pre></div>
 <p>some text</p>
+<div class="highlight"><pre><code class="language-text" data-lang="text">{% highlight html %}{% raw %}
+&lt;article&gt;{{ post.content }}&lt;/article&gt;
+{% endraw %}{% endhighlight %}
+</code></pre></div>
+<p>Test inner space block raw replacement:</p>
+<div class="highlight"><pre><code class="language-text" data-lang="text">This inline {% raw %}`&lt;code&gt;`{% endraw %} tag is escaped.
+</code></pre></div>

data/test/index.md

@@ -1,5 +1,6 @@
 ---
 escape_code: true
+escape_raw: true
 ---
 
 Some text
@@ -12,7 +13,7 @@ Stuff!
 ```
 guys!
 
-Testing the ``dobule {% _guys_ seriously? %} ` type`` of code thing.
+Testing the ``double {% _guys_ seriously? %} ` type`` of code thing.
 
 The random tab character below shouldn't trigger an escape.
 	
@@ -34,3 +35,11 @@ Stuff!
     stuff
     {% foo %}
 some text
+
+	{% highlight html %}{% raw %}
+	<article>{{ post.content }}</article>
+	{% endraw %}{% endhighlight %}
+
+Test inner space block raw replacement:
+
+    This inline {% raw %}`<code>`{% endraw %} tag is escaped.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-escape-code
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2014-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-hooks