Module: Compendium

Defined in:
lib/compendium.rb,
lib/compendium/dsl.rb,
lib/compendium/query.rb,
lib/compendium/engine.rb,
lib/compendium/errors.rb,
lib/compendium/metric.rb,
lib/compendium/option.rb,
lib/compendium/params.rb,
lib/compendium/report.rb,
lib/compendium/version.rb,
lib/compendium/open_hash.rb,
lib/compendium/sum_query.rb,
lib/compendium/result_set.rb,
lib/compendium/count_query.rb,
lib/compendium/param_types.rb,
lib/compendium/through_query.rb,
lib/compendium/context_wrapper.rb,
lib/compendium/collection_query.rb,
app/helpers/compendium/reports_helper.rb,
lib/compendium/abstract_chart_provider.rb,
app/controllers/compendium/reports_controller.rb

Defined Under Namespace

Modules: ChartProvider, DSL, Presenters, ReportsHelper Classes: AbstractChartProvider, BooleanParam, CollectionQuery, Configuration, ContextWrapper, CountQuery, DateParam, DropdownParam, Engine, Metric, OpenHash, Option, Param, ParamWithChoices, Params, Query, RadioParam, Report, ReportsController, ResultSet, ScalarParam, SumQuery, ThroughQuery

Constant Summary collapse

CompendiumError = 
Class.new(StandardError)
InvalidCommand = 
Class.new(CompendiumError)
CannotRedefineQueryType = 
Class.new(CompendiumError)
VERSION = 
'1.2.0'

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



42
43
44
 
# File 'lib/compendium.rb', line 42

def self.config
  @config
end

.configure {|@config ||= Compendium::Configuration.new| ... } ⇒ Object

Configures global settings for Compendium

Compendium.configure do |config|
  config.chart_provider = :AmCharts
end

Yields:



38
39
40
 
# File 'lib/compendium.rb', line 38

def self.configure(&block)
  yield @config ||= Compendium::Configuration.new
end

.reports ⇒ Object 



30
31
32
 
# File 'lib/compendium.rb', line 30

def self.reports
  @reports ||= []
end