rdo 0.1.5 → 0.1.6

data/README.md

@@ -293,7 +293,7 @@ This method returns nil if there are no rows, so if you need to distinguish
 between NULL and no rows, you will need to check the result contents the
 longer way around.
 
-### Logging Statements
+### Debugging
 
 A Logger instance (with an interface like that in Ruby stdlib) may be passed
 in the options when creating a connection. All queries will be logged with
@@ -303,6 +303,31 @@ DEBUG severity. Errors will be logged with FATAL severity.
 RDO.connect("postgres://user:pass@host/db", logger: Logger.new(STDOUT))
 ```
 
+A logger with some support for highlighting errors etc and which shows
+query execution times is configured (but disabled) by default. It is
+found at `RDO::ColoredLogger`. You can enable it by specify a log level:
+
+``` ruby
+RDO.connect("postgres://user:pass@host/db", log_level: Logger::DEBUG)
+```
+
+If you want the log output to go somewhere other than stdout, instantiate
+the logger manually.
+
+### Temporary debug output
+
+Turning on debug logging globally is often a little overkill and too noisy.
+You may enable debug logging in the context of a block, like so:
+
+``` ruby
+connection.debug do
+  # call some methods that execute SQL
+end
+```
+
+The log level will be restored after the block has executed, even if an
+Exception is raised.
+
 ## Contributing
 
 If you find a bug in RDO, send a pull request if you think you can fix it.
@@ -315,7 +340,10 @@ unintentionally.
 
 I haven't looked at what I need to change to have the drivers compile on
 Windows yet, but I will do. If anybody beats me to it, pull requests will
-be gladly accepted! I'll probably add some thin JDBC wrappers for jRuby.
+be gladly accepted! I was going to write JDBC wrappers for JRuby, but have
+decided to just aim for JRuby >= 1.6, which supports C extensions. This
+hasn't yet been tested with RDO. I should be able to make it work, as the
+parts of the Ruby API I use are very typical.
 
 ### Writing a driver for RDO
 

data/lib/rdo/connection.rb

@@ -127,6 +127,17 @@ module RDO
       Statement.new(@driver.prepare(command), logger)
     end
 
+    # Use debug log level in the context of a block.
+    def debug
+      raise ArgumentError,
+        "RDO::Connection#debug requires a block" unless block_given?
+
+      reset, logger.level = logger.level, Logger::DEBUG
+      yield
+    ensure
+      logger.level = reset
+    end
+
     private
 
     # Normalizes the given options String or Hash into a Symbol-keyed Hash.

data/lib/rdo/version.rb

@@ -6,5 +6,5 @@
 ##
 
 module RDO
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/rdo/connection_spec.rb

@@ -286,4 +286,39 @@ describe RDO::Connection do
       end
     end
   end
+
+  describe "#debug" do
+    let(:connection)   { RDO::Connection.new("test://host") }
+    let(:driver)       { double(:driver, open: true) }
+    let(:driver_class) { double(new: driver) }
+
+    before(:each) do
+      RDO::Connection.register_driver(:test, driver_class)
+      connection
+    end
+
+    it "sets the log level to debug" do
+      connection.logger.level = Logger::FATAL
+      level = nil
+      connection.debug { level = connection.logger.level }
+      level.should == Logger::DEBUG
+    end
+
+    it "restores the log level" do
+      connection.logger.level = Logger::FATAL
+      connection.debug { }
+      connection.logger.level.should == Logger::FATAL
+    end
+
+    context "when the block raise an Exception" do
+      it "restores the log level" do
+        connection.logger.level = Logger::FATAL
+        begin
+          connection.debug { raise "test" }
+        rescue
+        end
+        connection.logger.level.should == Logger::FATAL
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdo
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000 Z
+date: 2012-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec