octopress-render-tag 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7521e258881ed59759ca566d6312602228b9c452
-  data.tar.gz: 06101030a8b925ce0ecd587ccea896b0799d36fb
+  metadata.gz: f5acb80c4b4040ad60856fe838fba69f5e388efe
+  data.tar.gz: 44c850848b3cc59a01b1e663c0ab59c54d39dbce
 SHA512:
-  metadata.gz: 61ab181f1c0b9d656cc1bd9eebf1f33f2d0cd6940a2c78a940cd291bd798a378e32b60f19423b45fd820d6f104287fc6edc587de45f83c460f5c85c92cbd4b4d
-  data.tar.gz: 5f2a6f6ea3e6368e8f7b4e2074f77cc304b84ca834ff67f572ff4223b41ca1e2e121199c6ba88d6172be8ab00771e31586f25efe6110148bb7e80dcb533e882d
+  metadata.gz: 336a53eb17bb47428a0dfe24c2636d40e2f04f360698f1d63023c56cc4dcee4b62af1daa425eb749d7ec51165eb1dccea54e91c94d615ab6a06ee9a890b769ac
+  data.tar.gz: a62e352490234cb07e981fa050539228e0e8da1422b073dc7609bf0588efc3a7b560682e1306a07399a93291991ec55fd4f62a7a890fd3d542fa6b853717724e

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-script: cd test && bundle exec ruby test.rb
+script: cd test && bundle exec clash

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+### 1.0.1 - 2014-06-29
+
+- Added docs for Octopress Ink
+
+### 1.0.0 - 2014-06-29
+
+- Initial release
+

data/README.md

@@ -1,12 +1,16 @@
-# OctopressRenderTag
+# Octopress Render Tag
 
-TODO: Write a gem description
+Use the render tag to embed files directly from the file system. This tag also supports conditional rendering, in-line filters.
+
+[![Build Status](https://travis-ci.org/octopress/render-tag.svg)](https://travis-ci.org/octopress/render-tag)
+[![Gem Version](http://img.shields.io/gem/v/octopress-render-tag.svg)](https://rubygems.org/gems/octopress-render-tag)
+[![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_render_tag'
+    gem 'octopress-render-tag'
 
 And then execute:
 
@@ -14,15 +18,67 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install octopress_render_tag
+    $ gem install octopress-render-tag
+
+Next add it to your gems list in Jekyll's `_config.yml`
+
+    gems:
+      - octopress-render-tag
 
 ## Usage
 
-TODO: Write usage instructions here
+### How file paths work
+
+By default paths passed to the render tag are relative to the site source directory.
+
+    {% render _file.html %}      // relative to site source
+
+Relative paths like these are relative to the current file.
+
+    // some_page/test.html
+    
+    {% render ./_file.html %}              // renders some_page/_file.html
+    {% render ../other_page/_file.html %}  // renders other_page/_file.html
+
+You can even render files relative to system paths, however, remember that these renders will only work if
+the site is rendered on your system. If these files move, your site will fail to build.
+
+    {% render /_file.html %}     // relative to system root
+    {% render ~/_file.html %}    // relative to system user
+
+### Render tag features
+
+Render partials stored as a variable.
+
+    // If a page has the YAML front-matter
+    // theme: _post_themes/blue.css
+
+    <style>{% render page.theme %}</style>
+
+Render partials conditionally, using `if`, `unless` and ternary logic.
+
+    {% render ./post-footer.html if post.footer %}
+    {% render ./page-footer.html unless page.footer == false %}
+    {% render (post ? ./post-footer.html : ./page-footer.html) %}
+
+Filter partials.
+
+    {% render ./foo.html %}            //=> Yo, what's up
+    {% render ./foo.html | upcase %}   //=> YO, WHAT'S UP
+
+Automatic template processing.
+
+    // in some_page.html
+    {% render _test.md %}      // outputs markdown rendered to HTML
+
+Avoid template processing.
+
+    // in some_page.html
+    {% render raw _test.md %}  // Markdown is not processed
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/octopress_render_tag/fork )
+1. Fork it ( https://github.com/octopress/render-tag/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`)

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
+require "octopress-ink"
+
+desc "Copy Readme and Changelog into docs"
+task :update_docs do
+  Octopress::Ink.copy_doc 'README.md', 'assets/docs/index.markdown'
+  Octopress::Ink.copy_doc 'CHANGELOG.md', 'assets/docs/changelog.markdown', '/changelog/'
+end
 

data/assets/docs/changelog.markdown

@@ -0,0 +1,13 @@
+---
+title: "Changelog"
+permalink: /changelog/
+---
+
+### 1.0.1 - 2014-06-29
+
+- Added docs for Octopress Ink
+
+### 1.0.0 - 2014-06-29
+
+- Initial release
+

data/assets/docs/index.markdown

@@ -0,0 +1,87 @@
+---
+title: "Octopress Render Tag"
+---
+
+Use the render tag to embed files directly from the file system. This tag also supports conditional rendering, in-line filters.
+
+[![Build Status](https://travis-ci.org/octopress/render-tag.svg)](https://travis-ci.org/octopress/render-tag)
+[![Gem Version](http://img.shields.io/gem/v/octopress-render-tag.svg)](https://rubygems.org/gems/octopress-render-tag)
+[![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-render-tag'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-render-tag
+
+Next add it to your gems list in Jekyll's `_config.yml`
+
+    gems:
+      - octopress-render-tag
+
+## Usage
+
+### How file paths work
+
+By default paths passed to the render tag are relative to the site source directory.
+
+    {% render _file.html %}      // relative to site source
+
+Relative paths like these are relative to the current file.
+
+    // some_page/test.html
+    
+    {% render ./_file.html %}              // renders some_page/_file.html
+    {% render ../other_page/_file.html %}  // renders other_page/_file.html
+
+You can even render files relative to system paths, however, remember that these renders will only work if
+the site is rendered on your system. If these files move, your site will fail to build.
+
+    {% render /_file.html %}     // relative to system root
+    {% render ~/_file.html %}    // relative to system user
+
+### Render tag features
+
+Render partials stored as a variable.
+
+    // If a page has the YAML front-matter
+    // theme: _post_themes/blue.css
+
+    <style>{% render page.theme %}</style>
+
+Render partials conditionally, using `if`, `unless` and ternary logic.
+
+    {% render ./post-footer.html if post.footer %}
+    {% render ./page-footer.html unless page.footer == false %}
+    {% render (post ? ./post-footer.html : ./page-footer.html) %}
+
+Filter partials.
+
+    {% render ./foo.html %}            //=> Yo, what's up
+    {% render ./foo.html | upcase %}   //=> YO, WHAT'S UP
+
+Automatic template processing.
+
+    // in some_page.html
+    {% render _test.md %}      // outputs markdown rendered to HTML
+
+Avoid template processing.
+
+    // in some_page.html
+    {% render raw _test.md %}  // Markdown is not processed
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/render-tag/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/lib/octopress-render-tag.rb

@@ -1,5 +1,6 @@
 require "octopress-render-tag/version"
 require "octopress-tag-helpers"
+require "octopress-render-tag/ink-plugin"
 require "jekyll-page-hooks"
 require "jekyll"
 

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

@@ -1,7 +1,7 @@
 module Octopress
   module Tags
     module RenderTag
-      VERSION = "1.0.0"
+      VERSION = "1.0.1"
     end
   end
 end

data/octopress-render-tag.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "jekyll-page-hooks", "~> 1.0"
   spec.add_runtime_dependency "jekyll", "~> 2.0"
 
+  spec.add_development_dependency "clash"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "octopress-ink"
 end

data/test/.clash.yml

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

data/test/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'octopress-render-tag', path: '../'
+gem 'clash'

data/test/_config.yml

@@ -9,12 +9,10 @@ github_username:  jekyll
 
 exclude:
   - Gemfile*
-  - expected.html
-  - test.rb
+  - expected/
 
 render_test: kittens
 # Build settings
 markdown: kramdown
-permalink: pretty
 gems:
   - octopress-render-tag

data/test/_expected/license.html

@@ -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/test/test_render/license.html

@@ -0,0 +1,4 @@
+---
+permalink: license.html
+---
+{% render ../../LICENSE.txt %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-render-tag
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-tag-helpers
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: octopress-ink
+  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: Render files inline on any Jekyll page or post
 email:
 - brandon@imathis.com
@@ -89,22 +117,28 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/docs/changelog.markdown
+- assets/docs/index.markdown
 - lib/octopress-render-tag.rb
+- lib/octopress-render-tag/ink-plugin.rb
 - lib/octopress-render-tag/version.rb
 - octopress-render-tag.gemspec
+- test/.clash.yml
 - test/.gitignore
 - test/Gemfile
 - test/_config.yml
+- test/_expected/index.html
+- test/_expected/license.html
 - test/_test_render.md
-- test/expected.html
 - test/index.html
-- test/test.rb
 - test/test_render/_f.html
 - test/test_render/_var.html
+- test/test_render/license.html
 homepage: https://github.com/octopress/render-tag
 licenses:
 - MIT
@@ -130,12 +164,14 @@ signing_key:
 specification_version: 4
 summary: Render files inline on any Jekyll page or post
 test_files:
+- test/.clash.yml
 - test/.gitignore
 - test/Gemfile
 - test/_config.yml
+- test/_expected/index.html
+- test/_expected/license.html
 - test/_test_render.md
-- test/expected.html
 - test/index.html
-- test/test.rb
 - test/test_render/_f.html
 - test/test_render/_var.html
+- test/test_render/license.html

data/test/test.rb

@@ -1,11 +0,0 @@
-require 'colorator'
-has_failed = false
-
-system('rm -rf _site')
-system('jekyll build')
-
-diff = `diff _site/index.html expected.html`
-
-abort "Failed with diff: #{diff}" if diff.size > 0
-
-puts "passed".green