lv-jekyll-plugins 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f5809794f8465003e32020daff9eb8f3fa7714a
-  data.tar.gz: f20d71eacdde5aef66645ec2b48b39a45793f9a6
+  metadata.gz: 7eb76f46358bc07f122b9b1fa33d38e8d522202e
+  data.tar.gz: f343c975788f72d6cba48d78e86c477d69c9e6ba
 SHA512:
-  metadata.gz: 0bce0815700972b6aaa90c27c307cc44a86853e4255bffc033844d7b6e9fe88ae2697a5d07b170b2c3c3fb2f1e42301f85f019ce20180e4410d55de541c9bfee
-  data.tar.gz: 07a0700d1de6f1cccd646c031417313a773da4f7d1adec0fc9e00eac45e35074d8c069f17117679f4c170823ef21fdf6764e6bffc9bdee8dd3ca81102bb39b03
+  metadata.gz: 9280a13de1d4d626ef54d2f2e4465ee2d5edb2af5e3698c67926d45b91c1f981be13dee057a35f0246eb63353440fe135421dfa7b5bc84a583fd9fd7fef0417a
+  data.tar.gz: 79f0d7ba729aed366640fc37b0ab9490acb6b64af5305e6ec07985ada6a9dc0444ac239673abe432d79cfba1d4dade15bc78f2fdd3de4c2f208dabcc79bf00ef

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Ryan LeFevre
+Copyright (c) 2014 LayerVault
 
 MIT License
 

data/README.md

@@ -60,9 +60,19 @@ All plugins return a URL. You must build the HTML element yourself.
 
 ## Self-Hosting
 
-If you wish to use this plugin on your own self-hosted Jekyll site, the `_config.yml` must contain entries for your organization and a project:
+First, add the gem to your Gemfile and `bundle install`.
+
+``` ruby
+gem 'lv-jekyll-plugins'
+```
+
+Next, the Jekyll `_config.yml` must contain entries for your organization and a project. You should also add the plugin to the list of gems.
 
 ``` yaml
 organization: your-organization
 project: your-project
+gems:
+  - lv-jekyll-plugins
 ```
+
+And that should do it! When you build your project, all LayerVault tags should be correctly generated. If you run into any issues, please open a GitHub issue with as many details as you can provide.

data/lib/plugins/asset.rb

@@ -8,7 +8,7 @@ module Jekyll
 
       def initialize(tag_name, text, tokens)
         super
-        @text = text
+        @text = text.strip
       end
 
       def render(context)
@@ -32,7 +32,14 @@ module Jekyll
           map(&:first)
       end
     end
+
+    class ExampleAsset < Asset
+      def render(context)
+        "{% lv_asset #{@text.gsub 'lv_asset_example', 'lv_asset'} %}"
+      end
+    end
   end
 end
 
 Liquid::Template.register_tag('lv_asset', Jekyll::LayerVault::Asset)
+Liquid::Template.register_tag('lv_asset_example', Jekyll::LayerVault::ExampleAsset)

data/lib/plugins/download.rb

@@ -11,7 +11,7 @@ module Jekyll
 
       def initialize(tag_name, text, tokens)
         super
-        @text = text
+        @text = text.strip
       end
 
       def render(context)
@@ -34,7 +34,14 @@ module Jekyll
           tap { |m| m[1] = nil if m[1] == '-' }
       end
     end
+
+    class DownloadExample < Download
+      def render(context)
+        "{% lv_download #{@text.gsub 'lv_download_example', 'lv_download' } %}"
+      end
+    end
   end
 end
 
 Liquid::Template.register_tag('lv_download', Jekyll::LayerVault::Download)
+Liquid::Template.register_tag('lv_download_example', Jekyll::LayerVault::DownloadExample)

data/lib/plugins/preview.rb

@@ -12,7 +12,7 @@ module Jekyll
 
       def initialize(tag_name, text, tokens)
         super
-        @text = text
+        @text = text.strip
       end
 
       def render(context)
@@ -39,7 +39,14 @@ module Jekyll
           tap { |m| m[1] = nil if m[1] == '-' }
       end
     end
+
+    class PreviewExample < Preview
+      def render(context)
+        "{% lv_preview #{@text.gsub 'lv_preview_example', 'lv_preview'} %}"
+      end
+    end
   end
 end
 
 Liquid::Template.register_tag('lv_preview', Jekyll::LayerVault::Preview)
+Liquid::Template.register_tag('lv_preview_example', Jekyll::LayerVault::PreviewExample)

data/lib/plugins/project.rb

@@ -11,7 +11,14 @@ module Jekyll
         File.join(URL_BASE, config['organization'], config['project'])
       end
     end
+
+    class ProjectExample < Project
+      def render(context)
+        "{% lv_project %}"
+      end
+    end
   end
 end
 
 Liquid::Template.register_tag('lv_project', Jekyll::LayerVault::Project)
+Liquid::Template.register_tag('lv_project_example', Jekyll::LayerVault::ProjectExample)

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module LayerVault
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/spec/plugins/asset_spec.rb

@@ -59,5 +59,20 @@ describe Jekyll::LayerVault::Asset do
         expect(template.render(nil, options)).to eq target
       end
     end
+
+    context "with example tag" do
+      let (:source) { "{% lv_asset_example #{q}#{file}#{q} #{q}-#{q} #{q}#{asset}#{q} %}" }
+      let (:target) { "{% lv_asset #{q}#{file}#{q} #{q}-#{q} #{q}#{asset}#{q} %}" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces valid content" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
   end
 end

data/spec/plugins/download_spec.rb

@@ -58,5 +58,20 @@ describe Jekyll::LayerVault::Download do
         expect(template.render(nil, options)).to eq target
       end
     end
+
+    context "with example tag" do
+      let (:source) { "{% lv_download_example #{q}#{file}#{q} %}" }
+      let (:target) { "{% lv_download #{q}#{file}#{q} %}" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces valid content" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
   end
 end

data/spec/plugins/preview_spec.rb

@@ -92,5 +92,20 @@ describe Jekyll::LayerVault::Preview do
         end
       end
     end
+
+    context "with example tag" do
+      let (:source) { "{% lv_preview_example #{q}#{file}#{q} %}" }
+      let (:target) { "{% lv_preview #{q}#{file}#{q} %}" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces valid content" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
   end
 end

data/spec/plugins/project_spec.rb

@@ -23,4 +23,19 @@ describe Jekyll::LayerVault::Project do
   it "produces a valid URL" do
     expect(template.render(nil, options)).to eq target
   end
+
+  context "with example tag" do
+    let (:source) { "{% lv_project_example %}" }
+    let (:target) { "{% lv_project %}" }
+
+    it "parses successfully" do
+      expect {
+        template.render nil, options
+      }.to_not raise_error
+    end
+
+    it "produces valid content" do
+      expect(template.render(nil, options)).to eq target
+    end
+  end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: lv-jekyll-plugins
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryan LeFevre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   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
     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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 description: 
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -102,12 +102,12 @@ 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: []