class Jekyll::Reader
Attributes
Public Class Methods
# File lib/jekyll/reader.rb, line 7 def initialize(site) @site = site end
Public Instance Methods
Filter out any files/directories that are hidden or backup files (start with “.” or “#” or end with “~”), or contain site content (start with “_”), or are excluded in the site configuration, unless they are web server files such as '.htaccess'.
entries - The Array of String file/directory entries to filter. base_directory - The string representing the optional base directory.
Returns the Array of filtered entries.
# File lib/jekyll/reader.rb, line 116 def filter_entries(entries, base_directory = nil) EntryFilter.new(site, base_directory).filter(entries) end
Read the entries from a particular directory for processing
dir - The String representing the relative path of the directory to read. subfolder - The String representing the directory to read.
Returns the list of entries to process
# File lib/jekyll/reader.rb, line 126 def get_entries(dir, subfolder) base = site.in_source_dir(dir, subfolder) return [] unless File.exist?(base) entries = Dir.chdir(base) { filter_entries(Dir["**/*"], base) } entries.delete_if { |e| File.directory?(site.in_source_dir(base, e)) } end
Read Site
data from disk and load it into internal data structures.
Returns nothing.
# File lib/jekyll/reader.rb, line 14 def read @site.layouts = LayoutReader.new(site).read read_directories sort_files! @site.data = DataReader.new(site).read(site.config["data_dir"]) CollectionReader.new(site).read ThemeAssetsReader.new(site).read end
Recursively traverse directories to find pages and static files that will become part of the site according to the rules in filter_entries.
dir - The String relative path of the directory to read. Default: ''.
Returns nothing.
# File lib/jekyll/reader.rb, line 37 def read_directories(dir = "") base = site.in_source_dir(dir) return unless File.directory?(base) dot = Dir.chdir(base) { filter_entries(Dir.entries("."), base) } dot_dirs = dot.select { |file| File.directory?(@site.in_source_dir(base, file)) } dot_files = (dot - dot_dirs) dot_pages = dot_files.select do |file| Utils.has_yaml_header?(@site.in_source_dir(base, file)) end dot_static_files = dot_files - dot_pages retrieve_posts(dir) retrieve_dirs(base, dir, dot_dirs) retrieve_pages(dir, dot_pages) retrieve_static_files(dir, dot_static_files) end
Recursively traverse directories with the read_directories
function.
base - The String representing the site's base directory. dir - The String representing the directory to traverse down. dot_dirs - The Array of subdirectories in the dir.
Returns nothing.
# File lib/jekyll/reader.rb, line 75 def retrieve_dirs(_base, dir, dot_dirs) dot_dirs.each do |file| dir_path = site.in_source_dir(dir, file) rel_path = File.join(dir, file) unless @site.dest.chomp("/") == dir_path @site.reader.read_directories(rel_path) end end end
Retrieve all the pages from the current directory, add them to the site and sort them.
dir - The String representing the directory retrieve the pages from. dot_pages - The Array of pages in the dir.
Returns nothing.
# File lib/jekyll/reader.rb, line 92 def retrieve_pages(dir, dot_pages) site.pages.concat(PageReader.new(site, dir).read(dot_pages)) end
Retrieves all the posts(posts/drafts) from the given directory and add them to the site and sort them.
dir - The String representing the directory to retrieve the posts from.
Returns nothing.
# File lib/jekyll/reader.rb, line 62 def retrieve_posts(dir) return if outside_configured_directory?(dir) site.posts.docs.concat(post_reader.read_posts(dir)) site.posts.docs.concat(post_reader.read_drafts(dir)) if site.show_drafts end
Retrieve all the static files from the current directory, add them to the site and sort them.
dir - The directory retrieve the static files from. dot_static_files - The static files in the dir.
Returns nothing.
# File lib/jekyll/reader.rb, line 103 def retrieve_static_files(dir, dot_static_files) site.static_files.concat(StaticFileReader.new(site, dir).read(dot_static_files)) end
Sorts posts, pages, and static files.
# File lib/jekyll/reader.rb, line 24 def sort_files! site.collections.each_value { |c| c.docs.sort! } site.pages.sort_by!(&:name) site.static_files.sort_by!(&:relative_path) end
Private Instance Methods
Internal
Determine if the directory is supposed to contain posts and drafts. If the user has defined a custom collections_dir, then attempt to read posts and drafts only from within that directory.
Returns true if a custom collections_dir has been set but current directory lies outside that directory.
# File lib/jekyll/reader.rb, line 143 def outside_configured_directory?(dir) collections_dir = site.config["collections_dir"] !collections_dir.empty? && !dir.start_with?("/#{collections_dir}") end
Create a single PostReader
instance to retrieve drafts and posts from all valid directories in current site.
# File lib/jekyll/reader.rb, line 150 def post_reader @post_reader ||= PostReader.new(site) end