sql_safety_net 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95c009f77c241b91a184dcb900e781a4f6290561
-  data.tar.gz: c5c404c3fd88708adf9460d877dea543b48c5d3e
+  metadata.gz: 8bea9f78919f0aeda8e3d9a7e63d91c951f6fce7
+  data.tar.gz: ec3d635668247f26bf19b93eacacaef930e2e328
 SHA512:
-  metadata.gz: 83daf270812be2bfce093ec9861855feba974d12ce1e9d0963fefa70099c5162d4ac82f0015407dd7f95db7cfa67adcee674a2251e5f75e24a11c99977c400ef
-  data.tar.gz: 17e441031c94574f0a1c8df959f65ff7a4ef4fbdce08b0854abc6dfdbcf3c9bb1899691ae0a16701402fbad27ca951fc6a268e57c19eb3f35c05303e3b8aef0a
+  metadata.gz: de20705e4e92e7c9979640ed70aaebe0c1b7079ec688e530a96220cdd3da383175533b71269b4ea06843ea50488d0c21a90d97fce0bd40d7bb8bacd8d7b4d137
+  data.tar.gz: 0078dcbd525431aaa892514e7543c29794f74b56b8949be06cc4bb7e47a4334fd65233e5d8a9ee8d2edca98113d97e80281b85c0734a1b12a0cfd03afc69a0d3

data/.gitignore

@@ -1,8 +1,7 @@
-Gemfile.lock
-*.swm
-*.swn
-*.swo
-*.swp
+*.sw[mnop]
 *.gem
-coverage
-pkg
+/Gemfile.lock
+/gemfiles/*.lock
+/.bundle
+/coverage
+/pkg

data/Appraisals

@@ -0,0 +1,20 @@
+# Install gems for all appraisal definitions:
+#
+#     $ appraisal install
+#
+# To run tests on different versions:
+#
+#     $ appraisal activerecord_x.x rspec spec
+
+[
+  [ '3.2', '~> 3.2.0' ],
+  [ '4.0', '~> 4.0.0' ],
+  [ '4.1', '~> 4.1.0' ],
+  [ '4.2', '~> 4.2.0' ],
+].each do |ver_name, ver_req|
+  appraise "rails_#{ver_name}" do
+    gem 'activerecord', ver_req
+    gem 'activesupport', ver_req
+    gem 'actionpack', ver_req
+  end
+end

data/Rakefile

@@ -1 +1,21 @@
 require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+# Note: if you get this error: "Bundler could not find compatible versions for gem ..."
+# try deleting Gemfile.lock (usually happens when switching branches).
+
+task default: :appraise_all
+
+# This is slightly different from 'appraisal COMMAND' because it continues even if a definition fails.
+desc "Run rspecs for all appraisals"
+task :appraise_all do
+  success_map = {}
+  `bundle exec appraisal list`.lines.map(&:chomp).each do |appraise_def|
+     success = system('appraisal', appraise_def, 'rspec', 'spec')
+     success_map[appraise_def] = success
+  end
+  puts "\n===== Test Summary ====="
+  success_map.each do |appraise_def, success|
+    puts "#{appraise_def}: #{success ? 'no failures (but check pending)' : 'failed'}"
+  end
+end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+gem "activesupport", "~> 3.2.0"
+gem "actionpack", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+gem "activesupport", "~> 4.0.0"
+gem "actionpack", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+gem "activesupport", "~> 4.1.0"
+gem "actionpack", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+gem "activesupport", "~> 4.2.0"
+gem "actionpack", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/sql_safety_net/connection_adapter.rb

@@ -35,24 +35,17 @@ module SqlSafetyNet
         results = yield
         elapsed_time = Time.now - start_time
         
-        expanded_sql = sql
-        unless binds.empty?
-          sql = "#{sql} #{binds.collect{|col, val| [col.name, val]}.inspect}"
-        end
-        rows = results.size
+        # In Rails 4, results is an ActiveRecord::Result, so use #count
+        row_count = results.count
         result_size = 0
         results.each do |row|
           values = row.is_a?(Hash) ? row.values : row
           values.each{|val| result_size += val.to_s.size if val}
         end
         cached = CacheStore.in_fetch_block?
-        sql_str = nil
-        if method(:to_sql).arity == 1
-          sql_str = (sql.is_a?(String) ? sql : to_sql(sql))
-        else
-          sql_str = to_sql(sql, binds)
-        end
-        query_info = QueryInfo.new(sql_str, :elapsed_time => elapsed_time, :rows => rows, :result_size => result_size, :cached => cached)
+
+        query_info = QueryInfo.new(append_binds(sql, binds), :elapsed_time => elapsed_time,
+                                   :rows => row_count, :result_size => result_size, :cached => cached)
         queries << query_info
         
         # If connection includes a query plan analyzer then alert on issues in the query plan.
@@ -67,6 +60,14 @@ module SqlSafetyNet
         yield
       end
     end
-    
+
+    # the returned string is for display only; it's not valid sql
+    def append_binds(sql_str, binds)
+      if binds.empty?
+        sql_str
+      else
+        "#{sql_str} #{binds.map {|col, val| [col.name, val] }.inspect}"
+      end
+    end
   end
 end

data/lib/sql_safety_net/version.rb

@@ -1,3 +1,3 @@
 module SqlSafetyNet
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.0.2'.freeze
 end

data/spec/connection_adapter_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe SqlSafetyNet::ConnectionAdapter do
+  # ActiveRecord 4's conn.select returns an ActiveRecord::Result. This normalizes it so we can test on both AR 3.2 & 4.x
+  def hashify_select_result(results)
+    results.respond_to?(:to_hash) ? results.to_hash : results
+  end
   
   let(:connection){ SqlSafetyNet::TestModel.connection }
   
@@ -17,7 +21,9 @@ describe SqlSafetyNet::ConnectionAdapter do
     
     it "should analyze queries in the select method" do
       connection.should_receive(:analyze_query).with("select name, value from test_models", "SQL", []).and_yield
-      connection.send(:select, "select name, value from test_models", "SQL").should == [{"name"=>"test", "value"=>10}]
+      hashify_select_result(
+        connection.send(:select, "select name, value from test_models", "SQL")
+      ).should == [{"name"=>"test", "value"=>10}]
     end
   end
   
@@ -34,7 +40,7 @@ describe SqlSafetyNet::ConnectionAdapter do
       it "should analyze select statements" do
         SqlSafetyNet::QueryAnalysis.capture do |analysis|
           results = connection.send(:select, "select name, value from test_models order by name")
-          results.should == [{"name" => "foo", "value" => 100}, {"name" => "test", "value" => 10}]
+          hashify_select_result(results).should == [{"name" => "foo", "value" => 100}, {"name" => "test", "value" => 10}]
           analysis.queries.size.should == 1
           query_info = analysis.queries.first
           query_info.sql.should == "select name, value from test_models order by name"
@@ -44,20 +50,17 @@ describe SqlSafetyNet::ConnectionAdapter do
         end
       end
       
-      # ActiveRecord < 3.1 doesn't have the binds parameter
-      if ActiveRecord::VERSION::MAJOR > 3 || (ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR >= 1)
-        it "should analyze select statements using bind variables" do
-          SqlSafetyNet::QueryAnalysis.capture do |analysis|
-            name_column = SqlSafetyNet::TestModel.columns_hash["name"]
-            results = connection.send(:select, "select name, value from test_models where name = ? order by name", "SQL", [[name_column, "foo"]])
-            results.should == [{"name" => "foo", "value" => 100}]
-            analysis.queries.size.should == 1
-            query_info = analysis.queries.first
-            query_info.sql.should == 'select name, value from test_models where name = ? order by name [["name", "foo"]]'
-            query_info.rows.should == 1
-            query_info.result_size.should == 6
-            query_info.elapsed_time.should > 0
-          end
+      it "should analyze select statements using bind variables" do
+        SqlSafetyNet::QueryAnalysis.capture do |analysis|
+          name_column = SqlSafetyNet::TestModel.columns_hash["name"]
+          results = connection.send(:select, "select name, value from test_models where name = ? order by name", "SQL", [[name_column, "foo"]])
+          hashify_select_result(results).should == [{"name" => "foo", "value" => 100}]
+          analysis.queries.size.should == 1
+          query_info = analysis.queries.first
+          query_info.sql.should == 'select name, value from test_models where name = ? order by name [["name", "foo"]]'
+          query_info.rows.should == 1
+          query_info.result_size.should == 6
+          query_info.elapsed_time.should > 0
         end
       end
       

data/spec/spec_helper.rb

@@ -1,11 +1,5 @@
-require 'rubygems'
-
-active_record_version = ENV['ACTIVE_RECORD_VERSION'] || ">=3.2.0"
-gem 'activerecord', active_record_version
-gem 'activesupport', active_record_version
 require 'active_support/all'
 require 'active_record'
-puts "Testing against activerecord #{ActiveRecord::VERSION::STRING}"
 
 begin
   require 'simplecov'

data/sql_safety_net.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sql_safety_net/version'
 Gem::Specification.new do |spec|
   spec.name          = 'sql_safety_net'
-  spec.version       = SqlSafetyNet::VERSION
+  spec.version       = SqlSafetyNet::VERSION.dup  # ruby 1.9 needs dup
   spec.authors       = ['Brian Durand', 'Milan Dobrota']
   spec.email         = ['mdobrota@tribpub.com']
   spec.summary       = 'Debug SQL statements in ActiveRecord'
@@ -16,12 +16,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '~> 3.2.0'
-  spec.add_runtime_dependency 'activerecord', '~> 3.2.0'
-  spec.add_runtime_dependency 'actionpack', '~> 3.2.0'
+  spec.add_runtime_dependency 'activesupport', '>= 3.2.0', '< 4.3'
+  spec.add_runtime_dependency 'activerecord' , '>= 3.2.0', '< 4.3'
+  spec.add_runtime_dependency 'actionpack'   , '>= 3.2.0', '< 4.3'
 
-  spec.add_development_dependency 'rspec', '~> 2.8.0'
+  spec.add_development_dependency 'rspec'       , '~> 2.99'
   spec.add_development_dependency 'sqlite3-ruby', '>= 0'
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'     , '~> 1.7'
+  spec.add_development_dependency 'rake'        , '~> 10.0'
+  spec.add_development_dependency 'appraisal'  , '~> 2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sql_safety_net
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Brian Durand
@@ -9,64 +9,82 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +127,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Debug SQL statements in ActiveRecord by displaying warnings on bad queries.
 email:
 - mdobrota@tribpub.com
@@ -117,10 +149,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Appraisals
 - Gemfile
 - License.txt
 - README.rdoc
 - Rakefile
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
 - lib/sql_safety_net.rb
 - lib/sql_safety_net/cache_store.rb
 - lib/sql_safety_net/configuration.rb