active_record-comments 0.0.1

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - ree
+  - 1.9.3
+gemfile:
+  - gemfiles/activerecord_2.3.gemfile
+  - gemfiles/activerecord_3.0.gemfile
+  - gemfiles/activerecord_3.1.gemfile
+  - gemfiles/activerecord_3.2.gemfile

data/Appraisals

@@ -0,0 +1,5 @@
+["2.3", "3.0", "3.1", "3.2"].each do |version|
+  appraise "activerecord_#{version}" do
+    gem "activerecord", "~> #{version}.0"
+  end
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+
+gem "appraisal"
+gem "bump"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    active_record-comments (0.0.1)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.5.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.4)
+    bump (0.3.8)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.5.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record-comments!
+  appraisal
+  bump
+  rake
+  rspec (~> 2)
+  sqlite3

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "bump/tasks"
+require "appraisal"
+
+task :spec do
+  sh "rspec spec/"
+end
+
+task :default do
+  sh "bundle exec rake appraisal:install && bundle exec rake appraisal spec"
+end

data/Readme.md

@@ -0,0 +1,27 @@
+Adds comments to your activerecord queries so you can seem where they came from or what user caused them.<br/>
+for on Rails 2 + 3 + 4
+
+Install
+=======
+
+    gem install active_record-comments
+
+Usage
+=====
+
+    require "active_record/comments"
+
+    # => SELECT ... /* user.rb:123 */
+    result = ActiveRecord::Comments.comment("user.rb:123"){ User.where("x like y").count }
+
+    # => SELECT ... /* account cleanup initial */
+    result = ActiveRecord::Comments.comment("account cleanup") do
+      ActiveRecord::Comments.comment("initial"){ User.where("x like y").count }
+    end
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://travis-ci.org/grosser/active_record-comments.png)](https://travis-ci.org/grosser/active_record-comments)

data/active_record-comments.gemspec

@@ -0,0 +1,11 @@
+name = "active_record-comments"
+
+Gem::Specification.new name, "0.0.1" do |s|
+  s.summary = "Comments for activerecord"
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = "MIT"
+  s.add_runtime_dependency "activerecord"
+end

data/gemfiles/activerecord_2.3.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "bump"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "activerecord", "~> 2.3.0"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_2.3.gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: /Users/mgrosser/code/tools/active_record-comments
+  specs:
+    active_record-comments (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.15)
+      activesupport (= 2.3.15)
+    activesupport (2.3.15)
+    appraisal (0.5.1)
+      bundler
+      rake
+    bump (0.3.9)
+    diff-lcs (1.1.3)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    sqlite3 (1.3.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record-comments!
+  activerecord (~> 2.3.0)
+  appraisal
+  bump
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/activerecord_3.0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "bump"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "activerecord", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3.0.gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: /Users/mgrosser/code/tools/active_record-comments
+  specs:
+    active_record-comments (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.19)
+      activesupport (= 3.0.19)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.19)
+      activemodel (= 3.0.19)
+      activesupport (= 3.0.19)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.19)
+    appraisal (0.5.1)
+      bundler
+      rake
+    arel (2.0.10)
+    builder (2.1.2)
+    bump (0.3.9)
+    diff-lcs (1.1.3)
+    i18n (0.5.0)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record-comments!
+  activerecord (~> 3.0.0)
+  appraisal
+  bump
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/activerecord_3.1.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "bump"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "activerecord", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3.1.gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: /Users/mgrosser/code/tools/active_record-comments
+  specs:
+    active_record-comments (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.10)
+      activesupport (= 3.1.10)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.10)
+      activemodel (= 3.1.10)
+      activesupport (= 3.1.10)
+      arel (~> 2.2.3)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.10)
+      multi_json (>= 1.0, < 1.3)
+    appraisal (0.5.1)
+      bundler
+      rake
+    arel (2.2.3)
+    builder (3.0.4)
+    bump (0.3.9)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.2.0)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record-comments!
+  activerecord (~> 3.1.0)
+  appraisal
+  bump
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/activerecord_3.2.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "bump"
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3.2.gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: /Users/mgrosser/code/tools/active_record-comments
+  specs:
+    active_record-comments (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.5.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.4)
+    bump (0.3.9)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record-comments!
+  activerecord (~> 3.2.0)
+  appraisal
+  bump
+  rake
+  rspec (~> 2)
+  sqlite3

data/lib/active_record/comments.rb

@@ -0,0 +1,55 @@
+require "active_record"
+
+module ActiveRecord
+  module Comments
+    class << self
+      def comment(comment)
+        @comment ||= []
+        @comment << comment
+        yield
+      ensure
+        @comment.pop
+      end
+
+      def with_comment_sql(sql)
+        return sql unless comment = current_comment
+        "#{sql} /* #{comment} */"
+      end
+
+      private
+
+      def current_comment
+        @comment.join(" ") if @comment.present?
+      end
+    end
+  end
+end
+
+if ActiveRecord::VERSION::MAJOR == 2
+  class << ActiveRecord::Base
+    def construct_finder_sql_with_comments(options)
+      sql = construct_finder_sql_without_comments(options)
+      ActiveRecord::Comments.with_comment_sql(sql)
+    end
+    alias_method_chain(:construct_finder_sql, :comments)
+
+    def construct_calculation_sql_with_comments(operation, column_name, options)
+      sql = construct_calculation_sql_without_comments(operation, column_name, options)
+      ActiveRecord::Comments.with_comment_sql(sql)
+    end
+    alias_method_chain(:construct_calculation_sql, :comments)
+  end
+else
+  klass = if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0
+    Arel::SelectManager
+  else
+    ActiveRecord::Relation
+  end
+
+  klass.class_eval do
+    alias to_sql_with_comments to_sql
+    def to_sql
+      ActiveRecord::Comments.with_comment_sql(to_sql_with_comments)
+    end
+  end
+end

data/spec/active_record/comments_spec.rb

@@ -0,0 +1,96 @@
+require "spec_helper"
+
+describe ActiveRecord::Comments do
+  def normalize_sql(sql)
+    sql.gsub("``", '""').gsub("  ", " ").strip
+  end
+
+  describe ".current_comment" do
+    it "be empty when not called" do
+      ActiveRecord::Comments.comment("xxx"){}
+      ActiveRecord::Comments.send(:current_comment).should == nil
+    end
+
+    it "be filled when called" do
+      result = nil
+      ActiveRecord::Comments.comment("xxx") do
+        result = ActiveRecord::Comments.send(:current_comment)
+      end
+      "xxx".should == result
+    end
+
+    it "concat" do
+      result = nil
+      ActiveRecord::Comments.comment("xxx") do
+        ActiveRecord::Comments.comment("yyy") do
+          result = ActiveRecord::Comments.send(:current_comment)
+        end
+      end
+      result.should == "xxx yyy"
+    end
+
+    it "unpop" do
+      result = nil
+      ActiveRecord::Comments.comment("xxx") do
+        ActiveRecord::Comments.comment("yyy") { }
+        result = ActiveRecord::Comments.send(:current_comment)
+      end
+      result.should == "xxx"
+    end
+  end
+
+  describe ".comment" do
+    it "return results" do
+      ActiveRecord::Comments.comment("xxx"){ 1 }.should == 1
+    end
+  end
+
+  if ActiveRecord::VERSION::MAJOR == 2
+    describe "#construct_finder_sql" do
+      it "not be there when not called" do
+        ActiveRecord::Comments.comment("xxx"){ }
+        normalize_sql(User.scoped(:conditions => {:id => 1}).send(:construct_finder_sql, {})).should ==
+          'SELECT * FROM "users" WHERE ("users"."id" = 1)'
+      end
+
+      it "be there when called" do
+        result = nil
+        ActiveRecord::Comments.comment("xxx") do
+          result = User.scoped(:conditions => {:id => 1}).send(:construct_finder_sql, {})
+        end
+        normalize_sql(result).should == 'SELECT * FROM "users" WHERE ("users"."id" = 1) /* xxx */'
+      end
+    end
+
+    describe "#construct_calculation_sql_with_comments" do
+      it "not be there when not called" do
+        ActiveRecord::Comments.comment("xxx"){ }
+        normalize_sql(User.scoped(:conditions => {:id => 1}).send(:construct_calculation_sql_with_comments, "count", "id", {})).should ==
+          'SELECT count("users".id) AS count_id FROM "users" WHERE ("users"."id" = 1)'
+      end
+
+      it "be there when called" do
+        result = nil
+        ActiveRecord::Comments.comment("xxx") do
+          result = User.scoped(:conditions => {:id => 1}).send(:construct_calculation_sql_with_comments, "count", "id", {})
+        end
+        normalize_sql(result).should == 'SELECT count("users".id) AS count_id FROM "users" WHERE ("users"."id" = 1) /* xxx */'
+      end
+    end
+  else
+    describe "#to_sql" do
+      it "not be there when not called" do
+        ActiveRecord::Comments.comment("xxx"){ }
+        normalize_sql(User.where(:id => 1).to_sql).should == 'SELECT "users".* FROM "users" WHERE "users"."id" = 1'
+      end
+
+      it "be there when called" do
+        result = nil
+        ActiveRecord::Comments.comment("xxx") do
+          result = User.where(:id => 1).to_sql
+        end
+        normalize_sql(result).should == 'SELECT "users".* FROM "users" WHERE "users"."id" = 1 /* xxx */'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "active_record/comments"
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :name
+  end
+end
+
+class User < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: active_record-comments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- active_record-comments.gemspec
+- gemfiles/activerecord_2.3.gemfile
+- gemfiles/activerecord_2.3.gemfile.lock
+- gemfiles/activerecord_3.0.gemfile
+- gemfiles/activerecord_3.0.gemfile.lock
+- gemfiles/activerecord_3.1.gemfile
+- gemfiles/activerecord_3.1.gemfile.lock
+- gemfiles/activerecord_3.2.gemfile
+- gemfiles/activerecord_3.2.gemfile.lock
+- lib/active_record/comments.rb
+- spec/active_record/comments_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/active_record-comments
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2889031802467512839
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2889031802467512839
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Comments for activerecord
+test_files: []