rack-allocation_stats 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b36969b445a5459be5b57b576864b2ae741fa2
-  data.tar.gz: 3457b2ae204c7c4f705579e10d09f96f152fd169
+  metadata.gz: 0322a9bc39fa60cc33477bfcdff560519400aed3
+  data.tar.gz: c3e0738e1466e9c871edd03e59669cff5bcd0dbd
 SHA512:
-  metadata.gz: 7e4cf3c9b759764b915245db5ef056206654d26a6351adb45a5e2bf941e2d31ecba9d4c051b99f8421e69838297569388f8f32299776462289f49a84ede318fc
-  data.tar.gz: b408730fbd13191ad4d753a7f698b5eecf7c3ad856fa1b97e0089f3d89d15aeed54f810434b0b6c227fc39e56cf3f92029fd2e0e4488a65cf59ceffff43a462c
+  metadata.gz: 470676c568c368c51640fbaff41388797f1bf67c623cf984734c1e28db82f6ed9605b4b27fdef87a4256d90d0851d7672224b37387c5bd6c4802d1c00cf3061d
+  data.tar.gz: 8c5292291c5b64fff7bdf36deada58a7e39b68fc1e3af6fe0f099b9519d1f6d2cc1da9a03ca37d3a65e4497664d493c10dcff689027a95bea904303d581becdd

data/CHANGELOG.markdown

@@ -0,0 +1,7 @@
+v0.1.1
+
+* Fixed: should be including non-ruby interactive files in the gemspec
+
+v0.1.0
+
+* A lot of stuff

data/LICENSE

@@ -0,0 +1,195 @@
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "{}" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+

data/README.markdown

@@ -0,0 +1,114 @@
+Rack AllocationStats [![Build Status](https://travis-ci.org/srawlins/rack-allocation_stats.png?branch=master)](https://travis-ci.org/srawlins/rack-allocation_stats)
+====================
+
+Rack AllocationStats is a Rack Middleware, similar in design to
+[rack-perftools_profiler](https://github.com/bhb/rack-perftools_profiler), that
+will show information about object allocations that occurr during an HTTP
+request. The heart of Rack AllocationStats is the
+[AllocationStats](https://github.com/srawlins/allocation_stats) gem. Install
+Rack AllocationStats with Ruby 2.1 (newer than preview1) and:
+
+* Bundler: add `gem 'rack-allocation_stats'` to your Gemfile, or
+* RubyGems: run `gem install rack-allocation_stats`
+
+Rack AllocationStats must also be included in your Rack application's middleware:
+
+Rails:
+
+```ruby
+# in your config/application.rb
+config.middleware.use ::Rack::AllocationStats
+```
+
+Other Rack apps:
+
+```ruby
+# in your rackup file
+use Rack::AllocationStats
+```
+
+Summary
+=======
+
+In order to trigger Rack AllocationStats, a parameter must be appended to the
+request URL: `ras[trace]=true` ('ras' for Rack AllocationStats). This will
+trace the object allocations that occur inside your Rack app during your
+request.
+
+For example, if you have a Rack app that responds to the following request:
+
+```bash
+http://my.rack.app:9292/path?foo=bar
+```
+
+then you can just add `&ras[trace]=true` to activate Rack AllocationStats:
+
+```bash
+http://my.rack.app:9292/path?foo=bar&ras[trace]=true
+```
+
+Instead of the normal response that your app generates, Rack
+AllocationStats will respond with a tabular listing of allocation statistics.
+
+![Demonstration](basic-screen.gif)
+
+There are additional paramters that you can attach to the request URL to change
+the response:
+
+Help text
+=========
+
+To see some help text on what options are available, use `ras[trace]=true`, and
+also add `ras[help]`. Rack AllocationStats will respond with man page-style
+help text.
+
+Limit the file system scope
+===========================
+
+If you only wish to see allocations that originate from a certain directory, you can
+use the `ras[scope]` parameter. For example:
+
+* To limit the list of allocations to those with a `sourcefile` that includes
+  `yajl`, append to the location:
+  ```
+  ?ras[trace]=true&ras[scope]=yajl
+  ```
+
+* To limit the list of allocations to those in the present working directory.
+  `.` is a special value for `ras[scope]` that is expanded to the full path of
+  the present working directory, append to the location:
+  ```
+  ?ras[trace]=true&ras[scope]=.
+  ```
+
+Alias paths
+===========
+
+In order to reduce the with of the `sourcefile`, you can add
+`ras[alias_paths]=true`, which will shorten paths in the following directories:
+
+* your present working directory (to be replaced with `<PWD>`)
+* Ruby's `lib` directory (to be replaced with `<RUBYLIBDIR>`)
+* the Gem directory, where installed gems live (eg: sqlite3-1.3.8 to be
+  replaced with `<GEM:sqlite3-1.3.8>`)
+
+Change the output
+=================
+
+There are several values that you can pass with `ras[output]` parameter:
+
+* `columnar` is the default response output, displaying allocation groups in
+  text columns.
+* `json` will respond with a JSON string representing all of the groups of
+  allocations (by default grouped by sourcefile, sourceline, and object class).
+* `interactive` will respond with a JavaScript application that allows you to
+  interactively tweak how you wish to group, arrange, and filter the traced
+  allocations.
+
+Request multiple times
+======================
+
+If your Rack application appears to have some variability, you can use
+`ras[times]=N` to pass the request onto your Rack application `N` times. The
+response that Rack AllocationStats generates will contain all of the requests
+that occurred over the `N` requests.

data/TODO.markdown

@@ -0,0 +1,31 @@
+* README
+
+Interactive Mode
+================
+
+* option to divide counts by ras[times]
+* filter out specific gem
+* add sinatra example / spec
+* sorting ability
+* linkify ruby code
+* count pct choice
+* group by custom
+* display all ras[] parameters
+  (where? they're all in the location bar for now...)
+* jasmine specs:
+  * `byFileLineAndClassPlus()`
+  * `fillClassAbbreviations()`
+  * `filterOutGems()`
+  * `filterOutEval()`
+  * `filterAllocationsByControls()`
+  * `groupByFields()`
+  * `minCount()` ?
+  * `tupleize()`
+
+Output
+======
+
+* add `ras[output]=csv`
+* add `ras[group_by]=...`
+* add `ras[detail]=percent`
+* add `ras[burn]=BURN`

data/lib/rack/allocation_stats/help.txt

@@ -0,0 +1,19 @@
+Rack AllocationStats help
+
+Append ras[trace]=true to your URL to trace all object allocations during the
+request. The server will respond with statistics on the allocations, instead of
+the application's response.
+
+Options
+
+ras[times]=COUNT
+    send the request to the application COUNT times, to reduce statistics from
+    initial allocations that don't happen on repeat requests.
+
+ras[help]
+    immediately respond with this help text
+
+ras[scope]=SCOPE
+    limit the list of allocations in the response to those whose `sourcefile`
+    matches SCOPE. ras[scope]='.' is a special case which is expanded to be
+    the current working directory.

data/lib/rack/allocation_stats/interactive/allocations.js.erb

@@ -0,0 +1,24 @@
+/* Copyright 2013 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+ */
+
+var allocations = <%= Yajl::Encoder.encode(@allocations) %>;
+var pwd = "<%= Dir.pwd %>";
+var classAbbreviations = {};
+
+$(function() {
+  fillClassAbbreviations();
+
+  fillTableWith(
+      _.sortBy(
+          tupleize(_.groupBy(filterAllocationsByControls(), byFileLineAndClassPlus)),
+          valueLength
+      ),
+      ["file", "line", "class+ (abbrev)"]
+  );
+
+  $("#gb-controls input").change(refillTable);
+  $("#filter-controls input").change(refillTable);
+  $("#filter-count").change(refillTable);
+  $("#option-abbreviate-classes").change(refillTable);
+});

data/lib/rack/allocation_stats/interactive/index.html.erb

@@ -0,0 +1,109 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Rack::AllocationStats</title>
+
+    <script>
+<%= jquery_min_js %>
+    </script>
+
+    <script>
+<%= jquery_ui_min_js %>
+    </script>
+
+    <script>
+<%= underscore_min_js %>
+    </script>
+
+    <script>
+<%= interactive_js %>
+    </script>
+
+    <script>
+<%= allocations_js %>
+    </script>
+
+    <style>
+<%= jquery_ui_min_css %>
+    </style>
+
+    <style>
+<%= style_css %>
+    </style>
+
+    <script>
+$(function() {
+  var spinnerStart = Math.max(getParameterByName("ras[times]")*1, 1);
+  $("#filter-count").
+    val(spinnerStart).
+    spinner({
+      step: spinnerStart,
+      spin: function(event, ui) {
+        if (ui.value < 1 ) { $(this).spinner("value", 1); return false; }
+      },
+      change: refillTable,
+      stop: refillTable
+    });
+});
+    </script>
+  </head>
+  <body>
+    <main id="everything">
+      <h1>Rack::AllocationStats</h1>
+      <% if defined?(Rails) && Rails.env != "production" %>
+        <div class="warning">
+          Warning: This Rails app is running in <strong><%= Rails.env %></strong>
+          mode. You should only run Rack::AllocationStats against a Rails app in
+          <strong>production</strong> mode; the allocations below will be
+          <em>significantly</em> different (fewer).
+        </div>
+      <% end %>
+
+      <section id="controls">
+        <section id="gb-controls">
+          group by:
+          <label for="gb-file"><input type="checkbox" id="gb-file" name="file" checked="checked"></input>file</label>
+          <label for="gb-line"><input type="checkbox" id="gb-line" name="line" checked="checked"></input>line</label>
+          <label for="gb-class-path"><input type="checkbox" id="gb-class-path" name="class_path"></input>class path</label>
+          <label for="gb-method-id"><input type="checkbox" id="gb-method-id" name="method_id"></input>method id</label>
+          <label for="gb-class"><input type="checkbox" id="gb-class" name="class"></input>class</label>
+          <label for="gb-class-plus"><input type="checkbox" id="gb-class-plus" name="class_plus" checked="checked"></input>class+</label>
+        </section>
+
+        <section id="filter-controls">
+          <div>
+            filter out:
+            <label for="filter-ruby"><input type="checkbox" id="filter-ruby" name="filter-ruby"></input>ruby</label>
+            <label for="filter-gems"><input type="checkbox" id="filter-gems" name="filter-gems"></input>gems</label>
+            <label for="filter-pwd"><input type="checkbox" id="filter-pwd" name="filter-pwd"></input>project (PWD)</label>
+            <label for="filter-eval"><input type="checkbox" id="filter-eval" name="filter-eval" checked="checked"></input>(eval)</label>
+          </div>
+          <!--div>
+            specific gems:
+            <% allocating_gems.each do |allocating_gem| %>
+              <%= allocating_gem %>
+            <% end %>
+          </div-->
+        </section>
+
+        <section id="filter-controls">
+          only groups with at least:
+          <input type="text" id="filter-count" name="filter-count" />
+          allocations
+        </section>
+
+        <section id="option-controls">
+          <label for="option-abbreviate-classes">
+            <input type="checkbox" id="option-abbreviate-classes" name="option-abbreviate-classes" checked="checked"></input>abbreviate classes
+          </label>
+        </section>
+      </section>
+
+      <table id="allocations" cellpadding="0" cellspacing="0">
+        <thead></thead>
+        <tbody></tbody>
+      </table>
+      <div id="allocations-row-count"></div>
+    </main>
+  </body>
+</html>