slacker 0.0.7 → 0.0.8

data/lib/slacker/version.rb

@@ -1,3 +1,3 @@
 module Slacker
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/slacker_new/project/spec/sample_1.rb

@@ -1,65 +1,73 @@
-# describe opens up an example group
+# Method describe opens up an example group.
 describe 'My database' do
-  # Simple example which demonstrates inline query against the database
+  # Simple example which demonstrates inline query against the database.
   it 'contains system tables' do
-    # Select all system objects in the database
-    # Whe should have at least one of those
+    # Select all system objects in the database.
+    # We should have at least one of those.
     query_result = query("select * from sysobjects where xtype = 'S';")
     query_result.count.should > 0
   end
 
-  # The same query, this time using a SQL template
+  # The same query, this time using a SQL template.
   # See file sql/sample_1/sysobject.sql.erb
   it 'contains system tables (take two)' do
-    # Every sub-folder of the sql folder appears as an sql object
-    # and every *.sql.erb file within sql or an sql subfolder appears as a method of this object
-    # At the root of all sql objects is the sql folder accessible through the "sql" object
+    # SQL templates are located in the sql folder and are accessible through the "sql" object (see below).
+    # Each sub-folder of the sql folder appears as a sql object contained within its parent startint at the root - the "sql" object.
+    # Each template file (*.sql.erb) appears as a method of the folder it appears in.
+    # 
+    # For example, the file sysobjects.sql.erb is located in "sql/sample_1/",
+    # so it is accessible like this:
+    # sql.sample_1.sysobjects
+    
     query_result = sql.sample_1.sysobjects
     query_result.count.should > 0
   end
 
-  # This time we'll use a parameterized template
+  # This time we'll use a parameterized template.
   # See file sql/sample_1/sysobject_with_params.sql.erb
   it 'contains system tables (take three)' do
-    # Every file with extension .sql.erb located in the sql folder, becomes a method of object sql
+    # You can pass a hash to any SQL template - this hash becomes available to the
+    # template through the "options" object - see file sql/sample_1/sysobject_with_params.sql.erb as an example.
     query_result = sql.sample_1.sysobjects_with_params(:xtype => 'S')
     query_result.count.should > 0
   end
 
-  # Let's create a table and count our user objects which match this table name
-  # We should get one
+  # Let's create a table and count our user objects which match this table name.
+  # Every "it" (example) is executed in a transaction which is rolled back once the example is complete.
+  # This ensures that every example starts at the same state of the database as any other example in the spec.
+  # No example can ever interfere witht the results of another example.
   it 'contains a user table when one is created' do
     # Use inline query to create the table
     query('create table MyTable(id int, name varchar(100));')
 
-    # Now lookup the table by type and name using a more elaborate dynamic SQL template
+    # Now lookup the table by type and name using a more elaborate dynamic SQL template.
     # See template sql/sample_1/sysobject_with_params_2.sql.erb
     query_result = sql.sample_1.sysobjects_with_params_2(:xtype => 'U', :name => 'MyTable')
     query_result.count.should == 1
   end
 
-  # SQL Templates can contain multiple statements and can return multiple resultsets
+  # SQL Templates can contain multiple statements and can return multiple resultsets.
   it 'can play with numbers' do
-    # Note that we're calling the template with a block
-    # When called with a block, a template is executed and its result is accessible
-    # from within the block through the "results" object
+    # Note that this time we're calling the template with a block.
+    # When called with a block, a template is executed and its results are accessible
+    # from within the block through the "results" object.
     sql.sample_1.play_with_numbers(:x => 2, :y => 12) do
-      # The results object contains an array of all the resultsets generated by the query script
+      # The results object contains an array of all the resultsets generated by the query script.
       first_resultset = results[0]
 
-      # A resultset contains an array of records
-      # Each record is a hash of field => value pairs
+      # A resultset contains an array of records.
+      # Each record is a hash of field => value pairs.
       first_resultset[0][:product].should == 24
 
-      # A resultset can be matched directly against an array of hashes
+      # A resultset can be matched directly against an array of hashes using the "match" method.
       second_resultset = results[1]
       second_resultset.should match([{:x => 2, :y => 12, :sum => 14}])
 
-      # Of course this works too
+      # Of course this works too:
       results[1].should match([{:x => 2, :y => 12, :sum => 14}])
 
-      # Or a resultset's values can be matched one-by-one
-      # Note that this resultset contains two records
+      # Or a resultset's values can be matched one-by-one.
+      # Note that the third resultset contains two records:
       third_resultset = results[2]
       third_resultset[0][:p].should == 2
       third_resultset[0][:s].should == 34

metadata

@@ -2,7 +2,7 @@
 name: slacker
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Vassil Kovatchev
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-23 00:00:00 Z
+date: 2011-06-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler