Module: Forewarn

Defined in:
lib/forewarn.rb,
lib/forewarn/config.rb,
lib/forewarn/version.rb,
lib/forewarn/values/method.rb,
lib/forewarn/reporters/json.rb,
lib/forewarn/sets_up_warnings.rb,
lib/forewarn/triggers_warning.rb,
lib/forewarn/overrides_methods.rb,
lib/forewarn/builds_method_values.rb,
lib/forewarn/warners/string_mutation.rb,
lib/forewarn/remembers_wrapped_methods.rb

Defined Under Namespace

Modules: Reporters, Values, Warners Classes: BuildsMethodValues, OverridesMethods, RemembersWrappedMethods, SetsUpWarnings, TriggersWarning

Constant Summary collapse

DEFAULT_CONFIG = 
{
  :enabled => true,
  :logger => Kernel.method(:warn),
# TODO: implement a JSON reporter
#    :reporter => Forewarn::Reporters::Json,
#    :report_destination => "log/usage_warning.json",
  :warners => [Forewarn::Warners::StringMutation]
}.freeze
VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.config(overrides = {}) ⇒ Object 



16
17
18
 
# File 'lib/forewarn/config.rb', line 16

def self.config(overrides = {})
  @__config.merge!(overrides)
end

.start! ⇒ Object 



9
10
11
 
# File 'lib/forewarn.rb', line 9

def self.start!
  SetsUpWarnings.new.set_up!
end