better_rails_debugger 0.0.1

data/app/jobs/better_rails_debugger/application_job.rb

@@ -0,0 +1,4 @@
+module BetterRailsDebugger
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/better_rails_debugger/application_mailer.rb

@@ -0,0 +1,6 @@
+module BetterRailsDebugger
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/better_rails_debugger/analysis_group.rb

@@ -0,0 +1,49 @@
+module BetterRailsDebugger
+  class AnalysisGroup
+    include Mongoid::Document
+
+    include ::Mongoid::Document
+    include Mongoid::Timestamps
+
+    before_save :generate_analise_paths
+
+    field :name, type: String
+
+    has_many :group_instances, class_name: "::BetterRailsDebugger::GroupInstance", inverse_of: :analysis_group, dependent: :delete_all
+
+    # Settings
+
+    ## Memory options
+    field :collect_memory_information, type: Boolean, default: true    # Disable this, disable all memory tracking options
+    field :analise_memory_in_code, type: Boolean, default: true
+    field :analise_memory_in_gems, type: Boolean, default: false
+    field :record_objects_in, type: String, default: ""
+    field :times_to_run, type: Integer, default: 0                     # 0: Infinite
+    field :analyze_repeated_instances, type: Boolean, default: true    # if false, Check the identifier and do run the analyzer if already exist one with the same identifier
+
+    # Internal use
+    field :analise_paths, type: Array, default: []
+
+    private
+    def generate_analise_paths
+      if analise_memory_in_gems
+        analise_paths << /.*\/gems\/.*/
+      end
+
+      record_objects_in.to_s.split(/\n/).each do |line|
+        pp 'Line', line
+        line = line.strip
+        # Check if file exist
+        if File.exist? line
+          pp 'File exist'
+          if File.directory? line
+            pp 'File is a dir'
+            analise_paths << /#{line}.*/
+          elsif File.file? line
+            analise_paths << /#{line}$/
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/better_rails_debugger/application_record.rb

@@ -0,0 +1,5 @@
+module BetterRailsDebugger
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/better_rails_debugger/group_instance.rb

@@ -0,0 +1,42 @@
+module BetterRailsDebugger
+  class GroupInstance
+    include ::Mongoid::Document
+    include Mongoid::Timestamps
+
+    belongs_to :analysis_group, class_name: "::BetterRailsDebugger::AnalysisGroup"
+    has_many :objects, class_name: "::BetterRailsDebugger::ObjectInformation", inverse_of: :group_instance, dependent: :delete_all
+
+    # Basic information
+    field :identifier, type: String
+    field :metadata, type: Hash
+
+    # Status information
+    field :processed, type: Boolean
+    field :total_classes, type: Integer                 # Total number of used Classes
+    field :total_memory, type: Integer                  # Total memory used in bytes
+    field :total_files, type: Integer                   # Total file used on allocation
+    field :allocations_per_file, type: Hash             # Hash with `file => num_allocations`
+    field :inverse_allocation_per_file, type: Hash      # Hash with `allocations => Array<files>`
+
+    # Internal use
+    field :caller_file, type: String
+
+    def track_allocation_of?(path)
+      return true if match_file_list?(path) or called_from_caller_file?(path)
+      false
+    end
+
+    private
+    def match_file_list?(path)
+      analysis_group.analise_paths.any? do |regexp|
+        regexp.match?(path)
+      end
+    end
+
+    def called_from_caller_file?(path)
+      return false if !analysis_group.analise_memory_in_code
+      return true if analysis_group.analise_memory_in_code and /#{caller_file}/.match?(path)
+      false
+    end
+  end
+end

data/app/models/better_rails_debugger/object_information.rb

@@ -0,0 +1,19 @@
+module BetterRailsDebugger
+  class ObjectInformation
+    include ::Mongoid::Document
+    include Mongoid::Timestamps
+
+    belongs_to :group_instance, class_name: "::BetterRailsDebugger::GroupInstance"
+
+    field :ruby_object_id, type: Integer
+    field :source_file, type: String
+    field :source_line, type: Integer
+    field :memsize, type: Integer
+    field :class_name, type: String
+
+    # Internal use
+    field :source_code, type: String
+    field :formatted_source_code, type: String
+
+  end
+end

data/app/views/better_rails_debugger/analysis_groups/_form.html.haml

@@ -0,0 +1,41 @@
+= form_for @group do |f|
+  .form-group.d-flex
+    = f.label :name, class: 'sr-only', class: 'col-2'
+    = f.text_field :name, min: 3, class: 'form-control form-control-lg col-10'
+
+  %fielset.form-group
+    %legend Settings
+    .form-group.d-flex.justify-content-start
+      = f.label :times_to_run, class: 'col-2'
+      .col-10
+        = f.number_field :times_to_run
+        .text-secondary.d-inline Set 0 or any negative value to be infinite
+    .form-group.d-flex.justify-content-start
+      = f.label :analyze_repeated_instances, class: 'col-2'
+      .col-10
+        = f.check_box :analyze_repeated_instances
+        .text-secondary.d-inline if false, check the identifier and do not run the analyzer if already exist one
+    .form-group.d-flex.justify-content-start
+      = f.label :collect_memory_information, class: 'col-2'
+      .col-10
+        = f.check_box :collect_memory_information
+        .text-secondary.d-inline Disabling this option, is going to disable all memory options
+
+    .form-group.d-flex.justify-content-start
+      = f.label :record_objects_in, class: 'col-2'
+      .col-10
+        = f.text_area :record_objects_in, rows: 3, class: 'form-control col-4'
+        .text-secondary Every line must be a file or a directory, everything else is going to be omitted.
+
+    .form-group.d-flex.justify-content-start
+      = f.label :analise_memory_in_code, class: 'col-2'
+      .col-10
+        = f.check_box :analise_memory_in_code
+        .text-secondary.d-inline Enable this is you want to debug a memory bloat
+    .form-group.d-flex.justify-content-start
+      = f.label :analise_memory_in_gems, class: 'col-2'
+      .col-10
+        = f.check_box :analise_memory_in_gems
+        .text-danger.d-inline Analise memory of all gems in the block it's really slow
+
+  %button.btn.btn-primary{:type => "submit"} Confirm

data/app/views/better_rails_debugger/analysis_groups/edit.html.haml

@@ -0,0 +1,23 @@
+.card
+  .card-header
+    Edit Analysis Group
+  .card-body
+
+    - content_for :header_nav do
+      %ul.nav.navbar-nav.d-md-down-none
+        %li.nav-item
+          %a.nav-link.navbar-toggler.sidebar-toggler{:href => "#"} ☰
+        %li.nav-item.px-3
+          %a.nav-link{:href => analysis_groups_path} List
+
+      %ul.navbar-nav.ml-md-auto
+
+
+    - content_for :breadcrum do
+      %ol.breadcrumb
+        %li.breadcrumb-item.active
+          %a{:href => analysis_groups_path} Analysis Groups
+        %li.breadcrumb-item.active
+          %a{:href => "#"} New
+
+    = render 'better_rails_debugger/analysis_groups/form'

data/app/views/better_rails_debugger/analysis_groups/index.html.haml

@@ -0,0 +1,36 @@
+.card
+  .card-header
+    Analysis Groups
+  .card-body
+
+    - content_for :header_nav do
+      %ul.nav.navbar-nav.d-md-down-none
+        %li.nav-item
+          %a.nav-link.navbar-toggler.sidebar-toggler{:href => "#"} ☰
+        %li.nav-item.px-3
+          %a.nav-link{:href => new_analysis_group_path} New
+
+      %ul.navbar-nav.ml-md-auto
+
+
+    - content_for :breadcrum do
+      %ol.breadcrumb
+        %li.breadcrumb-item.active
+          %a{:href => "#"} Analysis Groups
+
+    %table.table.border.border-secondary.border-top-0
+      %thead.bg-secondary.text-white
+        %tr.d-flex
+          %th.col-8 Name
+          %th.col-2 ID
+          %th.col-2 Actions
+      %tbody
+        - @groups.each do |group|
+          %tr.d-flex
+            %td.col-8= link_to group.name, analysis_group_path(group.id)
+            %td.col-2= group.id
+            %td.col-2
+              = link_to "Inspect", analysis_group_path(group.id), class: 'btn btn-sm btn-secondary'
+              = link_to "Edit", edit_analysis_group_path(group.id), class: 'btn btn-sm btn-info'
+              = link_to "Delete", analysis_group_path(group.id), data: {  confirm: 'Are you sure?'}, method: :delete, class: 'btn btn-sm btn-danger'
+    = will_paginate @groups, renderer: WillPaginate::ActionView::BootstrapLinkRenderer

data/app/views/better_rails_debugger/analysis_groups/new.html.haml

@@ -0,0 +1,23 @@
+.card
+  .card-header
+    New Analysis Group
+  .card-body
+
+    - content_for :header_nav do
+      %ul.nav.navbar-nav.d-md-down-none
+        %li.nav-item
+          %a.nav-link.navbar-toggler.sidebar-toggler{:href => "#"} ☰
+        %li.nav-item.px-3
+          %a.nav-link{:href => analysis_groups_path} List
+
+      %ul.navbar-nav.ml-md-auto
+
+
+    - content_for :breadcrum do
+      %ol.breadcrumb
+        %li.breadcrumb-item.active
+          %a{:href => analysis_groups_path} Analysis Groups
+        %li.breadcrumb-item.active
+          %a{:href => "#"} New
+
+    = render 'better_rails_debugger/analysis_groups/form'

data/app/views/better_rails_debugger/analysis_groups/show.html.haml

@@ -0,0 +1,35 @@
+.card
+  .card-header
+    = @group.name
+  .card-body
+
+    - content_for :header_nav do
+      %ul.nav.navbar-nav.d-md-down-none
+        %li.nav-item
+          %a.nav-link.navbar-toggler.sidebar-toggler{:href => "#"} ☰
+        %li.nav-item.px-3
+          %a.nav-link{:href => analysis_groups_path} List
+
+      %ul.navbar-nav.ml-md-auto
+
+
+    - content_for :breadcrum do
+      %ol.breadcrumb
+        %li.breadcrumb-item
+          %a{:href => analysis_groups_path} Analysis Groups
+        %li.breadcrumb-item
+          %a{:href => "#"}= @group.name
+
+    %table.table.border.border-secondary.border-top-0
+      %thead.bg-secondary.text-white
+        %tr.d-flex
+          %th.col-8 Identifier
+          %th.col-2 Date
+          %th.col-2 Actions
+      %tbody
+        - @instances.each do |instance|
+          %tr.d-flex
+            %td.col-8= link_to instance.identifier, objects_group_instance_path(instance.id)
+            %th.col-2= instance.created_at.strftime("%c")
+            %td.col-2= link_to "Objects", objects_group_instance_path(instance.id), class: 'btn btn-sm btn-information'
+    = will_paginate @instances, renderer: WillPaginate::ActionView::BootstrapLinkRenderer

data/app/views/better_rails_debugger/group_instances/objects.html.haml

@@ -0,0 +1,62 @@
+.card
+  .card-header
+    = @instance.identifier
+    = "-"
+    = @instance.created_at.strftime("%c")
+  .card-body
+
+    - content_for :header_nav do
+      %ul.nav.navbar-nav.d-md-down-none
+        %li.nav-item
+          %a.nav-link.navbar-toggler.sidebar-toggler{:href => "#"} ☰
+        %li.nav-item.px-3
+          %a.nav-link{:href => group_instance_path(@instance)} List
+
+      %ul.navbar-nav.ml-md-auto
+
+
+    - content_for :breadcrum do
+      %ol.breadcrumb
+        %li.breadcrumb-item
+          %a{:href => analysis_groups_path} Analysis Groups
+        %li.breadcrumb-item
+          %a{:href => analysis_group_path(@instance.analysis_group.id)}= @instance.analysis_group.name
+        %li.breadcrumb-item
+          %a{:href => "#"}= @instance.identifier
+
+    .alert.alert-warning{:role => "alert"}
+      %h4.alert-heading
+        DISCLAIMER
+      %p
+        Remember that Memsize is a
+        %a.alert-link{:href => "http://ruby-doc.org/stdlib-2.5.0/libdoc/objspace/rdoc/ObjectSpace.html#method-c-memsize_of"} HINT.
+        The used memory is not the sum of every object listed here because different reasons.
+      %p
+        Better Rails Debugger only track the creation of Ruby objects, not the creation of C-Ruby objects, and oly
+        those objects that are created from the moment that a request arrive to a controller. Everythinng else, like
+        objects created by Middlewares, are not been tracked because performance.
+
+    %table.table.border.border-secondary.border-top-0
+      %thead.bg-secondary.text-white
+        %tr.d-flex
+          %th.col-8 Location
+          %th.col-2 Memsize
+          %th.col-2 Class
+
+      %tbody
+        - @objects.each do |object|
+          %tr.d-flex
+            %td.col-8
+              %i.fa.fa-eye.fa-2x.text-secondary{"aria-controls" => "collapseExample", "aria-expanded" => "false", "data-toggle" => "collapse", :href => "##{object.id}"}
+              %span.text-primary
+                =object.source_file
+              %span= ":"
+              %span.text-success=object.source_line
+            %td.col-2= number_to_human_size object.memsize
+            %td.col-2.text-danger= object.class_name
+          %tr.collapse.out{id: object.id}
+            %td{:colspan => 3}
+              %pre.line-numbers{:"data-start" => object.source_line - 6, :"data-line" => object.source_line}
+                %code.language-ruby= object.source_code
+
+    = will_paginate @objects, renderer: WillPaginate::ActionView::BootstrapLinkRenderer

data/app/views/better_rails_debugger/memory/index.html.haml

@@ -0,0 +1,20 @@
+.card
+  .card-header
+    Memory per request
+  .card-body
+
+    %table.table.border.border-secondary.border-top-0
+      %thead.bg-secondary.text-white
+        %th Request URL
+        %th Request IP
+        %th Total Objects
+        %th Actions
+
+      %tbody
+        - @requests.each do |request|
+          %tr
+            %td= request.url
+            %td= request.ip
+            %td= request.objects.count
+            %td= link_to "Inspect", memory_path(request.id)
+    = will_paginate @requests, renderer: WillPaginate::ActionView::BootstrapLinkRenderer

data/app/views/better_rails_debugger/memory/show.html.haml

@@ -0,0 +1,26 @@
+.card
+  .card-header
+    Request
+    = @request.url
+    = " - "
+    = @request.ip
+    at
+    = @request.created_at
+  .card-body
+
+
+    %table.table.border.border-secondary.border-top-0
+      %thead.bg-secondary.text-white
+        %th Object class
+        %th Location
+        %th Memsize
+        %th Actions
+
+      %tbody
+        - @request.objects.each do |object|
+          %tr
+            %td= object.class_name
+            %td= "#{object.source_file}:#{object.source_line}"
+            %td= object.memsize
+            %td
+    =# will_paginate @requests, renderer: WillPaginate::ActionView::BootstrapLinkRenderer

data/app/views/better_rails_debugger/shared/_header.html.haml

@@ -0,0 +1,4 @@
+%header.app-header.navbar
+  %button.navbar-toggler.mobile-sidebar-toggler.d-lg-none{:type => "button"} ☰
+  %a.navbar-brand{:href => "#"} BRD
+  = content_for :header_nav

data/app/views/better_rails_debugger/shared/_sidebar.html.haml

@@ -0,0 +1,5 @@
+.sidebar
+  %nav.sidebar-nav
+    %ul.nav
+      %li.nav-item
+        %a.nav-link{:href => analysis_groups_path} Analysis Group

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

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Better rails debugger</title>
+  <%= stylesheet_link_tag "better_rails_debugger/application", media: "all" %>
+  <%= javascript_include_tag "better_rails_debugger/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body class="app header-fixed sidebar-fixed">
+
+  <%= render partial: 'better_rails_debugger/shared/header' %>
+
+  <div class="app-body">
+
+    <%= render partial: 'better_rails_debugger/shared/sidebar' %>
+
+    <main class="main">
+      <%=
+        # https://coreui.io/docs/components/bootstrap-breadcrumb/
+        content_for :breadcrum %>
+      <div class="container-fluid">
+        <% if flash[:notice] %>
+            <div class="alert alert-primary" role="alert">
+              <%= flash[:notice] %>
+            </div>
+        <% end %>
+
+        <% if flash[:error] %>
+            <div class="alert alert-danger" role="alert">
+              <%= flash[:error] %>
+            </div>
+        <% end %>
+
+
+        <%= yield %>
+      </div>
+    </main>
+  </div>
+
+  <footer class="app-footer d-flex">
+    <span class="text-left">
+      Thanks to <a href="https://www.coreui.io/" target="_blank">CoreUI</a> team for this amazing template.
+    </span>
+  </footer>
+
+</body>
+</html>