fail_fast 0.2.1 → 0.3.0

data/CHANGELOG.txt

@@ -1,3 +1,6 @@
+0.3.0
+  - added value_of()
+  - added checks not linked to a config file  (FailFast().check do .. end)  
 0.2.1
   - improve + colour the report template
 0.2.0

data/README.markdown

@@ -7,7 +7,30 @@
 ## How to use :
 
 
-### Case 1 : don't start the application if the DB cannot be reached.
+### Example 0 : don't start the application if '_why' cannot be found (on the PATH).
+
+Insert this code early in your program starting sequence :
+
+	require 'fail_fast'
+	FailFast().check do
+      fail '_why could not be found on the path' unless `which _why` =~ /_why$/
+	end
+
+
+If _\_why_ can't be found :  
+* the application will exit immediately and    
+* you will see this report :
+
+
+    +------------------------------------------------------------------------------------------
+    |   FAIL_FAST error : precondition(s) not met.
+    +------------------------------------------------------------------------------------------
+    |  _why could not be found on the path
+    +------------------------------------------------------------------------------------------
+
+
+
+### Example 1 : don't start the application if the DB cannot be reached.
 
 Early in your project boot sequence insert this code :
 
@@ -19,14 +42,13 @@ Early in your project boot sequence insert this code :
 
 If the DB connection fails,   
 * the application will exit immediately and    
-* you'll see this report :
+* you will see this report :
   
 
     +------------------------------------------------------------------------------------------
     |   FAIL_FAST error : precondition(s) not met in
     |  -----------------
     |     file         :  "path/to/database.yml"
-    |     keys prefix  :  (none)
     +------------------------------------------------------------------------------------------
     |      error                                   key                                value
     +------------------------------------------------------------------------------------------
@@ -34,9 +56,9 @@ If the DB connection fails,
     +------------------------------------------------------------------------------------------
 
 Remark :  `check` will call `exit(1)` at the end of the first block with an error.   
-If you want to collect and report all the errors before exiting, use `check_now.but_fail_later` (see case 2 below).
+If you want to collect and report all the errors before exiting, use `check_now.but_fail_later` (see Example 2 below).
 
-### Case 2 : collect errors in multiple blocks.
+### Example 2 : collect errors in multiple blocks.
 
 
 	require 'fail_fast'
@@ -109,7 +131,7 @@ If it fails, you'll get a report like this :
     |  * fail                                                                       a custom failure message
     +------------------------------------------------------------------------------------------
 
-### Case 3 : print an additional custom message if errors were detected
+### Example 3 : print an additional custom message if errors were detected
 
 	...	# code like in the cases above.
 
@@ -123,8 +145,7 @@ If it fails, you'll get a report like this :
 
 ## Info :
 
-Failing fast is important.   
-This gem DSL lets you write tests scripts that run early in the boot sequence of an application.    
+This gem DSL lets you write preconditions-scripts that you run early in the boot sequence of an application.
 An exception is raised if one or more tests fail, and you get a detailled report of all the problems encountered.
 
 Some rules are based on the contents of configuration files (database.yml, config.yml, etc...) :   
@@ -169,6 +190,11 @@ You can also add custom rules, not related to any config files :
 	has_url_for     'bug_tracker/url'   
 	has_email_for   'newsletter/to_address'   
 
+* customize it
+
+    nda_file = value_of(:nda_file)
+    fail 'NDA is too old' if (Time.now - File.mtime(nda_file))  > (24 * 60 * 60) * 365
+
 Test the file system :
 
 	directory_exists_for  'assets-upload_dir'

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/fail_fast.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fail_fast}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alain Ravet"]
-  s.date = %q{2010-07-05}
+  s.date = %q{2010-07-17}
   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 = [
@@ -42,21 +42,22 @@ Gem::Specification.new do |s|
      "lib/fail_fast/support/error_details.rb",
      "lib/fail_fast/support/z_only_for_tests.rb",
      "show_all_errors.rb",
-     "spec/base_commands_spec.rb",
-     "spec/check_active_record_db_spec.rb",
-     "spec/check_email_spec.rb",
-     "spec/check_file_system_spec.rb",
-     "spec/check_mongo_db_spec.rb",
-     "spec/check_url_spec.rb",
-     "spec/check_value_spec.rb",
-     "spec/errors_storage_spec.rb",
-     "spec/file_is_empty_spec.rb",
-     "spec/file_is_missing_spec.rb",
+     "spec/base/base_commands_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_mongo_db_spec.rb",
+     "spec/extensions/check_url_spec.rb",
+     "spec/extensions/check_value_spec.rb",
      "spec/fixtures/empty.yml",
      "spec/fixtures/simple.yml",
      "spec/how_to_use_spec.rb",
-     "spec/multiple_blocks_support_spec.rb",
-     "spec/report_printing_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -66,19 +67,20 @@ Gem::Specification.new do |s|
   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_commands_spec.rb",
-     "spec/check_active_record_db_spec.rb",
-     "spec/check_email_spec.rb",
-     "spec/check_file_system_spec.rb",
-     "spec/check_mongo_db_spec.rb",
-     "spec/check_url_spec.rb",
-     "spec/check_value_spec.rb",
-     "spec/errors_storage_spec.rb",
-     "spec/file_is_empty_spec.rb",
-     "spec/file_is_missing_spec.rb",
+    "spec/base/base_commands_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_mongo_db_spec.rb",
+     "spec/extensions/check_url_spec.rb",
+     "spec/extensions/check_value_spec.rb",
      "spec/how_to_use_spec.rb",
-     "spec/multiple_blocks_support_spec.rb",
-     "spec/report_printing_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/fail_fast/base/base.rb

@@ -5,7 +5,7 @@ class FailFast
     def check(&block)
       fail_now_mode   = block_given? # false in the case of  *.check_now.but_fail_now do .. end
 
-      @config_file_not_found = !File.exist?(@config_file_path)
+      @config_file_not_found = @config_file_path && !File.exist?(@config_file_path)
       if @config_file_not_found
         add_error ErrorDetails.new(nil, :config_file_not_found, @config_file_path)
       else
@@ -30,7 +30,7 @@ class FailFast
   private
 
     def check_all_rules(&block)
-      @yaml_config_as_hash = YAML.load(ERB.new(File.read(@config_file_path)).result) || {}
+      @yaml_config_as_hash = (@config_file_path && YAML.load(ERB.new(File.read(@config_file_path)).result)) || {}
       self.instance_eval(&block)
     end
 

data/lib/fail_fast/extensions/check_value.rb

@@ -1,6 +1,14 @@
 class FailFast
   module CheckValue
 
+    # Usage
+    #  nda_file = value_of(:nda_file)
+    #
+    def value_of(key)
+      key_value_regexp_options(key, []).value
+    end
+
+
     # Usage
     #  has_values_for :sym_key, 'str_key'
     #

data/lib/fail_fast/report.txt.erb

@@ -1,10 +1,15 @@
+<% if @config_file_path %>
 +------------------------------------------------------------------------------------------
 |   FAIL_FAST error : precondition(s) not met in
 |  -----------------
 |     file         :  "<%= @config_file_path %>"
-|     keys prefix  :  <%= @keys_prefix ?  @keys_prefix.inspect : 'none' %>
+<% if @keys_prefix%>|     keys prefix  :  <%= @keys_prefix ?  @keys_prefix.inspect : 'none' %>
+<% end %>+------------------------------------------------------------------------------------------
+<% else %>
 +------------------------------------------------------------------------------------------
-<% @errors.each do |e|
+|   FAIL_FAST error : precondition(s) not met.
++------------------------------------------------------------------------------------------
+<% end %><% @errors.each do |e|
     @msg = case e.kind
         when :config_file_not_found
           red("The config file could not be found") + " : '#{yellow(lred(e.value))}'."

data/lib/fail_fast.rb

@@ -5,7 +5,7 @@ Dir.glob(File.dirname(__FILE__) + '/fail_fast/extensions/*.rb') {|file| require
 
 
 # alternative syntax
-def FailFast(config_file_path, keys_prefix=nil)
+def FailFast(config_file_path=nil, keys_prefix=nil)
   FailFast.new(config_file_path, keys_prefix)
 end
 

data/show_all_errors.rb

@@ -29,6 +29,9 @@ require 'fail_fast'
 FailFast('unknown-file').check_now.but_fail_later do
 end
 
+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
 
@@ -44,6 +47,9 @@ FailFast(SPEC_DIR + '/fixtures/simple.yml').check_now.but_fail_later do
   fake_http_server
   has_url_for 'test/host'                         # value is not a url
 
+  nda_file = value_of(:nda_file)
+  fail 'NDA is too old' if (Time.now - File.mtime(nda_file))  > (24 * 60 * 60) * 365
+
 #test http server :
   has_url_for 'test/url_not_reachable', :reachable => true #server is not reachable
 
@@ -69,6 +75,13 @@ FailFast(SPEC_DIR + '/fixtures/simple.yml').check_now.but_fail_later do
 
 #misc
   fail 'a custom failure message'
+
+#handmade :
+  fail 'zruby is not on the path' unless `which zruby` =~ /zruby$/
+
+  nda_file = value_of(:nda_file)
+  fail 'NDA is too old' if (Time.now - File.mtime(nda_file))  > (24 * 60 * 60) * 365
+
 end
 
 if FailFast.failed?

data/spec/{base_commands_spec.rb → base/base_commands_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+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') {

data/spec/{errors_storage_spec.rb → base/errors_storage_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "errors" do
   before(:each) { capture_stdout }

data/spec/{file_is_empty_spec.rb → base/file_is_empty_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "ConfigCheck on an empty file" do
   before(:each) { capture_stdout }

data/spec/{file_is_missing_spec.rb → base/file_is_missing_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "ConfigCheck on an unknown file" do
   before(:all) { capture_stdout }

data/spec/{multiple_blocks_support_spec.rb → base/multiple_blocks_support_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "FailFast.check_now.but_fail_later" do
   before(:all) { capture_stdout }

data/spec/base/not_linked_to_a_file_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "check not linked to a config file" do
+  before(:each) { capture_stdout }
+  after( :each) { restore_stdout }
+
+
+  it "should not raise an error when there are no checks" do
+    lambda {
+      FailFast().check do end
+    }.should_not raise_error
+    FailFast.failed?.should be_false
+  end
+
+  it "should raise an error when there is a failing check" do
+    lambda {
+      FailFast().check do
+        fail 'error'
+      end
+    }.should raise_error(ExitTriggered)
+    FailFast.failed?.should be_true
+  end
+
+  it "should raise a delayed error when there is a failing check" do
+    lambda {
+      FailFast().check_now.but_fail_later do
+        fail 'error'
+      end
+    }.should_not raise_error
+    lambda {
+      FailFast.fail_now
+    }.should raise_error(ExitTriggered)
+    FailFast.global_errors.collect(&:kind).should == [:fail]
+  end
+
+end

data/spec/{report_printing_spec.rb → base/report_printing_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "the printed error report" do
   before(:each) { capture_stdout }
@@ -9,13 +9,13 @@ describe "the printed error report" do
       FailFast(SIMPLE_FILE_PATH).check { has_value_for :anykey }
     rescue
     end
-    $stdout.string.should match(/error.*#{SIMPLE_FILE_PATH}.*missing_value/mi)
+    $stdout.string.should match(/error.*#{SIMPLE_FILE_PATH}.*missing value/mi)
   end
 
 
   it "contains an error details, even when we delay the failing" do
     FailFast(SIMPLE_FILE_PATH).check_now.but_fail_later { has_value_for :unknown_key }
-    $stdout.string.should match(/error.*#{SIMPLE_FILE_PATH}.*missing_value/mi)
+    $stdout.string.should match(/error.*#{SIMPLE_FILE_PATH}.*missing value/mi)
     $stdout.string.should match(/error.*#{SIMPLE_FILE_PATH}.*unknown_key/mi)
   end
 

data/spec/{check_active_record_db_spec.rb → extensions/check_active_record_db_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe 'has_ar_db' do
   context '' do

data/spec/{check_email_spec.rb → extensions/check_email_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe 'has_email_for()' do
   it_should_not_raise_an_error('when the value is an email') {

data/spec/{check_file_system_spec.rb → extensions/check_file_system_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 a_dir   = SPEC_DIR + '/fixtures'
 a_file  = SPEC_DIR + '/fixtures/simple.yml'

data/spec/{check_mongo_db_spec.rb → extensions/check_mongo_db_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe 'has_mongoDB' do
 

data/spec/{check_url_spec.rb → extensions/check_url_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe 'has_url_for()' do
 before(:all) do

data/spec/{check_value_spec.rb → extensions/check_value_spec.rb}

@@ -1,4 +1,31 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'value_of()' do
+  it 'should return nil when the value is blank' do
+    FailFast(SIMPLE_FILE_PATH).check { @@val = value_of(:key_with_blank_value) }
+    @@val.should be_nil
+  end
+
+  it 'should return nil when the key is unknown' do
+    FailFast(EMPTY_FILE_PATH).check { @@val = value_of(:anykey) }
+    @@val.should be_nil
+  end
+  it 'should return the value when it is a leaf'do
+    FailFast(SIMPLE_FILE_PATH).check { @@val = value_of(:first_key) }
+    @@val.should == 'premier'
+  end
+
+  it 'should return the values in a hash when the value is a tree' do
+    FailFast(SIMPLE_FILE_PATH).check { @@val = value_of(:test) }
+    @@val.should be_a(Hash)
+    @@val['mongoDB']['host'].should == 'localhost'
+  end
+
+  it 'should preprend the prefix to the key' do
+    FailFast(SIMPLE_FILE_PATH, 'test').check { @@val = value_of(:mongoDB) }
+    @@val['host'].should == 'localhost'
+  end
+end
 
 describe 'has_value_for()' do
 

data/spec/fixtures/simple.yml

@@ -30,3 +30,4 @@ db_connection:
 
 number_six: 6
 letter_x: x
+nda_file: <%= SPEC_DIR + '/fixtures/simple.yml' %>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fail_fast
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Alain Ravet
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-05 00:00:00 +02:00
+date: 2010-07-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,21 +97,22 @@ files:
 - lib/fail_fast/support/error_details.rb
 - lib/fail_fast/support/z_only_for_tests.rb
 - show_all_errors.rb
-- spec/base_commands_spec.rb
-- spec/check_active_record_db_spec.rb
-- spec/check_email_spec.rb
-- spec/check_file_system_spec.rb
-- spec/check_mongo_db_spec.rb
-- spec/check_url_spec.rb
-- spec/check_value_spec.rb
-- spec/errors_storage_spec.rb
-- spec/file_is_empty_spec.rb
-- spec/file_is_missing_spec.rb
+- spec/base/base_commands_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_mongo_db_spec.rb
+- spec/extensions/check_url_spec.rb
+- spec/extensions/check_value_spec.rb
 - spec/fixtures/empty.yml
 - spec/fixtures/simple.yml
 - spec/how_to_use_spec.rb
-- spec/multiple_blocks_support_spec.rb
-- spec/report_printing_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -149,17 +150,18 @@ signing_key:
 specification_version: 3
 summary: raises an error if the yaml contents of a config file does pass a test script.
 test_files: 
-- spec/base_commands_spec.rb
-- spec/check_active_record_db_spec.rb
-- spec/check_email_spec.rb
-- spec/check_file_system_spec.rb
-- spec/check_mongo_db_spec.rb
-- spec/check_url_spec.rb
-- spec/check_value_spec.rb
-- spec/errors_storage_spec.rb
-- spec/file_is_empty_spec.rb
-- spec/file_is_missing_spec.rb
+- spec/base/base_commands_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_mongo_db_spec.rb
+- spec/extensions/check_url_spec.rb
+- spec/extensions/check_value_spec.rb
 - spec/how_to_use_spec.rb
-- spec/multiple_blocks_support_spec.rb
-- spec/report_printing_spec.rb
 - spec/spec_helper.rb