octopress-wrap-tag 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e037650aa5dc1d0cab69c975cd5d990abbfe4fe
-  data.tar.gz: b75362d458cfc200894c9613635086674b960b3e
+  metadata.gz: 4de1867426ce69f1af6371588731c959b85de7a8
+  data.tar.gz: 05fa6afb1192fc9121358d89aede084511c38404
 SHA512:
-  metadata.gz: 3482a23bc0a51ff0757c5d16f7c2ebea79605358db96ab4dcb23b8c59e8943503a9513768a299313acb445e39f883da3cd23012381efe63e50e5cd51fb56b265
-  data.tar.gz: 62c0c6c9f67389f8be9ad6d952e2585d7e361666c9eaecfcc4f05a9bf0254d9109ef079be8e1946ddd8d2c41f535ba15b9748387fe9fd267ac45fac4a43dc3b2
+  metadata.gz: c050cfb7ff9bca567a72718fac7601d41ae3a40e036d0bc3912eea22a92d59ca32bddafefaa05a0c8e146a57e811cedb245f49b444b00b3447d251b0952cf161
+  data.tar.gz: 57cd6af73b84ffb83c840f707a420ddaf97130e83bdcab1eb66fcb7ea42029c1c09f58b49a5cc6a79b2750ac2f597263836e5cdc1e4b39b1b1c4341a4b589e8e

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.0.0 - 2015-01-11
+
+- Added support for Octopress docs.
+
 ### 1.0.0 - 2014-07-16
 
 - Initial release

data/README.md

@@ -27,100 +27,132 @@ Next add it to your gems list in Jekyll's `_config.yml`
 
 ## Usage
 
-Use this just like the Octopress include, render or yield tags, but wrap the output.
 
-    {% wrap include post.html %}
-      <article>{{ yield }}</article>
-    {% endwrap %}
+### Basic usage
 
-    {% wrap render ../LICENCE.md %}
-      <div class="licence-text">{{ yield }}</div>
-    {% endwrap %}
+the wrap tag is basically just wrapping Octopress's [include](https://github.com/octopress/include-tag), 
+[render](https://github.com/octopress/render-tag) and [yield](https://github.com/octopress/content-for)
+tags with HTML in a liquid block tag. So all the features are the same. 
 
-    {% wrap yeild post_footer %}
-      <div class="post-footer">{{ yield }}</div>
-    {% endwrap %}
+The wrap tag supports all the same features that Octopress's [include](https://github.com/octopress/include-tag), 
+[render](https://github.com/octopress/render-tag) and [yield](https://github.com/octopress/content-for) tags support. This also means that `wrap yield` won't output anything if there isn't any content.
 
-These wrap tags support all the same features that include, render and yield tags support. This also means that `wrap
-yield` won't output anything if there isn't any content. A great use case for `wrap yield` is to add content sections to a
-template which can be easily and optionally filled in a post or page, simply by using the
-[content_for](https://github.com/octopress/content-for) tag.
+```html
+{% wrap include post.html %}
+  <article>{{ yield }}</article>
+{% endwrap %}
 
-Include partials stored as a variable.
+{% wrap render ../LICENCE.md %}
+  <div class="licence-text">{{ yield }}</div>
+{% endwrap %}
 
-    // If a page has the following YAML front-matter
-    // sidebar: post_sidebar.html
+{% wrap yeild post_footer %}
+  <div class="post-footer">{{ yield }}</div>
+{% endwrap %}
+```
 
-    {% wrap include page.sidebar %}
-      <aside>{{ yield }}</aside>
-    {% endwrap %}
+### Yield example
 
-Include partials conditionally, using `if`, `unless` and ternary logic.
+A great use case for `wrap yield` is to add content sections to a
+template which can be easily and optionally filled from a post or page by using the
+[content_for](https://github.com/octopress/content-for) tag. Here's an example.
 
-    {% wrap include page.sidebar if page.sidebar %}
-      <aside>{{ yield }}</aside>
-    {% endwrap %}
+<!-- title:"In a page template"-->
 
-    {% wrap include comments.html unless page.comments == false %}
-      <div class="post-comments">{{ yield }}</div>
-    {% endwrap %}
+```html
+<aside class="sidebar">
+  {% wrap yield sidebar_before %}
+    <section>{{ yield }}</section>
+  {% endwrap %}
 
-    {% wrap include (post ? post_sidebar : page_sidebar) %}
-      <aside>{{ yield }}</aside>
-    {% endwrap %}
+  // Regular sidebar content goes here //
 
-Filter included partials.
+  {% wrap yield sidebar_after %}
+    <section>{{ yield }}</section>
+  {% endwrap %}
+</aside>
+```
 
-    {% include foo.html %}           //=> Yo, what's up
-    {% include foo.html | upcase %}  //=> YO, WHAT'S UP
+Now in any post or page you can add custom content to the sidebar with a content_for tag.
 
-Yes, it can handle a complex combination of features… but can you?
+<!-- title:"In a post" -->
 
-    {% include (post ? post_sidebar : page_sidebar) | smart_quotes unless site.theme.sidebar == false %}
+```html
+{% content_for sidebar_before %}
+  <h4>About this post</h4>
+  ...
+{% endcontent_for %}
+```
 
-### Include partials with an Octopress Ink plugin.
+This content will appear at the top of the sidebar, wrapped in a `section` element. The `sidebar_after` section won't be
+rendered since it wasn't set in this post.
 
-It's easy to include a partial from an Ink theme or plugin.
+### Advanced features
 
-Here's the syntax
+The examples below only demonstrate wrapping the include tag for brevity, but as stated earlier, the wrap tag 
+is basically just wrapping Octopress's [include](https://github.com/octopress/include-tag), 
+[render](https://github.com/octopress/render-tag) and [yield](https://github.com/octopress/content-for)
+tags with HTML in a liquid block tag. So all the features are the same. 
 
-    {% include [plugin-slug]:[partial-name] %}
+<!-- title:"If a page has this yaml front-matter" -->
+```html
+---
+sidebar: post_sidebar.html
+---
 
-Some examples:
+{% wrap include page.sidebar %}
+  <aside>{{ yield }}</aside>
+{% endwrap %}
+```
 
-    {% include theme:sidebar.html %}   // Include the sidebar from a theme plugin
-    {% include twitter:feed.html %}    // Include the feed from a twitter plugin
+Include partials conditionally, using `if`, `unless` and ternary logic.
 
-#### Overriding theme/plugin partials
+```html
+{% wrap include page.sidebar if page.sidebar %}
+  <aside>{{ yield }}</aside>
+{% endwrap %}
 
-Plugins and themes use this tag internally too. For example, the [octopress-feeds plugin](https://github.com/octopress/feeds/blob/master/assets/pages/article-feed.xml#L10) uses the include tag to
-render partials for the RSS feed.
+{% wrap include comments.html unless page.comments == false %}
+  <div class="post-comments">{{ yield }}</div>
+{% endwrap %}
 
-    {% for post in site.articles %}
-      <entry>
-        {% include feeds:entry.xml %}
-      </entry>
-    {% endfor %}
+{% wrap include (post ? post_sidebar : page_sidebar) %}
+  <aside>{{ yield }}</aside>
+{% endwrap %}
+```
 
+Filter included partials.
 
-If you want to make a change to the `entry.xml` partial, you could create your own version at `_plugins/feeds/includes/entry.xml`.
-Now whenever `{% include feeds:entry.xml %}` is called, the include tag will use *your* local partial instead of the plugin's partial.
+```
+{% wrap include greeting.html %} yo, {{ yield }}{% endwrap %}           //=> yo, what's up?
+{% wrap include greeting.html %} yo, {{ yield | upcase }}{% endwrap %}  //=> yo, WHAT'S UP?
+{% wrap include greeting.html | upcase %} Yo, {{ yield }}{% endwrap %}  //=> YO, WHAT'S UP?
+```
 
-Note: To make overriding partials easier, you can copy all of a plugin's partials to your local override path with the Octopress Ink command:
 
-    octopress ink copy [plugin-slug] [options]
+### Include partials with an Octopress Ink plugin.
 
-To copy all includes from the feeds plugin, you'd run:
+It's easy to include a partial from an Ink theme or plugin.
 
-    octopress ink copy feeds --includes
+Here's the syntax
 
-This will copy all of the partials from octopress-feeds to `_plugins/feeds/includes/`. Modify any of the partials, and delete those that you want to be read from the plugin.
+```
+{% wrap include [plugin-slug]:[partial-name] %}
+{{ yield }}
+{% endwrap %}
+```
 
-To list all partials from a plugin, run:
+Some examples:
 
-    octopress ink list [plugin-slug] --includes
+```html
+{% wrap include theme:sidebar.html %}   // Include the sidebar from a theme plugin
+  <aside>{{ yield }}</aside>
+{% endwrap %}
 
-Note: When a plugin is updated, your local partials may be out of date, but will still override the plugin's partials. Be sure to watch changelogs and try to keep your modifications current.
+{% wrap include twitter:feed.html %}    // Include the feed from a twitter plugin
+  <div class="twitter-feed">{{ yield }}</div>
+{% endwrap %}
+```
 
 ## Contributing
 

data/assets/docs/index.markdown

@@ -29,7 +29,15 @@ Next add it to your gems list in Jekyll's `_config.yml`
 
 ## Usage
 
-Use this just like the Octopress include, render or yield tags, but wrap the output.
+
+### Basic usage
+
+the wrap tag is basically just wrapping Octopress's [include](https://github.com/octopress/include-tag), 
+[render](https://github.com/octopress/render-tag) and [yield](https://github.com/octopress/content-for)
+tags with HTML in a liquid block tag. So all the features are the same. 
+
+The wrap tag supports all the same features that Octopress's [include](https://github.com/octopress/include-tag), 
+[render](https://github.com/octopress/render-tag) and [yield](https://github.com/octopress/content-for) tags support. This also means that `wrap yield` won't output anything if there isn't any content.
 
     {% wrap include post.html %}
       <article>{{ yield }}</article>
@@ -43,12 +51,44 @@ Use this just like the Octopress include, render or yield tags, but wrap the out
       <div class="post-footer">{{ yield }}</div>
     {% endwrap %}
 
-These wrap tags support all the same features that include, render and yield tags support. This also means that `wrap
-yield` won't output anything if there isn't any content. A great use case for `wrap yield` is to add content sections to a
-template which can be easily and optionally filled in a post or page, simply by using the
-[content_for](https://github.com/octopress/content-for) tag.
+### Yield example
+
+A great use case for `wrap yield` is to add content sections to a
+template which can be easily and optionally filled from a post or page by using the
+[content_for](https://github.com/octopress/content-for) tag. Here's an example.
+
+    // In a page template
+
+    <aside class="sidebar">
+      {% wrap yield sidebar_before %}
+        <section>{{ yield }}</section>
+      {% endwrap %}
+
+      // Regular sidebar content goes here //
+
+      {% wrap yield sidebar_after %}
+        <section>{{ yield }}</section>
+      {% endwrap %}
+    </aside>
 
-Include partials stored as a variable.
+Now in any post or page you can add custom content to the sidebar with a content_for tag.
+
+    // In a post
+
+    {% content_for sidebar_before %}
+      <h4>About this post</h4>
+      ...
+    {% endcontent_for %}
+
+This content will appear at the top of the sidebar, wrapped in a `section` element. The `sidebar_after` section won't be
+rendered since it wasn't set in this post.
+
+### Advanced features
+
+The examples below only demonstrate wrapping the include tag for brevity, but as stated earlier, the wrap tag 
+is basically just wrapping Octopress's [include](https://github.com/octopress/include-tag), 
+[render](https://github.com/octopress/render-tag) and [yield](https://github.com/octopress/content-for)
+tags with HTML in a liquid block tag. So all the features are the same. 
 
     // If a page has the following YAML front-matter
     // sidebar: post_sidebar.html
@@ -73,12 +113,10 @@ Include partials conditionally, using `if`, `unless` and ternary logic.
 
 Filter included partials.
 
-    {% include foo.html %}           //=> Yo, what's up
-    {% include foo.html | upcase %}  //=> YO, WHAT'S UP
-
-Yes, it can handle a complex combination of features… but can you?
+    {% wrap include greeting.html %} yo, {{ yield }}{% endwrap %}           //=> yo, what's up?
+    {% wrap include greeting.html %} yo, {{ yield | upcase }}{% endwrap %}  //=> yo, WHAT'S UP?
+    {% wrap include greeting.html | upcase %} Yo, {{ yield }}{% endwrap %}  //=> YO, WHAT'S UP?
 
-    {% include (post ? post_sidebar : page_sidebar) | smart_quotes unless site.theme.sidebar == false %}
 
 ### Include partials with an Octopress Ink plugin.
 
@@ -86,43 +124,20 @@ It's easy to include a partial from an Ink theme or plugin.
 
 Here's the syntax
 
-    {% include [plugin-slug]:[partial-name] %}
+    {% wrap include [plugin-slug]:[partial-name] %}
+    {{ yield }}
+    {% endwrap %}
 
 Some examples:
 
-    {% include theme:sidebar.html %}   // Include the sidebar from a theme plugin
-    {% include twitter:feed.html %}    // Include the feed from a twitter plugin
-
-#### Overriding theme/plugin partials
-
-Plugins and themes use this tag internally too. For example, the [octopress-feeds plugin](https://github.com/octopress/feeds/blob/master/assets/pages/article-feed.xml#L10) uses the include tag to
-render partials for the RSS feed.
-
-    {% for post in site.articles %}
-      <entry>
-        {% include feeds:entry.xml %}
-      </entry>
-    {% endfor %}
-
-
-If you want to make a change to the `entry.xml` partial, you could create your own version at `_plugins/feeds/includes/entry.xml`.
-Now whenever `{% include feeds:entry.xml %}` is called, the include tag will use *your* local partial instead of the plugin's partial.
-
-Note: To make overriding partials easier, you can copy all of a plugin's partials to your local override path with the Octopress Ink command:
-
-    octopress ink copy [plugin-slug] [options]
-
-To copy all includes from the feeds plugin, you'd run:
-
-    octopress ink copy feeds --includes
-
-This will copy all of the partials from octopress-feeds to `_plugins/feeds/includes/`. Modify any of the partials, and delete those that you want to be read from the plugin.
-
-To list all partials from a plugin, run:
+    {% wrap include theme:sidebar.html %}   // Include the sidebar from a theme plugin
+      <aside>{{ yield }}</aside>
+    {% endwrap %}
 
-    octopress ink list [plugin-slug] --includes
+    {% wrap include twitter:feed.html %}    // Include the feed from a twitter plugin
+      <div class="twitter-feed">{{ yield }}</div>
+    {% endwrap %}
 
-Note: When a plugin is updated, your local partials may be out of date, but will still override the plugin's partials. Be sure to watch changelogs and try to keep your modifications current.
 
 ## Contributing
 

data/lib/octopress-wrap-tag.rb

@@ -1,5 +1,4 @@
 require "octopress-wrap-tag/version"
-require "octopress-wrap-tag/ink-plugin"
 
 require "octopress-tag-helpers"
 require "octopress-include-tag"
@@ -11,7 +10,7 @@ require "jekyll"
 #
 module Octopress
   module Tags
-    module WrapTag
+    module Wrap
       class Tag < Liquid::Block
 
         def initialize(tag_name, markup, tokens)
@@ -46,13 +45,13 @@ module Octopress
             content = Octopress::Tags::Yield::Tag.new('yield', markup, []).render(context)
           when 'render'
             begin
-              content = Octopress::Tags::RenderTag::Tag.new('render', markup, []).render(context)
+              content = Octopress::Tags::Render::Tag.new('render', markup, []).render(context)
             rescue => error
               error_msg error
             end
           when 'include'
             begin
-              content = Octopress::Tags::IncludeTag::Tag.new('include', markup, []).render(context)
+              content = Octopress::Tags::Include::Tag.new('include', markup, []).render(context)
             rescue => error
               error_msg error
             end
@@ -88,4 +87,15 @@ module Octopress
   end
 end
 
-Liquid::Template.register_tag('wrap', Octopress::Tags::WrapTag::Tag)
+Liquid::Template.register_tag('wrap', Octopress::Tags::Wrap::Tag)
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Wrap Tag",
+    gem:         "octopress-wrap-tag",
+    version:     Octopress::Tags::Wrap::VERSION,
+    description: "Wrap include, render, and yield tags",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    source_url:  "https://github.com/octopress/wrap-tag"
+  })
+end

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

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

data/octopress-wrap-tag.gemspec

@@ -5,7 +5,7 @@ require 'octopress-wrap-tag/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "octopress-wrap-tag"
-  spec.version       = Octopress::Tags::WrapTag::VERSION
+  spec.version       = Octopress::Tags::Wrap::VERSION
   spec.authors       = ["Brandon Mathis"]
   spec.email         = ["brandon@imathis.com"]
   spec.summary       = %q{A Liquid block tag which makes it easy to wrap an include, render or yield tag with html}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-wrap-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-07-17 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-tag-helpers
@@ -158,6 +158,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".clash.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -168,10 +169,8 @@ files:
 - assets/docs/changelog.markdown
 - assets/docs/index.markdown
 - lib/octopress-wrap-tag.rb
-- lib/octopress-wrap-tag/ink-plugin.rb
 - lib/octopress-wrap-tag/version.rb
 - octopress-wrap-tag.gemspec
-- test/.clash.yml
 - test/.gitignore
 - test/Gemfile
 - test/_config.yml
@@ -214,7 +213,6 @@ specification_version: 4
 summary: A Liquid block tag which makes it easy to wrap an include, render or yield
   tag with html
 test_files:
-- test/.clash.yml
 - test/.gitignore
 - test/Gemfile
 - test/_config.yml

data/lib/octopress-wrap-tag/ink-plugin.rb

@@ -1,11 +0,0 @@
-begin
-  require 'octopress-ink'
-
-  Octopress::Ink.add_plugin({
-    name:        'Wrap Tag',
-    assets_path: File.join(File.expand_path(File.dirname(__FILE__)), '../../assets' ),
-    description: "A Liquid block tag which makes it easy to wrap an include, render or yield tag with html"
-  })
-rescue LoadError
-end
-