class Jekyll::StaticFile

Attributes

data[R]
extname[R]
name[R]
relative_path[R]

Public Class Methods

mtimes() click to toggle source

The cache of last modification times [path] -> mtime.

# File lib/jekyll/static_file.rb, line 13
def mtimes
  @mtimes ||= {}
end
new(site, base, dir, name, collection = nil) click to toggle source

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/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
reset_cache() click to toggle source
# File lib/jekyll/static_file.rb, line 17
def reset_cache
  @mtimes = nil
end

Public Instance Methods

basename() click to toggle source

Generate “basename without extension” and strip away any trailing periods. NOTE: `String#gsub` removes all trailing periods (in comparison to `String#chomp`)

# File lib/jekyll/static_file.rb, line 120
def basename
  @basename ||= File.basename(name, extname).gsub(%r!\.*\z!, "")
end
cleaned_relative_path() click to toggle source

Similar to Jekyll::Document#cleaned_relative_path. Generates a relative path with the collection's directory removed when applicable

and additionally removes any multiple periods in the string.

NOTE: `String#gsub!` removes all trailing periods (in comparison to `String#chomp!`)

Examples:

When `relative_path` is "_methods/site/my-cool-avatar...png":
  cleaned_relative_path
  # => "/site/my-cool-avatar"

Returns the cleaned relative path of the static file.

# File lib/jekyll/static_file.rb, line 146
def cleaned_relative_path
  @cleaned_relative_path ||= begin
    cleaned = relative_path[0..-extname.length - 1]
    cleaned.gsub!(%r!\.*\z!, "")
    cleaned.sub!(@collection.relative_directory, "") if @collection
    cleaned
  end
end
defaults() click to toggle source

Returns the front matter defaults defined for the file's URL and/or type as defined in _config.yml.

# File lib/jekyll/static_file.rb, line 179
def defaults
  @defaults ||= @site.frontmatter_defaults.all url, type
end
destination(dest) click to toggle source

Obtain destination path.

dest - The String path to the destination dir.

Returns destination file path.

# File lib/jekyll/static_file.rb, line 56
def destination(dest)
  dest = @site.in_dest_dir(dest)
  @site.in_dest_dir(dest, Jekyll::URL.unescape_path(url))
end
destination_rel_dir() click to toggle source
# File lib/jekyll/static_file.rb, line 61
def destination_rel_dir
  if @collection
    File.dirname(url)
  else
    @dir
  end
end
inspect() click to toggle source

Returns a debug string on inspecting the static file. Includes only the relative path of the object.

# File lib/jekyll/static_file.rb, line 185
def inspect
  "#<#{self.class} @relative_path=#{relative_path.inspect}>"
end
modified?() click to toggle source

Is source path modified?

Returns true if modified since last write.

# File lib/jekyll/static_file.rb, line 81
def modified?
  self.class.mtimes[path] != mtime
end
modified_time() click to toggle source
# File lib/jekyll/static_file.rb, line 69
def modified_time
  @modified_time ||= File.stat(path).mtime
end
mtime() click to toggle source

Returns last modification time for this file.

# File lib/jekyll/static_file.rb, line 74
def mtime
  modified_time.to_i
end
path() click to toggle source

Returns source file path.

# File lib/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
placeholders() click to toggle source
# File lib/jekyll/static_file.rb, line 124
def placeholders
  {
    :collection => @collection.label,
    :path       => cleaned_relative_path,
    :output_ext => "",
    :name       => "",
    :title      => "",
  }
end
to_liquid() click to toggle source
# File lib/jekyll/static_file.rb, line 114
def to_liquid
  @to_liquid ||= Drops::StaticFileDrop.new(self)
end
type() click to toggle source

Returns the type of the collection if present, nil otherwise.

# File lib/jekyll/static_file.rb, line 173
def type
  @type ||= @collection.nil? ? nil : @collection.label.to_sym
end
url() click to toggle source

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/jekyll/static_file.rb, line 158
def url
  @url ||= begin
    base = if @collection.nil?
             cleaned_relative_path
           else
             Jekyll::URL.new(
               :template     => @collection.url_template,
               :placeholders => placeholders
             )
           end.to_s.chomp("/")
    base << extname
  end
end
write(dest) click to toggle source

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/jekyll/static_file.rb, line 101
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
write?() click to toggle source

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/jekyll/static_file.rb, line 89
def write?
  publishable = defaults.fetch("published", true)
  return publishable unless @collection

  publishable && @collection.write?
end

Private Instance Methods

copy_file(dest_path) click to toggle source
# File lib/jekyll/static_file.rb, line 191
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