slacker 0.0.5 → 0.0.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slacker (0.0.4)
+    slacker (0.0.5)
       bundler (~> 1.0.15)
       rspec (= 2.5.0)
       ruby-odbc (= 0.99994)

data/README.markdown

@@ -7,10 +7,40 @@ __Slacker__ is a Ruby (RSpec-based) framework for developing automated tests for
 # Install
     gem install slacker
 
-__Slacker__ automatically installs the following gems:
+The following gems are installed automatically:
 
 * rspec 2.5.0
 * ruby-odbc 0.99994
 
-__Slacker__ runs on Windows and Linux.<br/>
-Before installing __Slacker__ on Windows, you need to install the Windows DevKit (ruby-odbc contains native extensions).
+## Requirements
+
+__Slacker__ requires Ruby 1.9.2 running on Windows or Linux.
+
+Before installing __Slacker__ on Windows, you need to install the [Ruby Windows Development Kit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit) (__ruby-odbc__ contains native extensions).
+
+# Documentation TODO
+
+Document the following features:
+
+* Slacker project
+ * Project structure
+ * Configuration
+* Running Slacker
+* DSL
+* SQL Templates
+* Data Fixtures
+* Test Matrices
+* Generated SQL
+* Debugging
+
+
+# LICENSE
+(The MIT License)
+
+Copyright (c) 2011 Vassil Kovatchev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/slacker_new

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'fileutils'
+
+def usage
+<<END
+Use slacker_new to create a new Slacker project:
+
+slacker_new <project_name>
+END
+end
+
+def project_template_path
+  File.expand_path("#{File.dirname(__FILE__)}/../lib/slacker_new/project")
+end
+
+def slacker_new(project_name)
+  files = Dir.glob("#{project_template_path}/**")
+  FileUtils.mkdir(project_name) unless File.exist?(project_name)
+  FileUtils.cp_r(files, project_name)
+end
+
+def project_template_files(project_name)
+  files = Dir.glob("#{project_template_path}/**/*").map{|file| file.gsub(/^#{Regexp.escape(project_template_path)}\//, "./#{project_name}/")}
+end
+
+if ARGV.count != 1
+  puts usage
+else
+  project_name = ARGV[0]
+  puts "Creating project #{project_name}..."
+  slacker_new(project_name)
+  puts project_template_files(project_name)
+end

data/lib/slacker/application.rb

@@ -125,7 +125,11 @@ EOF
         a['TDS_Version'] = '7.0' #Used by the linux driver
       end
 
-      @database.drvconnect(drv)
+      begin
+        @database.drvconnect(drv)
+      rescue ODBC::Error => e
+        throw_error("#{e.class}: #{e.message}")
+      end
     end
 
     # Run a script against the currently configured database

data/lib/slacker/rspec_ext.rb

@@ -14,6 +14,10 @@ module Slacker
       @results
     end
 
+    def results
+      @results
+    end
+
     def result(index = 1, options = {})
       # Flatten the result in case we're getting a multi-result-set response
       res = case !@results.empty? && @results[0].kind_of?(Array)

data/lib/slacker/version.rb

@@ -1,3 +1,3 @@
 module Slacker
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/slacker_new/project/database.yml

@@ -0,0 +1,9 @@
+# Database connection
+# When Slacker is executed, it will attempt to connect to this database
+
+# Replace the following with your connection information
+# Note that at this point Slacker only works with SQL Server authentication
+server: my_server
+database: my_database
+user: user_name
+password: password

data/lib/slacker_new/project/lib/helpers/my_helper.rb

@@ -0,0 +1,2 @@
+module MyHelper
+end

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

@@ -0,0 +1,70 @@
+# describe opens up an example group
+describe 'My database' do
+  # 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
+    query_result = query("select * from sysobjects where xtype = 'S';")
+    query_result.count.should > 0
+  end
+
+  # 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
+    query_result = sql.sample_1.sysobjects
+    query_result.count.should > 0
+  end
+
+  # 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
+    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
+  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
+    # 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
+  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
+    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
+      first_resultset = results[0]
+
+      # 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
+      second_resultset = results[1]
+      second_resultset.should match([{:x => 2, :y => 12, :sum => 14}])
+
+      # 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
+      third_resultset = results[2]
+      third_resultset[0][:p].should == 2
+      third_resultset[0][:s].should == 34
+      third_resultset[1][:p].should == 12
+      third_resultset[1][:s].should == 44
+    end
+  end
+end

data/lib/slacker_new/project/sql/sample_1/play_with_numbers.sql.erb

@@ -0,0 +1,16 @@
+declare @x int;
+declare @y int;
+
+set @x = <%= options[:x]%>;
+set @y = <%= options[:y]%>;
+
+-- Return just the product of @x and @y
+select @x * @y [product] union all
+select 12;
+
+-- Return the numbers and their sum
+select @x x, @y y, @x + @y [sum];
+
+-- Get the two numbers in one column and their sum with 32 in another
+select @x p, @x + 32 s union all
+select @y p, @y + 32 s;

data/lib/slacker_new/project/sql/sample_1/sysobjects.sql.erb

@@ -0,0 +1 @@
+select * from sysobjects where xtype = 'S';

data/lib/slacker_new/project/sql/sample_1/sysobjects_with_params.sql.erb

@@ -0,0 +1,2 @@
+<%# Every parameter passed to a SQL template appears in the options hash available to the template %>
+select * from sysobjects where xtype = '<%= options[:xtype] %>';

data/lib/slacker_new/project/sql/sample_1/sysobjects_with_params_2.sql.erb

@@ -0,0 +1,5 @@
+<%# Query sysobjects by a dynamic criteria depending on the presence of parameters %>
+select * from sysobjects
+where 1 = 1
+<%= options[:xtype].nil? ? '' : " and xtype = '#{options[:xtype]}'" %>
+<%= options[:name].nil? ? '' : " and name = '#{options[:name]}'" %>;

data/slacker.gemspec

@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "slacker"
 
-  s.files = ['LICENSE', 'README.markdown', 'Rakefile', 'Gemfile', 'slacker.gemspec', 'Gemfile.lock'] + Dir.glob("{bin,lib,spec}/**/*")
+  s.files = ['README.markdown', 'Rakefile', 'Gemfile', 'slacker.gemspec', 'Gemfile.lock'] + Dir.glob("{bin,lib,spec}/**/*")
   s.test_files = Dir.glob("spec/**/*")
-  s.executables = ['slacker']
+  s.executables = ['slacker', 'slacker_new']
   s.require_paths = ["lib"]
 
   s.required_ruby_version = '>= 1.9.2'

data/spec/rspec_ext_spec.rb

@@ -39,6 +39,10 @@ describe Slacker::RSpecExt do
     @instance.should respond_to(:result)
   end
 
+  it 'responds to results' do
+    @instance.should respond_to(:results)
+  end
+
   it 'responds to sql' do
     @instance.should respond_to(:sql)
   end
@@ -84,37 +88,5 @@ describe Slacker::RSpecExt do
       @instance.sql.nest.example_1.respond_to?(:helper_1).should be_true
       @instance.sql.nest.example_1.helper_1.should == 'nest/example_1/helper_1.sql.erb called'
     end
-
-#    context do
-#      before(:each) do
-#        # Fake the current example in the RSpec ext
-#        @example = OpenStruct.new :metadata => {:sql => ''}
-#        @instance.stub(:example).and_return(@example)
-#      end
-#
-#      specify "with files from the current example's file folder taking priority over the helpers folder" do
-#        @example.metadata[:example_group] = {:file_path => SpecHelper.expand_test_files_path('test_slacker_project/spec/example_1.rb')}
-#        @instance.sql.respond_to?(:helper_1).should be_true
-#        @instance.sql.helper_1.should == 'example_1/helper_1.sql called'
-#      end
-#
-#      specify "in example group giving priority to SQL files over SQL.ERB files" do
-#        @example.metadata[:example_group] = {:file_path => SpecHelper.expand_test_files_path('test_slacker_project/spec/example_1.rb')}
-#        @instance.sql.respond_to?(:helper_2).should be_true
-#        @instance.sql.helper_2.should == 'example_1/helper_2.sql called'
-#      end
-#
-#      specify "works with deeply nested example files reflecting their location in the lookup of SQL files in the SQL folder" do
-#        @example.metadata[:example_group] = {:file_path => SpecHelper.expand_test_files_path('test_slacker_project/spec/nest/example_1.rb')}
-#        @instance.sql.respond_to?(:helper_1).should be_true
-#        @instance.sql.helper_1.should == 'nest/example_1/helper_1.sql.erb called'
-#      end
-#
-#      specify "falls back to the global helper when there is no matching file in the example folder" do
-#        @example.metadata[:example_group] = {:file_path => SpecHelper.expand_test_files_path('test_slacker_project/spec/example_1.rb')}
-#        @instance.sql.respond_to?(:helper_3).should be_true
-#        @instance.sql.helper_3.should == 'helpers/helper_3.sql called'
-#      end
-#    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: slacker
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Vassil Kovatchev
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-22 00:00:00 Z
+date: 2011-06-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -50,18 +50,19 @@ email:
 - vassil.kovatchev@gmail.com
 executables: 
 - slacker
+- slacker_new
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-- LICENSE
 - README.markdown
 - Rakefile
 - Gemfile
 - slacker.gemspec
 - Gemfile.lock
 - bin/slacker
+- bin/slacker_new
 - lib/slacker/string_helper.rb
 - lib/slacker/command_line_formatter.rb
 - lib/slacker/version.rb
@@ -73,6 +74,16 @@ files:
 - lib/slacker/sql.rb
 - lib/slacker/application.rb
 - lib/slacker.rb
+- lib/slacker_new/project/lib/helpers/my_helper.rb
+- lib/slacker_new/project/data/my_table.csv
+- lib/slacker_new/project/debug/failed_examples/example_001.sql
+- lib/slacker_new/project/debug/passed_examples/example_001.sql
+- lib/slacker_new/project/sql/sample_1/sysobjects_with_params_2.sql.erb
+- lib/slacker_new/project/sql/sample_1/play_with_numbers.sql.erb
+- lib/slacker_new/project/sql/sample_1/sysobjects_with_params.sql.erb
+- lib/slacker_new/project/sql/sample_1/sysobjects.sql.erb
+- lib/slacker_new/project/spec/sample_1.rb
+- lib/slacker_new/project/database.yml
 - spec/rspec_ext_spec.rb
 - spec/query_result_matcher_spec.rb
 - spec/spec_helper.rb

data/LICENSE

@@ -1,3 +0,0 @@
-== slacker
-
-Put appropriate LICENSE for your project here.