whoops_notifier 0.0.3 → 0.0.4

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/whoops_notifier.rb

@@ -14,7 +14,7 @@ module WhoopsNotifier
     
     # @overload notify(evidence)
     #   Notify using the default basic strategy
-    #   @param [Hash] evidence the evidence expected by the basic strategy
+    #   @param [Hash] evidence the evidence expected by the basic strategy, used by strategy to build report
     # @overload notify(strategy_name, evidence)
     #   @param [Symbol, String] strategy_name
     #   @param [Hash] evidence same as above

data/lib/whoops_notifier/investigator.rb

@@ -1,8 +1,9 @@
 module WhoopsNotifier
+  
+  # A "glue" class which coordinates report creation
   class Investigator
     # get data from evidence using a strategy to create a report and decide whether it should be ignored
-    attr_accessor :strategy, :report, :evidence, :ignore_report
-    alias :ignore_report? :ignore_report
+    attr_accessor :strategy, :report, :evidence
 
     def initialize(strategy, evidence)
       raise ArgumentError, "strategy can not be nil" if strategy.nil?
@@ -13,11 +14,11 @@ module WhoopsNotifier
     end
     
     def investigate!
-      create_report
+      strategy.call(report, evidence)
     end
     
-    def create_report
-      strategy.call(self)
+    def ignore_report?
+      report.ignore?
     end
   end
 end

data/lib/whoops_notifier/report.rb

@@ -5,6 +5,8 @@ module WhoopsNotifier
       attr_accessor attribute
     end
     
+    attr_accessor :ignore
+    
     def initialize
       self.event_time = Time.now
     end
@@ -16,5 +18,9 @@ module WhoopsNotifier
       end
       h
     end
+    
+    def ignore?
+      ignore
+    end
   end
 end

data/lib/whoops_notifier/strategies/basic.rb

@@ -1,6 +1,6 @@
 strategy = WhoopsNotifier::Strategy.new("default::basic")
 
-strategy.add_report_modifier(:use_basic_hash) do |report, evidence|
+strategy.add_report_builder(:use_basic_hash) do |report, evidence|
   report.event_type             = evidence[:event_type]
   report.service                = evidence[:service]
   report.environment            = evidence[:environment]

data/lib/whoops_notifier/strategy.rb

@@ -1,37 +1,54 @@
 module WhoopsNotifier
+  
+  # Strategies are responsible for building Reports and determining whether a
+  # a Report should be ignored.
+  #
+  # Each strategy contains any number of report builders and ignore criteria.
+  # 
+  # Each report builder and ignore criteria takes a name. This makes adding a
+  # report builder or ignore criteria more like adding a method - the name 
+  # makes it easier to see the intention of the code. It also makes it easier
+  # to get useful info when you inspect the strategy.
+  #
+  # Strategies use call to actually apply modifiers and criteria for the same
+  # reason that Rack uses call. Conceivably, you could add a strategy to the
+  # notifier with 
+  # WhoopsNotifier.strategies[:lambda_stragey] = lambda{ |report, evidence| 
+  #   report.details = evidence[:detail]
+  # }
+  # or something along those lines. 
   class Strategy
-    # ask witnesses for data, create a report using a strategy, send or ignore
-    attr_accessor :name, :ignore_criteria, :report_modifiers
+    attr_accessor :name, :ignore_criteria, :report_builders
 
     def initialize(name)
       self.name             = name
       self.ignore_criteria  = []
-      self.report_modifiers = []
+      self.report_builders = []
       WhoopsNotifier.strategies[name] = self
     end
     
-    def call(investigator)
-      report_modifiers.each do |report_modifier|
-        report_modifier.call(investigator.report, investigator.evidence)
+    def call(report, evidence)
+      report_builders.each do |report_modifier|
+        report_modifier.call(report, evidence)
       end
       
       ignore_criteria.each do |ignore_criterion|
-        if ignore_criterion.call(investigator.report)
-          investigator.ignore_report = true
+        if ignore_criterion.call(report, evidence)
+          report.ignore = true
           break
         end
       end
     end
     
-    # block should take one param, the investigator
+    # block should take two params, the report and the evidence
     # use evidence to build the report
-    def add_report_modifier(name, &block)
+    def add_report_builder(name, &block)
       give_name(name, block)
-      @report_modifiers << block
+      @report_builders << block
     end
     
     # block takes one param, the investigator's report
-    def add_ignore_case(name, &block)
+    def add_ignore_criteria(name, &block)
       give_name(name, block)
       @ignore_criteria << block
     end
@@ -44,7 +61,7 @@ module WhoopsNotifier
     end
     
     def inspect
-      "#{name}\nreport modifiers: #{report_modifiers.collect{|r| r.name}.join(", ")}\nignore criteria: #{ignore_criteria.collect{|i| i.name}.join(", ")}"
+      "#{name}\nreport modifiers: #{report_builders.collect{|r| r.name}.join(", ")}\nignore criteria: #{ignore_criteria.collect{|i| i.name}.join(", ")}"
     end
   end
 end

data/spec/investigator_spec.rb

@@ -16,10 +16,10 @@ describe "WhoopsNotifier::Investigator" do
   end
   
   describe "#investigate!" do
-    it "should not send report if ignore_report is true" do
+    it "should not send report if ignore_report? is true" do
       strategy = lambda{}
       investigator = WhoopsNotifier::Investigator.new(strategy, {})
-      investigator.ignore_report = true
+      investigator.stub(:ignore_report?).and_return(true)
       
       investigator.should_not_receive(:send_report)
       

data/spec/strategy_spec.rb

@@ -7,26 +7,26 @@ describe "WhoopsNotifier::Strategy" do
       WhoopsNotifier.strategies[:test].should == s
     end
     
-    it "creates empty arrays for ignore criteria and report_modifiers" do
+    it "creates empty arrays for ignore criteria and report_builders" do
       s = WhoopsNotifier::Strategy.new(:test)
       s.ignore_criteria.should == []
-      s.report_modifiers.should == []
+      s.report_builders.should == []
     end
   end
   
-  describe "#add_report_modifier" do
+  describe "#add_report_builder" do
     it "adds a named block" do
       s = WhoopsNotifier::Strategy.new(:test)
-      s.add_report_modifier(:add_message) { |investigator| }
+      s.add_report_builder(:add_message) { |report, evidence| }
 
-      s.report_modifiers.first.name.should == :add_message
+      s.report_builders.first.name.should == :add_message
     end
   end
   
-  describe "#add_ignore_case" do
+  describe "#add_ignore_criteria" do
     it "adds a named ignore criteria block" do
       s = WhoopsNotifier::Strategy.new(:test)
-      s.add_ignore_case(:ignore_if_empty) { |investigator| }
+      s.add_ignore_criteria(:ignore_if_empty) { |report| }
 
       s.ignore_criteria.first.name.should == :ignore_if_empty
     end
@@ -37,22 +37,22 @@ describe "WhoopsNotifier::Strategy" do
       strategy = WhoopsNotifier::Strategy.new(:test)
       investigator = WhoopsNotifier::Investigator.new(strategy, nil)
       
-      strategy.add_ignore_case(:always_ignore) do |report|
+      strategy.add_ignore_criteria(:always_ignore) do |report|
         true
       end
       
-      strategy.call(investigator)
-      investigator.ignore_report.should == true
+      strategy.call(investigator.report, investigator.evidence)
+      investigator.ignore_report?.should == true
     end
     
     it "should modify the investigator's report according to the report modifiers" do
       strategy = WhoopsNotifier::Strategy.new(:test)
       investigator = WhoopsNotifier::Investigator.new(strategy, {:service => "service"})
-      strategy.add_report_modifier(:add_details){ |report, evidence|
+      strategy.add_report_builder(:add_details){ |report, evidence|
         report.service = evidence[:service] + " test"
       }
       
-      strategy.call(investigator)
+      strategy.call(investigator.report, investigator.evidence)
       
       investigator.report.service.should == "service test"
     end
@@ -63,11 +63,11 @@ describe "WhoopsNotifier::Strategy" do
       strategy = WhoopsNotifier::Strategy.new(:awesome_strategy)
       investigator = WhoopsNotifier::Investigator.new(strategy, nil)
       
-      strategy.add_report_modifier(:report1){ }
-      strategy.add_report_modifier(:report2){ }
+      strategy.add_report_builder(:report1){ }
+      strategy.add_report_builder(:report2){ }
       
-      strategy.add_ignore_case(:ignore1){ true }
-      strategy.add_ignore_case(:ignore2){ true }
+      strategy.add_ignore_criteria(:ignore1){ true }
+      strategy.add_ignore_criteria(:ignore2){ true }
       
       strategy.inspect.should == "awesome_strategy
 report modifiers: report1, report2

data/whoops_notifier.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whoops_notifier}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Higginbotham"]
-  s.date = %q{2011-06-11}
+  s.date = %q{2011-07-09}
   s.description = %q{Handles basic notification responsibilities and allows creation of report creation strategies}
   s.email = %q{daniel@flyingmachinestudios.com}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whoops_notifier
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Daniel Higginbotham
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-11 00:00:00 -04:00
+date: 2011-07-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency