class Jekyll::PostReader

Attributes

site[R]
unfiltered_content[R]

Public Class Methods

new(site) click to toggle source
# File lib/jekyll/readers/post_reader.rb, line 7
def initialize(site)
  @site = site
end

Public Instance Methods

read_content(dir, magic_dir, matcher) click to toggle source

Read all the content files from <source>/<dir>/magic_dir

and return them with the type klass.

dir - The String relative path of the directory to read. magic_dir - The String relative directory to <dir>,

looks for content here.

klass - The return type of the content.

Returns klass type of content files

# File lib/jekyll/readers/post_reader.rb, line 52
def read_content(dir, magic_dir, matcher)
  @site.reader.get_entries(dir, magic_dir).map do |entry|
    next unless matcher.match?(entry)

    path = @site.in_source_dir(File.join(dir, magic_dir, entry))
    Document.new(path,
                 :site       => @site,
                 :collection => @site.posts)
  end.tap(&:compact!)
end
read_drafts(dir) click to toggle source

Read all the files in <source>/<dir>/_drafts and create a new Document object with each one.

dir - The String relative path of the directory to read.

Returns nothing.

# File lib/jekyll/readers/post_reader.rb, line 17
def read_drafts(dir)
  read_publishable(dir, "_drafts", Document::DATELESS_FILENAME_MATCHER)
end
read_posts(dir) click to toggle source

Read all the files in <source>/<dir>/_posts and create a new Document object with each one.

dir - The String relative path of the directory to read.

Returns nothing.

# File lib/jekyll/readers/post_reader.rb, line 27
def read_posts(dir)
  read_publishable(dir, "_posts", Document::DATE_FILENAME_MATCHER)
end
read_publishable(dir, magic_dir, matcher) click to toggle source

Read all the files in <source>/<dir>/<magic_dir> and create a new Document object with each one insofar as it matches the regexp matcher.

dir - The String relative path of the directory to read.

Returns nothing.

# File lib/jekyll/readers/post_reader.rb, line 37
def read_publishable(dir, magic_dir, matcher)
  read_content(dir, magic_dir, matcher)
    .tap { |docs| docs.each(&:read) }
    .select { |doc| processable?(doc) }
end

Private Instance Methods

processable?(doc) click to toggle source
# File lib/jekyll/readers/post_reader.rb, line 65
def processable?(doc)
  if doc.content.nil?
    Jekyll.logger.debug "Skipping:", "Content in #{doc.relative_path} is nil"
    false
  elsif !doc.content.valid_encoding?
    Jekyll.logger.debug "Skipping:", "#{doc.relative_path} is not valid UTF-8"
    false
  else
    publishable?(doc)
  end
end
publishable?(doc) click to toggle source
# File lib/jekyll/readers/post_reader.rb, line 77
def publishable?(doc)
  site.publisher.publish?(doc).tap do |will_publish|
    if !will_publish && site.publisher.hidden_in_the_future?(doc)
      Jekyll.logger.warn "Skipping:", "#{doc.relative_path} has a future date"
    end
  end
end