module Peek

Constants

ALLOWED_ENVS
VERSION

Public Class Methods

adapter() click to toggle source
# File lib/peek.rb, line 10
def self.adapter
  @adapter
end
adapter=(*adapter_options) click to toggle source
# File lib/peek.rb, line 14
def self.adapter=(*adapter_options)
  adapter, *parameters = *Array.wrap(adapter_options).flatten

  @adapter = case adapter
  when Symbol
    adapter_class_name = adapter.to_s.camelize
    adapter_class =
      begin
        require "peek/adapters/#{adapter}"
      rescue LoadError => e
        raise "Could not find adapter for #{adapter} (#{e})"
      else
        Peek::Adapters.const_get(adapter_class_name)
      end
    adapter_class.new(*parameters)
  when nil
    Peek::Adapters::Memory.new
  else
    adapter
  end

  @adapter
end
enabled?() click to toggle source
# File lib/peek.rb, line 38
def self.enabled?
  ALLOWED_ENVS.include?(env)
end
env() click to toggle source
# File lib/peek.rb, line 42
def self.env
  Rails.env
end
into(klass, options = {}) click to toggle source
# File lib/peek.rb, line 73
def self.into(klass, options = {})
  @views ||= []
  @views << [klass, options]
end
reset() click to toggle source

Clears out any and all views.

Returns nothing.

# File lib/peek.rb, line 81
def self.reset
  @views = nil
  @cached_views = nil
end
results() click to toggle source
# File lib/peek.rb, line 54
def self.results
  results = {
    context: {},
    data: Hash.new { |h, k| h[k] = {} }
  }

  views.each do |view|
    if view.context?
      results[:context][view.key] = view.context
    end

    view.results.each do |key, value|
      results[:data][view.key][key] = value
    end
  end

  results
end
setup() click to toggle source
# File lib/peek.rb, line 86
def self.setup
  ActiveSupport::Deprecation.warn "'Peek.setup' is deprecated and does nothing.", caller
end
views() click to toggle source
# File lib/peek.rb, line 46
def self.views
  @cached_views ||= if @views && @views.any?
    @views.collect { |klass, options| klass.new(options.dup) }.select(&:enabled?)
  else
    []
  end
end