rack-allocation_stats 0.1.0

data/spec/rack/allocation_stats_spec.rb

@@ -0,0 +1,216 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require_relative "../spec_helper"
+
+describe Rack::AllocationStats do
+  before do
+    @app = HelloWorldApp.new
+    @vanilla_request_env = Rack::MockRequest.env_for("/")
+    @traced_request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true")
+  end
+
+  it "returns something when called with a tracing request" do
+    status, headers, _ = Rack::AllocationStats.new(@app).call(@traced_request_env)
+
+    expect(headers["Content-Type"]).to eq "text/plain"
+    expect(status).to be 200
+  end
+
+  it "does not interfere when not a trace request" do
+    _, _, body = Rack::AllocationStats.new(@app).call(@vanilla_request_env)
+
+    expect(body).to eq ["Hello Rack!"]
+  end
+
+  it "deletes ras[] params before hitting next app" do
+    allocation_stats = Rack::AllocationStats.new(@app)
+
+    @app.should_receive(:call).with(query_string({}))
+
+    status, headers, _ = allocation_stats.call(@traced_request_env)
+  end
+
+  it "returns the correct body when called with a tracing request" do
+    _, _, body = Rack::AllocationStats.new(@app).call(@traced_request_env)
+
+    expected_body = [
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated    4 `String`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated    1 `Array<String>`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated    1 `Array<Fixnum,Hash,Array>`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated    1 `Hash`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[0]}  allocated    1 `String`\n"
+    ]
+
+    expect(body).to include(expected_body[0])
+    expect(body).to include(expected_body[1])
+    expect(body).to include(expected_body[2])
+    expect(body).to include(expected_body[3])
+    expect(body).to include(expected_body[4])
+  end
+
+  it "returns the correct body when called with alias_paths" do
+    request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[alias_paths]=true")
+    _, _, body = Rack::AllocationStats.new(@app).call(request_env)
+
+    expected_body = [
+      "<PWD>/spec/hello_world_app.rb:#{@app.allocating_lines[1]}  allocated    4 `String`\n",
+      "<PWD>/spec/hello_world_app.rb:#{@app.allocating_lines[1]}  allocated    1 `Array<String>`\n",
+      "<PWD>/spec/hello_world_app.rb:#{@app.allocating_lines[1]}  allocated    1 `Array<Fixnum,Hash,Array>`\n",
+      "<PWD>/spec/hello_world_app.rb:#{@app.allocating_lines[1]}  allocated    1 `Hash`\n",
+      "<PWD>/spec/hello_world_app.rb:#{@app.allocating_lines[0]}  allocated    1 `String`\n"
+    ]
+
+    expect(body).to include(expected_body[0])
+    expect(body).to include(expected_body[1])
+    expect(body).to include(expected_body[2])
+    expect(body).to include(expected_body[3])
+    expect(body).to include(expected_body[4])
+  end
+
+  it "returns correct body when called with a tracing request with times" do
+    request_env = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[times]=4")
+    _, _, body = Rack::AllocationStats.new(@app).call(request_env)
+
+    expected_body = [
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated   16 `String`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated    4 `Array<String>`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated    4 `Array<Fixnum,Hash,Array>`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[1]}  allocated    4 `Hash`\n",
+      "#{HelloWorldApp::FULL_PATH}:#{@app.allocating_lines[0]}  allocated    4 `String`\n"
+    ]
+
+    expect(body).to include(expected_body[0])
+    expect(body).to include(expected_body[1])
+    expect(body).to include(expected_body[2])
+    expect(body).to include(expected_body[3])
+    expect(body).to include(expected_body[4])
+  end
+
+  it "returns correct body when called on just local files" do
+    yaml_app = YamlApp.new
+    request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[scope]=.")
+    _, _, body = Rack::AllocationStats.new(yaml_app).call(request_env)
+
+    # should be:
+    # yaml_app.rb:15  allocated    4 `String`
+    # yaml_app.rb:14  allocated    2 `String`
+    # yaml_app.rb:14  allocated    1 `Array<>`
+    # yaml_app.rb:14  allocated    1 `Array<String>`
+    # yaml_app.rb:15  allocated    1 `Array<Fixnum,Hash,Array>`
+    # yaml_app.rb:15  allocated    1 `Array<String>`
+    # yaml_app.rb:15  allocated    1 `Hash`
+
+    expect(body.size).to eq 7
+  end
+
+  it "returns the correct body when called on a specific directory" do
+    yaml_app = YamlApp.new
+    psych_request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[scope]=psych")
+    _, _, body = Rack::AllocationStats.new(yaml_app).call(psych_request_env)
+
+    expect(body.size).to eq 44
+  end
+
+  it "returns HTML5 in response to an interactive request" do
+    interactive_request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[output]=interactive")
+    _, _, body = Rack::AllocationStats.new(@app).call(interactive_request_env)
+
+    expect(body[0]).to match /^<!DOCTYPE html>/
+  end
+
+  it "returns the corrent Content-Length in the headers" do
+    file = "/foo/bar.rb"
+    line = 7
+
+    # TODO 5 comes from factories.rb; it should come from here.
+    # TODO String comes from factories.rb; it should come from here.
+    expected_body = "#{file}:#{line}   allocated    5 `String`\n"
+
+    stats = FactoryGirl.build(:stats, files: [file], sourceline: line)
+    AllocationStats.stub(:trace) { stats }
+    allocation_stats = Rack::AllocationStats.new(@app)
+    _, headers, _ = allocation_stats.call(@traced_request_env)
+
+    headers["Content-Length"].to_i.should be expected_body.length
+  end
+
+  context("scoping") do
+    before do
+      stats = FactoryGirl.build(:stats, files: ["/foo/bar.rb", File.join(Dir.pwd, "baz.rb")])
+      AllocationStats.stub(:trace) { stats }
+      @allocation_stats = Rack::AllocationStats.new(@app)
+    end
+
+    it "returns all allocations when no scope is specified" do
+      _, _, body = @allocation_stats.call(@traced_request_env)
+
+      text = body.join
+      text.should include("bar.rb")
+      text.should include("baz.rb")
+    end
+
+    it "returns locally-scoped allocations" do
+      request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[scope]=.")
+
+      _, _, body = @allocation_stats.call(request_env)
+
+      text = body.join
+      text.should include("baz.rb")
+      text.should_not include("bar.rb")
+    end
+
+    it "returns allocations limited by scope" do
+      request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[scope]=foo")
+
+      _, _, body = @allocation_stats.call(request_env)
+
+      text = body.join
+      text.should include("bar.rb")
+      text.should_not include("baz.rb")
+    end
+  end
+
+  it "returns JSON when res[output]=json" do
+    stats = FactoryGirl.build(:stats, files: ["/foo/bar.rb", File.join(Dir.pwd, "baz.rb")])
+    AllocationStats.stub(:trace) { stats }
+    @allocation_stats = Rack::AllocationStats.new(@app)
+
+    json_request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[output]=json")
+    _, _, body = @allocation_stats.call(json_request_env)
+
+    allocation = stats.allocations.all.first
+    first_group_key = ["/foo/bar.rb", 7, String]
+
+    text = body.join
+    text.should include(allocation.to_json)
+    text.should include(first_group_key.to_json)
+
+    hash = {group_key: first_group_key, allocations: [allocation, allocation, allocation]}
+
+    text.should include(Yajl::Encoder.encode(hash))
+  end
+
+  it "returns the right Content-Type and status for JSON" do
+    json_request_env  = Rack::MockRequest.env_for("/", :params => "ras[trace]=true&ras[output]=json")
+    status, headers, _ = Rack::AllocationStats.new(@app).call(json_request_env)
+
+    expect(headers["Content-Type"]).to eq "application/json"
+    expect(status).to be 200
+  end
+
+  it "returns the right Content-Type and status for help" do
+    help_request_env  = Rack::MockRequest.env_for("/", :params => "ras[help]")
+    status, headers, _ = Rack::AllocationStats.new(@app).call(help_request_env)
+
+    expect(headers["Content-Type"]).to eq "text/plain"
+    expect(status).to be 200
+  end
+
+  it "returns the right body for help" do
+    help_request_env  = Rack::MockRequest.env_for("/", :params => "ras[help]")
+    _, _, body = Rack::AllocationStats.new(@app).call(help_request_env)
+
+    body.first.should include("Rack AllocationStats help\n")
+  end
+end

data/spec/sinatra_app.rb

@@ -0,0 +1,10 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require "sinatra"
+
+class HelloSinatraApp < Sinatra::Base
+  get "/hello" do
+    "Hello World!"
+  end
+end

data/spec/sinatra_templates_app.rb

@@ -0,0 +1,85 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require "sinatra"
+require "haml"
+require "liquid"
+require "redcarpet"
+require "slim"
+
+class SinatraTemplatesApp < Sinatra::Base
+  HELLOS = ["Hello", "Hola", "Bonjour", "Gutentag",
+            "こんにちは", "привет"]
+
+  enable :inline_templates
+
+  get "/erb" do
+    erb :erb
+  end
+
+  get "/haml" do
+    haml :haml
+  end
+
+  get "/liquid" do
+    liquid :liquid, locals: { hellos: HELLOS }
+  end
+
+  get "/slim" do
+    slim :slim
+  end
+
+  get "/markdown" do
+    markdown(:markdown)
+  end
+end
+
+__END__
+
+@@ erb
+<html>
+  <body>
+    <ul id="hi">
+      <% HELLOS.each do |hello| %>
+        <li class="greeting"><%= hello %> World!</li>
+      <% end %>
+    </ul>
+  </body>
+</html>
+
+@@ haml
+%html
+  %body
+    %ul#hi
+      - HELLOS.each do |hello|
+        %li.greeting
+          =hello
+          World!
+
+@@ liquid
+<html>
+  <body>
+    <ul>
+      {% for hello in hellos %}
+        <li class="greeting">{{ hello }} World!</li>
+      {% endfor %}
+    </ul>
+  </body>
+</html>
+
+@@ markdown
+* Hello World!
+* Hola World!
+* Bonjour World!
+* Gutentag World!
+* こんにちは World!
+* привет World!
+
+@@ slim
+html
+  body
+    ul id="hi"
+      - HELLOS.each do |hello|
+        li.greeting
+          = hello
+          |  World!

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require "pry"
+
+require_relative "../lib/rack/allocation_stats"
+require_relative "hello_world_app"
+require_relative "yaml_app"
+require_relative "yajl_app"
+
+require "factory_girl"
+require_relative "factories"
+
+if RbConfig::CONFIG["MAJOR"].to_i < 2 || RbConfig::CONFIG["MINOR"].to_i < 1
+  warn "Error: ObjectStats requires Ruby 2.1 or greater"
+  exit 1
+end
+
+module Matchers
+  class QueryString
+    def initialize(expected_match)
+      @expected_match = expected_match
+    end
+
+    def matches?(env)
+      request = Rack::Request.new(env)
+      query_string = request.GET
+      if query_string.eql? @expected_match
+        true
+      else
+        env_description = "env, where Rack::Request.new(env).GET is #{query_string.inspect}"
+        env.instance_eval <<-RUBY
+          def description; #{env_description.inspect}; end
+        RUBY
+        false
+      end
+    end
+
+    def description
+      "query_string(#{@expected_match.inspect})"
+    end
+
+    def failure_message; end
+
+    def negative_failure_message; end
+  end
+
+  def query_string(expected)
+    QueryString.new(expected)
+  end
+end
+
+RSpec.configure do |config|
+  config.include Matchers
+end

data/spec/yajl_app.rb

@@ -0,0 +1,20 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require "rack"
+require "yajl"
+
+class YajlApp
+  FULL_PATH = __FILE__
+
+  attr_accessor :allocating_lines
+
+  def initialize
+    @allocating_lines = []
+  end
+
+  def call(env)
+    y = Yajl.dump(["one string", "two string", {"uno" => 1, "two" => 2}, "ho "*3]); @allocating_lines << __LINE__ # lots of objects not from here
+    @allocating_lines << __LINE__; [200, {"Content-Type" => "text/html"}, ["Hello Rack!"]]
+  end
+end

data/spec/yaml_app.rb

@@ -0,0 +1,20 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require "rack"
+require "yaml"
+
+class YamlApp
+  FULL_PATH = __FILE__
+
+  attr_accessor :allocating_lines
+
+  def initialize
+    @allocating_lines = []
+  end
+
+  def call(env)
+    y = YAML.dump(["one string", "two string"]); @allocating_lines << __LINE__ # lots of objects not from here
+    @allocating_lines << __LINE__; [200, {"Content-Type" => "text/html"}, ["Hello Rack!"]]
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: rack-allocation_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Rawlins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: allocation_stats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware for tracing object allocations in Ruby 2.1
+email:
+- sam.rawlins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./demo_rack_apps/Rails_3.2.15/app/helpers/tasks_helper.rb
+- ./demo_rack_apps/Rails_3.2.15/app/helpers/projects_helper.rb
+- ./demo_rack_apps/Rails_3.2.15/app/helpers/application_helper.rb
+- ./demo_rack_apps/Rails_3.2.15/app/models/task.rb
+- ./demo_rack_apps/Rails_3.2.15/app/models/project.rb
+- ./demo_rack_apps/Rails_3.2.15/app/controllers/tasks_controller.rb
+- ./demo_rack_apps/Rails_3.2.15/app/controllers/projects_controller.rb
+- ./demo_rack_apps/Rails_3.2.15/app/controllers/application_controller.rb
+- ./demo_rack_apps/Rails_3.2.15/config/environments/production.rb
+- ./demo_rack_apps/Rails_3.2.15/config/environments/development.rb
+- ./demo_rack_apps/Rails_3.2.15/config/environments/test.rb
+- ./demo_rack_apps/Rails_3.2.15/config/application.rb
+- ./demo_rack_apps/Rails_3.2.15/config/boot.rb
+- ./demo_rack_apps/Rails_3.2.15/config/environment.rb
+- ./demo_rack_apps/Rails_3.2.15/config/routes.rb
+- ./demo_rack_apps/Rails_3.2.15/config/initializers/wrap_parameters.rb
+- ./demo_rack_apps/Rails_3.2.15/config/initializers/inflections.rb
+- ./demo_rack_apps/Rails_3.2.15/config/initializers/backtrace_silencers.rb
+- ./demo_rack_apps/Rails_3.2.15/config/initializers/mime_types.rb
+- ./demo_rack_apps/Rails_3.2.15/config/initializers/secret_token.rb
+- ./demo_rack_apps/Rails_3.2.15/config/initializers/session_store.rb
+- ./demo_rack_apps/Rails_3.2.15/db/migrate/20131104031829_create_tasks.rb
+- ./demo_rack_apps/Rails_3.2.15/db/migrate/20131104031828_create_projects.rb
+- ./demo_rack_apps/Rails_3.2.15/db/schema.rb
+- ./demo_rack_apps/Rails_3.2.15/db/seeds.rb
+- ./demo_rack_apps/Rails_3.2.15/test/test_helper.rb
+- ./demo_rack_apps/Rails_3.2.15/test/unit/helpers/tasks_helper_test.rb
+- ./demo_rack_apps/Rails_3.2.15/test/unit/helpers/projects_helper_test.rb
+- ./demo_rack_apps/Rails_3.2.15/test/unit/project_test.rb
+- ./demo_rack_apps/Rails_3.2.15/test/unit/task_test.rb
+- ./demo_rack_apps/Rails_3.2.15/test/functional/tasks_controller_test.rb
+- ./demo_rack_apps/Rails_3.2.15/test/functional/projects_controller_test.rb
+- ./demo_rack_apps/Rails_3.2.15/test/performance/browsing_test.rb
+- ./demo_rack_apps/Rails_4.0.1/app/helpers/tasks_helper.rb
+- ./demo_rack_apps/Rails_4.0.1/app/helpers/projects_helper.rb
+- ./demo_rack_apps/Rails_4.0.1/app/helpers/application_helper.rb
+- ./demo_rack_apps/Rails_4.0.1/app/models/task.rb
+- ./demo_rack_apps/Rails_4.0.1/app/models/project.rb
+- ./demo_rack_apps/Rails_4.0.1/app/controllers/tasks_controller.rb
+- ./demo_rack_apps/Rails_4.0.1/app/controllers/projects_controller.rb
+- ./demo_rack_apps/Rails_4.0.1/app/controllers/application_controller.rb
+- ./demo_rack_apps/Rails_4.0.1/config/environments/production.rb
+- ./demo_rack_apps/Rails_4.0.1/config/environments/development.rb
+- ./demo_rack_apps/Rails_4.0.1/config/environments/test.rb
+- ./demo_rack_apps/Rails_4.0.1/config/application.rb
+- ./demo_rack_apps/Rails_4.0.1/config/boot.rb
+- ./demo_rack_apps/Rails_4.0.1/config/environment.rb
+- ./demo_rack_apps/Rails_4.0.1/config/routes.rb
+- ./demo_rack_apps/Rails_4.0.1/config/initializers/filter_parameter_logging.rb
+- ./demo_rack_apps/Rails_4.0.1/config/initializers/wrap_parameters.rb
+- ./demo_rack_apps/Rails_4.0.1/config/initializers/inflections.rb
+- ./demo_rack_apps/Rails_4.0.1/config/initializers/backtrace_silencers.rb
+- ./demo_rack_apps/Rails_4.0.1/config/initializers/mime_types.rb
+- ./demo_rack_apps/Rails_4.0.1/config/initializers/secret_token.rb
+- ./demo_rack_apps/Rails_4.0.1/config/initializers/session_store.rb
+- ./demo_rack_apps/Rails_4.0.1/db/migrate/20131102201320_create_projects.rb
+- ./demo_rack_apps/Rails_4.0.1/db/migrate/20131102201321_create_tasks.rb
+- ./demo_rack_apps/Rails_4.0.1/db/schema.rb
+- ./demo_rack_apps/Rails_4.0.1/db/seeds.rb
+- ./demo_rack_apps/Rails_4.0.1/test/helpers/tasks_helper_test.rb
+- ./demo_rack_apps/Rails_4.0.1/test/helpers/projects_helper_test.rb
+- ./demo_rack_apps/Rails_4.0.1/test/test_helper.rb
+- ./demo_rack_apps/Rails_4.0.1/test/models/project_test.rb
+- ./demo_rack_apps/Rails_4.0.1/test/models/task_test.rb
+- ./demo_rack_apps/Rails_4.0.1/test/controllers/tasks_controller_test.rb
+- ./demo_rack_apps/Rails_4.0.1/test/controllers/projects_controller_test.rb
+- ./lib/rack/allocation_stats/call_app_directly.rb
+- ./lib/rack/allocation_stats/tracer.rb
+- ./lib/rack/allocation_stats/formatters/html.rb
+- ./lib/rack/allocation_stats/formatters/json.rb
+- ./lib/rack/allocation_stats/formatters/text.rb
+- ./lib/rack/allocation_stats/formatters/base.rb
+- ./lib/rack/allocation_stats/action.rb
+- ./lib/rack/allocation_stats/middleware.rb
+- ./lib/rack/allocation_stats.rb
+- ./spec/yaml_app.rb
+- ./spec/rack/allocation_stats_spec.rb
+- ./spec/spec_helper.rb
+- ./spec/sinatra_app.rb
+- ./spec/yajl_app.rb
+- ./spec/factories.rb
+- ./spec/sinatra_templates_app.rb
+- ./spec/hello_world_app.rb
+homepage: 
+licenses:
+- Apache v2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 2.0.99
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rack middleware for tracing object allocations in Ruby 2.1
+test_files: []