jekyll-cat 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c009189a0472310e08bd714370497c372fa32c034305911961e4768c5939c31e
+  data.tar.gz: 39c45447f6acc6578a9a68e7e350047cf16608c6fbe962d054010cc9076c1f82
+SHA512:
+  metadata.gz: e7df718e05c4b7025ed8a40ec42554fdc1e52ffdaf32e83d09af104cbc1767ec102f5c5bac1761e3e993ce59fecaa8aee0ef142c10c1c695734e329c735994ba
+  data.tar.gz: 19c662cd239261125358a2ff58639918af5b1487f528c3910e91d857493641e364f5ac32f5dc0468aa87d08ebde1bb726d2eebefcf684bdc6130815f815d456d

data/.gitignore

@@ -0,0 +1,3 @@
+_site/
+.sass-cache/
+.jekyll-metadata

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Josh Davenport
+
+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,28 @@
+# Jekyll cat
+
+Its name inspired by unix [cat](https://en.wikipedia.org/wiki/Cat_(Unix)), this Jekyll plugin providing a method to output contents of files and URLs. You can access files relatively (e.g. any file in the site, or in directories surrounding it, permissions allowing) as well as absolute paths (if that is any use) and contents return at URLs.
+
+## Install
+Add the following to your Gemfile and then run bundle install.
+
+gem 'jekyll-cat'
+
+## Usage
+In liquid, use the `cat` tag to execute your include, passing the tag your path or url.
+
+## Examples
+### Relative
+```
+{% cat assets/vector/my-svg-file.svg %}
+```
+
+### Absolute
+```
+{% cat /path/to/file %}
+```
+
+### URL
+```
+{% cat https://loripsum.net/api/ %}
+```
+

data/jekyll-cat.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-cat"
+  spec.version       = '1.0.0'
+  spec.authors       = ["Josh Davenport"]
+  spec.email         = ["josh@joshdavenport.co.uk"]
+  spec.summary       = 'Jekyll plugin providing a method to output contents of files and URLs'
+  spec.homepage      = 'https://github.com/joshdavenport/jekyll-cat'
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_development_dependency 'jekyll', '>= 3.1'
+end
+

data/lib/jekyll-cat.rb

@@ -0,0 +1,47 @@
+require 'liquid'
+require 'json'
+require 'uri'
+require 'open-uri'
+
+module Jekyll
+  class Cat < Liquid::Tag
+
+    def initialize(tag_name, path, tokens)
+      super
+      @path = path
+    end
+
+    def render(context)
+      if @path =~ URI::regexp
+        # the requested resource is a URL
+        return render_url(context)
+      elsif @path[0] == '/'
+        # the requested resource is an file, specified with an absolute path
+        return render_file_abs(context)
+      else
+        # the requested resource is an file, specified with a relative path
+        return render_file_rel(context)
+      end 
+    end
+
+    def render_file_abs(context)
+      file_path = @path
+      content = File.read(file_path.strip!)
+      return content
+    end
+
+    def render_file_rel(context)
+      site_source = context.registers[:site].config['source']
+      file_path = site_source + '/' + @path
+      content = File.read(file_path.strip!)
+      return content
+    end
+
+    def render_url(context)
+      encoded_url = URI.encode(@path)
+      return open(encoded_url).read
+    end
+  end
+end
+
+Liquid::Template.register_tag('cat', Jekyll::Cat)

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-cat
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Josh Davenport
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- josh@joshdavenport.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- jekyll-cat.gemspec
+- lib/jekyll-cat.rb
+homepage: https://github.com/joshdavenport/jekyll-cat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin providing a method to output contents of files and URLs
+test_files: []