active-record-profiler 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a7100d5c7531cd91b863eda7d33b18e4bf42f70
-  data.tar.gz: bff2d8ace930dbc38ce3a1ec2bc6a36ed9f6e33a
+  metadata.gz: 9d6641cabb2840a5296af94eefdcc316c0e9db6a
+  data.tar.gz: 4fb6390d719cac7e40cf23fca1cdfa51c25e35fb
 SHA512:
-  metadata.gz: 983b8595fbeedc12c65082590033ff996adc409c044682cd8cb6ece0dc893353771c72fdb1b063d137a4f840cceb582f7a9cffafb41a15cd6f7ddbaa78320501
-  data.tar.gz: 4463447815648e31ca7ac8ace162fa9bcb22647510af5827e7867f3f8a9534c8fe829553ba6e483665d22f53005f12b4674922a7c60937d99350443b6abcf827
+  metadata.gz: 2a9998a9a5c8043121ab527de45f88aef74582deb027dc8a54e3c47d6968e1a078f511883f43c46d56d739e283fd34e324a1fd3c5b4a50937cabc1a03aea90b7
+  data.tar.gz: b0b449787dd1cf05f38a377cb16518dc71a3a4570625ffc34f6faefb4d4a1acf95c41d24cad032b227a8af1995f5809d722ccaf73bf8706e64c38fc3e6ff6e6a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.2.0
+
+* Support for registering alternate editor URL schemes (see README)
+
 # 1.1.0
 
 * Add self-profiling for the logger component

data/README.md

@@ -1,6 +1,5 @@
 ActiveRecordProfiler
 ====================
-** Note: ** This gem is in transition from an old Rails 2.x plugin and still has some issues to iron out. In particular, using the notification system to track ActiveRecord query durations isn't as straightforward as it seems, so the times recorded by the profiler don't match the times ActiveRecord reports in the logs. It's still handy for tracking where your N+1 queries are coming from, thoug....
 
 The `active-record-profiler` gem adds a log formatter to improve the standard SQL logging and a log subscriber to provide profiler-like tracking of SQL statements generated by application code. The log formatter makes the SQL statements in your logs look like this (imagine it's all in one log line):
 
@@ -21,13 +20,17 @@ Installation
 ============
 Add it to your Gemfile, like so:
 
-    gem 'active-record-profiler'
+```ruby
+gem 'active-record-profiler'
+```
 
 Then do `bundle install`, and then add a new initializer, `config/initializers/active_record_profiler.rb`:
 
-    ActiveRecord::Base.logger =
-        ActiveRecordProfiler::Logger.new(ActiveRecord::Base.logger)
-    ActiveRecordProfiler::LogSubscriber.attach_to :active_record unless Rails.env.test?
+```ruby
+ActiveRecord::Base.logger =
+    ActiveRecordProfiler::Logger.new(ActiveRecord::Base.logger)
+ActiveRecordProfiler::LogSubscriber.attach_to :active_record unless Rails.env.test?
+```
 
 The first line adds call-site information to ActiveRecord logging, and the second line enables profiling (except in the test environment, where it would mess up your profiling data).
 
@@ -37,65 +40,107 @@ Configuration
 ## stats_flush_period ##
 Control the (approximate) frequency of statistics flushes (default: `1.hour`)
 
-    ActiveRecordProfiler.stats_flush_period = 1.hour
+```ruby
+ActiveRecordProfiler.stats_flush_period = 1.hour
+```
 
-Note that only flushed data is available for use in the rake reports (described below). If you are running a multithreaded or multiprocess server (which covers most common rails server types), your data will be incomplete until all those threads/processes/servers have flushed their data. This limitation exists primarily to avoid the overhead of coordinating/locking during the process of serving your application's web requests.
+Note that only flushed data is available for use in the reports (described below). If you are running a multithreaded or multiprocess server (which covers most common rails server types), your data will be incomplete until all those threads/processes/servers have flushed their data. This limitation exists primarily to avoid the overhead of coordinating/locking during the process of serving your application's web requests.
 
 ## profile_dir ##
 Directory where profile data is recorded. (default: `Rails.root,join('log', 'profiler_data'`)
 
-    ActiveRecordProfiler.profile_dir = Rails.root.join('log', 'profiler_data'
+```ruby
+ActiveRecordProfiler.profile_dir = Rails.root.join('log', 'profiler_data')
+```
 
 ## sql_ignore_pattern ##
-Any SQL statements matching this pattern will not be tracked by the profiler output, though it will still appear in the enhanced SQL logging. (default: `/^(SHOW FIELDS |SET SQL_AUTO_IS_NULL|SET NAMES |EXPLAIN |BEGIN|COMMIT|PRAGMA )/`)
+Any SQL statements matching this pattern will not be tracked by the profiler output, though it will still appear in the enhanced SQL logging. (default: `/^(SHOW (:?FULL )?FIELDS |SET SQL_AUTO_IS_NULL|SET NAMES |EXPLAIN |BEGIN|COMMIT|PRAGMA )/`)
 
-    ActiveRecordProfiler.sql_ignore_pattern = /^SET /x
+```ruby
+ActiveRecordProfiler.sql_ignore_pattern = /^SET /x
+```
 
 ## app_path_pattern ##
  Any calling location that matches this pattern will be tracked individually. Any locations that do __not__ match will be grouped under a single `Non-application code` label. The default only includes the `app`, `lib`, and `vendor` directories, but that's usually suitable and avoids noise. (default: `Regexp.new(Regexp.quote("#{Rails.root.expand_path}/") + "(:?app|lib|vendor)/")`)
 
-    ActiveRecordProfiler.app_path_pattern = Regexp.new(Regexp.quote("#{Rails.root.expand_path}/"))
+```ruby
+ActiveRecordProfiler.app_path_pattern = Regexp.new(Regexp.quote("#{Rails.root.expand_path}/"))
+```
 
 ## trim_root_path ##
 This prefix will be removed from the calling site filepath for brevity. (default: `"#{Rails.root.expand_path}/"`)
 
-    ActiveRecordProfiler.trim_root_path = "#{Rails.root.parent.expand_path}/app"
+```ruby
+ActiveRecordProfiler.trim_root_path = "#{Rails.root.parent.expand_path}/app"
+```
 
 ## profile_self ##
 This setting controls whether the profiler records information about how much time was spent in the profiling code itself. If you want to know what kind of overhead the profiler is adding, set this to true. (default: `false`)
 
-    ActiveRecordProfiler.profile_self = true
-
+```ruby
+ActiveRecordProfiler.profile_self = true
+```
 
 ## link_location ##
 Whether or not to make the locations in the profiler reports into source code links (only works with editors that can be launched via URL scheme) (default: `false`):
 
-    ActiveRecordProfiler.link_location = true
-
+```ruby
+ActiveRecordProfiler.link_location = true
+```
+
+## Source Code Editor Links ##
+ActiveRecordProfiler currently only knows how to build links for a couple of different editors, but you can configure your own by adding a partial to your application, in `shared/active_record_profiler/_editor.html.erb`, which contains javascript code to set up a new formatter:
+
+```html
+<script type="text/javascript">
+  // Remove default formatters, if you want:
+  // ActiveRecordProfiler.clearLinkFormatters();
+  //
+  // Add a new editor with a name and a function that takes the file and line 
+  // number, and returns a URL that links to that source code location:
+  ActiveRecordProfiler.registerLinkFormatter('Sublime Text', 
+      function(file, line, selectedLinkFormatter) {
+        return "subl://open/?url=file://" + file + "&line=" + line;
+      }
+  );
+</script>
+```
+
+The `ActiveRecordProfiler.registerLinkFormatter` method takes a `name` parameter (this shows up in the Editor menu) and a function which will be passed the `file` and `line` of a calling site. It will also be sent the `name` of the currently selected formatter, but this is usually ignored. The function should return a URL that links to the editor or source code view.
 
 Command Line Reports
 ====================
 To see a top-100 list of what SQL statements your application is spending its time in, run the following rake task:
 
-    rake profiler:aggregate max_lines=100 show_sql=true
+```bash
+rake profiler:aggregate max_lines=100 show_sql=true
+```
 
 This will return a list of the SQL which is taking the most time in your application in this format:
 
-    <file path>:<line number>:in <method name>: <total duration>, <call count>, <max single call duration>
+```
+<file path>:<line number>:in <method name>: <total duration>, <call count>, <max single call duration>
+```
 
 This will aggregate all of the profiler data you have accumulated; in order to limit the timeframe of the data, use the `prefix` option to specify a partial date/time:
 
-    rake profiler:aggregate max_lines=100 show_sql=true prefix=2010-06-20-10  # data from June 20 during the 10am hour (roughly)
+```bash
+rake profiler:aggregate max_lines=100 show_sql=true prefix=2010-06-20-10  # data from June 20 during the 10am hour (roughly)
+```
 
 Each thread running the profiler flushes its stats periodically, and there is a rake task to combine multiple profiler data files together in order to keep the number of data files down to a manageable number. A good way to manage the data files on a server is to set up a cron task to run the following command once per hour or once per day:
 
-    rake profiler:aggregate compact=<'hour' or 'date'> RAILS_ENV=qa
+```bash
+rake profiler:aggregate compact=<'hour' or 'date'> RAILS_ENV=qa
+```
 
 Compacting by hour will result in a single file for each hour any process dumped its stats. Compacting by day will result in a single file for each day. When using the `prefix` option to generate a profiler report, you cannot specify an hour if you have compacted your data by date instead of hour (the prefix matching operates on the file names, which will not have hours if they have been compacted by date).
 
 You can clear out all profiler data using the following command:
 
-    rake profiler:clear_data
+```bash
+rake profiler:clear_data
+```
   
 If you want programmatic access to the profiler data, check out the source code for the rake tasks in `lib/active-record-profiler/tasks.rake`.
 
@@ -109,13 +154,17 @@ The `active-record-profiler` gem also includes support for producing reports in
  
 In order to make it available, you'll want to mount the engine within your application's `routes.rb`. Since you don't want the public to have access to your profiler reports, you'll want to limit access to it. You could only mount the profiler's web interface in the development environment:
 
-    mount ActiveRecordProfiler::Engine => "/profiler"  if Rails.env.development?
+```ruby
+mount ActiveRecordProfiler::Engine => "/profiler"  if Rails.env.development?
+```
 
 Or, if you are using [Devise](https://github.com/plataformatec/devise) and have an admin flag on a `User` model, for example:
 
-    authenticated :user, -> user { user.admin? } do
-      mount ActiveRecordProfiler::Engine => "/profiler"
-    end
+```ruby
+authenticated :user, -> user { user.admin? } do
+  mount ActiveRecordProfiler::Engine => "/profiler"
+end
+```
 
 When you visit the path where you've mounted the web interface, you will by default see a report for the current day. If you just installed `active-record-profiler`, there probably won't be anything there yet, in which case you should go play with your app for a while and come back later. :) Also note that if the web server you are using has multiple processes or threads, you won't see data from those other processes/threads until they dump their data.
 

data/app/assets/javascripts/active_record_profiler/profiler.js

@@ -3,7 +3,8 @@ var ActiveRecordProfiler = (function (my_module) {
 
   var SOURCE_ROOT_KEY = "db_prof_source_root";
   var SOURCE_EDITOR_KEY = "db_prof_source_editor";
-  var profilerSourceRootField, sourceEditorSelect, railsRoot;
+  var profilerSourceRootField, sourceEditorSelect, railsRoot, editorOptions, 
+      linkFormatters = {};
 
   function supportsLocalStorage() {
     try {
@@ -53,30 +54,58 @@ var ActiveRecordProfiler = (function (my_module) {
     }
   }
 
-  my_module.formatLink = function (file, line, editor) {
-    var link;
+  my_module.clearLinkFormatters = function () {
+    $.each(linkFormatters, function (editorName, formatter) {
+      if (editorOptions[editorName]) {
+        editorOptions[editorName].remove();
+      }
+    });
+    editorOptions = null;
+    linkFormatters = {};
+  };
 
-    switch (editor) {
-      case "subl":
-      case "txmt":
-        link = editor + "://open/?url=file://" + file + "&line=" + line;
-        break;
-      default:
-        // do nothing, return undefined link
+  my_module.registerLinkFormatter = function (name, formatter) {
+    if (!editorOptions) {
+      editorOptions = {};
+      sourceEditorSelect.find('option').each(function (index, el) {
+        jqElement = $(el);
+        editorOptions[jqElement.text()] = jqElement;
+      });
     }
 
-    return link;
+    linkFormatters[name] = formatter;
+    if (!editorOptions[name]) {
+      var newOption = $('<option>').text(name);
+      editorOptions[name] = newOption;
+      sourceEditorSelect.append(newOption);
+      if (name === getSourceEditor()) {
+        sourceEditorSelect.val(name);
+      }
+    } // else we already have an option and are just replacing the formatter
   };
 
   my_module.showSourceFile = function (file, line) {
     var root = profilerSourceRootField.val();
     var editor = sourceEditorSelect.val();
     if (root == "") { root = railsRoot; }
-    // window.location = "txmt://open/?url=file://" + root + "/" + file + "&line=" + line;
-    var link = my_module.formatLink(root + "/" + file, line, editor);
-    if (link) {
-      window.location = link;
+
+    if (!editor) {
+      console.log("Cannot link to source code: no editor specified.");
+      return;
+    }
+    var linkFormatter = linkFormatters[editor];
+    if (!linkFormatter) {
+      console.log("Cannot link to source code: no link formatter for editor '" + editor + "'.");
+      return;
+    }
+    var link = linkFormatter(root + "/" + file, line, editor);
+    if (!link) {
+      console.log("Cannot link to source code: link formatter returned undefined.");
+      return;
     }
+
+    // Send browser to editor link
+    window.location = link;
   };
 
   $(function () {
@@ -98,6 +127,20 @@ var ActiveRecordProfiler = (function (my_module) {
       var link = $(this);
       my_module.showSourceFile(link.data('file'), link.data('line'));
     });
+
+    // Install console.log dummy function if it doesn't exist, so we can log
+    // without fuss.
+    if (typeof window.console == 'undefined') { 
+      window.console = {log: function (msg) {} }; 
+    }
+
+    // Add known editors/link formatters
+    ActiveRecordProfiler.registerLinkFormatter('Sublime Text', function(file, line) {
+      return "subl://open/?url=file://" + file + "&line=" + line;
+    });
+    ActiveRecordProfiler.registerLinkFormatter('TextMate', function(file, line) {
+      return "txmt://open/?url=file://" + file + "&line=" + line;
+    });
   });
 
   return my_module;

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

@@ -5,7 +5,5 @@
   <label for="source_root">Editor (for location links):</label>
   <select id="source_editor">
     <option value="">None</option>
-    <option value="subl">Sublime Text</option>
-    <option value="txmt">TextMate</option>
   </select>
 </form>

data/app/views/layouts/active_record_profiler/application.html.erb

@@ -10,5 +10,7 @@
 
 <%= yield %>
 
+<%= render 'shared/active_record_profiler/editors' %>
+
 </body>
 </html>

data/app/views/shared/active_record_profiler/_editors.html.erb

@@ -0,0 +1,10 @@
+<script type="text/javascript">
+  // Remove default formatters, if you want:
+  // ActiveRecordProfiler.clearLinkFormatters();
+  //
+  // Add a new editor with a name and a function that takes the file and line 
+  // number, and returns a URL that links to that source code location:
+  // ActiveRecordProfiler.registerLinkFormatter('Sublime Text', function(file, line) {
+  //   return "subl://open/?url=file://" + file + "&line=" + line;
+  // });
+</script>

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

@@ -1,3 +1,3 @@
 module ActiveRecordProfiler
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active-record-profiler
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ben Turner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,6 +122,7 @@ files:
 - app/views/active_record_profiler/reports/_report_table.html.erb
 - app/views/active_record_profiler/reports/index.html.erb
 - app/views/layouts/active_record_profiler/application.html.erb
+- app/views/shared/active_record_profiler/_editors.html.erb
 - config/initializers/default_config.rb
 - config/routes.rb
 - lib/active-record-profiler.rb