jekyll-postfiles 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83ecad5523c6564d8bf0f84674f54ba82295ca03
+  data.tar.gz: 96a2acb28eb23d7771dcf2d845b4eed0f7f8a686
+SHA512:
+  metadata.gz: c844451a153fa9dcd1451555b6839496f8ec43f30ae57e9cbf6435bd08eb1106860d77cc463e3b0fdd0573d1f00c9ce948dc4c666f9ec5fe6a06dbbaf4ed6114
+  data.tar.gz: b645575e93dbff13c94582fbcc635f3423a7d39773ca161f650276aca43f62b9bb9ff57a16a8c10862e12f664ad224cf3c8a210e3776e880327e1ec5295bfdd4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicolas Hoizey
+
+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,196 @@
+# jekyll-postfiles
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-postfiles.svg)](https://badge.fury.io/rb/jekyll-postfiles)
+[![Gem Downloads](https://img.shields.io/gem/dt/jekyll-postfiles.svg?style=flat)](http://rubygems.org/gems/jekyll-postfiles)
+
+## Easing the management of images (and other files) attached to Markdown posts
+
+### The pain of Jekyll's recommended posts assets management
+
+Jekyll's natural way to deal with static files attached to posts, like images or PDFs, is to put them all in a global `assets/` (or `downloads/`) folder at the site root. Read "[Including images and resources](https://jekyllrb.com/docs/posts/#including-images-and-resources)" in Jekyll's documentation.
+
+You can of course put files in subfolders of `assets/`, but it will be really cumbersome to manage posts' Markdown files in `_posts/` or a subfolder, and images elsewhere, and then use the good hierarchy in all Markdown image tags.
+
+Imagine you have these files:
+
+```
+_posts/
+  2016-06/
+    2016-06-09-so-long-cloudflare-and-thanks-for-all-the-fissh.md
+…
+assets/
+  2016-06-09-cloudflare/
+    cloudflare-architecture.png
+    performance-report-sample.pdf
+```
+
+To use the image and PDF files in the post's Markdown, you will have to write this:
+
+```markdown
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+
+![Cloudflare architecture](/assets/2016-06-09-cloudflare/cloudflare-architecture.png)
+
+Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat.
+
+Here is [an example of performance report](/assets/2016-06-09-cloudflare/performance-report-sample.pdf).
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+```
+
+Painful to write.
+
+Imagine you want to change the post's publication date, or one of the file names?
+
+Painful to update.
+
+What if you want to put new WIP Markdown files in `_drafts/`, and the attached assets somewhere in a way they won't be copied to the destination `_site/` folder next time you build the site? You can't put the files in the `assets/` folder, so when you will publish the draft, you will have to change the assets location in the Markdown file.
+
+Painful, and prone to errors.
+
+And what about previewing the content while editing? If you use an editor like [MacDown](http://macdown.uranusjr.com/) with live preview, how will it find the actual path to the images? What means `/assets/…` for the editor?
+
+Painful to preview.
+
+### There must be another way
+
+What if instead, you could have the files stored like that:
+
+```
+_posts/
+  2016-06-09-cloudflare/
+    2016-06-09-so-long-cloudflare-and-thanks-for-all-the-fissh.md
+    cloudflare-architecture.png
+    performance-report-sample.pdf
+```
+
+And if you could write your Markdown like this:
+
+```markdown
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+
+![Cloudflare architecture](cloudflare-architecture.png)
+
+Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat.
+
+Here is [an example of performance report](performance-report-sample.pdf).
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.
+```
+
+Much easier!
+
+- Easy to store, everything is in one single folder.
+- Easy to write, no path to add to file links
+- Easy to update
+- Easy to move from `_drafts/` to `_posts/`, without anything to change in the Mardown content
+- Easy to edit in any editor with live preview
+
+### Not every assets need this
+
+[Some Jekyll users will try to convince you](http://stackoverflow.com/a/10366173/717195) it's a bad idea, because it means the asset is tightly linked to the post.
+
+In my own experience, 95% of assets, at least, are used in one single post. And this is pretty common to find such requests from users of other static generators, like [Hugo](https://github.com/spf13/hugo/issues/147) ([fixed in May 2015](https://github.com/spf13/hugo/issues/147#issuecomment-104067783)), [Nikola](https://github.com/getnikola/nikola/issues/2266) ([already there, but not obvious or user friendly](https://github.com/getnikola/nikola/issues/2266#issuecomment-189211387)), [Octopress](http://stackoverflow.com/questions/17052468/insert-local-image-into-a-blog-post-with-octopress), etc.
+
+But it's true this might not be ideal for all assets (the remaining 5%), so you can of course continue using full assets paths with `/assets/…` to have a few assets shared by several posts.
+
+## How does it work?
+
+This plugin takes any file that is in posts folders, and copy them to the folder in which the post HTML page will be created.
+
+Let's say you have these files:
+
+```
+_posts/
+  2016-06-09-cloudflare/
+    2016-06-09-so-long-cloudflare-and-thanks-for-all-the-fissh.md
+    cloudflare-architecture.png
+    performance-report-sample.pdf
+```
+
+And your Jekyll settings for permalinks are these:
+
+```yaml
+# Permalinks
+permalink: /:year/:month/:day/:title/
+```
+
+Jekyll with this plugin will generate the site content like this:
+
+```
+2016/
+  06/
+    09/
+      so-long-cloudflare-and-thanks-for-all-the-fissh/
+        index.html
+        cloudflare-logo.png
+        performance-report-sample.pdf
+```
+
+If you change your Jekyll settings for permalinks like these:
+
+```yaml
+# Permalinks
+permalink: /:year/:month/:day/:title.html
+```
+
+Jekyll with this plugin will generate the site content like this:
+
+```
+2016/
+  06/
+    09/
+      so-long-cloudflare-and-thanks-for-all-the-fissh.html
+      cloudflare-logo.png
+      performance-report-sample.pdf
+```
+
+Handy, isn't it?
+
+## Installation
+
+Add this line to your `Gemfile`:
+
+```ruby
+gem 'jekyll-postfiles'
+```
+
+Execute this:
+
+```shell
+$ bundle
+```
+
+And add this line to your `_config.yml`:
+
+```yaml
+gems:
+  - jekyll-postfiles
+```
+
+## Usage
+
+You don't have anything to do.
+
+Just put the images (and PDFs, etc.) in the same folder as your Markdown files, and use the standard Markdown image syntax, without any path.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/nhoizey/jekyll-postfiles](https://github.com/nhoizey/jekyll-postfiles)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Thanks
+
+Inspired by [this old Gist](https://gist.github.com/kevinoid/3131752) by [@kevinoid](https://github.com/kevinoid/).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/_release.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+# https://github.com/svenfuchs/gem-release
+
+if [ -z "$1" ]; then
+  echo "Usage: provide the release type (patch, minor, major)."
+  exit -1
+else
+  release_type="$@"
+fi
+
+gem bump --version "$release_type" --tag --release

data/jekyll-postfiles.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-postfiles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-postfiles"
+  spec.version       = JekyllPostFiles::VERSION
+  spec.authors       = ["Nicolas Hoizey"]
+  spec.email         = ["nicolas@hoizey.com"]
+
+  spec.summary       = %q{A Jekyll plugin to keep posts assets alongside their Markdown files}
+  spec.description   = %q{This plugin takes any file that is in posts folders, and copy them to the folder in which the post HTML page will be created.}
+  spec.homepage      = "https://nhoizey.github.io/jekyll-postfiles/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.42"
+end

data/lib/jekyll-postfiles/version.rb

@@ -0,0 +1,3 @@
+module JekyllPostFiles
+  VERSION = "2.0.0"
+end

data/lib/jekyll-postfiles.rb

@@ -0,0 +1,60 @@
+require "jekyll-postfiles/version"
+require "jekyll"
+
+module Jekyll
+
+  class PostFile < StaticFile
+
+    # Initialize a new PostFile.
+    #
+    # site - The Site.
+    # base - The String path to the <source>.
+    # dir - The String path of the source directory of the file (rel <source>).
+    # name - The String filename of the file.
+    def initialize(site, base, dir, name, dest)
+      super(site, base, dir, name)
+      @name = name
+      @dest = dest
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns destination file path.
+    def destination(dest)
+      File.join(@dest, @name)
+    end
+  end
+
+  class PostFileGenerator < Generator
+
+    # Copy the files from post's folder.
+    #
+    # post - A Post which may have associated content.
+    def copy_post_files(post)
+
+      postpath = post.path
+      postdir = File.dirname(postpath)
+      destdir = File.dirname(post.destination(""))
+
+      site = post.site
+      sitesrcdir = site.source
+      contents = Dir.glob(File.join(postdir, '**', '*')) do |filepath|
+        if filepath != postpath
+          filedir, filename = File.split(filepath[sitesrcdir.length..-1])
+          site.static_files <<
+            PostFile.new(site, sitesrcdir, filedir, filename, destdir)
+        end
+      end
+    end
+
+    # Generate content by copying files associated with each post.
+    def generate(site)
+      site.posts.docs.each do |post|
+        copy_post_files(post)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-postfiles
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Nicolas Hoizey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+description: This plugin takes any file that is in posts folders, and copy them to
+  the folder in which the post HTML page will be created.
+email:
+- nicolas@hoizey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- _release.sh
+- jekyll-postfiles.gemspec
+- lib/jekyll-postfiles.rb
+- lib/jekyll-postfiles/version.rb
+homepage: https://nhoizey.github.io/jekyll-postfiles/
+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.6.4
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to keep posts assets alongside their Markdown files
+test_files: []