data_objects 0.9.11 → 0.9.12

data/lib/data_objects/spec/typecast/range_spec.rb

@@ -0,0 +1,36 @@
+share_examples_for 'supporting Range' do
+
+  include DataObjectsSpecHelpers
+
+  before :all do
+    setup_test_environment
+  end
+
+  before :each do
+    @connection = DataObjects::Connection.new(CONFIG.uri)
+  end
+
+  after :each do
+    @connection.close
+  end
+
+  describe 'passing a Range as a parameter in execute_reader' do
+
+      before  do
+        @reader = @connection.create_command("SELECT * FROM widgets WHERE id between ?").execute_reader(2..5)
+      end
+
+      after do
+        @reader.close
+      end
+
+      it 'should return correct number of rows' do
+        counter  = 0
+        while(@reader.next!) do
+          counter += 1
+        end
+        counter.should == 4
+      end
+
+  end
+end

data/lib/data_objects/spec/typecast/string_spec.rb

@@ -0,0 +1,86 @@
+share_examples_for 'supporting String' do
+
+  include DataObjectsSpecHelpers
+
+  before :all do
+    setup_test_environment
+  end
+
+  before :each do
+    @connection = DataObjects::Connection.new(CONFIG.uri)
+  end
+
+  after :each do
+    @connection.close
+  end
+
+  describe 'reading a String' do
+
+    describe 'with automatic typecasting' do
+
+      before  do
+        @reader = @connection.create_command("SELECT code FROM widgets WHERE ad_description = ?").execute_reader('Buy this product now!')
+        @reader.next!
+        @values = @reader.values
+      end
+
+      after do
+        @reader.close
+      end
+
+      it 'should return the correctly typed result' do
+        @values.first.should be_kind_of(String)
+      end
+
+      it 'should return the correct result' do
+        @values.first.should == "W0000001"
+      end
+
+    end
+
+    describe 'with manual typecasting' do
+
+      before  do
+        @command = @connection.create_command("SELECT weight FROM widgets WHERE ad_description = ?")
+        @command.set_types(String)
+        @reader = @command.execute_reader('Buy this product now!')
+        @reader.next!
+        @values = @reader.values
+      end
+
+      after do
+        @reader.close
+      end
+
+      it 'should return the correctly typed result' do
+        @values.first.should be_kind_of(String)
+      end
+
+      it 'should return the correct result' do
+        @values.first.should == "13.4"
+      end
+
+    end
+
+  end
+
+  describe 'writing a String' do
+
+    before  do
+      @reader = @connection.create_command("SELECT id FROM widgets WHERE id = ?").execute_reader("2")
+      @reader.next!
+      @values = @reader.values
+    end
+
+    after do
+      @reader.close
+    end
+
+    it 'should return the correct entry' do
+      # Some of the drivers starts autoincrementation from 0 not 1
+      @values.first.should satisfy { |val| val == 1 or val == 2 }
+    end
+
+  end
+
+end

data/lib/data_objects/spec/typecast/time_spec.rb

@@ -0,0 +1,64 @@
+share_examples_for 'supporting Time' do
+
+  include DataObjectsSpecHelpers
+
+  before :all do
+    setup_test_environment
+  end
+
+  before :each do
+    @connection = DataObjects::Connection.new(CONFIG.uri)
+  end
+
+  after :each do
+    @connection.close
+  end
+
+  describe 'reading a Time' do
+
+    describe 'with manual typecasting' do
+
+      before  do
+        @command = @connection.create_command("SELECT release_date FROM widgets WHERE ad_description = ?")
+        @command.set_types(Time)
+        @reader = @command.execute_reader('Buy this product now!')
+        @reader.next!
+        @values = @reader.values
+      end
+
+      after do
+        @reader.close
+      end
+
+      it 'should return the correctly typed result' do
+        @values.first.should be_kind_of(Time)
+      end
+
+      it 'should return the correct result' do
+        @values.first.should == Time.local(2008, 2, 14)
+      end
+
+    end
+
+  end
+
+  describe 'writing an Time' do
+
+    before  do
+      @reader = @connection.create_command("SELECT id FROM widgets WHERE release_datetime = ?").execute_reader(Time.utc(2008, 2, 14, 00, 31, 12))
+      @reader.next!
+      @values = @reader.values
+    end
+
+    after do
+      @reader.close
+    end
+
+    it 'should return the correct entry' do
+       #Some of the drivers starts autoincrementation from 0 not 1
+       @values.first.should satisfy { |val| val == 1 or val == 0 }
+    end
+
+  end
+
+end

data/lib/data_objects/transaction.rb

@@ -5,41 +5,48 @@ module DataObjects
 
   class Transaction
 
+    # The host name. Note, this relies on the host name being configured and resolvable using DNS
     HOST = "#{Socket::gethostbyname(Socket::gethostname)[0]}" rescue "localhost"
     @@counter = 0
 
+    # The connection object allocated for this transaction
     attr_reader :connection
+    # A unique ID for this transaction
     attr_reader :id
 
+    # Instantiate the Transaction subclass that's appropriate for this uri scheme
     def self.create_for_uri(uri)
       uri = uri.is_a?(String) ? URI::parse(uri) : uri
       DataObjects.const_get(uri.scheme.capitalize)::Transaction.new(uri)
     end
 
     #
-    # Creates a Transaction bound to the given connection
-    #
-    # ==== Parameters
-    # conn<DataObjects::Connection>:: The Connection to bind the new Transaction to
+    # Creates a Transaction bound to a connection for the given DataObjects::URI
     #
     def initialize(uri)
       @connection = DataObjects::Connection.new(uri)
       @id = Digest::SHA256.hexdigest("#{HOST}:#{$$}:#{Time.now.to_f}:#{@@counter += 1}")
     end
 
+    # Close the connection for this Transaction
     def close
       @connection.close
     end
 
-    [:begin, :commit, :rollback, :rollback_prepared, :prepare].each do |method_name|
-
-      eval <<EOF
-def #{method_name}
-  raise NotImplementedError
-end
-EOF
-
+    # Begin the Transaction
+    def begin; not_implemented; end
+    # Commit changes made in this Transaction
+    def commit; not_implemented; end
+    # Rollback changes made in this Transaction
+    def rollback; not_implemented; end;
+    # Prepare this Transaction for the second phase of a two-phase commit
+    def prepare; not_implemented; end;
+    # Abandon the second phase of a two-phase commit and roll back the changes
+    def rollback_prepared; not_implemented; end;
+
+  private
+    def not_implemented
+      raise NotImplementedError
     end
-
   end
 end

data/lib/data_objects/uri.rb

@@ -2,15 +2,27 @@ gem 'addressable', '~>2.0'
 require 'addressable/uri'
 
 module DataObjects
-  URI = Struct.new(:scheme, :user, :password, :host, :port, :path, :query, :fragment)
 
-  class URI
+  # A DataObjects URI is of the form scheme://user:password@host:port/path#fragment
+  #
+  # The elements are all optional except scheme and path:
+  # scheme:: The name of a DBMS for which you have a do_\<scheme\> adapter gem installed. If scheme is *jdbc*, the actual DBMS is in the _path_ followed by a colon.
+  # user:: The name of the user to authenticate to the database
+  # password:: The password to use in authentication
+  # host:: The domain name (defaulting to localhost) where the database is available
+  # port:: The TCP/IP port number to use for the connection
+  # path:: The name or path to the database
+  # query:: Parameters for the connection, for example encoding=utf8
+  # fragment:: Not currently known to be in use, but available to the adapters
+  class URI < Struct.new(:scheme, :user, :password, :host, :port, :path, :query, :fragment)
+    # Make a DataObjects::URI object by parsing a string. Simply delegates to Addressable::URI::parse.
     def self.parse(uri)
       return uri if uri.kind_of?(self)
       uri = Addressable::URI::parse(uri) unless uri.kind_of?(Addressable::URI)
       self.new(uri.scheme, uri.user, uri.password, uri.host, uri.port, uri.path, uri.query_values, uri.fragment)
     end
 
+    # Display this URI object as a string
     def to_s
       string = ""
       string << "#{scheme}://"   if scheme
@@ -30,5 +42,15 @@ module DataObjects
       string << "##{fragment}"   if fragment
       string
     end
+
+    # Compare this URI to another for hashing
+    def eql?(other)
+      to_s.eql?(other.to_s)
+    end
+
+    # Hash this URI
+    def hash
+      to_s.hash
+    end
   end
 end

data/lib/data_objects/version.rb

@@ -1,3 +1,4 @@
 module DataObjects
-  VERSION = "0.9.11" unless defined?(DataObjects::VERSION)
+  # Current DataObjects Gem version
+  VERSION = "0.9.12" unless defined?(DataObjects::VERSION)
 end

data/spec/command_spec.rb

@@ -10,15 +10,7 @@ describe DataObjects::Command do
     @connection.close
   end
 
-  it "should assign the connection object to @connection" do
-    @command.instance_variable_get("@connection").should == @connection
-  end
-
-  it "should assign the sql text to @text" do
-    @command.instance_variable_get("@text").should == 'SQL STRING'
-  end
-
-  %w{connection execute_non_query execute_reader set_types to_s}.each do |meth|
+  %w{connection execute_non_query execute_reader set_types}.each do |meth|
     it "should respond to ##{meth}" do
       @command.should respond_to(meth.intern)
     end
@@ -30,12 +22,4 @@ describe DataObjects::Command do
     end
   end
 
-  it "should make the connection object available in #connection" do
-    @command.connection.should == @command.instance_variable_get("@connection")
-  end
-
-  it "should make the SQL text available in #to_s" do
-    @command.to_s.should == @command.instance_variable_get("@text")
-  end
-
 end

data/spec/connection_spec.rb

@@ -20,15 +20,6 @@ describe DataObjects::Connection do
   end
 
   describe "initialization" do
-    it "should accept a regular connection uri as a String" do
-      c = DataObjects::Connection.new('mock://localhost/database')
-      # relying on the fact that mock connection sets @uri
-      uri = c.instance_variable_get("@uri")
-
-      uri.scheme.should == 'mock'
-      uri.host.should == 'localhost'
-      uri.path.should == '/database'
-    end
 
     it "should accept a connection uri as a Addressable::URI" do
       c = DataObjects::Connection.new(Addressable::URI::parse('mock://localhost/database'))
@@ -41,21 +32,8 @@ describe DataObjects::Connection do
       c.should be_kind_of(DataObjects::Mock::Connection)
 
       c = DataObjects::Connection.new(Addressable::URI.parse('mock:jndi://jdbc/database'))
-      #c.should be_kind_of(DataObjects::Mock::Connection)
+      c.should be_kind_of(DataObjects::Mock::Connection)
     end
 
-    it "should return the Connection using username" do
-      c = DataObjects::Connection.new(Addressable::URI.parse('mock://root@localhost/database'))
-      c.instance_variable_get(:@uri).user.should == 'root'
-      c.instance_variable_get(:@uri).password.should be_nil
-
-      c = DataObjects::Connection.new(Addressable::URI.parse('mock://root:@localhost/database'))
-      c.instance_variable_get(:@uri).user.should == 'root'
-      c.instance_variable_get(:@uri).password.should == ''
-
-      c = DataObjects::Connection.new(Addressable::URI.parse('mock://root:pwd@localhost/database'))
-      c.instance_variable_get(:@uri).user.should == 'root'
-      c.instance_variable_get(:@uri).password.should == 'pwd'
-    end
   end
 end

data/spec/lib/pending_helpers.rb

@@ -0,0 +1,11 @@
+module DataObjects::Spec
+  module PendingHelpers
+    def pending_if(message, boolean)
+      if boolean
+        pending(message) { yield }
+      else
+        yield
+      end
+    end
+  end
+end

data/spec/lib/rspec_immediate_feedback_formatter.rb

@@ -0,0 +1,53 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+# Code is based on standard SpecdocFormatter, but will print full error details as soon as they are found.
+# Successful or pending examples are written only as a dot in the output. Header is only printed if errors occur.
+#
+# To use it, add the following to your spec/spec.opts:
+#  --require
+#  lib/rspec_immediate_feedback_formatter.rb
+#  --format
+#  Spec::Runner::Formatter::ImmediateFeedbackFormatter
+
+module Spec
+  module Runner
+    module Formatter
+      class ImmediateFeedbackFormatter < BaseTextFormatter
+
+        def add_example_group(example_group)
+          super
+          @current_group = example_group.description
+        end
+
+        def example_failed(example, counter, failure)
+          if @current_group
+            output.puts
+            output.puts @current_group
+            @current_group = nil  # only print the group name once
+          end
+
+          message = if failure.expectation_not_met?
+            "- #{example.description} (FAILED - #{counter})"
+          else
+            "- #{example.description} (ERROR - #{counter})"
+          end
+
+          output.puts(red(message))
+          dump_failure(counter, failure)  # dump stacktrace immediately
+          output.flush
+        end
+
+        def example_passed(*)
+          output.print green('.')
+          output.flush
+        end
+
+        def example_pending(*)
+          super
+          output.print yellow('*')
+          output.flush
+        end
+      end
+    end
+  end
+end

data/spec/result_spec.rb

@@ -9,9 +9,6 @@ describe DataObjects::Result do
 
     result = command.execute_non_query
 
-    # In case the driver needs to access the command or connection to load additional data.
-    result.instance_variables.map { |i| i.to_s }.should include('@command')
-
     # Affected Rows:
     result.should respond_to(:to_i)
     result.to_i.should == 0