class Jekyll::Plugin
Constants
- PRIORITIES
Public Class Methods
Source
# File lib/jekyll/plugin.rb, line 70 def self.<=>(other) PRIORITIES[other.priority] <=> PRIORITIES[priority] end
Spaceship is priority [higher -> lower]
other - The class to be compared.
Returns -1, 0, 1.
Source
# File lib/jekyll/plugin.rb, line 23 def self.catch_inheritance(const) const.define_singleton_method :inherited do |const_| (@children ||= Set.new).add const_ yield const_ if block_given? end end
Source
# File lib/jekyll/plugin.rb, line 32 def self.descendants @children ||= Set.new out = @children.map(&:descendants) out << self unless superclass == Plugin Set.new(out).flatten end
Source
# File lib/jekyll/plugin.rb, line 15 def self.inherited(const) catch_inheritance(const) do |const_| catch_inheritance(const_) end end
Source
# File lib/jekyll/plugin.rb, line 88 def initialize(config = {}) # no-op for default end
Initialize a new plugin. This should be overridden by the subclass.
config - The Hash of configuration options.
Returns a new instance.
Source
# File lib/jekyll/plugin.rb, line 47 def self.priority(priority = nil) @priority ||= nil @priority = priority if priority && PRIORITIES.key?(priority) @priority || :normal end
Get or set the priority of this plugin. When called without an argument it returns the priority. When an argument is given, it will set the priority.
priority - The Symbol priority (default: nil). Valid options are:
:lowest, :low, :normal, :high, :highest
Returns the Symbol priority.
Source
# File lib/jekyll/plugin.rb, line 60 def self.safe(safe = nil) @safe = safe unless defined?(@safe) && safe.nil? @safe || false end
Get or set the safety of this plugin. When called without an argument it returns the safety. When an argument is given, it will set the safety.
safe - The Boolean safety (default: nil).
Returns the safety Boolean.
Public Instance Methods
Source
# File lib/jekyll/plugin.rb, line 79 def <=>(other) self.class <=> other.class end
Spaceship is priority [higher -> lower]
other - The class to be compared.
Returns -1, 0, 1.