solid_assert 0.7.2 → 0.7.3

data/README.md

@@ -1,12 +1,12 @@
 # solid_assert
 
-*solid_assert* is a simple implementation of an `assert` utility in Ruby. It let you code tests for your assumptions inside your code itself. 
+*solid_assert* is a simple implementation of an `assert` utility in Ruby. It let you write tests for your assumptions while coding. 
 
 Assertions are meant to test conditions about the integrity of your code. You should use them for testing assumptions like the following:
 
 - If the flow reaches here, then this variable has to have this value.
 - This line of code should never be executed.
-- At this point, this list should contain one entry for all the keys in this hash.
+- At this point, this list should contain one entry for each key in this hash.
 
 Notice that assertions shouldn't be used for handling error situations. Use Ruby built-in exception handling for that.
 
@@ -16,39 +16,59 @@ Assertions are typically used in development mode. You might want to disable the
 
 In your `Gemfile`
 
-	gem "solid_assert"
+```ruby
+gem "solid_assert"
+```
 
 # Usage
 
 You can enable assertions with
 
-	SolidAssert.enable_assertions
+```ruby
+SolidAssert.enable_assertions
+```
 
 Assertions are disabled by default.
 
 Use `assert` for testing conditions. You can optionally provide a message
 
-	assert some_string != "some value"
-	assert clients.empty?, "Isn't the clients list empty?"
-	
+```ruby
+assert some_string != "some value"
+assert clients.empty?, "Isn't the clients list empty?"
+```
+
 Use `invariant` for testing blocks of code. This comes handy when testing your assumptions requires several lines of code. You can provide an optional message if you want
 
-	invariant do
-		one_variable = calculate_some_value
-		other_variable = calculate_some_other_value
-		one_variable > other_variable
-	end
+```ruby
+invariant do
+	one_variable = calculate_some_value
+	other_variable = calculate_some_other_value
+	one_variable > other_variable
+end
+```
+
+```ruby
+invariant "Lists with different sizes?" do
+	one_variable = calculate_some_value
+	other_variable = calculate_some_other_value
+	one_variable > other_variable
+end
+```
+
+## Rails
+
+Create a file named `solid_assert.rb` in the `config/initializers` dir with the following content:
+
+```ruby
+SolidAssert.enable_assertions if !Rails.env.production?
+```
 
-	invariant "Have the lists had different sizes?" do
-		one_variable = calculate_some_value
-		other_variable = calculate_some_other_value
-		one_variable > other_variable
-	end
+This way assertions will be disabled in production and enabled in the rest of environments
 
 ## References
 
-- [Programming with assertions](http://download.oracle.com/javase/1.4.2/docs/guide/lang/assert.html). A great article on assertions. It is about the Java language, but the concepts it explains apply to any programming language.
-- [Writing Solid Code](http://www.amazon.com/Writing-Solid-Code-Microsoft-Programming/dp/1556155514). A great book on good coding design practices. Again, it based in C, but the practices it talks about apply to coding in any programming language.
+- [Programming with assertions](http://download.oracle.com/javase/1.4.2/docs/guide/lang/assert.html). A great article on assertions. It is about the Java language, but the concepts apply to any programming language.
+- There are good references to assertive programming in some classic books like [The Pragmatic Programmer From Journeyman to Master](http://www.amazon.com/exec/obidos/ASIN/020161622X/ref=nosim/jorgmanrpersp-20), [Code Complete](http://www.amazon.com/exec/obidos/ASIN/0735619670/ref=nosim/jorgmanrpersp-20) and [Writing solid code](http://www.amazon.com/exec/obidos/ASIN/1556155514/ref=nosim/jorgmanrpersp-20)
 
 
 

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.7.3

data/solid_assert.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{solid_assert}
-  s.version = "0.7.2"
+  s.version = "0.7.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Jorge Manrubia}]
-  s.date = %q{2011-09-19}
+  s.date = %q{2011-09-20}
   s.description = %q{Assert utility for ruby. It let you code your assumptions and code invariants, so they are checked automatically. It can be deactivated, so you it doesn't affect to your program performance (for example, in production)'}
   s.email = %q{jorge.manrubia@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: solid_assert
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 7
-  - 2
-  version: 0.7.2
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Jorge Manrubia
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-19 00:00:00 Z
+date: 2011-09-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development