lv-jekyll-plugins 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f5809794f8465003e32020daff9eb8f3fa7714a
+  data.tar.gz: f20d71eacdde5aef66645ec2b48b39a45793f9a6
+SHA512:
+  metadata.gz: 0bce0815700972b6aaa90c27c307cc44a86853e4255bffc033844d7b6e9fe88ae2697a5d07b170b2c3c3fb2f1e42301f85f019ce20180e4410d55de541c9bfee
+  data.tar.gz: 07a0700d1de6f1cccd646c031417313a773da4f7d1adec0fc9e00eac45e35074d8c069f17117679f4c170823ef21fdf6764e6bffc9bdee8dd3ca81102bb39b03

data/.gitignore

@@ -0,0 +1,23 @@
+*.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
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan LeFevre
+
+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,68 @@
+# LayerVault Jekyll Plugins
+
+Plugins that add extra LayerVault-specfic functionality to our public pages.
+
+## Available Plugins
+
+All plugins return a URL. You must build the HTML element yourself.
+
+### Assets
+
+``` liquid
+# Asset Group/Asset.png in latest revision of File.psd
+{% lv_asset "File.psd" "Group/Asset.png" %}
+{% lv_asset "File.psd" "-" "Group/Asset.png" %}
+# => https://layervault.com/organization/project/File.psd/assets/Group/Asset.png?raw=1
+
+# Asset Group/Asset.png in revision 12 of File.psd
+{% lv_asset "File.psd" "12" "Group/Asset.png" %}
+# => https://layervault.com/organization/project/File.psd/revisions/12/assets/Group/Asset.png?raw=1
+```
+
+### Previews
+
+``` liquid
+# First preview in latest revision of File.psd
+{% lv_preview "File.psd" %}
+# => https://layervault.com/organization/project/File.psd/previews/1?raw=1
+
+# 2nd preview of latest revision of File.psd
+{% lv_preview "File.psd" "-" "2" %}
+# => https://layervault.com/organization/project/File.psd/previews/2?raw=1
+
+# First preview of 2nd revision of File.psd
+{% lv_preview "File.psd" "2" %}
+# => https://layervault.com/organization/project/File.psd/revisions/2/previews/1?raw=1
+
+# 2nd preview of 3rd revision of File.psd
+{% lv_preview "File.psd" "3" "2" %}
+# => https://layervault.com/organization/project/File.psd/revisions/3/previews/2?raw=1
+```
+
+### Project
+
+``` liquid
+{% lv_project %}
+# => https://layervault.com/organization/project
+```
+
+### Download
+
+``` liquid
+# Latest revision of File.psd
+{% lv_download "File.psd" %}
+# => https://layervault.com/organization/project/File.psd?raw=1
+
+# 2nd revision of File.psd
+{% lv_download "File.psd" "2" %}
+# => https://layervault.com/organization/project/File.psd/revisions/2?raw=1
+```
+
+## 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:
+
+``` yaml
+organization: your-organization
+project: your-project
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/lv-jekyll-plugins.rb

@@ -0,0 +1,4 @@
+require 'plugins/asset'
+require 'plugins/download'
+require 'plugins/preview'
+require 'plugins/project'

data/lib/plugins/asset.rb

@@ -0,0 +1,38 @@
+require 'liquid'
+require 'plugins/common'
+
+module Jekyll
+  module LayerVault
+    class Asset < Liquid::Tag
+      include Common
+
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text
+      end
+
+      def render(context)
+        return @text unless valid_parameters?
+
+        config = context.registers[:site].config
+        file, revision, asset = parse_parameters
+
+        url = File.join(URL_BASE, config['organization'], config['project'], file)
+        url = File.join(url, 'revisions', revision) unless revision.nil?
+        url = File.join(url, 'assets', asset)
+        url += "?raw=1"
+      end
+
+      private
+
+      def parse_parameters
+        @text.scan(PARAM_REGEX).
+          tap { |m| m.insert 1, [] if m.length == 2 }.
+          tap { |m| m[1] = [] if m[1][0] == '-' }.
+          map(&:first)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('lv_asset', Jekyll::LayerVault::Asset)

data/lib/plugins/common.rb

@@ -0,0 +1,14 @@
+module Jekyll
+  module LayerVault
+    module Common
+      URL_BASE = "https://layervault.com".freeze
+      PARAM_REGEX = /(?:"|')(.+?)(?:"|')/
+
+      private
+
+      def valid_parameters?
+        @text.scan(/"|'/).length.even?
+      end
+    end
+  end
+end

data/lib/plugins/download.rb

@@ -0,0 +1,40 @@
+require 'liquid'
+require 'plugins/common'
+
+# {% lv_download "File.psd" %}
+# {% lv_download "File.psd" "2" %}
+
+module Jekyll
+  module LayerVault
+    class Download < Liquid::Tag
+      include Common
+
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text
+      end
+
+      def render(context)
+        return @text unless valid_parameters?
+
+        config = context.registers[:site].config
+        file, revision = parse_parameters
+
+        url = File.join(URL_BASE, config['organization'], config['project'], file)
+        url = File.join(url, 'revisions', revision) unless revision.nil?
+        url += "?raw=1"
+      end
+
+      private
+
+      def parse_parameters
+        @text.
+          scan(PARAM_REGEX).
+          flatten.
+          tap { |m| m[1] = nil if m[1] == '-' }
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('lv_download', Jekyll::LayerVault::Download)

data/lib/plugins/preview.rb

@@ -0,0 +1,45 @@
+require 'liquid'
+require 'plugins/common'
+
+# {% lv_preview "File.psd" %}
+# {% lv_preview "File.psd" "1" %}
+# {% lv_preview "File.psd" "1" "2" %}
+
+module Jekyll
+  module LayerVault
+    class Preview < Liquid::Tag
+      include Common
+
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text
+      end
+
+      def render(context)
+        return @text unless valid_parameters?
+
+        config = context.registers[:site].config
+        file, revision, page = parse_parameters
+
+        url = File.join(URL_BASE, config['organization'], config['project'], file)
+        url = File.join(url, 'revisions', revision) unless revision.nil?
+        url = File.join(url, 'previews', page)
+
+        url += "?raw=1"
+      end
+
+      private
+
+      def parse_parameters
+        @text.
+          scan(PARAM_REGEX).
+          flatten.
+          tap { |m| m.push nil if m.length == 1 }.
+          tap { |m| m.push '1' if m.length == 2 }.
+          tap { |m| m[1] = nil if m[1] == '-' }
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('lv_preview', Jekyll::LayerVault::Preview)

data/lib/plugins/project.rb

@@ -0,0 +1,17 @@
+require 'liquid'
+require 'plugins/common'
+
+module Jekyll
+  module LayerVault
+    class Project < Liquid::Tag
+      include Common
+
+      def render(context)
+        config = context.registers[:site].config
+        File.join(URL_BASE, config['organization'], config['project'])
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('lv_project', Jekyll::LayerVault::Project)

data/lib/version.rb

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

data/lv-jekyll-plugins.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lv-jekyll-plugins"
+  spec.version       = Jekyll::LayerVault::VERSION
+  spec.authors       = ["Ryan LeFevre"]
+  spec.email         = ["ryan@layervault.com"]
+  spec.summary       = %q{Jekyll plugins for LayerVault public pages}
+  spec.homepage      = ""
+  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 "liquid"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2"
+end

data/spec/plugins/asset_spec.rb

@@ -0,0 +1,63 @@
+describe Jekyll::LayerVault::Asset do
+  let (:organization) { "layervault" }
+  let (:project) { "project" }
+  let (:file) { "folder/file.psd" }
+  let (:revision) { 2 }
+  let (:asset) { "Group/Asset.png" }
+  let (:jekyll_config) { Struct.new(:config) }
+  let (:template) { Liquid::Template.parse(source) }
+  let (:options) do 
+    {
+      registers: {
+        site: jekyll_config.new({'organization' => organization, 'project' => project})
+      }
+    }
+  end
+
+  ["\"", "'"].each do |q|
+    context "without revision number" do
+      let (:source) { "{% lv_asset #{q}#{file}#{q} #{q}#{asset}#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/assets/#{asset}?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+
+    context "with revision number" do
+      let (:source) { "{% lv_asset #{q}#{file}#{q} #{q}#{revision}#{q} #{q}#{asset}#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/revisions/#{revision}/assets/#{asset}?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+
+    context "with dash revision" do
+      let (:source) { "{% lv_asset #{q}#{file}#{q} #{q}-#{q} #{q}#{asset}#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/assets/#{asset}?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+  end
+end

data/spec/plugins/download_spec.rb

@@ -0,0 +1,62 @@
+describe Jekyll::LayerVault::Download do
+  let (:organization) { "layervault" }
+  let (:project) { "project" }
+  let (:file) { "folder/file.psd" }
+  let (:revision) { 2 }
+  let (:jekyll_config) { Struct.new(:config) }
+  let (:template) { Liquid::Template.parse(source) }
+  let (:options) do 
+    {
+      registers: {
+        site: jekyll_config.new({'organization' => organization, 'project' => project})
+      }
+    }
+  end
+
+  ["\"", "'"].each do |q|
+    context "without revision number" do
+      let (:source) { "{% lv_download #{q}#{file}#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+
+    context "with revision number" do
+      let (:source) { "{% lv_download #{q}#{file}#{q} #{q}#{revision}#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/revisions/#{revision}?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+
+    context "with dash revision" do
+      let (:source) { "{% lv_download #{q}#{file}#{q} #{q}-#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+  end
+end

data/spec/plugins/preview_spec.rb

@@ -0,0 +1,96 @@
+describe Jekyll::LayerVault::Preview do
+  let (:organization) { "layervault" }
+  let (:project) { "project" }
+  let (:file) { "folder/file.psd" }
+  let (:revision) { 2 }
+  let (:preview) { 3 }
+  let (:jekyll_config) { Struct.new(:config) }
+  let (:template) { Liquid::Template.parse(source) }
+  let (:options) do 
+    {
+      registers: {
+        site: jekyll_config.new({'organization' => organization, 'project' => project})
+      }
+    }
+  end
+
+  ["\"", "'"].each do |q|
+    context "without revision number" do
+      let (:source) { "{% lv_preview #{q}#{file}#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/previews/1?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+
+    context "with revision number" do
+      let (:source) { "{% lv_preview #{q}#{file}#{q} #{q}#{revision}#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/revisions/#{revision}/previews/1?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+
+    context "with dash revision" do
+      let (:source) { "{% lv_preview #{q}#{file}#{q} #{q}-#{q} %}" }
+      let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/previews/1?raw=1" }
+
+      it "parses successfully" do
+        expect {
+          template.render nil, options
+        }.to_not raise_error
+      end
+
+      it "produces a valid URL" do
+        expect(template.render(nil, options)).to eq target
+      end
+    end
+
+    context "with page number" do
+
+      context "with dash revision" do
+        let (:source) { "{% lv_preview #{q}#{file}#{q} #{q}-#{q} #{q}#{preview}#{q} %}" }
+        let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/previews/#{preview}?raw=1" }
+
+        it "parses successfully" do
+          expect {
+            template.render nil, options
+          }.to_not raise_error
+        end
+
+        it "produces a valid URL" do
+          expect(template.render(nil, options)).to eq target
+        end
+      end
+
+      context "with revision number" do
+        let (:source) { "{% lv_preview #{q}#{file}#{q} #{q}#{revision}#{q} #{q}#{preview}#{q} %}" }
+        let (:target) { "https://layervault.com/#{organization}/#{project}/#{file}/revisions/#{revision}/previews/#{preview}?raw=1" }
+
+        it "parses successfully" do
+          expect {
+            template.render nil, options
+          }.to_not raise_error
+        end
+
+        it "produces a valid URL" do
+          expect(template.render(nil, options)).to eq target
+        end
+      end
+    end
+  end
+end

data/spec/plugins/project_spec.rb

@@ -0,0 +1,26 @@
+describe Jekyll::LayerVault::Project do
+  let (:organization) { "layervault" }
+  let (:project) { "project" }
+  let (:jekyll_config) { Struct.new(:config) }
+  let (:template) { Liquid::Template.parse(source) }
+  let (:options) do 
+    {
+      registers: {
+        site: jekyll_config.new({'organization' => organization, 'project' => project})
+      }
+    }
+  end
+  let (:source) { "{% lv_project %}" }
+  let (:template) { Liquid::Template.parse(source) }
+  let (:target) { "https://layervault.com/#{organization}/#{project}" }
+
+  it "parses successfully" do
+    expect {
+      template.render nil, options
+    }.to_not raise_error
+  end
+
+  it "produces a valid URL" do
+    expect(template.render(nil, options)).to eq target
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'lv-jekyll-plugins'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: lv-jekyll-plugins
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Ryan LeFevre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-11 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: 
+email:
+- ryan@layervault.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lv-jekyll-plugins.rb
+- lib/plugins/asset.rb
+- lib/plugins/common.rb
+- lib/plugins/download.rb
+- lib/plugins/preview.rb
+- lib/plugins/project.rb
+- lib/version.rb
+- lv-jekyll-plugins.gemspec
+- spec/plugins/asset_spec.rb
+- spec/plugins/download_spec.rb
+- spec/plugins/preview_spec.rb
+- spec/plugins/project_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Jekyll plugins for LayerVault public pages
+test_files:
+- spec/plugins/asset_spec.rb
+- spec/plugins/download_spec.rb
+- spec/plugins/preview_spec.rb
+- spec/plugins/project_spec.rb
+- spec/spec_helper.rb