lib/activerecord/association_preload.rb lib/activerecord/base_ext.rb lib/activerecord/calculations_ext.rb lib/activerecord/connection_adapters/abstract/database_statements_ext.rb lib/activerecord/connection_adapters/mysql_adapter_ext.rb lib/activerecord/connection_adapters/sqlite3_adapter_ext.rb lib/activerecord/connection_adapters/sqlite_adapter_ext.rb spec/fixtures/schema.rb spec/sql_display_spec.rb @@ -1,26 +1,23 @@ # sql_display -For when you want to display the SQL a query executes, but don't want to go into the model! +For when you want to display the SQL a query executes, but don't want to go into the log! -# Usage +## Works with - ActiveRecord::Base.sql do - Post.all - end - => "SELECT * FROM posts" - -which will display queries to all models, or +Currently only works with mysql and sqlite adapters. More coming soon! + +## Usage - YourModel.sql do - Post.all + YourModel.sql + YourModel.all end - => "SELECT * FROM posts" - +This will show you the output of the call inside the block, without actually running it. You are only able to do one call per block, as it will only display the query for the last call inside the block. + +## Broken Things -which will display queries to YourModel only. - -But I'm sure a smart cookie / muffin such as you already knew that. +Currently doesn't work with :joins. -These methods can be called in models, controllers, helpers, views and external libraries. +## Contributors +perplect README.markdown @@ -1,3 +1,3 @@ test: adapter: sqlite3 - database: tmp/sql_display.sqlite \ No newline at end of file + database: ':memory:' \ No newline at end of file config/database.yml @@ -1 +1 @@ -ActiveRecord::Base.send :include, SqlDisplay \ No newline at end of file +require 'sql_display' \ No newline at end of file init.rb @@ -1,30 +1,10 @@ -module SqlDisplay - def self.included(base) - base.extend ClassMethods - end - - module ClassMethods - def sql(&block) - target = self.class == ActiveRecord::Base ? ActiveRecord::Base : self - old_logger = target.logger - target.logger = ActiveSupport::BufferedLogger.new("tmp/sql_display.log") - target.logger.level = Logger::DEBUG - target.establish_connection(YAML::load_file("#{RAILS_ROOT}/config/database.yml")[RAILS_ENV]) - logger.info("\n") - yield - output = File.readlines("tmp/sql_display.log").map do |line| - # remove the crap - line.gsub(/\[.*?m/, "").gsub("\e", "").gsub(/^.*? \(.*?\)/, '').gsub("SET SQL_AUTO_IS_NULL=0\n", "").strip - end - if /Logfile created/.match(output.first) - output -= [output.first] # Remove the standard logger header crap - end - FileUtils.rm("tmp/sql_display.log") - target.logger = old_logger - target.establish_connection(YAML::load_file("#{RAILS_ROOT}/config/database.yml")[RAILS_ENV]) - output.join("\n").strip - end - end -end +require 'activerecord/association_preload' +require 'activerecord/base_ext' +require 'activerecord/calculations_ext' -ActiveRecord::Base.send :include, SqlDisplay +require 'activerecord/connection_adapters/abstract/database_statements_ext' + +# TODO: Load the relevant adapter. +require 'activerecord/connection_adapters/mysql_adapter_ext' +require 'activerecord/connection_adapters/sqlite_adapter_ext' +require 'activerecord/connection_adapters/sqlite3_adapter_ext' \ No newline at end of file lib/sql_display.rb @@ -1,13 +1,35 @@ class Post < ActiveRecord::Base - include SqlDisplay - belongs_to :user - has_and_belongs_to_many :tags + has_many :posts_tags + has_many :tags, :through => :posts_tags + + def self.factory(text, created_at = nil) + create!(:text => text, :created_at => created_at) + end end class Tag < ActiveRecord::Base - has_and_belongs_to_many :posts + has_many :posts_tags + has_many :posts, :through => :posts_tags end -class User < ActiveRecord::Base - has_many :posts -end \ No newline at end of file +class PostsTag < ActiveRecord::Base + belongs_to :post + belongs_to :tag +end + +## seed data: + +year = Time.now.year + +1.upto(12) do |month| + month.times do |n| + Post.factory "post #{n}", Time.local(year, month, 1) + end +end + +Post.factory "Today's post" +Post.factory "Yesterday's post", 1.day.ago.utc +Post.factory "Tomorrow's post", 1.day.from_now.utc + +post = Post.factory "Last year", Time.local(year - 1, 1, 1) +post.tags.create(:name => "ruby") spec/fixtures/models.rb @@ -1,22 +1,20 @@ # Inspiration gained from Thinking Sphinx's test suite. # Pat Allan is a genius. - -$:.unshift File.dirname(__FILE__) + '/../lib' +this = File.dirname(__FILE__) +$:.unshift this + '/../lib' RAILS_ENV = 'test' RAILS_ROOT = '.' require 'rubygems' -require 'activerecord' +require "activerecord" + +ActiveRecord::Base.establish_connection( + :adapter => "sqlite3", + :database => ":memory:" +) + require 'sql_display' require 'spec' -require 'spec/fixtures/models' -require 'spec/test_helper' -FileUtils.mkdir_p "#{Dir.pwd}/tmp" -ActiveRecord::Base.logger = Logger.new("tmp/#{RAILS_ENV}.log") +load File.join(this, "fixtures/schema.rb") +load File.join(this, "fixtures/models.rb") -Spec::Runner.configure do |config| - - test = TestHelper.new - test.setup_sqlite3 - -end spec/spec_helper.rb 8a3421a166ac5fe1ac44c5b89e49b131de74f929 Ryan Bigg radarlistener@gmail.com http://github.com/radar/sql_display/commit/2e3928652efdd7399b6ef44430e9f75a926d2de4 2e3928652efdd7399b6ef44430e9f75a926d2de4 2009-06-14T01:36:42-07:00 2009-06-14T01:36:42-07:00 Rewrite of the plugin. Better way to gather the information is to override the method calls with methods that return the query. At least, in my books it is. 055f08cb2588c4084441db180cf8d1ed2e280a5a Ryan Bigg radarlistener@gmail.com