jekyll-postfiles 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3f717f8740d6deda8214d36c11af41d99ad31952
-  data.tar.gz: 1d344f57c25424d9a2413f803cec4a398ce6c1d3
+SHA256:
+  metadata.gz: 0fbc83e7c863e6c9c8de143eb478b3e264cc640d1c88b2a7170be1cacbabb0c6
+  data.tar.gz: 8c8cd59474d3de1cbd0702b733a2f3f89f1a0df3dd64deb72628354ceff4830b
 SHA512:
-  metadata.gz: d1b6074e7a7a974b71336a5cfb4f43cc0e0f5ba495f7a20c35a78eafa8ced132d265453696fe183672695fd5d196dbf785ae1cad39e2b2a97f983d9549b7f618
-  data.tar.gz: 8449666bd84da6554a417711a3a5ff3ec80855bc34b2653c12cdb8336f6c549852b9c2bbf2b5d729ecb2dc1793fbc78168ca1b5b0eb31102dd4fa84f2feb9ce5
+  metadata.gz: 49bdc09297feda1dc497e8c2c04b18234117231b9e08433539117805f122a7c6339e4cca229da2da7a267f4c79191b6370626ab90f45747d0e7f88fb0f46519e
+  data.tar.gz: fcb9eb8fe93bb3388a085610bf341f04602b50a48311ed40b4bb7e0ba3d0c708124683bffabbd98fc27241a02ca66a8d5590c2447a45e8eb8ac169bf7551b339

data/Gemfile

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

data/README.md

@@ -6,7 +6,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-## Table of contents
 
 - [Easing the management of images (and other files) attached to Markdown posts](#easing-the-management-of-images-and-other-files-attached-to-markdown-posts)
   - [The pain of Jekyll's recommended posts assets management](#the-pain-of-jekylls-recommended-posts-assets-management)
@@ -202,7 +201,7 @@ Just put the images (and PDFs, etc.) in the same folder as your Markdown files,
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/nhoizey/jekyll-postfiles](https://github.com/nhoizey/jekyll-postfiles)
+Thanks for your interest in contributing! There are many ways to contribute to this project. Get started here (https://github.com/nhoizey/jekyll-postfiles/blob/master/CONTRIBUTING.md).
 
 ## License
 

data/RELEASES.md

@@ -0,0 +1,6 @@
+# Releases
+
+## [v3.0.0](https://github.com/nhoizey/jekyll-postfiles/releases/tag/v3.0.0)
+
+- [Rewrite for Jekyll 3.8.0](https://github.com/nhoizey/jekyll-postfiles/pull/12) by [@Birch-san](https://github.com/Birch-san)
+- Match jekyll's coding style thanks to [Rubocop](http://rubocop.readthedocs.io/)

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 task :default => :spec

data/lib/jekyll-postfiles.rb

@@ -1,86 +1,3 @@
-require "jekyll-postfiles/version"
-require "jekyll"
+# frozen_string_literal: true
 
-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)
-
-      post_path = post.path
-      site = post.site
-      site_src_dir = site.source
-
-      # Jekyll.logger.warn(
-      #   "[PostFiles]",
-      #   "Current post: #{post_path[site_src_dir.length..-1]}"
-      # )
-
-      post_dir = File.dirname(post_path)
-      dest_dir = File.dirname(post.destination(""))
-
-      # Count other Markdown files in the same directory
-      other_md_count = 0
-      other_md = Dir.glob(File.join(post_dir, '*.{md,markdown}'), File::FNM_CASEFOLD) do |mdfilepath|
-        if mdfilepath != post_path
-          other_md_count += 1
-        end
-      end
-
-      contents = Dir.glob(File.join(post_dir, '*')) do |filepath|
-        if filepath != post_path \
-            && !File.directory?(filepath) \
-            && !File.fnmatch?('*.{md,markdown}', filepath, File::FNM_EXTGLOB | File::FNM_CASEFOLD)
-          # Jekyll.logger.warn(
-          #   "[PostFiles]",
-          #   "-> attachment: #{filepath[site_src_dir.length..-1]}"
-          # )
-          if other_md_count > 0
-            Jekyll.logger.abort_with(
-              "[PostFiles]",
-              "Sorry, there can be only one Markdown file in each directory containing other assets to be copied by jekyll-postfiles"
-            )
-          end
-          filedir, filename = File.split(filepath[site_src_dir.length..-1])
-          site.static_files <<
-            PostFile.new(site, site_src_dir, filedir, filename, dest_dir)
-        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
+require "jekyll/postfiles"

data/lib/jekyll/postfiles.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "pathname"
+
+module Jekyll
+  module PostFiles
+
+    # there's a bug in the regex Document::DATE_FILENAME_MATCHER:
+    #   %r!^(?:.+/)*(\d{2,4}-\d{1,2}-\d{1,2})-(.*)(\.[^.]+)$!
+    # used by:
+    #   jekyll/lib/jekyll/readers/post_reader.rb#read_posts
+    # which ultimately populates:
+    #   site.posts.docs
+    #
+    # the original code's intention was to match:
+    #   all files with a date in the name
+    # but it accidentally matches also:
+    #   all files immediately within a directory whose name contains a date
+    #
+    # our plugin changes the regex, to:
+    #   avoid false positive when directory name matches date regex
+    Hooks.register :site, :after_reset do |site|
+      # Suppress warning messages.
+      original_verbose = $VERBOSE
+      $VERBOSE = nil
+      Document.const_set("DATE_FILENAME_MATCHER", PostFileGenerator::FIXED_DATE_FILENAME_MATCHER)
+      # Activate warning messages again.
+      $VERBOSE = original_verbose
+    end
+
+    class PostFile < StaticFile
+      # Initialize a new PostFile.
+      #
+      # site - The Site.
+      # base - The String path to the <source> - /srv/jekyll
+      # dir  - The String path between <source> and the file - _posts/somedir
+      # name - The String filename of the file - cool.svg
+      # dest - The String path to the containing folder of the document which is output - /dist/blog/[:tag/]*:year/:month/:day
+      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
+      FIXED_DATE_FILENAME_MATCHER = %r!^(?:.+/)*(\d{2,4}-\d{1,2}-\d{1,2})-([^/]*)(\.[^.]+)$!
+
+      # _posts/
+      #   2018-01-01-whatever.md     # there's a date on this filename, so it will be treated as a post
+      #                              # it's a direct descendant of _posts, so we do not treat it as an asset root
+      #   somedir/
+      #     2018-05-01-some-post.md  # there's a date on this filename, so it will be treated as a post.
+      #                              # moreover, we will treat its dir as an asset root
+      #     cool.svg                 # there's no date on this filename, so it will be treated as an asset
+      #     undated.md               # there's no date on this filename, so it will be treated as an asset
+      #     img/
+      #       cool.png               # yes, even deeply-nested files are eligible to be copied.
+      def generate(site)
+        site_srcroot = Pathname.new site.source
+        posts_src_dir = site_srcroot + "_posts"
+        drafts_src_dir = site_srcroot + "_drafts"
+
+        # Jekyll.logger.warn("[PostFiles]", "_posts: #{posts_src_dir}")
+        # Jekyll.logger.warn("[PostFiles]", "docs: #{site.posts.docs.map(&:path)}")
+
+        docs_with_dirs = site.posts.docs
+          .reject { |doc|
+            Pathname.new(doc.path).dirname.instance_eval { |dirname|
+              [posts_src_dir, drafts_src_dir].reduce(false) { |acc, dir|
+                acc || dirname.eql?(dir)
+              }
+            }
+          }
+
+        # Jekyll.logger.warn("[PostFiles]", "postdirs: #{docs_with_dirs.map{|doc| Pathname.new(doc.path).dirname}}")
+
+        assets = docs_with_dirs.map { |doc|
+          dest_dir = Pathname.new(doc.destination("")).dirname
+          Pathname.new(doc.path).dirname.instance_eval { |postdir|
+            Dir[postdir + "**/*"]
+              .reject { |fname| fname =~ FIXED_DATE_FILENAME_MATCHER }
+              .reject { |fname| File.directory? fname }
+              .map { |fname|
+                asset_abspath = Pathname.new fname
+                srcroot_to_asset = asset_abspath.relative_path_from(site_srcroot)
+                srcroot_to_assetdir = srcroot_to_asset.dirname
+                asset_basename = srcroot_to_asset.basename
+
+                assetdir_abs = site_srcroot + srcroot_to_assetdir
+                postdir_to_assetdir = assetdir_abs.relative_path_from(postdir)
+                PostFile.new(site, site_srcroot, srcroot_to_assetdir.to_path, asset_basename, (dest_dir + postdir_to_assetdir).to_path)
+              }
+          }
+        }.flatten
+
+        site.static_files.concat(assets)
+      end
+    end
+  end
+end

data/lib/jekyll/postfiles/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module PostFiles
+    VERSION = "3.0.0"
+  end
+end

metadata

@@ -1,59 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-postfiles
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Nicolas Hoizey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: 0.55.0
   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.
+        version: 0.55.0
+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.\n"
 email:
 - nicolas@hoizey.com
 executables: []
@@ -61,13 +75,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
+- RELEASES.md
 - Rakefile
-- _release.sh
-- jekyll-postfiles.gemspec
 - lib/jekyll-postfiles.rb
-- lib/jekyll-postfiles/version.rb
+- lib/jekyll/postfiles.rb
+- lib/jekyll/postfiles/version.rb
 homepage: https://nhoizey.github.io/jekyll-postfiles/
 licenses:
 - MIT
@@ -88,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to keep posts assets alongside their Markdown files

data/_release.sh

@@ -1,11 +0,0 @@
-#!/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

@@ -1,23 +0,0 @@
-# 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

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