fail_fast 0.5.2 → 0.6.0

data/CHANGELOG.txt

@@ -1,3 +1,9 @@
+0.6.0
+  - report errors to Hoptoad (http://hoptoadapp.com)
+    ex:
+        FailFast.report_to :hoptoad => '<your-api-token>'
+        ... (rest of your FF script)
+
 0.5.2
   - changed: replace Jeweler & Rubygems by Bundler
   - add: all checkers methods return a success status (true/false)

data/README.markdown

@@ -109,7 +109,7 @@ If it fails, you'll get a report like this :
     +------------------------------------------------------------------------------------------
     |   FAIL_FAST error : precondition(s) not met in
     |  -----------------
-    |     file         :  "./spec/fixtures/simple.yml"
+    |     file         :  "./spec/_/fixtures/simple.yml"
     |     keys prefix  :  none
     +------------------------------------------------------------------------------------------
     |      error                                   key                                value
@@ -123,9 +123,9 @@ If it fails, you'll get a report like this :
     |  * not_a_url                              test/host                           localhost                      
     |  * url_not_reachable                      test/url_not_reachable              http://xxx.zzz                 
     |  * directory_not_found                                                        /foobarbaz                     
-    |  * directory_not_found                    test/a_file                         ./spec/fixtures/simple.yml     
+    |  * directory_not_found                    test/a_file                         ./spec/_/fixtures/simple.yml
     |  * file_not_found                                                             /tmp/foo/bar/??nOTaFile        
-    |  * file_not_found                         test/a_directory                    ./spec/fixtures                
+    |  * file_not_found                         test/a_directory                    ./spec/_/fixtures
     |  * mongoDB_server_not_found                                                   10.0.0.123                     
     |  * mongoDB_server_not_found               test/mongoDB                        localhost                      
     |  * mongoDB_db_not_found                                                       not_a_known_db                 
@@ -160,6 +160,19 @@ If it fails, you'll get a report like this :
 	end
 
 
+### Example 5 : also sending errors report to Hoptoad (http://hoptoadapp.com)
+
+    FailFast().check do
+        ...                 # errors only reported to stdout
+	end
+    ...
+	FailFast.report_to :hoptoad => '<your-api-token>'       # <- add this in your FF script
+    ...
+    FailFast().check do
+        ...                 # errors also reported to your Hoptoad account
+	end
+
+
 
 ## Info :
 

data/fail_fast.gemspec

@@ -4,7 +4,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name          =   'fail_fast'
-  s.version       =   '0.5.2'
+  s.version       =   '0.6.0'
 
   s.date          =   Time.now.utc.strftime("%Y-%m-%d")
   s.homepage      =   'http://github.com/alainravet/fail_fast'
@@ -23,7 +23,11 @@ Gem::Specification.new do |s|
   s.require_paths =   %w(lib)
 
   s.add_development_dependency 'rspec',         '= 1.3.2'
-  s.add_development_dependency 'activerecord',  '>= 0'
+  s.add_development_dependency 'activerecord',  '= 2.3.12'
   s.add_development_dependency 'mongo',         '>= 0'
-  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'bson_ext'
+  s.add_development_dependency 'bson_ext'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'vcr'
 end

data/lib/fail_fast.rb

@@ -1,8 +1,95 @@
-require 'fail_fast/main'
+require 'yaml'
+require 'erb'
+
+require File.expand_path(File.dirname(__FILE__) + '/fail_fast/support/error_db')
+class FailFast
+
+  @@_errors_db = FailFast::ErrorDb.new
+  @@global_error_reporters = nil
+
+  def initialize(config_file_path=nil, keys_prefix=nil)
+    @config_file_path = config_file_path
+    @keys_prefix      = keys_prefix
+    @errors_key       = ErrorDb.key_for(config_file_path, keys_prefix)
+    FailFast.global_error_reporters.each do |r| register_errors_reporter(r) end
+  end
+
+
+  class << self
+    def fail_now
+      exit(1) unless errors_db.keys.empty?
+    end
+
+    def failed?
+      !global_errors.empty?
+    end
+
+    def errors_db #:nodoc:
+      @@_errors_db
+    end
+
+    # @param reporters [Object] 1 or many error reporters (must respond to :report)
+    def report_to(reporter)
+      reporter.is_a?(Hash) ?
+        init_global_error_reporter_from_hash(reporter) :
+        add_global_error_reporter(reporter)
+    end
+
+    def init_global_error_reporter_from_hash(params)
+      [].tap do |reporters|
+        if api_token = params.delete(:hoptoad)
+          r = FailFast::ErrorReporter::Hoptoad.new(api_token)
+          FailFast.report_to r
+          reporters.push(r)
+        end
+      end
+    end
+
+    def global_error_reporters
+      reset_global_error_reporters unless @@global_error_reporters
+      @@global_error_reporters
+    end
+  private
+    def reset_global_error_reporters
+      @@global_error_reporters = [ErrorReporter::Stdout.new]
+    end
+
+    def add_global_error_reporter(reporter)
+      global_error_reporters.push(reporter) unless global_error_reporters.include?(reporter)
+      reporter
+    end
+  end
+
+
+  def add_error(value)
+    @@_errors_db.append(@errors_key, value)
+  end
+
+  def errors
+    @@_errors_db.errors_for(@errors_key)
+  end
+
+
+
+  def error_reporters
+    @error_reporters ||= []
+  end
+
+  # @param reporters [Object] 1 or many error reporters (must respond to :report)
+  def register_errors_reporters(*reporters)
+    reporters.each do |r| register_errors_reporter(r) end
+  end
+
+  def register_errors_reporter(reporter)
+    error_reporters.push reporter unless error_reporters.include?(reporter)
+  end
+end
+
 Dir.glob(File.dirname(__FILE__) + '/fail_fast/support/*.rb'   ) {|file| require file }
 Dir.glob(File.dirname(__FILE__) + '/fail_fast/base/*.rb'      ) {|file| require file }
 Dir.glob(File.dirname(__FILE__) + '/fail_fast/extensions/*.rb') {|file| require file }
 
+require 'fail_fast/error_reporter'
 
 # alternative syntax
 def FailFast(config_file_path=nil, keys_prefix=nil)

data/lib/fail_fast/base/base.rb

@@ -1,7 +1,5 @@
 class FailFast
   module Base
-    ERB_TEMPLATE = File.dirname(__FILE__) + '/../report.txt.erb'
-
     def check(&block)
       fail_now_mode   = block_given? # false in the case of  *.check_now.but_fail_now do .. end
 
@@ -12,7 +10,7 @@ class FailFast
         check_all_rules(&block) if block_given?
       end
       unless errors.empty?
-        print_errors
+        report_errors
         exit(1) if fail_now_mode
       end
       self
@@ -24,7 +22,7 @@ class FailFast
       return if @config_file_not_found
       check_all_rules(&block) if block_given?
       unless errors.empty?
-        print_errors
+        report_errors
       end
     end
   private
@@ -34,9 +32,15 @@ class FailFast
       self.instance_eval(&block)
     end
 
-    def print_errors #:nodoc:
-      @errors = errors
-      puts "\n\n\n" + ERB.new(File.read(ERB_TEMPLATE)).result(binding) + "\n\n"
+    def report_errors #:nodoc:
+      context = {
+          :errors_to_report => errors,
+          :config_file_path => @config_file_path,
+          :keys_prefix      => @keys_prefix,
+      }
+      error_reporters.each do |reporter|
+        reporter.report(errors, context)
+      end
     end
   end
 end

data/lib/fail_fast/base/console_utils.rb

@@ -0,0 +1,20 @@
+class FailFast
+
+  module ConsoleUtils #:nodoc:
+
+    NO_COLOUR="\033[0m"
+    RED      ="\033[31m"
+    LRED      ="\033[1;31m"
+    BLUE     ="\033[34m"
+    GREEN    ="\033[32m"
+    YELLOW   ="\033[1;33m"
+
+    def red(   str) [RED,    str, NO_COLOUR].join  end
+    def lred(   str) [LRED,    str, NO_COLOUR].join  end
+    def blue(  str) [BLUE,   str, NO_COLOUR].join  end
+    def green( str) [GREEN,  str, NO_COLOUR].join  end
+    def yellow(str) [YELLOW, str, NO_COLOUR].join  end
+  end
+end
+
+FailFast.send  :include, FailFast::ConsoleUtils

data/lib/fail_fast/base/utils.rb

@@ -40,19 +40,6 @@ class FailFast
 
       Params.new(key, value, regexp, options)
     end
-
-    NO_COLOUR="\033[0m"
-    RED      ="\033[31m"
-    LRED      ="\033[1;31m"
-    BLUE     ="\033[34m"
-    GREEN    ="\033[32m"
-    YELLOW   ="\033[1;33m"
-
-    def red(   str) [RED,    str, NO_COLOUR].join  end
-    def lred(   str) [LRED,    str, NO_COLOUR].join  end
-    def blue(  str) [BLUE,   str, NO_COLOUR].join  end
-    def green( str) [GREEN,  str, NO_COLOUR].join  end
-    def yellow(str) [YELLOW, str, NO_COLOUR].join  end
   end
 end
 

data/lib/fail_fast/error_reporter.rb

@@ -0,0 +1,7 @@
+class FailFast
+  module ErrorReporter
+    autoload :Base,       'fail_fast/error_reporter/base'
+    autoload :Stdout,     'fail_fast/error_reporter/stdout'
+    autoload :Hoptoad,    'fail_fast/error_reporter/hoptoad'
+  end
+end

data/lib/fail_fast/error_reporter/base.rb

@@ -0,0 +1,40 @@
+module FailFast::ErrorReporter
+  class Base
+    include FailFast::ConsoleUtils
+
+    protected
+
+      def default_message_for(e, use_color=true)
+        @use_color = use_color
+        qc_value  = "'#{vcol(e.value)}'"
+        qc_key    = "'#{kcol(e.key)}'"
+        details = if    e.value.nil? then " for the key #{qc_key}"
+                  elsif e.key.nil?   then " #{qc_value}"
+                  else  " #{qc_value} for the key #{qc_key}"
+                  end
+
+        s = case e.kind
+          when :config_file_not_found             then mcol("The config file could not be found") + " : #{yellow(e.value)}."
+          when :missing_value                     then mcol("Missing value") +" #{details}."
+          when :value_does_not_match              then mcol("Invalid value") +" #{details}."
+          when :not_an_email                      then mcol("Invalid email address") + " #{details}."
+          when :not_a_url                         then mcol("Invalid url") + " #{details}."
+          when :url_not_reachable                 then mcol("Could not reach the url") + " #{details}."
+          when :directory_not_found               then mcol("Missing directory") + " #{details}."
+          when :file_not_found                    then mcol("Missing file") + " #{details}."
+          when :not_on_path                       then mcol("App not on path : ") + " #{details}."
+          when :mongoDB_server_not_found          then mcol("Could not connect to the mongoDb server") + " #{details}."
+          when :mongoDB_db_not_found              then mcol("Could not open the mongoDb db") + " #{details}."
+          when :active_record_db_connection_error then mcol("Could not connect to the DB server") + " #{details}."
+          when :fail                              then mcol(e.value)
+          else
+            "%-38s %-35s %-30s \n" % [ e.kind, e.key, qc_value]
+        end
+        e.message ? "#{e.message}\n| #{s}": s
+      end
+
+      def mcol(msg) @use_color ?   lred(msg) : msg end
+      def kcol(key) @use_color ? yellow(key) : key end
+      def vcol(val) @use_color ? yellow(val) : val end
+  end
+end

data/lib/fail_fast/error_reporter/hoptoad.rb

@@ -0,0 +1,34 @@
+module FailFast::ErrorReporter
+  class Hoptoad < Base
+    REQUEST_ERB_TEMPLATE = File.join(File.dirname(__FILE__), 'hoptoad', 'post_error_request.xml.erb')
+
+    attr_reader :response
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def report(errors, context)
+      require 'net/http'
+      uri = URI.parse('http://hoptoadapp.com/notifier_api/v2/notices')
+      @response = Net::HTTP.start(uri.host, uri.port) {|http|
+        req = Net::HTTP::Post.new(uri.path)
+        req['Content-Type'] = 'text/xml'
+        req['Accept'      ] = 'text/xml'
+        http.request(req, xml_req(errors, context))
+      }
+    end
+
+  private
+    def xml_req(errors, context)
+      config_path       = context[:config_file_path]
+      project_root      = '/testapp'
+      environment_name  = 'test'
+      app_version       = '1.0.0'
+      error_msg         = default_message_for(errors.first, false)
+
+      ERB.new(File.read(REQUEST_ERB_TEMPLATE)).result(binding).gsub(/[\t\r\n]/,'')
+    end
+
+  end
+end

data/lib/fail_fast/error_reporter/hoptoad/post_error_request.xml.erb

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notice version="2.0">
+  <api-key><%=@api_key%></api-key>
+  <notifier>
+    <name>FailFast Hoptoad Notifier</name>
+    <version>0.1</version>
+    <url>https://github.com/alainravet/fail_fast</url>
+  </notifier>
+  <error>
+    <class>FailFastError</class>
+    <message>FailFastError at <%= Time.now %></message>
+    <backtrace>
+<% errors.each_with_index do |error, i| %>
+      <line method="<%= config_path %>" file="<%= default_message_for(error, false) %>" number='<%= 1+i %>'/>
+<% end %>
+    </backtrace>
+  </error>
+  <server-environment>
+    <project-root><%= project_root %></project-root>
+    <environment-name><%= environment_name %></environment-name>
+    <app-version><%= app_version %></app-version>
+  </server-environment>
+</notice>

data/lib/fail_fast/error_reporter/stdout.rb

@@ -0,0 +1,9 @@
+module FailFast::ErrorReporter
+  class Stdout < Base
+    ERB_TEMPLATE = File.dirname(__FILE__) + '/../report.txt.erb'
+
+    def report(errors, context)
+      puts "\n\n\n" + ERB.new(File.read(FailFast::ErrorReporter::Stdout::ERB_TEMPLATE)).result(binding) + "\n\n"
+    end
+  end
+end

data/lib/fail_fast/report.txt.erb

@@ -1,13 +1,18 @@
-<% if @config_file_path %>
+<%
+    config_file_path = context[:config_file_path]
+    keys_prefix      = context[:keys_prefix]
+    errors_to_report = context[:errors_to_report]
+%>
+<% if config_file_path %>
 +------------------------------------------------------------------------------------------
 |   <%= lred 'FAIL_FAST error' %> : precondition(s) not met in
 |  -----------------
-|     file          :  "<%= @config_file_path %>"
-<% if @keys_prefix%>|     keys prefix  :  <%= @keys_prefix.inspect %>
+|     file          :  "<%= config_file_path %>"
+<% if keys_prefix %>|     keys prefix  :  <%= keys_prefix.inspect %>
 <% end %>+------------------------------------------------------------------------------------------
 <% else %>
 +------------------------------------------------------------------------------------------
 |   <%= lred 'FAIL_FAST error' %> : precondition(s) not met.
 +------------------------------------------------------------------------------------------
-<% end %>| <%= @errors.collect{|e| default_message_for(e)}.join("\n| ") %>
+<% end %>| <%= errors_to_report.collect{|e| default_message_for(e)}.join("\n| ") %>
 +------------------------------------------------------------------------------------------

data/lib/fail_fast/support/error_details.rb

@@ -1,4 +1,4 @@
-class FailFast::ErrorDetails < Struct.new(:key, :kind, :value, :message)
+class FailFast::ErrorDetails
 
   attr_reader :key, :kind, :value, :message
 
@@ -6,6 +6,10 @@ class FailFast::ErrorDetails < Struct.new(:key, :kind, :value, :message)
     @key, @kind, @value, @message = key, kind, value, message
   end
 
+  def ==(other)
+    self.key == other.key && self.kind == other.kind && self.value == other.value && self.message == other.message
+  end
+
   def has_key_and_kind?(akey, akind) #:nodoc:
     (key.to_s == akey.to_s) && kind.to_sym == akind.to_sym
   end

data/show_all_errors.rb

@@ -3,10 +3,10 @@ gem 'mongo', '1.0'
 require 'mongo'
 
 def fake_http_server
-  require 'fakeweb'
-  FakeWeb.register_uri(:get, "http://example.com/index.html", :body => "I'm reachable!")
-  FakeWeb.register_uri(:get, "http://localhost/index.html", :body => "I'm reachable!")
-  FakeWeb.register_uri(:get, "http://example.com", :body => "I'm reachable!")
+  require 'webmock'
+  stub_request(:get, "http://example.com/index.html").to_return(:body => "I'm reachable!")
+  stub_request(:get, "http://localhost/index.html"  ).to_return(:body => "I'm reachable!")
+  stub_request(:get, "http://example.com"           ).to_return(:body => "I'm reachable!")
 end
 def fake_mongo_server_absent
   require 'mocha'
@@ -34,7 +34,7 @@ FailFast().check_now.but_fail_later do
   fail '_why could not be found on the path' unless `which _why` =~ /_why$/
 end
 
-FailFast(SPEC_DIR + '/fixtures/simple.yml').check_now.but_fail_later do
+FailFast(SPEC_DIR + '/_/fixtures/simple.yml').check_now.but_fail_later do
 
 #test values :
   has_value_for   :first_keyNOT , :message => 'this is a custom message' # single absent key

data/spec/{fixtures → _/fixtures}/simple.yml

@@ -26,9 +26,9 @@ test:
     host: localhost
     database: unknown_mongoDB_db
 
-  a_directory:  <%= SPEC_DIR + '/fixtures' %>
+  a_directory:  <%= SPEC_DIR + '/_/fixtures' %>
 
-  a_file: <%= SPEC_DIR + '/fixtures/simple.yml' %>
+  a_file: <%= SPEC_DIR + '/_/fixtures/simple.yml' %>
 
 db_connection:
   adapter: mysql
@@ -36,7 +36,7 @@ db_connection:
 
 number_six: 6
 letter_x: x
-nda_file: <%= SPEC_DIR + '/fixtures/simple.yml' %>
+nda_file: <%= SPEC_DIR + '/_/fixtures/simple.yml' %>
 development:
   t_url: 'http://localhost:3200'
   t_email: t_email@test.com