rails_mini_profiler 0.1.2 → 0.3.0

data/app/javascript/stylesheets/flamegraph.scss

@@ -0,0 +1,9 @@
+#wrapper {
+  height: 100vh;
+  width: 100%;
+}
+
+#speedscope-iframe {
+  width: 100%;
+  height: 100%;
+  border: none; }

data/app/{assets/stylesheets/rails_mini_profiler/navbar.css → javascript/stylesheets/navbar.scss}

@@ -5,13 +5,13 @@
   display: flex;
   justify-content: center;
 
-  box-shadow: 0 0 20px 0 rgba(0,0,0,.2);
+  box-shadow: 0 0 20px 0 rgba(0, 0, 0, .2);
 
   background: var(--primary);
 }
 
 .header a {
-  color:white;
+  color: white;
   text-decoration: none;
 }
 

data/app/{assets/stylesheets/rails_mini_profiler/profiled_requests.css → javascript/stylesheets/profiled_requests.scss}

@@ -1,9 +1,3 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/
-
-
 main {
   width: 100%;
 
@@ -133,7 +127,7 @@ main {
 .data-item {
   display: flex;
   flex-direction: column;
-  align-items: start;
+  align-items: flex-start;
   list-style: none;
 
   margin-right: 3rem;

data/app/javascript/stylesheets/rails-mini-profiler.scss

@@ -0,0 +1,175 @@
+@import 'flashes';
+@import 'flamegraph';
+@import 'navbar';
+@import 'profiled_requests';
+@import 'traces';
+
+@import url('https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600;700&display=swap');
+
+@font-face {
+  font-family: 'Open Sans';
+  font-weight: 400;
+  font-style: normal;
+}
+
+@font-face {
+  font-family: 'Open Sans';
+  font-weight: 600;
+  font-style: normal;
+}
+
+@font-face {
+  font-family: 'Open Sans';
+  font-weight: 700;
+  font-style: normal;
+}
+
+html {
+  width: 100%;
+  height: 100%;
+  margin: 0;
+  padding: 0;
+
+  --grey-50: #F9FAFB;
+  --grey-100: #F3F4F6;
+  --grey-200: #E5E7EB;
+  --grey-400: #9CA3AF;
+  --grey-500: #6B7280;
+  --grey-700: #374151;
+  --grey-900: #111827;
+
+  --red-400: #F87171;
+  --red-500: #EF4444;
+  --red-600: #DC2626;
+
+  --yellow-400: #FBBF24;
+  --yellow-500: #F59E0B;
+
+  --green-300: #6EE7B7;
+  --green-400: #34D399;
+  --green-500: #10B981;
+
+  --blue-400: #60A5FA;
+  --blue-500: #3B82F6;
+
+  --main-width: 1056px;
+
+  --primary: var(--red-600);
+
+  --border-color: var(--grey-200);
+  --text-color: var(--grey-900);
+
+  font-family: 'Open Sans', monospace;
+
+}
+
+body {
+  width: 100%;
+  height: 100%;
+  margin: 0;
+  padding: 0;
+
+  color: var(--text-color)
+}
+
+h1 {
+  padding: 2rem 0 1rem;
+}
+
+button {
+  border: none;
+  border-radius: .25rem;
+  padding: 0.5em .5em;
+  text-align: center;
+  text-decoration: none;
+  display: inline-block;
+  font-size: 1rem;
+  cursor: pointer;
+}
+
+button:hover {
+  box-shadow: 0 .25rem .25rem 0 var(--grey-50);
+}
+
+/* --------------------------------------- */
+
+.text-left {
+  text-align: left;
+}
+
+.text-right {
+  text-align: right;
+}
+
+/* --------------------------------------- */
+
+.pill {
+  margin: .2rem 0;
+  padding: .1rem .4rem;
+  border-radius: 5px;
+
+  font-size: .9rem;
+  font-weight: 600;
+  letter-spacing: .1rem;
+
+  background: var(--grey-200);
+}
+
+/* --------------------------------------- */
+
+.popover {
+  display: flex;
+  flex-direction: column;
+  width: 600px;
+  padding: 1em;
+  color: black;
+}
+
+.popover-header {
+  display: flex;
+  padding-bottom: 1em;
+  flex-direction: row;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.popover-description {
+  margin: 0;
+  padding: 0;
+}
+
+.popover-close {
+  background: transparent;
+  padding: 0;
+  font-weight: 700;
+  font-size: 20px;
+  color: var(--grey-400);
+}
+
+.popover-body {
+  padding: 1em 0;
+}
+
+.popover-footer {
+  border-top: 1px solid var(--grey-50);
+}
+
+.tippy-box[data-theme~='rmp'] {
+  background: white;
+  box-shadow: 8px 0 30px 4px rgba(0, 0, 0, .2), 8px 4px 10px 0 rgba(0, 0, 0, .05);
+  border-radius: 3px;
+
+  transition: all cubic-bezier(.19,1,.22,1) .2s;
+}
+.tippy-box[data-theme~='rmp'][data-placement^='top'] > .tippy-arrow::before {
+  border-top-color: white;
+}
+.tippy-box[data-theme~='rmp'][data-placement^='bottom'] > .tippy-arrow::before {
+  border-bottom-color: white;
+}
+.tippy-box[data-theme~='rmp'][data-placement^='left'] > .tippy-arrow::before {
+  border-left-color: white;
+}
+.tippy-box[data-theme~='rmp'][data-placement^='right'] > .tippy-arrow::before {
+  border-right-color: white;
+}

data/app/{assets/stylesheets/rails_mini_profiler/traces.css → javascript/stylesheets/traces.scss}

@@ -1,8 +1,3 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/
-
 .trace-list {
   margin: 0;
   padding: 0;

data/app/models/rails_mini_profiler/application_record.rb

@@ -3,7 +3,7 @@
 module RailsMiniProfiler
   class ApplicationRecord < ActiveRecord::Base
     if RailsMiniProfiler.storage_configuration.database.present?
-      establish_connection(RailsMiniProfiler.storage_configuration.database.present?)
+      establish_connection(RailsMiniProfiler.storage_configuration.database)
     end
 
     self.abstract_class = true

data/app/presenters/rails_mini_profiler/profiled_request_presenter.rb

@@ -23,11 +23,11 @@ module RailsMiniProfiler
 
       if model.flamegraph.present?
         link_to(flamegraph_path(model.id), title: 'Show Flamegraph') do
-          inline_svg_tag('rails_mini_profiler/graph.svg')
+          inline_svg('graph.svg')
         end
       else
         link_to(flamegraph_path(model.id), title: 'No Flamegraph present for this request', class: 'link-disabled') do
-          inline_svg_tag('rails_mini_profiler/graph.svg')
+          inline_svg('graph.svg')
         end
       end
     end

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

@@ -1,13 +1,6 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Rails Mini Profiler</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= javascript_include_tag "rails_mini_profiler" %>
-  <%= stylesheet_link_tag "rails_mini_profiler/application", media: "all" %>
-</head>
+<%= render 'rails_mini_profiler/shared/head' %>
 <body>
 
 <%= render 'rails_mini_profiler/shared/navbar' %>

data/app/views/layouts/rails_mini_profiler/flamegraph.html.erb

@@ -1,13 +1,6 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Rails Mini Profiler</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= javascript_include_tag "rails_mini_profiler" %>
-  <%= stylesheet_link_tag "rails_mini_profiler/application", media: "all" %>
-</head>
+<%= render 'rails_mini_profiler/shared/head' %>
 <body>
 
 <main>

data/app/views/rails_mini_profiler/badge.html.erb

@@ -32,6 +32,6 @@
   }
 </style>
 <a id="rails-mini-profiler-badge" href="<%= profiled_request_path(@profiled_request.id) %>" data-turbolinks="false" title="View performance data">
-  <%= inline_svg_tag('rails_mini_profiler/logo_variant', id: "rails-mini-profiler-badge-icon") %>
+  <%= inline_svg('logo_variant.svg', id: "rails-mini-profiler-badge-icon") %>
   <%= (@profiled_request.duration.to_f / 100).round %>ms
 </a>

data/app/views/rails_mini_profiler/profiled_requests/index.html.erb

@@ -1,6 +1,6 @@
 <% if @profiled_requests.empty? %>
   <section class="placeholder">
-    <%= inline_svg_tag('rails_mini_profiler/logo_variant', class: 'placeholder-image') %>
+    <%= inline_svg('logo_variant.svg', class: 'placeholder-image') %>
     <div class="placeholder-text">
       <h2> There is nothing here yet! </h2>
       <p>Send some requests to your app for them to show up here</p>
@@ -43,11 +43,11 @@
         <td class=""><%= profiled_request.created_at %></td>
         <td class="request-buttons">
           <%= link_to(profiled_request_path(profiled_request.id), title: 'Show Details') do %>
-            <%= inline_svg_tag('rails_mini_profiler/show.svg', options = {}) %>
+            <%= inline_svg('show.svg', options = {}) %>
           <% end %>
           <%= profiled_request.flamegraph_icon %>
           <%= link_to(profiled_request_path(profiled_request.id), title: 'Delete Request', method: :delete) do %>
-            <%= inline_svg_tag('rails_mini_profiler/delete.svg') %>
+            <%= inline_svg('delete.svg') %>
           <% end %>
         </td>
       </tr>

data/app/views/rails_mini_profiler/shared/_head.erb

@@ -0,0 +1,13 @@
+<head>
+  <title>Rails Mini Profiler</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <% if defined?(Webpacker::Engine) %>
+    <%= javascript_pack_tag "rails-mini-profiler" %>
+    <%= stylesheet_pack_tag 'rails-mini-profiler' %>
+  <% else %>
+    <%= javascript_include_tag "rails_mini_profiler" %>
+    <%= stylesheet_link_tag "rails_mini_profiler/application", media: "all" %>
+  <%end %>
+</head>

data/app/views/rails_mini_profiler/shared/_navbar.html.erb

@@ -1,7 +1,7 @@
 <header class="header">
   <nav class="nav">
     <a class="home" href="<%= profiled_requests_path %>">
-      <%= inline_svg_tag('rails_mini_profiler/logo', class: 'home-logo') %>
+      <%= inline_svg('logo.svg', class: 'home-logo') %>
       <h1 class="home-title">Rails Mini Profiler </h1>
     </a>
     <ul class="header-links">

data/lib/generators/rails_mini_profiler/install_generator.rb

@@ -1,15 +1,33 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
+  # Generators for Rails Mini Profiler
   module Generators
+    # A basic installation generator to help set up users apps
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('templates', __dir__)
 
+      # Install Rails Mini Profiler to your Rails app
+      #
+      # Updates the routes file to mount the engine, adds an initializer and copies a migration.
       desc 'Install rails-mini-profiler'
+
       def install
         route("mount RailsMiniProfiler::Engine => '/rails_mini_profiler'")
         template 'rails_mini_profiler.rb.erb', 'config/initializers/rails_mini_profiler.rb'
         system('rails rails_mini_profiler:install:migrations')
+        webpacker_install if defined?(Webpacker::Engine)
+      end
+
+      private
+
+      def webpacker_install
+        run 'yarn add @rails-mini-profiler/assets'
+        webpack_config = YAML.load_file(Rails.root.join('config', 'webpacker.yml'))[Rails.env]
+        destination = Rails.root.join(webpack_config['source_path'],
+                                      webpack_config['source_entry_path'],
+                                      'rails-mini-profiler.js')
+        template('rails_mini_profiler.js.erb', destination)
       end
     end
   end

data/lib/generators/rails_mini_profiler/templates/rails_mini_profiler.js.erb

@@ -0,0 +1,13 @@
+import "@rails-mini-profiler/assets"
+
+// Import styles
+import "@rails-mini-profiler/assets/dist/rails-mini-profiler.css";
+
+// Import images
+//
+// You may simplify this when using a glob loader (e.g glob-import-loader)
+<%- Dir.chdir(RailsMiniProfiler::Engine.root.join('app/javascript/images')) do -%>
+  <%- Dir.glob('**/*').each do |file| -%>
+import "@rails-mini-profiler/assets/dist/images/<%= file %>";
+  <%- end -%>
+<%- end -%>

data/lib/generators/rails_mini_profiler/templates/rails_mini_profiler.rb.erb

@@ -1,13 +1,24 @@
 RailsMiniProfiler.configure do |config|
   # Customize when Rails Mini Profiler should run
-  # config.enabled = proc { |env| Rails.env.development? || request.headers[RMP_ENABLED].present? }
+  config.enabled = proc { |env| Rails.env.development? || env['HTTP_RMP_ENABLED'].present? }
 
-  # Disable Flamegraph generation
-  # config.flamegraph_enabled = false
+  # Configure how hedgehog badge is rendered
+  config.badge_enabled = true
+  # config.badge_position = 'top-left'
 
-  # Use RailsMiniProfiler::Storage::ActiveRecord to store profiles in your Database
-  config.storage = RailsMiniProfiler::Storage
+  # Configure Flamegraph generation
+  config.flamegraph_enabled = true
+  # config.flamegraph_sample_rate = 0.5
 
-  # Uncomment to customize how users are detected
-  # config.user_provider = proc { |env| Rack::Request.new(env).ip }
+  # Configure endpoints to profile
+  config.skip_paths = []
+
+  # Configure how Rails Mini Profiler stores profiling information
+  # config.storage.database = :rmp_database
+  # config.storage.profiled_requests_table = :rmp_profiled_requests
+  # config.storage.traces_table = :rmp_traces
+  # config.storage.flamegraphs_table = :rmp_flamegraphs
+
+  # Customize how users are detected
+  config.user_provider = proc { |env| Rack::Request.new(env).ip }
 end

data/lib/rails_mini_profiler.rb

@@ -6,8 +6,6 @@ require 'inline_svg'
 require 'rails_mini_profiler/version'
 require 'rails_mini_profiler/engine'
 
-require 'rails_mini_profiler/errors'
-
 require 'rails_mini_profiler/user'
 require 'rails_mini_profiler/request_context'
 
@@ -26,28 +24,56 @@ require 'rails_mini_profiler/badge'
 require 'rails_mini_profiler/tracers'
 require 'rails_mini_profiler/middleware'
 
+# Main namespace for Rails Mini Profiler
 module RailsMiniProfiler
   class << self
+    # Create a new configuration object
+    #
+    # @return [Configuration] a new configuration
     def configuration
       @configuration ||= Configuration.new
     end
 
+    # Configure Rails Mini Profiler
+    #
+    # You may use this to configure where and how Rails Mini Profiler stores profiling and storage information.
+    #
+    # @see https://github.com/hschne/rails-mini-profiler#configuration
+    #
+    # @yieldreturn [Configuration] a new configuration
     def configure
       yield(configuration)
     end
 
+    # Access storage configuration.
+    #
+    #
+    # @return [Storage] a new storage configuration
     def storage_configuration
-      configuration.storage.configuration
+      configuration.storage
     end
 
+    # Access the current logger
+    #
+    # @return [Logger] the logger instance
     def logger
       @logger ||= configuration.logger
     end
 
+    # Authorize the current user for this request
+    #
+    # @param current_user [Object] the current user
+    #
+    # @see User#current_user
     def authorize!(current_user)
       RailsMiniProfiler::User.current_user = current_user
     end
 
+    # Set the current user for this request
+    #
+    # @param current_user [Object] the current user
+    #
+    # @see User#current_user
     def current_user=(current_user)
       RailsMiniProfiler::User.current_user = current_user
     end