module Farscape

cache() click to toggle source

# File lib/farscape/cache.rb, line 5
def self.cache
  @cache ||= ActiveSupport::Cache::MemoryStore.new
end

cache=(new_cache) click to toggle source

# File lib/farscape/cache.rb, line 9
def self.cache=(new_cache)
  @cache = new_cache
end

clear() click to toggle source

Removes all plugins and disablings of plugins

# File lib/farscape/plugins.rb, line 66
def self.clear
  @plugins = {}
  @disabling_rules = []
  @middleware_stack = nil
end

clients() click to toggle source

# File lib/farscape/clients.rb, line 5
def self.clients
  @clients ||= {http: Farscape::Agent::HTTPClient}
end

disable!(name_or_type) click to toggle source

Prevents a plugin from being registered, and disables it if it's already there

# File lib/farscape/plugins.rb, line 54
def self.disable!(name_or_type)
  @middleware_stack = nil
  @disabling_rules, @plugins = Plugins.disable(name_or_type, @disabling_rules, @plugins)
end

disabled?(options) click to toggle source

# File lib/farscape/plugins.rb, line 45
def self.disabled?(options)
  Plugins.disabled?(@plugins, @disabling_rules, options)
end

disabled_plugins() click to toggle source

# File lib/farscape/plugins.rb, line 41
def self.disabled_plugins
  Plugins.disabled_plugins(@plugins)
end

disabling_rules() click to toggle source

# File lib/farscape/plugins.rb, line 18
def self.disabling_rules
  @disabling_rules
end

enable!(name_or_type) click to toggle source

Allows a plugin to be registered, and enables it if it's already there

# File lib/farscape/plugins.rb, line 60
def self.enable!(name_or_type)
  @middleware_stack = nil
  @disabling_rules, @plugins = Plugins.enable(name_or_type, @disabling_rules, @plugins)
end

enabled?(options) click to toggle source

# File lib/farscape/plugins.rb, line 49
def self.enabled?(options)
  Plugins.enabled?(@plugins, @disabling_rules, options)
end

enabled_plugins() click to toggle source

# File lib/farscape/plugins.rb, line 37
def self.enabled_plugins
  Plugins.enabled_plugins(@plugins)
end

logger() click to toggle source

# File lib/farscape/logger.rb, line 5
def self.logger
  @logger ||= Logger.new(STDOUT)
end

logger=(new_logger) click to toggle source

# File lib/farscape/logger.rb, line 9
def self.logger=(new_logger)
  @logger = new_logger
end

middleware_stack() click to toggle source

Returns the Poset representing middleware dependency

# File lib/farscape/plugins.rb, line 33
def self.middleware_stack
  @middleware_stack ||= Plugins.construct_stack(enabled_plugins)
end

plugins() click to toggle source

# File lib/farscape/plugins.rb, line 14
def self.plugins
  @plugins
end

register_plugin(options) click to toggle source

# File lib/farscape/plugins.rb, line 22
def self.register_plugin(options)
  @middleware_stack = nil
  options[:enabled] = self.enabled?(options)
  @plugins[options[:name]] = options
end

register_plugins(a_list) click to toggle source

# File lib/farscape/plugins.rb, line 28
def self.register_plugins(a_list)
  a_list.each { |options| register_plugin(options) }
end

Constants

Attributes

Public Class Methods