class JekyllFeed::Generator

Constants

MINIFY_REGEX

Matches all whitespace that follows

1. A '>', which closes an XML tag or
2. A '}', which closes a Liquid tag

We will strip all of this whitespace to minify the template

Public Instance Methods

generate(site) click to toggle source

Main plugin action, called by Jekyll-core

# File lib/jekyll-feed/generator.rb, line 9
def generate(site)
  @site = site
  if disabled_in_development?
    Jekyll.logger.info "Jekyll Feed:", "Skipping feed generation in development"
    return
  end
  collections.each do |name, meta|
    Jekyll.logger.info "Jekyll Feed:", "Generating feed for #{name}"
    (meta["categories"] + [nil]).each do |category|
      path = feed_path(:collection => name, :category => category)
      next if file_exists?(path)

      @site.pages << make_page(path, :collection => name, :category => category)
    end
  end
  generate_feed_by_tag if config["tags"] && !@site.tags.empty?
end

Private Instance Methods

collections() click to toggle source

Returns a hash representing all collections to be processed and their metadata in the form of { collection_name => { categories = […], path = “…” } }

# File lib/jekyll-feed/generator.rb, line 58
def collections
  return @collections if defined?(@collections)

  @collections = case config["collections"]
                 when Array
                   config["collections"].map { |c| [c, {}] }.to_h
                 when Hash
                   config["collections"]
                 else
                   {}
                 end

  @collections = normalize_posts_meta(@collections)
  @collections.each_value do |meta|
    meta["categories"] = (meta["categories"] || []).to_set
  end

  @collections
end
config() click to toggle source

Returns the plugin’s config or an empty hash if not set

# File lib/jekyll-feed/generator.rb, line 36
def config
  @config ||= @site.config["feed"] || {}
end
disabled_in_development?() click to toggle source
# File lib/jekyll-feed/generator.rb, line 145
def disabled_in_development?
  config && config["disable_in_development"] && Jekyll.env == "development"
end
feed_path(collection: "posts", category: nil) click to toggle source

Determines the destination path of a given feed

collection - the name of a collection, e.g., “posts” category - a category within that collection, e.g., “news”

Will return “/feed.xml”, or the config-specified default feed for posts Will return ‘/feed/category.xml` for post categories WIll return `/feed/collection.xml` for other collections Will return `/feed/collection/category.xml` for other collection categories

# File lib/jekyll-feed/generator.rb, line 49
def feed_path(collection: "posts", category: nil)
  prefix = collection == "posts" ? "/feed" : "/feed/#{collection}"
  return "#{prefix}/#{category}.xml" if category

  collections.dig(collection, "path") || "#{prefix}.xml"
end
feed_source_path() click to toggle source

Path to feed.xml template file

# File lib/jekyll-feed/generator.rb, line 105
def feed_source_path
  @feed_source_path ||= File.expand_path "feed.xml", __dir__
end
feed_template() click to toggle source
# File lib/jekyll-feed/generator.rb, line 109
def feed_template
  @feed_template ||= File.read(feed_source_path).gsub(MINIFY_REGEX, "")
end
file_exists?(file_path) click to toggle source

Checks if a file already exists in the site source

# File lib/jekyll-feed/generator.rb, line 114
def file_exists?(file_path)
  File.exist? @site.in_source_dir(file_path)
end
generate_feed_by_tag() click to toggle source
# File lib/jekyll-feed/generator.rb, line 78
def generate_feed_by_tag
  tags_config = config["tags"]
  tags_config = {} unless tags_config.is_a?(Hash)

  except    = tags_config["except"] || []
  only      = tags_config["only"] || @site.tags.keys
  tags_pool = only - except
  tags_path = tags_config["path"] || "/feed/by_tag/"

  generate_tag_feed(tags_pool, tags_path)
end
generate_tag_feed(tags_pool, tags_path) click to toggle source
# File lib/jekyll-feed/generator.rb, line 90
def generate_tag_feed(tags_pool, tags_path)
  tags_pool.each do |tag|
    # allow only tags with basic alphanumeric characters and underscore to keep
    # feed path simple.
    next if %r![^a-zA-Z0-9_]!.match?(tag)

    Jekyll.logger.info "Jekyll Feed:", "Generating feed for posts tagged #{tag}"
    path = "#{tags_path}#{tag}.xml"
    next if file_exists?(path)

    @site.pages << make_page(path, :tags => tag)
  end
end
make_page(file_path, collection: "posts", category: nil, tags: nil) click to toggle source

Generates contents for a file

# File lib/jekyll-feed/generator.rb, line 120
def make_page(file_path, collection: "posts", category: nil, tags: nil)
  PageWithoutAFile.new(@site, __dir__, "", file_path).tap do |file|
    file.content = feed_template
    file.data.merge!(
      "layout"     => nil,
      "sitemap"    => false,
      "xsl"        => file_exists?("feed.xslt.xml"),
      "collection" => collection,
      "category"   => category,
      "tags"       => tags
    )
    file.output
  end
end
normalize_posts_meta(hash) click to toggle source

Special case the “posts” collection, which, for ease of use and backwards compatability, can be configured via top-level keys or directly as a collection

# File lib/jekyll-feed/generator.rb, line 137
def normalize_posts_meta(hash)
  hash["posts"] ||= {}
  hash["posts"]["path"] ||= config["path"]
  hash["posts"]["categories"] ||= config["categories"]
  config["path"] ||= hash["posts"]["path"]
  hash
end