maiha-rows_logger 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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/README

@@ -0,0 +1,104 @@
+RowsLogger
+==========
+
+This plugin offers rich information about result sets to AR logs.
+
+
+Usage
+=====
+
+Just enjoy Rails as usual.
+
+
+Example
+=======
+
+Consider some read operations like this.
+
+  Member.count
+  Member.find(:all)
+
+That usually makes following log.
+
+  SQL (0.000300)   SELECT count(*) AS count_all FROM members
+  Member Load (0.000482)   SELECT * FROM members
+
+RowsLogger appends information about rows count to the log.
+
+  SQL (0.000301) (1 Row)   SELECT count(*) AS count_all FROM members
+  Member Load (0.000415) (3 Rows)   SELECT * FROM members
+
+
+For Developpers
+===============
+
+This plugin modfies following methods.
+  'ConnectionAdapters::AbstractAdapter#log'
+  'ConnectionAdapters::AbstractAdapter#log_info'
+
+<before>
+ConnectionAdapters::AbstractAdapter#log
+  --> log_info(sql, name, seconds)
+
+<after>
+ConnectionAdapters::AbstractAdapter#log
+  --> log_info(sql, name, seconds, result = nil)
+        --> log_result_info(result)
+              --> ConcreteAdapter#count_result(result)
+
+
+<an example for concrete adapter>
+ConnectionAdapters::MysqlAdapter#count_result
+  protected
+  def count_result(result)
+    result.num_rows
+  end
+
+
+Count Result Method
+===================
+
+The 'count_result' method of Adapter class should return count of result set
+from 'result' object, where 'result' is an object generated by 'log' method.
+This is used as result information.
+
+For exmaple, although this is nonsencial definition,
+
+  def count_result(result)
+    0
+  end
+
+this code always appends "(0 Rows)" to the log. The returned value is directly
+used even if it is not a numeric value. But no information will be appended
+in following cases.
+
+1) when 'count_result' method returns nil
+2) when 'count_result' method is not defined in current adapter
+
+
+Note
+====
+
+'count_result' method should be defined as 'protected' or 'public' because
+we check whether it is implemented or not in current adapter by using
+'respond_to?' method.
+
+
+Supported Databases
+===================
+
+Currently these databases are supported.
+
+* PostgreSQL
+* MySQL
+
+
+For Other Databases
+===================
+
+Put a new adapter file that contains 'count_result' method for
+your database adapter into adatpers directory.
+
+
+Copyright (c) 2008 maiha@wota.jp, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the rows_logger plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the rows_logger plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RowsLogger'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/adapters/mysql.rb

@@ -0,0 +1,6 @@
+ActiveRecord::ConnectionAdapters::MysqlAdapter.class_eval do
+  protected
+  def count_result(result)
+    result.num_rows
+  end
+end

data/adapters/postgresql.rb

@@ -0,0 +1,10 @@
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval do
+  protected
+  def count_result(result)
+    if result.is_a?(PGresult)
+      result.num_tuples
+    else
+      nil
+    end
+  end
+end

data/init.rb

@@ -0,0 +1,65 @@
+# Include hook code here
+
+Dir["#{ File.dirname(__FILE__) }/adapters/*.rb"].each do |path|
+  adapter = File.basename(path, '.rb')
+  if ActiveRecord::Base.respond_to?("#{adapter}_connection")
+    ActiveRecord::Base.logger.debug "RowsLogger plugin enables #{adapter}"
+    require path
+  end
+end
+
+
+ActiveRecord::Base.class_eval do
+  cattr_accessor :disable_cache_logging
+end
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+      protected
+        def log(sql, name)
+          if block_given?
+            if @logger and @logger.level <= Logger::INFO
+              result = nil
+              seconds = Benchmark.realtime { result = yield }
+              @runtime += seconds
+              log_info(sql, name, seconds, result)
+              result
+            else
+              yield
+            end
+          else
+            log_info(sql, name, 0)
+            nil
+          end
+        rescue Exception => e
+          # Log message and raise exception.
+          # Set last_verfication to 0, so that connection gets verified
+          # upon reentering the request loop
+          @last_verification = 0
+          message = "#{e.class.name}: #{e.message}: #{sql}"
+          log_info(message, name, 0)
+          raise ActiveRecord::StatementInvalid, message
+        end
+
+        def log_info(sql, name, runtime, result = nil)
+          return unless @logger
+          return if name == "CACHE" and ActiveRecord::Base.disable_cache_logging
+
+          @logger.debug(
+            format_log_entry(
+              "#{name.nil? ? "SQL" : name} (#{sprintf("%f", runtime)})#{log_result_info(result)}",
+              sql.gsub(/ +/, " ")
+            )
+          )
+        end
+
+        def log_result_info(result)
+          return nil if result.nil? or !respond_to?(:count_result)
+
+          count = count_result(result) rescue '?' or return nil
+          unit  = (count == 1) ? 'Row' : 'Rows'
+          " (%s %s)" % [count, unit]
+        end
+end
+
+
+

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/rows_logger.rb

@@ -0,0 +1 @@
+# RowsLogger

data/tasks/rows_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rows_logger do
+#   # Task goes here
+# end

data/test/rows_logger_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class RowsLoggerTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: maiha-rows_logger
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- maiha
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-10 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: maiha@wota.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- adapters/mysql.rb
+- adapters/postgresql.rb
+- init.rb
+- install.rb
+- lib/rows_logger.rb
+- tasks/rows_logger_tasks.rake
+- test/rows_logger_test.rb
+has_rdoc: true
+homepage: http://github.com/maiha/rows_logger
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+