fail_fast 0.5.1 → 0.5.2

data/.gitignore

@@ -19,3 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+
+/Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@failfast

data/CHANGELOG.txt

@@ -1,3 +1,12 @@
+0.5.2
+  - changed: replace Jeweler & Rubygems by Bundler
+  - add: all checkers methods return a success status (true/false)
+    ex:
+        ...
+        unless directory_exists_for  '/log'           # now returns true/false
+          puts "The /log directory is missing"        #  ...
+          puts "create it with $ mkdir /log"          #  ...
+        end                                           #  ...
 0.5.1
   - fixed .failed? bug
   - fixed key prefixes (broken in 0.5.0)

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem 'rake'
+gemspec

data/README.markdown

@@ -135,7 +135,21 @@ If it fails, you'll get a report like this :
     |  * fail                                                                       a custom failure message
     +------------------------------------------------------------------------------------------
 
-### Example 3 : print an additional custom message if errors were detected
+### Example 3 : capture - and handle - individual errors
+
+	FailFast().check_now.but_fail_later do
+	  directory_exists_for  '/cache'                # default error handling/message
+
+	  unless directory_exists_for  '/log'           # custom error handling
+	    puts "The /log directory is missing"        #  ...
+	    puts "create it with $ mkdir /log"          #  ...
+	  end                                           #  ...
+	end
+
+	FailFast.fail_now   # exit it an error was detected in any of the 3 blocks above.
+
+
+### Example 4 : print an additional custom message if errors were detected
 
 	...	# code like in the cases above.
 

data/Rakefile

@@ -1,47 +1,19 @@
-require 'rubygems'
-require 'rake'
+# encoding: UTF-8
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "fail_fast"
-    gem.summary = %Q{raises an error if the yaml contents of a config file does pass a test script.}
-    gem.description = %Q{raises an error if the yaml contents of a config file does not pass a test script.}
-    gem.email = "alainravet@gmail.com"
-    gem.homepage = "http://github.com/alainravet/fail_fast"
-    gem.authors = ["Alain Ravet"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "activerecord"
-    gem.add_development_dependency "mongo"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'rake'
+require 'rake/rdoctask'
 
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.spec_files = FileList['spec/**/*_spec.rb']
 end
+task :default => :spec
 
 Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+  spec.libs    << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "config_file_check #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  spec.rcov    = true
 end

data/fail_fast.gemspec

@@ -1,114 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
+$:.push File.expand_path("../lib", __FILE__)
+
 Gem::Specification.new do |s|
-  s.name = %q{fail_fast}
-  s.version = "0.5.1"
+  s.name          =   'fail_fast'
+  s.version       =   '0.5.2'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Alain Ravet"]
-  s.date = %q{2010-07-29}
-  s.description = %q{raises an error if the yaml contents of a config file does not pass a test script.}
-  s.email = %q{alainravet@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.markdown"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "CHANGELOG.txt",
-     "LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "fail_fast.gemspec",
-     "lib/fail_fast.rb",
-     "lib/fail_fast/base/base.rb",
-     "lib/fail_fast/base/messaging.rb",
-     "lib/fail_fast/base/utils.rb",
-     "lib/fail_fast/base/z_only_for_tests.rb",
-     "lib/fail_fast/extensions/base_commands.rb",
-     "lib/fail_fast/extensions/check_active_record_db.rb",
-     "lib/fail_fast/extensions/check_email.rb",
-     "lib/fail_fast/extensions/check_file_system.rb",
-     "lib/fail_fast/extensions/check_is_on_path.rb",
-     "lib/fail_fast/extensions/check_mongo_db.rb",
-     "lib/fail_fast/extensions/check_url.rb",
-     "lib/fail_fast/extensions/check_value.rb",
-     "lib/fail_fast/main.rb",
-     "lib/fail_fast/report.txt.erb",
-     "lib/fail_fast/support/error_db.rb",
-     "lib/fail_fast/support/error_details.rb",
-     "lib/fail_fast/support/z_only_for_tests.rb",
-     "show_all_errors.rb",
-     "spec/base/base_commands_spec.rb",
-     "spec/base/error_details_spec.rb",
-     "spec/base/errors_storage_spec.rb",
-     "spec/base/file_is_empty_spec.rb",
-     "spec/base/file_is_missing_spec.rb",
-     "spec/base/multiple_blocks_support_spec.rb",
-     "spec/base/not_linked_to_a_file_spec.rb",
-     "spec/base/report_printing_spec.rb",
-     "spec/extensions/check_active_record_db_spec.rb",
-     "spec/extensions/check_email_spec.rb",
-     "spec/extensions/check_file_system_spec.rb",
-     "spec/extensions/check_is_on_path_spec.rb",
-     "spec/extensions/check_mongo_db_spec.rb",
-     "spec/extensions/check_url_spec.rb",
-     "spec/extensions/check_value_spec.rb",
-     "spec/extensions/key_prefix_spec.rb",
-     "spec/fixtures/empty.yml",
-     "spec/fixtures/simple.yml",
-     "spec/how_to_use_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/alainravet/fail_fast}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{raises an error if the yaml contents of a config file does pass a test script.}
-  s.test_files = [
-    "spec/base/base_commands_spec.rb",
-     "spec/base/error_details_spec.rb",
-     "spec/base/errors_storage_spec.rb",
-     "spec/base/file_is_empty_spec.rb",
-     "spec/base/file_is_missing_spec.rb",
-     "spec/base/multiple_blocks_support_spec.rb",
-     "spec/base/not_linked_to_a_file_spec.rb",
-     "spec/base/report_printing_spec.rb",
-     "spec/extensions/check_active_record_db_spec.rb",
-     "spec/extensions/check_email_spec.rb",
-     "spec/extensions/check_file_system_spec.rb",
-     "spec/extensions/check_is_on_path_spec.rb",
-     "spec/extensions/check_mongo_db_spec.rb",
-     "spec/extensions/check_url_spec.rb",
-     "spec/extensions/check_value_spec.rb",
-     "spec/extensions/key_prefix_spec.rb",
-     "spec/how_to_use_spec.rb",
-     "spec/spec_helper.rb"
-  ]
+  s.date          =   Time.now.utc.strftime("%Y-%m-%d")
+  s.homepage      =   'http://github.com/alainravet/fail_fast'
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.summary       =   'raises an error if the yaml contents of a config file does pass a test script.'
+  s.description   =   'raises an error if the yaml contents of a config file does pass a test script.'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_development_dependency(%q<activerecord>, [">= 0"])
-      s.add_development_dependency(%q<mongo>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<activerecord>, [">= 0"])
-      s.add_dependency(%q<mongo>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<activerecord>, [">= 0"])
-    s.add_dependency(%q<mongo>, [">= 0"])
-  end
-end
+  s.authors       =   'Alain Ravet'
+  s.email         =   'alain.ravet@gmail.com'
+  s.extra_rdoc_files = %w(LICENSE README.markdown)
+  s.rdoc_options  =   ["--charset=UTF-8"]
 
+  s.platform    = Gem::Platform::RUBY
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths =   %w(lib)
+
+  s.add_development_dependency 'rspec',         '= 1.3.2'
+  s.add_development_dependency 'activerecord',  '>= 0'
+  s.add_development_dependency 'mongo',         '>= 0'
+  s.add_development_dependency 'fakeweb'
+end

data/lib/fail_fast/base/base.rb

@@ -34,7 +34,7 @@ class FailFast
       self.instance_eval(&block)
     end
 
-    def print_errors
+    def print_errors #:nodoc:
       @errors = errors
       puts "\n\n\n" + ERB.new(File.read(ERB_TEMPLATE)).result(binding) + "\n\n"
     end

data/lib/fail_fast/base/messaging.rb

@@ -1,6 +1,6 @@
 class FailFast
 
-  module Messaging
+  module Messaging #:nodoc:
 
     def default_message_for(e)
       qc_value  = "'#{vcol(e.value)}'"

data/lib/fail_fast/base/utils.rb

@@ -1,8 +1,9 @@
 class FailFast
 
-  class Params < Struct.new(:key, :value, :regexp, :options) ; end
+  class Params < Struct.new(:key, :value, :regexp, :options) #:nodoc:
+  end
 
-  module Utils
+  module Utils #:nodoc:
 
     def blank?(value)
       value.nil? || (value.is_a?(String) && '' == value.strip)

data/lib/fail_fast/base/z_only_for_tests.rb

@@ -1,10 +1,10 @@
 # ONLY USED BY TESTS !!
 class FailFast
-  def self.global_errors
+  def self.global_errors  #:nodoc:
     @@_errors_db.global_data
   end
 
-  def self.reset_error_db!
+  def self.reset_error_db!  #:nodoc:
     @@_errors_db = ErrorDb.new
   end
 end

data/lib/fail_fast/extensions/directory_exists.rb

@@ -0,0 +1,41 @@
+class FailFast
+  module DirectoryExists
+
+    # Ensure the value is an existing directory
+    #
+    # Usage
+    #   directory_exists '/tmp'
+    #   directory_exists '/tmp', :message => 'custom message'
+    #
+    def directory_exists(path, options={})
+      success = File.exists?(path) && File.directory?(path)
+      unless success
+        add_error ErrorDetails.new(nil, :directory_not_found, path, options[:message])
+      end
+      success
+    end
+
+    # Ensure the key value is an existing directory
+    #
+    # Usage
+    #   directory_exists_for 'foo/config'
+    #   directory_exists_for 'foo/config', :message => 'custom message'
+    #
+    def directory_exists_for(raw_key, *params)
+      p = key_value_regexp_options(raw_key, params)
+      key, options = p.key, p.options
+
+      return false unless has_value_for raw_key, :message => options[:message]
+
+      path = value_for_deep_key(key)
+      success = File.exists?(path) && File.directory?(path)
+      unless success
+        add_error ErrorDetails.new(key, :directory_not_found, p.value, options[:message])
+      end
+      success
+    end
+
+  end
+end
+
+FailFast.send  :include, FailFast::DirectoryExists

data/lib/fail_fast/extensions/file_exists.rb

@@ -0,0 +1,41 @@
+class FailFast
+  module FileExists
+
+    # Ensure the value is an existing file
+    #
+    # Usage
+    #   file_exists '~/.bash_profile'
+    #   file_exists '~/.bash_profile', :message => 'custom message'
+    #
+    def file_exists(path, options={})
+      success = File.exists?(path) && File.file?(path)
+      unless success
+        add_error ErrorDetails.new(nil, :file_not_found, path, options[:message])
+      end
+      success
+    end
+
+    # Ensure the key value is an existing file exists
+    #
+    # Usage
+    #   file_exists_for 'foo/config/app.yml'
+    #   file_exists_for 'foo/config/app.yml', :message => 'custom message'
+    #
+    def file_exists_for(raw_key, *params)
+      p = key_value_regexp_options(raw_key, params)
+      key, options = p.key, p.options
+
+      return false unless has_value_for raw_key, :message => options[:message]
+
+      path = value_for_deep_key(key)
+      success = File.exists?(path) && File.file?(path)
+      unless success
+        add_error ErrorDetails.new(key, :file_not_found, p.value, options[:message])
+      end
+      success
+    end
+
+  end
+end
+
+FailFast.send  :include, FailFast::FileExists

data/lib/fail_fast/extensions/{check_active_record_db.rb → has_active_record_db.rb}

@@ -1,7 +1,7 @@
 require 'active_record'
 
 class FailFast
-  module CheckActiveRecordDB
+  module HasActiveRecordDB
 
     # Ensure the ActiveRecord connection can be established :
     #
@@ -22,6 +22,7 @@ class FailFast
       unless @success
         add_error ErrorDetails.new(nil, :active_record_db_connection_error, @error_message, options[:message])
       end
+      @success
     end
 
     # Ensure the ActiveRecord connection can be established :
@@ -49,12 +50,13 @@ class FailFast
       unless @success
         add_error ErrorDetails.new(key, :active_record_db_connection_error, @error_message, options[:message])
       end
+      @success
     end
 
   end
 end
 
-FailFast.send  :include, FailFast::CheckActiveRecordDB
+FailFast.send  :include, FailFast::HasActiveRecordDB
 
 # ActiveRecord::Base.establish_connection(
 #    :adapter  => "mysql",

data/lib/fail_fast/extensions/{check_email.rb → has_email.rb}

@@ -1,6 +1,6 @@
 class FailFast
 
-  module CheckEmail
+  module HasEmail
     # Usage
     #  has_email_for 'test/admin_email'
     #
@@ -8,16 +8,18 @@ class FailFast
       p = key_value_regexp_options(raw_key, params)
       key, options = p.key, p.options
 
-      return unless has_value_for raw_key, :message =>  options[:message]
+      return false unless has_value_for raw_key, :message =>  options[:message]
 
       value = value_for_deep_key(key)
-      if EmailValidator.invalid_email_address?(value)
+      failure = EmailValidator.invalid_email_address?(value)
+      if failure
         add_error ErrorDetails.new(key, :not_an_email, value, options[:message])
       end
+      !failure
     end
   end
 
-  module EmailValidator
+  module EmailValidator #:nodoc:
     VALID_EMAIL_ADDRESS_REGEXP = /^[a-zA-Z][\w\.-]*[a-zA-Z0-9]@[a-zA-Z0-9][\w\.-]*[a-zA-Z0-9]\.[a-zA-Z][a-zA-Z\.]*[a-zA-Z]$/
 
     def self.valid_email_address?(email)
@@ -31,4 +33,4 @@ class FailFast
   end
 end
 
-FailFast.send  :include, FailFast::CheckEmail
+FailFast.send  :include, FailFast::HasEmail

data/lib/fail_fast/extensions/{check_mongo_db.rb → has_mongo_db.rb}

@@ -1,5 +1,5 @@
 class FailFast
-  module CheckMongoDB
+  module HasMongoDB
 
     # Ensure the mongoDB server can be reached, and the db could be opened :
     #
@@ -18,12 +18,14 @@ class FailFast
         @conn = Mongo::Connection.new(host, port, options)
       rescue Mongo::ConnectionFailure
         add_error ErrorDetails.new(nil, :mongoDB_server_not_found, host, options[:message])
-        return
+        return false
       end
 
-      if db && !@conn.database_names.include?(db)
+      failure = db && !@conn.database_names.include?(db)
+      if failure
         add_error ErrorDetails.new(nil, :mongoDB_db_not_found, db, options[:message])
       end
+      !failure
     end
 
     # Ensure the mongoDB server can be reached, and the db could be opened :
@@ -35,9 +37,9 @@ class FailFast
     def has_mongoDB_for(key, *params)
       p = key_value_regexp_options(key, params)
       key, options = p.key, p.options
-      return unless has_value_for key              , :message => options[:message]
-      return unless has_value_for "#{key}/host"    , :message => options[:message]
-      return unless has_value_for "#{key}/database", :message => options[:message]
+      return false unless has_value_for key              , :message => options[:message]
+      return false unless has_value_for "#{key}/host"    , :message => options[:message]
+      return false unless has_value_for "#{key}/database", :message => options[:message]
 
 
       value = value_for_deep_key(key)
@@ -47,16 +49,18 @@ class FailFast
         @conn = Mongo::Connection.new(host, port)
       rescue Mongo::ConnectionFailure
         add_error ErrorDetails.new(key, :mongoDB_server_not_found, host, options[:message])
-        return
+        return false
       end
 
       must_check_db = !(false == options[:check_database])
-      if must_check_db && !@conn.database_names.include?(db)
+      failure = must_check_db && !@conn.database_names.include?(db)
+      if failure
         add_error ErrorDetails.new(key, :mongoDB_db_not_found, db, options[:message])
       end
+      !failure
     end
 
   end
 end
 
-FailFast.send  :include, FailFast::CheckMongoDB
+FailFast.send  :include, FailFast::HasMongoDB

data/lib/fail_fast/extensions/{check_url.rb → has_url.rb}

@@ -1,6 +1,6 @@
 class FailFast
 
-  module CheckUrl
+  module HasUrl
     # Usage
     #   test if the url is valid :
     #     has_url_for 'test/server_url'
@@ -13,20 +13,22 @@ class FailFast
     def has_url_for(raw_key, *params)
       p = key_value_regexp_options(raw_key, params)
       key, options = p.key, p.options
-      return unless has_value_for raw_key, :message =>  options[:message]
+      return false unless has_value_for raw_key, :message =>  options[:message]
 
       value = value_for_deep_key(key)
       if UrlValidator.invalid_url?(value)
         add_error ErrorDetails.new(key, :not_a_url, value, options[:message])
-        return
+        return false
       end
-      if true==options.delete(:reachable) && UrlValidator.unreachable_url?(value, options)
+      failure = true==options.delete(:reachable) && UrlValidator.unreachable_url?(value, options)
+      if failure
         add_error ErrorDetails.new(key, :url_not_reachable, value, options[:message])
       end
+      !failure
     end
   end
 
-  module UrlValidator
+  module UrlValidator #:nodoc:
     IPv4_PART = /\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]/  # 0-255
     VALID_URL_REGEXP = %r{
       \A
@@ -69,4 +71,4 @@ class FailFast
   end
 end
 
-FailFast.send  :include, FailFast::CheckUrl
+FailFast.send  :include, FailFast::HasUrl

data/lib/fail_fast/extensions/{check_value.rb → has_value.rb}

@@ -1,5 +1,5 @@
 class FailFast
-  module CheckValue
+  module HasValue
 
     # Usage
     #  nda_file = value_of(:nda_file)
@@ -40,10 +40,10 @@ class FailFast
       elsif options.is_a?(Hash) && options[:in].is_a?(Array)
         add_error ErrorDetails.new(key, :value_not_in_array,   p.value, message) unless options[:in].include?(p.value)
       end
-      no_new_error = nof_errors == errors.size
+      success = no_new_error = nof_errors == errors.size
     end
 
   end
 end
 
-FailFast.send  :include, FailFast::CheckValue
+FailFast.send  :include, FailFast::HasValue

data/lib/fail_fast/extensions/{check_is_on_path.rb → is_on_path.rb}

@@ -1,5 +1,5 @@
 class FailFast
-  module CheckIsOnPath
+  module IsOnPath
 
     # Ensure the application is on the path
     #
@@ -8,9 +8,11 @@ class FailFast
     #   is_on_path 'jruby', :message => 'custom message'
     #
     def is_on_path(app, options = {})
-      unless found_on_the_path(app)
+      success = found_on_the_path(app)
+      unless success
         add_error ErrorDetails.new(nil, :not_on_path, app, options[:message])
       end
+      success
     end
 
     # Ensure the key value can be found on the path
@@ -20,19 +22,21 @@ class FailFast
     #   is_on_path_for 'file_compressor', :message => 'custom message'
     #
     def is_on_path_for(key, options = {})
-      return unless has_value_for key, :message =>  options[:message]
+      return false unless has_value_for key, :message =>  options[:message]
       app   = value_for_deep_key(key)
 
-      unless found_on_the_path(app)
+      success = found_on_the_path(app)
+      unless success
         add_error ErrorDetails.new(key, :not_on_path, app, options[:message])
       end
+      success
     end
 
   private
     def found_on_the_path(app)
-      `which #{app}` =~ /#{app}$/
+      !!(`which #{app}` =~ /#{app}$/)
     end
   end
 end
 
-FailFast.send  :include, FailFast::CheckIsOnPath
+FailFast.send  :include, FailFast::IsOnPath

data/lib/fail_fast/main.rb

@@ -20,7 +20,7 @@ class FailFast
     !global_errors.empty?
   end
 
-  def self.errors_db
+  def self.errors_db #:nodoc:
     @@_errors_db
   end
 

data/lib/fail_fast/support/error_db.rb

@@ -1,5 +1,5 @@
 class FailFast
-  class ErrorDb
+  class ErrorDb #:nodoc:
     def initialize
       @@hash = {}
     end

data/lib/fail_fast/support/error_details.rb

@@ -6,11 +6,11 @@ class FailFast::ErrorDetails < Struct.new(:key, :kind, :value, :message)
     @key, @kind, @value, @message = key, kind, value, message
   end
 
-  def has_key_and_kind?(akey, akind)
+  def has_key_and_kind?(akey, akind) #:nodoc:
     (key.to_s == akey.to_s) && kind.to_sym == akind.to_sym
   end
 
-  def has_value_and_kind?(avalue, akind)
+  def has_value_and_kind?(avalue, akind) #:nodoc:
     (value.to_s == avalue.to_s) && kind.to_sym == akind.to_sym
   end
 end

data/lib/fail_fast/support/z_only_for_tests.rb

@@ -1,6 +1,6 @@
 # ONLY USED BY TESTS !!
 class FailFast::ErrorDb
-  def global_data
+  def global_data #:nodoc:
     @@hash.keys.collect {|key|errors_for(key)}.flatten
   end
 end

data/spec/base/base_commands/fail_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "fail()" do
+  it_should_raise_a_direct_error('message-123', :fail, 'when fail() is called') {
+    fail 'message-123'
+  }
+end