class Jekyll::StaticFile
Attributes
Public Class Methods
The cache of last modification times [path] -> mtime.
# File lib/ngage/jekyll/static_file.rb, line 13 def mtimes @mtimes ||= {} end
Initialize a new StaticFile
.
site - The Site
. base - The String path to the <source>. dir - The String path between <source> and the file. name - The String filename of the file. rubocop: disable ParameterLists
# File lib/ngage/jekyll/static_file.rb, line 29 def initialize(site, base, dir, name, collection = nil) @site = site @base = base @dir = dir @name = name @collection = collection @relative_path = File.join(*[@dir, @name].compact) @extname = File.extname(@name) @data = @site.frontmatter_defaults.all(relative_path, type) end
# File lib/ngage/jekyll/static_file.rb, line 17 def reset_cache @mtimes = nil end
Public Instance Methods
# File lib/ngage/jekyll/static_file.rb, line 115 def basename File.basename(name, extname) end
Returns the front matter defaults defined for the file's URL
and/or type as defined in _config.yml.
# File lib/ngage/jekyll/static_file.rb, line 151 def defaults @defaults ||= @site.frontmatter_defaults.all url, type end
Obtain destination path.
dest - The String path to the destination dir.
Returns destination file path.
# File lib/ngage/jekyll/static_file.rb, line 56 def destination(dest) @site.in_dest_dir(*[dest, destination_rel_dir, @name].compact) end
# File lib/ngage/jekyll/static_file.rb, line 60 def destination_rel_dir if @collection File.dirname(url) else @dir end end
Is source path modified?
Returns true if modified since last write.
# File lib/ngage/jekyll/static_file.rb, line 80 def modified? self.class.mtimes[path] != mtime end
# File lib/ngage/jekyll/static_file.rb, line 68 def modified_time @modified_time ||= File.stat(path).mtime end
Returns last modification time for this file.
# File lib/ngage/jekyll/static_file.rb, line 73 def mtime modified_time.to_i end
Returns source file path.
# File lib/ngage/jekyll/static_file.rb, line 42 def path # Static file is from a collection inside custom collections directory if !@collection.nil? && !@site.config["collections_dir"].empty? File.join(*[@base, @site.config["collections_dir"], @dir, @name].compact) else File.join(*[@base, @dir, @name].compact) end end
# File lib/ngage/jekyll/static_file.rb, line 119 def placeholders { :collection => @collection.label, :path => relative_path[ @collection.relative_directory.size..relative_path.size], :output_ext => "", :name => "", :title => "", } end
# File lib/ngage/jekyll/static_file.rb, line 111 def to_liquid @to_liquid ||= Drops::StaticFileDrop.new(self) end
Returns the type of the collection if present, nil otherwise.
# File lib/ngage/jekyll/static_file.rb, line 145 def type @type ||= @collection.nil? ? nil : @collection.label.to_sym end
Applies a similar URL-building technique as Jekyll::Document
that takes the collection's URL
template into account. The default URL
template can be overriden in the collection's configuration in _config.yml.
# File lib/ngage/jekyll/static_file.rb, line 133 def url @url ||= if @collection.nil? relative_path else ::Jekyll::URL.new( :template => @collection.url_template, :placeholders => placeholders ) end.to_s.chomp("/") end
Write the static file to the destination directory (if modified).
dest - The String path to the destination dir.
Returns false if the file was not modified since last time (no-op).
# File lib/ngage/jekyll/static_file.rb, line 97 def write(dest) dest_path = destination(dest) return false if File.exist?(dest_path) && !modified? self.class.mtimes[path] = mtime FileUtils.mkdir_p(File.dirname(dest_path)) FileUtils.rm(dest_path) if File.exist?(dest_path) copy_file(dest_path) true end
Whether to write the file to the filesystem
Returns true unless the defaults for the destination path from _config.yml contain `published: false`.
# File lib/ngage/jekyll/static_file.rb, line 88 def write? defaults.fetch("published", true) end
Private Instance Methods
# File lib/ngage/jekyll/static_file.rb, line 157 def copy_file(dest_path) if @site.safe || Jekyll.env == "production" FileUtils.cp(path, dest_path) else FileUtils.copy_entry(path, dest_path) end unless File.symlink?(dest_path) File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path) end end