Module: Wisper

Defined in:
lib/wisper/broadcasters/logger_broadcaster.rb,
lib/wisper.rb,
lib/wisper/version.rb,
lib/wisper/publisher.rb,
lib/wisper/configuration.rb,
lib/wisper/rspec/matchers.rb,
lib/wisper/global_listeners.rb,
lib/wisper/registration/block.rb,
lib/wisper/registration/object.rb,
lib/wisper/temporary_listeners.rb,
lib/wisper/registration/registration.rb,
lib/wisper/broadcasters/send_broadcaster.rb

Overview

Provides a way of wrapping another broadcaster with logging

Defined Under Namespace

Modules: Broadcasters, Publisher, RSpec Classes: BlockRegistration, Configuration, GlobalListeners, ObjectRegistration, Registration, TemporaryListeners

Constant Summary collapse

VERSION = 
"1.5.0"

Class Method Summary collapse

Class Method Details

.add_listener(listener, options = {}) ⇒ Object 



24
25
26
27
 
# File 'lib/wisper.rb', line 24

def self.add_listener(listener, options = {})
  warn "[DEPRECATION] `use Wisper.subscribe` instead of `Wisper.add_listener`"
  self.subscribe(listener, options)
end

.configuration ⇒ Object 



44
45
46
 
# File 'lib/wisper.rb', line 44

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



40
41
42
 
# File 'lib/wisper.rb', line 40

def self.configure
  yield(configuration)
end

.included(base) ⇒ Object 



14
15
16
17
 
# File 'lib/wisper.rb', line 14

def self.included(base)
  warn "[DEPRECATION] `include Wisper::Publisher` instead of `include Wisper`"
  base.class_eval { include Wisper::Publisher  }
end

.setup ⇒ Object 



48
49
50
51
52
 
# File 'lib/wisper.rb', line 48

def self.setup
  configure do |config|
    config.broadcaster(:default, Broadcasters::SendBroadcaster.new)
  end
end

.subscribe(*args, &block) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/wisper.rb', line 29

def self.subscribe(*args, &block)
  if block_given?
    TemporaryListeners.with(*args, &block)
  else
    options = args.last.is_a?(Hash) ? args.pop : {}
    args.each do |listener|
      GlobalListeners.add(listener, options)
    end
  end
end

.with_listeners(*args, &block) ⇒ Object 



19
20
21
22
 
# File 'lib/wisper.rb', line 19

def self.with_listeners(*args, &block)
  warn "[DEPRECATION] `use Wisper.subscribe` instead of `Wisper.with_listeners`"
  self.subscribe(*args, &block)
end