rack-allocation_stats 0.1.0

data/demo_rack_apps/Rails_4.0.1/test/controllers/tasks_controller_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class TasksControllerTest < ActionController::TestCase
+  setup do
+    @task = tasks(:one)
+  end
+
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:tasks)
+  end
+
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+
+  test "should create task" do
+    assert_difference('Task.count') do
+      post :create, task: { description: @task.description, name: @task.name, project_id: @task.project_id }
+    end
+
+    assert_redirected_to task_path(assigns(:task))
+  end
+
+  test "should show task" do
+    get :show, id: @task
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, id: @task
+    assert_response :success
+  end
+
+  test "should update task" do
+    patch :update, id: @task, task: { description: @task.description, name: @task.name, project_id: @task.project_id }
+    assert_redirected_to task_path(assigns(:task))
+  end
+
+  test "should destroy task" do
+    assert_difference('Task.count', -1) do
+      delete :destroy, id: @task
+    end
+
+    assert_redirected_to tasks_path
+  end
+end

data/demo_rack_apps/Rails_4.0.1/test/helpers/projects_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class ProjectsHelperTest < ActionView::TestCase
+end

data/demo_rack_apps/Rails_4.0.1/test/helpers/tasks_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class TasksHelperTest < ActionView::TestCase
+end

data/demo_rack_apps/Rails_4.0.1/test/models/project_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ProjectTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/demo_rack_apps/Rails_4.0.1/test/models/task_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TaskTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/demo_rack_apps/Rails_4.0.1/test/test_helper.rb

@@ -0,0 +1,15 @@
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  ActiveRecord::Migration.check_pending!
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/lib/rack/allocation_stats.rb

@@ -0,0 +1,22 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require "bundler/setup"
+require "rack"
+require "allocation_stats"
+
+require_relative "allocation_stats/action"
+require_relative "allocation_stats/call_app_directly"
+require_relative "allocation_stats/middleware"
+require_relative "allocation_stats/tracer"
+
+require_relative "allocation_stats/formatters/base"
+require_relative "allocation_stats/formatters/html"
+require_relative "allocation_stats/formatters/json"
+require_relative "allocation_stats/formatters/text"
+
+module Rack::AllocationStats
+  def self.new(app, options = {})
+    Middleware.new(app, options)
+  end
+end

data/lib/rack/allocation_stats/action.rb

@@ -0,0 +1,14 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+module Rack::AllocationStats
+  class Action
+    def initialize(env, middleware)
+      @env = env
+      @request = Rack::Request.new(env)
+      @get_params = @request.GET.clone
+      @middleware = middleware
+      @stats = nil
+    end
+  end
+end

data/lib/rack/allocation_stats/call_app_directly.rb

@@ -0,0 +1,14 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+module Rack::AllocationStats
+  class CallAppDirectly < Action
+    def act
+      @result = @middleware.call_app(@env)
+    end
+
+    def response
+      @result
+    end
+  end
+end

data/lib/rack/allocation_stats/formatters/base.rb

@@ -0,0 +1,11 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+module Rack::AllocationStats::Formatters
+  class Base
+    def initialize(tracer, allocations)
+      @tracer = tracer
+      @allocations = allocations
+    end
+  end
+end

data/lib/rack/allocation_stats/formatters/html.rb

@@ -0,0 +1,23 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+class Rack::AllocationStats::Formatters::HTML < Rack::AllocationStats::Formatters::Base
+  def format
+    interactive_dir = File.join(__dir__, "..", "interactive")
+
+    index_html_erb     = ERB.new(File.read(File.join(interactive_dir, "index.html.erb")))
+    jquery_min_js      =         File.read(File.join(interactive_dir, "jquery-2.0.3.min.js"))
+    jquery_ui_min_js   =         File.read(File.join(interactive_dir, "jquery-ui-1.10.3.custom.min.js"))
+    underscore_min_js  =         File.read(File.join(interactive_dir, "underscore-min.js"))
+    allocations_js_erb = ERB.new(File.read(File.join(interactive_dir, "allocations.js.erb")))
+    allocations_js     = allocations_js_erb.result(binding)
+    interactive_js     =         File.read(File.join(interactive_dir, "interactive.js"))
+    jquery_ui_min_css  =         File.read(File.join(interactive_dir, "jquery-ui-1.10.3.custom.min.css"))
+    style_css          =         File.read(File.join(interactive_dir, "style.css"))
+
+    allocating_gems = ["no gems allocated any objects"]
+
+    html_body = index_html_erb.result(binding)
+    return [html_body]
+  end
+end

data/lib/rack/allocation_stats/formatters/json.rb

@@ -0,0 +1,12 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+class Rack::AllocationStats::Formatters::JSON < Rack::AllocationStats::Formatters::Base
+  def format
+    allocations = @allocations.to_a.map do |group_key, allocations|
+      { group_key: group_key, allocations: allocations }
+    end
+
+    return [Yajl::Encoder.encode(allocations)]
+  end
+end

data/lib/rack/allocation_stats/formatters/text.rb

@@ -0,0 +1,33 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+class Rack::AllocationStats::Formatters::Text < Rack::AllocationStats::Formatters::Base
+  def format
+    file_length = @allocations.inject(0) { |length, allocation| [allocation[0][0].length , length].max }
+
+    total_count = @tracer.stats.allocations.all.size
+    bytes = @tracer.stats.allocations.bytes.all.inject { |sum, e| sum + e }
+    sums = "Total: #{total_count} allocations; #{bytes} bytes\n\n"
+
+    body = []
+
+    if @tracer.gc_report
+      gc_report = @tracer.stats.gc_profiler_report + "\n\n"
+      body += [gc_report]
+    end
+
+    running_total = 0
+    body + @allocations.map do |key, group|
+      sourcefile = key[0]
+      sourceline = key[1]
+      klass      = key[2]
+      my_pct     = (group.size * 1.0 / total_count) * 100
+      running_total += group.size
+      running_pct = (running_total * 1.0 / total_count) * 100
+
+      # TODO add a parameter to show/hide pct
+      #"%-#{file_length+4}s allocated %4d `%s` (%4.2f %4.2f)\n" % ["#{sourcefile}:#{sourceline}", group.size, klass, my_pct, running_pct]
+      "%-#{file_length+4}s allocated %4d `%s`\n" % ["#{sourcefile}:#{sourceline}", group.size, klass]
+    end
+  end
+end

data/lib/rack/allocation_stats/middleware.rb

@@ -0,0 +1,62 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+module Rack::AllocationStats
+  class Middleware
+    include Rack::Utils
+
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      @env = env
+      action = choose_action
+      action.act
+      action.response
+    end
+
+    def call_app(env)
+      @app.call(env)
+    end
+
+    def choose_action
+      request = Rack::Request.new(@env)
+      if request.GET["ras"] && request.GET["ras"].has_key?("help")
+        @content_type = "text/plain"
+        help_text
+      elsif request.GET["ras"] && request.GET["ras"]["trace"]
+        @content_type = content_type(request.GET["ras"]["output"])
+        Tracer.new(@env, self)
+      else
+        CallAppDirectly.new(@env, self)
+      end
+    end
+
+    def content_type(output_type)
+      case output_type
+      when "interactive" then "text/html"
+      when "json"        then "application/json"
+      else                    "text/plain"
+      end
+    end
+
+    def allocation_stats_response(body)
+      [200, headers(body), Array(body)]
+    end
+
+    def headers(body)
+      {
+        "Content-Type"   => @content_type,
+        "Content-Length" => body.inject(0) { |len, part| len + bytesize(part) }.to_s
+      }
+    end
+
+    def help_text
+      app = OpenStruct.new
+      app.body = [File.read(File.join(__dir__, "help.txt"))]
+      app.response = allocation_stats_response(app.body)
+      app
+    end
+  end
+end

data/lib/rack/allocation_stats/tracer.rb

@@ -0,0 +1,80 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require 'yajl'
+
+module Rack::AllocationStats
+  class Tracer < Action
+    include Rack::Utils
+
+    attr_reader :gc_report, :stats
+
+    def initialize(*args)
+      super
+      request = Rack::Request.new(@env)
+
+      # Once we're here, GET["ras"] better exist
+      @scope = request.GET["ras"]["scope"]
+      @times = (request.GET["ras"]["times"] || 1).to_i
+      @gc_report = request.GET["ras"]["gc_report"]
+      @output = (request.GET["ras"]["output"] || :columnar).to_sym
+      @alias_paths = request.GET["ras"]["alias_paths"] || false
+      @new_env = delete_custom_params(@env)
+    end
+
+    def act
+      @stats = AllocationStats.trace do
+        @times.times do
+          @middleware.call_app(@new_env)
+        end
+      end
+    end
+
+    def response
+      allocations = scoped_allocations
+
+      if @output == :interactive
+        allocations = allocations.all
+        @middleware.allocation_stats_response(Formatters::HTML.new(self, allocations).format)
+      elsif @output == :json
+        allocations = default_groups_and_sort(allocations)
+        @middleware.allocation_stats_response(Formatters::JSON.new(self, allocations).format)
+      else
+        allocations = default_groups_and_sort(allocations)
+        @middleware.allocation_stats_response(Formatters::Text.new(self, allocations).format)
+      end
+    end
+
+    def scoped_allocations
+      allocations = @stats.allocations(alias_paths: @alias_paths)
+
+      return allocations if @scope.nil?
+
+      if @scope == "."
+        return allocations.from_pwd
+      else
+        return allocations.from(@scope)
+      end
+    end
+
+    def default_groups_and_sort(allocations)
+      allocations.
+        group_by(:sourcefile, :sourceline, :class_plus).
+        sort_by_size.
+        all
+    end
+
+    def delete_custom_params(env)
+      new_env = env
+
+      get_params = Rack::Request.new(new_env).GET
+      get_params.delete("ras")
+
+      new_env.delete("rack.request.query_string")
+      new_env.delete("rack.request.query_hash")
+
+      new_env["QUERY_STRING"] = build_query(get_params)
+      new_env
+    end
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,53 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+FactoryGirl.define do
+  factory :allocation, class: AllocationStats::Allocation do
+
+    ignore do
+      object "A String"
+      sourcefile "foo/bar.rb"
+      sourceline 7
+    end
+
+    initialize_with { new(object) }
+
+    after(:build) do |allocation, evaluator|
+      allocation.instance_variable_set(:@sourcefile, evaluator.sourcefile)
+      allocation.instance_variable_set(:@sourceline, evaluator.sourceline)
+    end
+  end
+
+  # This might be overly complicated for now... but it was terribly fun to learn
+  # FactoryGirl's API, and I'll leave it for future use...
+  factory :stats, class: AllocationStats do
+    ignore do
+      size 5
+      files ["foo/bar.rb", "baz/quux.rb"]
+      sourceline 7
+    end
+
+    after(:build) do |stats, evaluator|
+      allocations = []
+      size = evaluator.size
+      files_count = evaluator.files.size
+
+      # 3 from 1st file
+      if size > 0
+        file = evaluator.files[0]
+        count = [size, 3].min
+        count.times { allocations << FactoryGirl.build(:allocation, sourcefile: file, sourceline: evaluator.sourceline) }
+        size -= count
+      end
+
+      # more from 2nd file
+      if size > 0
+        file = evaluator.files[1 % files_count]
+        size.times { allocations << FactoryGirl.build(:allocation, sourcefile: file, sourceline: evaluator.sourceline) }
+        size -= count
+      end
+
+      stats.instance_variable_set(:@new_allocations, allocations)
+    end
+  end
+end

data/spec/hello_world_app.rb

@@ -0,0 +1,21 @@
+# 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 HelloWorldApp
+  FULL_PATH = __FILE__
+
+  attr_accessor :allocating_lines
+
+  def initialize
+    @allocating_lines = []
+  end
+
+  def call(env)
+    a = "Ahhhhhhhhhhhhhhhhhhhhh"; @allocating_lines << __LINE__
+    #y = YAML.dump(["one string", "two string"]) # lots OF objects not from here
+    @allocating_lines << __LINE__; [200, {"Content-Type" => "text/html"}, ["Hello Rack!"]]
+  end
+end