debug-extras 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22f0e2df357a2929bee4703f660b777bad7eae9c
-  data.tar.gz: 37da334a490125800388a00ce5dee88b0eed0362
+  metadata.gz: 377e4b36eef7d82e29633387824887706ee7d937
+  data.tar.gz: fa54e8daab506a47c6fc1fd977547a7631bf1783
 SHA512:
-  metadata.gz: e44b543a282aa88c2d10111afc9e1270ab5320b6cb06a2c2a3151b67af925437c770fb754fe3c83de19c7afaa0d8f306a7e0edab8b8fc2f09292e39ffedbd49b
-  data.tar.gz: bac5229d5b6bde0dee0bbcca118b8e9439cba96ef42cd16a72fe7ad2ee964cfc2c1a3f22cb16461ef21c1a767f50fda4cec16c76135c4765c9f7e81b3a67ffd9
+  metadata.gz: 06c880e79dc2c7224e6e71c2ac10883d0cc0ce1121192eede19f82259f8bff163477ca6506418aad1f98a3525890c8bb5f1a05dd6093db3b154350d526294832
+  data.tar.gz: ab52151f23fff72a327ec182361e6a95f32e3c26b92af479d03d44b53a4b54638776942b26aed16ea8842717b4407a64427a38d4d37f83884dd62d569a8151b2

data/README.md

@@ -1,16 +1,6 @@
-TODO: move to js
-TODO: check with rspec
-TODO: check with pure ruby
-TODO: make PR to better_errors? -
-TODO: check byebug
-TODO: update pivotal
-TODO: update REAMDE
-
 # DebugExtras [![Gem](https://img.shields.io/gem/v/debug-extras.svg)](https://rubygems.org/gems/debug-extras) [![Build Status](https://img.shields.io/travis/vavgustov/debug-extras/master.svg)](https://travis-ci.org/vavgustov/debug-extras) [![Code Climate](https://img.shields.io/codeclimate/github/vavgustov/debug-extras.svg)](https://codeclimate.com/github/vavgustov/debug-extras)
 
-Extras for Ruby on Rails debugging.
-
-TODO: add image here with dd results
+Extras for Ruby on Rails debugging. [Screenshots](https://github.com/vavgustov/debug-extras#screenshots).
 
 ## Features
 
@@ -23,7 +13,7 @@ It's something like simple alternative to `dd` function from
 
 2. `dump <variable>` at your views. It's alternative for `debug` method from `ActionView::Helpers::DebugHelper`.
 
-3. fix for `better_errors` and `binding_or_caller` performance
+3. temporary fix for `better_errors` and `binding_or_caller` performance [issue](https://github.com/charliesome/better_errors/issues/341).
 
 ## Installation
 
@@ -39,20 +29,20 @@ And then execute:
 
 Or you can install it using [rgversion](https://github.com/vavgustov/rgversion) like any other gems.
 
-## Samples
+## Screenshots
+
+`dd` from controller/model/service/etc:
 
 ```ruby
-dd self.instance_variables
+dd Book.all
 ```
 
-![image](https://user-images.githubusercontent.com/312873/28998770-ddfc7b74-7a3b-11e7-905b-52b3c1c797a4.png)
+![image](https://user-images.githubusercontent.com/312873/29333319-0480bb34-820c-11e7-82b0-3d2e648a4af8.png)
+
+`dump` from views:
 
 ```erb
-<%= rap self.instance_variables %>
+<%= dump Book.all %>
 ```
 
-![image](https://user-images.githubusercontent.com/312873/28998927-9111f88a-7a3f-11e7-9c8d-cb825472d8ca.png)
-
-
-
-
+![image](https://user-images.githubusercontent.com/312873/29333320-0482b484-820c-11e7-87ce-800e5319ce98.png)

data/lib/debug_extras/dumper.rb

@@ -50,7 +50,7 @@ module DebugExtras
       output = ""
 
       dump.split("<").map.with_index do |v, k|
-        if v.include? ":0x" and not v.include? "kbd"
+        if v.include? ":0x" and not (v.include? "kbd" or v.include? "pre")
           v.sub!(">", "")
         else
           output << "<" unless k.zero?

data/lib/debug_extras/{middleware.rb → middleware/debug.rb}

@@ -1,13 +1,18 @@
 module DebugExtras
-  class Middleware
+  class Debug
     def initialize(app)
       @app = app
     end
 
     def call(env)
-      better_errors_fix env
       @app.call env
     rescue StandardError => ex
+      process_exception(ex, env)
+    end
+
+    private
+
+    def process_exception(ex, env)
       if [ex.class, ex.cause.class].map(&:to_s).include? "DebugExtras::DebugData"
         debug_page = DebugPage.new(ex, env["PATH_INFO"])
         [200, { "Content-Type" => "text/html; charset=utf-8" }, [debug_page.render]]
@@ -15,12 +20,5 @@ module DebugExtras
         @app.call env
       end
     end
-
-    private
-
-    # based on https://github.com/charliesome/better_errors/issues/341
-    def better_errors_fix(env)
-      env["puma.config"].options.user_options.delete(:app) if env.has_key?("puma.config")
-    end
   end
-end
+end

data/lib/debug_extras/middleware/fast_better_errors.rb

@@ -0,0 +1,13 @@
+module DebugExtras
+  # based on https://github.com/charliesome/better_errors/issues/341 proposals
+  class FastBetterErrors
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env["puma.config"].options.user_options.delete(:app) if env.has_key?("puma.config")
+      @app.call env
+    end
+  end
+end

data/lib/debug_extras/railtie.rb

@@ -1,17 +1,34 @@
+require "debug_extras/middleware/debug"
+require "debug_extras/middleware/fast_better_errors"
+
 module DebugExtras
   class Railtie < Rails::Railtie
     initializer "debug_extras.configure_rails_initialization" do
-      if defined? ActionDispatch::DebugExceptions
-        app.middleware.insert_after ActionDispatch::DebugExceptions, DebugExtras::Middleware
-      else
-        app.middleware.use DebugExtras::Middleware
+      if Rails.env.development?
+        insert_middleware(DebugExtras::Debug)
+        insert_middleware(DebugExtras::FastBetterErrors) if better_errors_slow?
       end
     end
 
     private
 
+    def insert_middleware(middleware)
+      if defined? BetterErrors::Middleware
+        app.middleware.insert_before ActionDispatch::Reloader, middleware
+      elsif defined? ActionDispatch::DebugExceptions
+        app.middleware.insert_after ActionDispatch::DebugExceptions, middleware
+      else
+        app.middleware.use middleware
+      end
+    end
+
+    def better_errors_slow?
+      return false unless defined? BetterErrors && defined? Puma
+      BetterErrors.binding_of_caller_available && [Rails.version, Puma::Const::PUMA_VERSION].map(&:to_i) == [5, 3]
+    end
+
     def app
       Rails.application
     end
   end
-end
+end

data/lib/debug_extras/version.rb

@@ -1,3 +1,3 @@
 module DebugExtras
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debug-extras
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Vladimir Avgustov
@@ -127,7 +127,8 @@ files:
 - lib/debug_extras/dumper.rb
 - lib/debug_extras/exceptions.rb
 - lib/debug_extras/helpers/view_helpers.rb
-- lib/debug_extras/middleware.rb
+- lib/debug_extras/middleware/debug.rb
+- lib/debug_extras/middleware/fast_better_errors.rb
 - lib/debug_extras/railtie.rb
 - lib/debug_extras/settings.rb
 - lib/debug_extras/templates/debug.html.erb