fail_fast 0.1.0 → 0.1.1

data/CHANGELOG.txt

@@ -1,2 +1,4 @@
+0.1.1
+  - added command : fail('message')
 0.1.0
   - initial version

data/README.markdown

@@ -1,27 +1,62 @@
 # fail_fast : don't start your application if some preconditions are not met.
 
+## How to install :
+
+    gem install fail_fast
+
 ## How to use :
 
 Early in your project boot sequence insert code like
 
     require 'fail_fast'
     FailFast('database.yml').check do
-      has_active_record_db_for Rails.env
+      has_active_record_db_for  Rails.env
     end
 
     FailFast('database.mongo.yml').check do
-      has_mongoDB_for Rails.env
+      has_mongoDB_for   Rails.env
     end
 
     FailFast('path_to/config.yml', prefix=Rails.env).check do
-      has\_values_for 'author/fname', 'author/lname'
-      has\_url_for 'bug_tracker/url', :reachable => true
-      has\_email_for 'newsletter/to_address'
+      has_values_for    'author/fname', 'author/lname'
+      has_email_for     'newsletter/to_address'
+      has_url_for       'bug_tracker/url', :reachable => true
 
       directory_exists_for  '/tmp'
       file_exists_for       'public/nda.pdf'
+
+      fail "I don't work on Sunday" if 0 == Time.now.wday
     end
 
+If it fails, you'll get a report like this :
+    
+    +------------------------------------------------------------------------------------------
+    |   FAIL_FAST error : "./spec/fixtures/simple.yml"
+    |   key prefix  = nil
+    +------------------------------------------------------------------------------------------
+    |      error                                   key                                value
+    +------------------------------------------------------------------------------------------
+    |  * missing_value                          first_keyNOT                                                       
+    |  * missing_value                          last_keyNOT                                                        
+    |  * missing_value                          number_sixNOT                                                      
+    |  * missing_value                          testNOT/mongoDB/database                                           
+    |  * value_does_not_match                   last_key                            dernier                        
+    |  * not_an_email                           test/host                           localhost                      
+    |  * 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     
+    |  * file_not_found                                                             /tmp/foo/bar/??nOTaFile        
+    |  * 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                 
+    |  * mongoDB_db_not_found                   test/unknown_mongoDB_db             unknown_mongoDB_db             
+    |  * active_record_db_connection_error                                          Unknown database 'some-db'     
+    |  * active_record_db_connection_error      db_connection                       Unknown database 'a_db'
+    |  * fail                                                                       a custom failure message
+    +------------------------------------------------------------------------------------------
+
 
 ## Info :
 
@@ -49,10 +84,10 @@ You can also add custom rules, not related to any config files :
 
 ### _free/direct_ commands (not linked to the yaml file contents) :
 
-    directory_exists  '/tmp'
-    file_exists       '/Users/me/.bash_profile'
-    has_mongoDB           'localhost', 'db_app_1'
-    has_active_record_db  :host => 'dbserv', :adapter => 'mysql', :database => 'db'
+      directory_exists      '/tmp'
+      file_exists           '/Users/me/.bash_profile'
+      has_mongoDB           'localhost', 'db_app_1'
+      has_active_record_db  :host => 'dbserv', :adapter => 'mysql', :database => 'db'
 
 
 ### _keyed_ commands (linked to a value found in a yaml file) :
@@ -61,8 +96,8 @@ You can also add custom rules, not related to any config files :
 
 *presence :*
 
-      has_value_for :application_name
-      has_values_for 'author/fname', 'author/lname'
+      has_value_for   :application_name
+      has_values_for  'author/fname', 'author/lname'
 
 *contents <-> a regexp or pattern :*
 
@@ -72,20 +107,20 @@ You can also add custom rules, not related to any config files :
 
 Test the file system :
 
-      directory_exists_for  'public/assets'
-      file_exists_for       'public/500_custom.html'
+      directory_exists_for  'assets-upload_dir'
+      file_exists_for       'assets-nda_pdf_file'
 
 Test external services :
 
-    # is a webserver up ?
-    has_url_for 'bug_tracker/url', :reachable => true
-    has_url_for 'bug_tracker/url', :reachable => true, :may_add_trailing_slash => true
+      # is a webserver up ?
+      has_url_for     'bug_tracker/url', :reachable => true
+      has_url_for     'bug_tracker/url', :reachable => true, :may_add_trailing_slash => true
 
 
-    # can we connect to a mongoDB db/server :
-    has_mongoDB_for 'test/mongoDB'
-    has_mongoDB_for 'test/unknown_mongoDB_db', :check_database => false
+      # can we connect to a mongoDB db/server :
+      has_mongoDB_for   'test/mongoDB'
+      has_mongoDB_for   'test/unknown_mongoDB_db', :check_database => false
 
-    # can we connect to a SQL db :
-    has_active_record_db_for 'production/db_connection'
+      # can we connect to a SQL db :
+      has_active_record_db_for 'production/db_connection'
 

data/Rakefile

@@ -11,6 +11,7 @@ begin
     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

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/fail_fast.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fail_fast}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alain Ravet"]
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
      "lib/fail_fast/check_url.rb",
      "lib/fail_fast/check_value.rb",
      "lib/fail_fast/main.rb",
+     "lib/fail_fast/misc.rb",
      "lib/fail_fast/report.txt.erb",
      "show_all_errors.rb",
      "spec/file_is_empty_spec.rb",
@@ -46,6 +47,7 @@ Gem::Specification.new do |s|
      "spec/has_url_for_spec.rb",
      "spec/has_value_for_spec.rb",
      "spec/how_to_use_spec.rb",
+     "spec/misc_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -64,6 +66,7 @@ Gem::Specification.new do |s|
      "spec/has_url_for_spec.rb",
      "spec/has_value_for_spec.rb",
      "spec/how_to_use_spec.rb",
+     "spec/misc_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -73,13 +76,16 @@ Gem::Specification.new do |s|
 
     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

data/lib/fail_fast/misc.rb

@@ -0,0 +1,13 @@
+class FailFast
+  module Misc
+
+    # Usage
+    #   if 0 == Time.now.wday
+    #     fail "I don't work on Sunday""
+    #   end
+    def fail(message)
+      FailFast.errors << ErrorDetails.new(nil, :fail, message)
+    end
+  end
+end
+FailFast.send  :include, FailFast::Misc

data/lib/fail_fast.rb

@@ -6,6 +6,7 @@ require 'fail_fast/check_mongo_db'
 require 'fail_fast/check_active_record_db'
 require 'fail_fast/check_url'
 require 'fail_fast/check_email'
+require 'fail_fast/misc'
 
 
 def FailFast(path, prefix=nil)

data/show_all_errors.rb

@@ -60,4 +60,7 @@ FailFast(SPEC_DIR + '/fixtures/simple.yml').check do
 #test ActiveRecord
   has_active_record_db      :host => 'localhost', :adapter => 'mysql', :database=> 'some-db'
   has_active_record_db_for  'db_connection'
+
+#misc
+  fail 'a custom failure message'
 end

data/spec/misc_spec.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fail_fast
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Alain Ravet
@@ -35,7 +35,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: mongo
+  name: activerecord
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -48,6 +48,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: raises an error if the yaml contents of a config file does not pass a test script.
 email: alainravet@gmail.com
 executables: []
@@ -74,6 +88,7 @@ files:
 - lib/fail_fast/check_url.rb
 - lib/fail_fast/check_value.rb
 - lib/fail_fast/main.rb
+- lib/fail_fast/misc.rb
 - lib/fail_fast/report.txt.erb
 - show_all_errors.rb
 - spec/file_is_empty_spec.rb
@@ -87,6 +102,7 @@ files:
 - spec/has_url_for_spec.rb
 - spec/has_value_for_spec.rb
 - spec/how_to_use_spec.rb
+- spec/misc_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -133,4 +149,5 @@ test_files:
 - spec/has_url_for_spec.rb
 - spec/has_value_for_spec.rb
 - spec/how_to_use_spec.rb
+- spec/misc_spec.rb
 - spec/spec_helper.rb