active-record-profiler 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f21bba7efa8c7b0a97c5cbb6e7f15afc0abce5f2
-  data.tar.gz: e0cbc22689b9d89ba6e7645e8188c53fdbbc9531
+  metadata.gz: 5c12f1f799f5c869fcf16f72e489ac780fceec1e
+  data.tar.gz: 4e48ed70ce4e865c1b6455d348406758c6093a8e
 SHA512:
-  metadata.gz: 099329047eed7c0453cc649d0cd50bbcbcb7d90da020c4849279daaee68255fd5c2c8d76b6b5dec7246272f4506d51d4f8d3f6918eb81aac63f8ce7fab4ed1a2
-  data.tar.gz: 69b055021bc8fb38adc0f7a220ef902da16fc7faa2c6f1360f6955a1798ac3619660552c1f87836757ddda608da69606d0056422d15f4d1cb4ffe536ea96eba1
+  metadata.gz: 0ab8ee51d8c05c57b3e66b509c66da56950b9e0a56bcd675878139324195059c63e48035b69c1b874cb8ed3b6e2aadf0a489e140feca165289de3cea2c3bf31c
+  data.tar.gz: 1c85774fa1246002d9dbca6b845d87ab5adac01451fd2ea0111c96d9a6bd29641784a85939b626a6281fe36255d5398c603437ce2d61aa142f977a504380dfd5

data/.gitignore

@@ -1,3 +1,4 @@
 test/dummy/log/*
 test/dummy/db/*.sqlite3
-test/dummy/tmp/*
+test/dummy/tmp/*
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+2.2.4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.0.0
+
+* Rails 5 compatibility
+
 # 1.2.0
 
 * Support for registering alternate editor URL schemes (see README)
@@ -7,7 +11,7 @@
 * Add self-profiling for the logger component
 * Prevent calling a logger.add block twice in the unusual case where the block returns a nil message.
 * Convert duration in events from milliseconds to seconds (doh!). You'll want to clear old profiler data when upgrading.
-* Don't accumulate statistics for queries fulfilled by the CACHE 
+* Don't accumulate statistics for queries fulfilled by the CACHE
 
 # 1.0
 

data/README.md

@@ -24,6 +24,12 @@ Add it to your Gemfile, like so:
 gem 'active-record-profiler'
 ```
 
+If you are using a version of Rails older than 5, you'll want the 1.2 release:
+
+```ruby
+gem 'active-record-profiler', '~> 1.2.1'
+```
+
 Then do `bundle install`, and then add a new initializer, `config/initializers/active_record_profiler.rb`:
 
 ```ruby

data/active-record-profiler.gemspec

@@ -21,8 +21,8 @@ EOF
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", "~> 4.0"
-  spec.add_dependency "jquery-rails", ">= 3.1", "< 4.1"
+  spec.add_dependency "rails", ">= 5.0"
+  spec.add_dependency "jquery-rails"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.3"

data/app/helpers/active_record_profiler/reports_helper.rb

@@ -23,5 +23,9 @@ module ActiveRecordProfiler
     def location_description(path, line_number)
       "#{breakable_path(path)}: #{h(line_number)}".html_safe
     end
+
+    def report_params
+      @_report_params ||= params.permit(:sort, :date)
+    end
   end
 end

data/app/views/active_record_profiler/reports/_report_table.html.erb

@@ -3,16 +3,16 @@
     <tr>
       <th class="location">Location</th>
       <th class="duration">
-        <%= report_column_header_link(ActiveRecordProfiler::Collector::DURATION, @report_options[:sort], 'Total Duration (s)', params) %>
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::DURATION, @report_options[:sort], 'Total Duration (s)', report_params) %>
       </th>
       <th class="count">
-        <%= report_column_header_link(ActiveRecordProfiler::Collector::COUNT, @report_options[:sort], 'Count', params) %>
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::COUNT, @report_options[:sort], 'Count', report_params) %>
       </th>
       <th class="average-duration">
-        <%= report_column_header_link(ActiveRecordProfiler::Collector::AVG_DURATION, @report_options[:sort], 'Avg. Duration (ms)', params) %>
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::AVG_DURATION, @report_options[:sort], 'Avg. Duration (ms)', report_params) %>
       </th>
       <th class="max-duration">
-        <%= report_column_header_link(ActiveRecordProfiler::Collector::LONGEST, @report_options[:sort], 'Max. Duration (ms)', params) %>          
+        <%= report_column_header_link(ActiveRecordProfiler::Collector::LONGEST, @report_options[:sort], 'Max. Duration (ms)', report_params) %>          
       </th>
       <th class="max-duration-sql">SQL for Max Duration</th>
     </tr>

data/config/initializers/default_config.rb

@@ -4,5 +4,6 @@ ActiveRecordProfiler.sql_ignore_pattern =
   /^(SHOW (:?FULL )?FIELDS |SET SQL_AUTO_IS_NULL|SET NAMES |EXPLAIN |BEGIN|COMMIT|PRAGMA )/i
 ActiveRecordProfiler.app_path_pattern = Regexp.new(Regexp.quote("#{Rails.root.expand_path}/") + "(:?app|lib|vendor)/")
 ActiveRecordProfiler.trim_root_path = "#{Rails.root.expand_path}/"
+ActiveRecordProfiler.trim_cache_id_pattern = /___?[0-9]+_[0-9]+(?=')/
 ActiveRecordProfiler.profile_self = false
 ActiveRecordProfiler.link_location = false

data/lib/active-record-profiler.rb

@@ -7,8 +7,9 @@ require "active-record-profiler/engine" if defined?(Rails)
 module ActiveRecordProfiler
   require 'fileutils'
   require 'json'
-  
-  mattr_accessor :link_location, :stats_flush_period, :profile_dir, 
-      :sql_ignore_pattern, :app_path_pattern, :trim_root_path, :profile_self
+
+  mattr_accessor :link_location, :stats_flush_period, :profile_dir,
+      :sql_ignore_pattern, :app_path_pattern, :trim_root_path,
+      :trim_cache_id_pattern, :profile_self
 end
 

data/lib/active-record-profiler/collector.rb

@@ -42,7 +42,11 @@ module ActiveRecordProfiler
     
     # This prefix will be removed from location names, for brevity.
     cattr_accessor :trim_root_path
-    
+
+    # This pattern will be removed from location names, to remove cache ids that change
+    # when templates are recompiled.
+    cattr_accessor :trim_cache_id_pattern
+
     # Controls whether or not to record profiling data for time spent in the
     # profiler code itself.
     cattr_accessor :profile_self
@@ -188,8 +192,8 @@ module ActiveRecordProfiler
     protected
 
     def find_app_call_location(call_stack)
-      call_stack = caller
-      while frame = call_stack.shift
+      call_stack ||= caller(2)
+      call_stack.each do |frame|
         if app_path_pattern.match(frame)
           return trim_location(frame)
         end
@@ -198,7 +202,7 @@ module ActiveRecordProfiler
     end
     
     def trim_location(loc)
-      loc.sub(trim_root_path, '')
+      loc.sub(trim_root_path, '').sub(trim_cache_id_pattern, '')
     end
     
     def update_counts(location, seconds, count, sql, longest = nil)

data/lib/active-record-profiler/engine.rb

@@ -8,10 +8,12 @@ module ActiveRecordProfiler
 
     initializer "active_record_profiler.apply_default" do
       # Copy module settings to collector class
-      [:stats_flush_period, :profile_dir, :sql_ignore_pattern, 
-          :app_path_pattern, :trim_root_path, :profile_self
+      [
+        :stats_flush_period, :profile_dir, :sql_ignore_pattern,
+        :app_path_pattern, :trim_root_path, :trim_cache_id_pattern,
+        :profile_self
       ].each do |config_item|
-        ActiveRecordProfiler::Collector.send("#{config_item}=".to_sym, 
+        ActiveRecordProfiler::Collector.send("#{config_item}=".to_sym,
             ActiveRecordProfiler.send(config_item))
       end
     end

data/lib/active-record-profiler/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordProfiler
-  VERSION = "1.2.1"
+  VERSION = "2.0.0"
 end

data/test/active_record_profiler/collector_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper.rb'
+
+module ActiveRecordProfiler
+  class CollectorTest < ActiveSupport::TestCase
+    def setup
+      @test_log = StringIO.new
+      ActiveRecord::Base.logger = ActiveSupport::Logger.new(@test_log)
+    end
+
+    def test_template_path_removes_app_root
+      stack_locations = [
+        "/var/deploy/current/app/views/users/_row.html.erb:34:in `_app_views_users__row_html_erb___3709568271919910637_70125680359900'",
+        "/var/deploy/current/app/views/users/index.html.erb:34:in `_app_views_users_index_html_erb__1553888856029099377_70230900703660'",
+        "/var/deploy/rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/gems/actionview-5.1.4/lib/action_view/template.rb:352:in `instrument_render_template'",
+      ]
+      location = app_collector.call_location_name(stack_locations)
+
+      assert_match(%r{\A/app/views/users/_row.html.erb:34:in `}, location)
+    end
+
+    def test_template_path_includes_only_real_path_components
+      stack_locations = [
+        "/var/deploy/current/app/views/users/_row.html.erb:34:in `_app_views_users__row_html_erb___3709568271919910637_70125680359900'",
+        "/var/deploy/current/app/views/users/index.html.erb:34:in `_app_views_users_index_html_erb__1553888856029099377_70230900703660'",
+        "/var/deploy/rbenv/versions/2.2.4/lib/ruby/gems/2.2.0/gems/actionview-5.1.4/lib/action_view/template.rb:352:in `instrument_render_template'",
+      ]
+      location = app_collector.call_location_name(stack_locations)
+
+      assert_match(/in `.*app.*views.*users.*row.*html.*erb'\z/, location)
+    end
+
+    private
+
+    def app_collector(app_root: "/var/deploy/current")
+      @app_collector ||= Collector.new.tap do |collector|
+        collector.app_path_pattern = Regexp.new(Regexp.quote("/var/deploy/current"))
+        collector.trim_root_path = "/var/deploy/current"
+      end
+    end
+  end
+end

data/test/active_record_profiler_test.rb

@@ -7,13 +7,13 @@ class ActiveRecordProfilerTest < ActiveSupport::TestCase
     ActiveRecord::Base.logger = ActiveRecordProfiler::Logger.new(
         ActiveSupport::Logger.new(@test_log))
   end
-  
+
   def test_caller_location_appears_in_log
     sql = 'SELECT 1 FROM widgets'
     ActiveRecord::Base.connection.select_value(sql)
     @test_log.rewind
     log_data = @test_log.read
-    assert_match Regexp.new(Regexp.quote(sql) + '.*' + Regexp.quote('active_record_profiler_test.rb')), log_data
+    assert_match Regexp.new(Regexp.quote(sql)), log_data
   end
 
   def test_profiler_records_query_site

data/test/dummy/config/application.rb

@@ -17,9 +17,6 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
-
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
   end
 end
 

metadata

@@ -1,49 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: active-record-profiler
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Ben Turner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2018-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +134,7 @@ files:
 - lib/active-record-profiler/version.rb
 - screenshots/enhanced-log.png
 - screenshots/web-reports.png
+- test/active_record_profiler/collector_test.rb
 - test/active_record_profiler_test.rb
 - test/database.yml
 - test/dummy/README.rdoc
@@ -213,11 +208,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Enhances ActiveRecord logging and profiles queries
 test_files:
+- test/active_record_profiler/collector_test.rb
 - test/active_record_profiler_test.rb
 - test/database.yml
 - test/dummy/README.rdoc