debug-extras 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e34769bc216f226f3de5f2902f86bf32a0281a2e88ca9f570ce2e3a3917843f
-  data.tar.gz: 84f665b83921c3ade1705737bce363b018c4b716b08e038f421a6cf923bc77b5
+  metadata.gz: 47c7d5857ff588d85e3ba344e2aee47b70215c4f5a72b95e48126b64e5195640
+  data.tar.gz: 454499099c76781bd703496790f64281de68ba5244660520012ff7f126f1d21c
 SHA512:
-  metadata.gz: 2d4b6203f3dfecb61035156af58f33abb8a491a7a49eff9ffd6f3f98d6143c801bbe62ca13d94be3885d9aa83b1d21022ed43fb1bcb5b8106f2756c8c2dbd3dc
-  data.tar.gz: a8e8f0a3dc847eee18b07f1b495dd681011b1205f80f16c12a66d6f8c942146558ab885759a1d1074674f50bb1f5f9b5c7cbb0a4eb362d89a3de1776726fe9e4
+  metadata.gz: c96945e47ae1372d61d8b5a6185bdba50bb09ff28d0b5cfe9b113e2b0aed558ed4fc3dc612a3acc74c88fc9d67717db66085eb6c14e8e814f8eeff552da090c3
+  data.tar.gz: f828a05a023fbb690515e186e89d97fcbfc6822245ddba53185dc6ddb39184e48d3217549bd4e5bc3fcc7809336d46238dd5a7ade85a79137b07731e469bf265

data/.travis.yml

@@ -1,4 +1,7 @@
 sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=61fe9088e439d6574c5637416244043c983795d2e70f2e01e5435a144ada5aee
 language: ruby
 rvm:
   - 2.1.10
@@ -6,4 +9,15 @@ rvm:
   - 2.3.6
   - 2.4.3
   - 2.5.0
-before_install: gem install bundler -v 1.16.1
+before_install: 
+  - gem install bundler -v 1.16.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  email: false

data/README.md

@@ -1,19 +1,29 @@
-# 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)
+# 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) [![Maintainability](https://api.codeclimate.com/v1/badges/63067512ae858df2a5b3/maintainability)](https://codeclimate.com/github/vavgustov/debug-extras/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/63067512ae858df2a5b3/test_coverage)](https://codeclimate.com/github/vavgustov/debug-extras/test_coverage)
 
-Extras for Ruby on Rails debugging. [Screenshots](https://github.com/vavgustov/debug-extras#screenshots).
+Extras for Ruby on Rails debugging. [Screenshots](https://github.com/vavgustov/debug-extras#usage).
 
-## Features
+> Note: README actual for master branch.
+
+## Table of Contents
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+    - [#dd](#dd)
+    - [#wp](#wp)
+    - [#dump](#dump)
+- [Styling](#styling)    
+- [License](#license)
 
-At this moment provide next things:
-1. `dd <variable>` at any place of your application 
-(controllers/models/views/services/etc). After that you can see dump of this 
-variable without any other stuff at your web browser. 
-It's something like simple alternative to `dd` function from 
-[Laravel](https://laravel.com/) for [Ruby on Rails](http://rubyonrails.org/).
+## Features
+* `dd <variable>` at any `app/` place. Inspired by `dd` function from 
+[Laravel](https://laravel.com/).
 
-2. `dump <variable>` at your views. It's alternative for `debug` method from `ActionView::Helpers::DebugHelper`.
+* `wp <variable>` at any `app/` place. Inspired by classic PHP 'print' debugging. 
+It works for HTML pages and bypass other content types like `application/json`.
 
-3. temporary fix for `better_errors` and `binding_or_caller` with `puma 3.x` performance [issue](https://github.com/charliesome/better_errors/issues/341).
+* `dump <variable>` at your views. It's alternative for `debug` method from 
+`ActionView::Helpers::DebugHelper` and `ap` from `AwesomePrint`.
 
 ## Installation
 
@@ -27,25 +37,43 @@ And then execute:
 
     $ bundle
 
-Or you can install it using [rgversion](https://github.com/vavgustov/rgversion) like any other gems.
+## Usage
 
-## Screenshots
+### #dd
 
-`dd` from controller/model/service/etc:
+Call `dd` from any `app/` place:
 
 ```ruby
-dd Book.all
+dd @books
 ```
 
-![image](https://user-images.githubusercontent.com/312873/29333319-0480bb34-820c-11e7-82b0-3d2e648a4af8.png)
+![image](https://user-images.githubusercontent.com/312873/35333798-26e3f95e-0121-11e8-86e1-4e0d5bd1b068.png)
 
-`dump` from views:
+### #wp
+
+Call `wp` from any `app/` place:
+
+```ruby
+wp 'Authors through #wp method (called from controller):'
+wp @authors
+```
+
+![image](https://user-images.githubusercontent.com/312873/35333801-271a9c0c-0121-11e8-91d5-740706150c32.png)
+
+### #dump
+
+Call `dump` from views:
 
 ```erb
-<%= dump Book.all %>
+<%= dump 'Books through #dump method (called from view):' %>
+<%= dump @books %>
 ```
 
-![image](https://user-images.githubusercontent.com/312873/29333320-0482b484-820c-11e7-87ce-800e5319ce98.png)
+![image](https://user-images.githubusercontent.com/312873/35333799-26ffefba-0121-11e8-8021-a5faa62e6953.png)
+
+## Styling
+DebugExtras inject CSS to the page on methods call. You can override styles and set your fonts, 
+margins, etc using `.debug-extras` wrapper. Just look to page sources to get an idea.  
 
 ## License
 

data/debug-extras.gemspec

@@ -22,11 +22,11 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "awesome_print", ">= 1.6", "< 1.9"
+  spec.add_dependency "railties", "> 4.0", "< 6"
 
-  spec.add_runtime_dependency "awesome_print", ">= 1.6", "< 1.9"
-  spec.add_runtime_dependency "actionview", "> 4.0", "< 6"
-  spec.add_runtime_dependency "activesupport", "> 4.0", "< 6"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "simplecov", "~> 0.15"
 end

data/lib/debug-extras.rb

@@ -1,20 +1,27 @@
 require "active_support/dependencies/autoload"
 require "active_support/lazy_load_hooks"
-require "debug_extras/core_ext/kernel"
-require "debug_extras/version"
 
 module DebugExtras
   extend ActiveSupport::Autoload
 
   autoload :DebugPage
   autoload :Dumper
-  autoload :Middleware
+  autoload :Injector
   autoload :Settings
+end
+
+ActiveSupport.on_load :action_view do
+  require "debug_extras/ext/action_view"
+  ::ActionView::Base.send :include, DebugExtras::ActionView
+end
 
-  ActiveSupport.on_load :action_view do
-    require "debug_extras/helpers/view_helpers"
-    ::ActionView::Base.send :include, DebugExtras::Helpers::ViewHelpers
-  end
+ActiveSupport.on_load :action_controller do
+  require "debug_extras/ext/action_controller"
+  ::ActionController::Base.send :include, DebugExtras::ActionController
 end
 
+require "debug_extras/core_ext/kernel"
+require "debug_extras/exceptions"
+require "debug_extras/version"
+
 require "debug_extras/railtie" if defined? Rails::Railtie

data/lib/debug_extras/core_ext/kernel.rb

@@ -1,10 +1,16 @@
-require "debug_extras/exceptions"
-
 module Kernel
   # dump object through exception message
-  def dd(dump, settings = {})
-    DebugExtras::Dumper.new(dump, settings).render do |message|
+  def dd(dump)
+    DebugExtras::Dumper.new(dump, 'debug-dd').render do |message|
       raise DebugExtras::DebugData, message
     end
   end
+
+  # print on the html page like php
+  def wp(message)
+    $debug_extras_messages ||= []
+    unless message.blank?
+      $debug_extras_messages << message
+    end
+  end
 end

data/lib/debug_extras/debug_page.rb

@@ -5,11 +5,13 @@ module DebugExtras
     def initialize(exception, request_path)
       @exception = exception
       @request_path = request_path
-      @template = File.read(File.expand_path("../templates/debug.html.erb", __FILE__))
     end
 
     def render
-      ERB.new(@template).result(binding)
+      template = File.read(File.expand_path("../templates/debug.html.erb", __FILE__))
+      styles = File.read(File.expand_path("../templates/styles.html", __FILE__))
+      @inject_styles = ERB.new(styles).result(binding)
+      ERB.new(template).result(binding)
     end
   end
 end

data/lib/debug_extras/dumper.rb

@@ -3,52 +3,25 @@ require "awesome_print"
 
 module DebugExtras
   class Dumper
-    include ActionView::Context
-    include ActionView::Helpers::TagHelper
+    include ::ActionView::Context
+    include ::ActionView::Helpers::TagHelper
 
-    def initialize(dump, settings)
+    def initialize(dump, css_class)
       @dump = dump
-      @settings = settings
+      @css_class = "debug-extras #{css_class}"
+      $debug_extras_add_styles = true
     end
 
     def render
-      message = content_tag(:div, class: 'debug-extras') do
-        @settings.merge! Settings.ap_options
-
-        output = @dump.ai Settings.ap_options
-        output = render_object_names output
-        output = add_styles_to_tag(:pre, output)
-        output = add_styles_to_tag(:kbd, output)
-
-        output.html_safe
+      message = content_tag(:div, class: @css_class) do
+        render_object_names(@dump.ai(Settings.options)).html_safe
       end
-
       yield message if block_given?
-
       message
     end
 
-    private
-
-    def convert_hash_to_style(styles)
-      styles.map { |k, v| "#{k}: #{v}" }.join('; ')
-    end
-
-    def add_styles_to_tag(tag, output)
-      case tag
-        when :pre
-          output.sub!("<pre>", "<pre style=\"#{convert_hash_to_style(Settings.ap_styles(:pre))}\">")
-        when :kbd
-          output.gsub!("<kbd style=\"", "<kbd style=\"#{convert_hash_to_style(Settings.ap_styles(:kbd))}; ")
-        else
-          output
-      end
-      output
-    end
-
     def render_object_names(dump)
       output = ""
-
       dump.split("<").map.with_index do |v, k|
         if v.include? ":0x" and not (v.include? "kbd" or v.include? "pre")
           v.sub!(">", "")
@@ -57,7 +30,6 @@ module DebugExtras
         end
         output << v
       end
-
       output
     end
   end

data/lib/debug_extras/ext/action_controller.rb

@@ -0,0 +1,9 @@
+module DebugExtras
+  module ActionController
+    def render(*args)
+      super
+      injector = Injector.new(response)
+      response.body = injector.process_response
+    end
+  end
+end

data/lib/debug_extras/ext/action_view.rb

@@ -0,0 +1,9 @@
+require "active_support/concern"
+
+module DebugExtras
+  module ActionView
+    def dump(object)
+      Dumper.new(object, 'debug-dump').render
+    end
+  end
+end

data/lib/debug_extras/injector.rb

@@ -0,0 +1,50 @@
+module DebugExtras
+  class Injector
+    def initialize(response)
+      @response = response
+      @result = @response.body
+    end
+
+    def process_response
+      if response_is_html?
+        inject_messages
+        inject_styles
+      end
+      @result
+    end
+
+    private
+
+    def response_is_html?
+      return false unless @response.headers['Content-Type'].include?('html')
+      tags = %w[<html <head </head> <body </body> </html>]
+      tags.each do |tag|
+        return false unless @response.body.include? tag
+      end
+      true
+    end
+
+    def inject_messages
+      return if $debug_extras_messages.blank?
+      $debug_extras_messages.map! { |message| DebugExtras::Dumper.new(message, 'debug-wp').render }
+      injection = $debug_extras_messages.join('')
+      @result = inject_content('<body') do |html|
+        body = html.second.split('>')
+        body.second.prepend(injection) if body.size > 1
+        html[1] = body.join('>')
+      end
+    end
+
+    def inject_styles
+      return unless $debug_extras_add_styles
+      injection = File.read(File.expand_path('../templates/styles.html', __FILE__))
+      @result = inject_content('</head>') { |html| html.first << injection }
+    end
+
+    def inject_content(tag)
+      html = @result.split(tag)
+      yield html if block_given?
+      html.join(tag)
+    end
+  end
+end

data/lib/debug_extras/middleware/debug.rb

@@ -5,6 +5,7 @@ module DebugExtras
     end
 
     def call(env)
+      reset_stack
       @app.call env
     rescue StandardError => ex
       process_exception(ex, env)
@@ -12,6 +13,11 @@ module DebugExtras
 
     private
 
+    def reset_stack
+      $debug_extras_add_styles = false
+      $debug_extras_messages = []
+    end
+
     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"])

data/lib/debug_extras/railtie.rb

@@ -1,13 +1,9 @@
 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 Rails.env.development?
-        insert_middleware(DebugExtras::Debug)
-        insert_middleware(DebugExtras::FastBetterErrors) if better_errors_slow?
-      end
+    initializer "debug_extras.setup_middleware" do
+      insert_middleware(DebugExtras::Debug) if Rails.env.development?
     end
 
     private
@@ -22,11 +18,6 @@ module DebugExtras
       end
     end
 
-    def better_errors_slow?
-      return false unless defined?(BetterErrors) && defined?(Puma::Const::PUMA_VERSION)
-      BetterErrors.binding_of_caller_available && Puma::Const::PUMA_VERSION.split(".").first.to_i == 3
-    end
-
     def app
       Rails.application
     end

data/lib/debug_extras/settings.rb

@@ -1,35 +1,13 @@
 module DebugExtras
   module Settings
-    class << self
-      def ap_options
-        { html: true, color: { array: :yellowish } }
-      end
-
-      def ap_styles(tag)
-        {
-          pre: {
-            "background" => "#f5f8fa",
-            "border" => "1px solid #ccc",
-            "border-radius" => "0",
-            "color" => "#111",
-            "font-family" => "Menlo, Consolas, Ubuntu, monospace",
-            "font-weight" => "bold",
-            "font-size" => "12px",
-            "line-height" => "1.43",
-            "margin" => "0 0 10px",
-            "padding" => "10px",
-            "white-space" => "pre-wrap",
-          },
-          kbd: {
-            "background" => "none",
-            "box-shadow" => "none",
-            "font-family" => "Menlo, Consolas, Ubuntu, monospace",
-            "font-weight" => "bold",
-            "font-size" => "12px",
-            "padding" => "2px 4px"
-          }
-        }[tag]
-      end
+    def self.options
+      {
+        html: true,
+        color: {
+          array: :yellowish,
+          class: :cyanish
+        }
+      }
     end
   end
 end

data/lib/debug_extras/templates/debug.html.erb

@@ -1,3 +1,4 @@
+<!-- page generated by debug-extras #dd method call -->
 <!doctype html>
 <html lang="en">
 <head>
@@ -10,18 +11,14 @@
     body {
       margin: 0;
       padding: 15px;
-      color: #c52f24;
-      background: #f5f8fa;
-    }
-
-    pre {
-      border: 0 !important;
     }
 
     .container {
       width: 100%;
     }
   </style>
+
+  <%= @inject_styles %>
 </head>
 <body>
 <div class="container">

data/lib/debug_extras/templates/styles.html

@@ -0,0 +1,31 @@
+<!-- styles injected by debug-extras gem -->
+<style>
+  .debug-extras pre {
+    padding: 10px;
+    text-align: left;
+  }
+
+  .debug-extras kbd {
+    padding: 2px 4px;
+  }
+
+  .debug-extras pre,
+  .debug-extras kbd {
+    background: none;
+    border: none;
+    box-shadow: none;
+    font-family: SFMono-Regular, Menlo, Monaco, Consolas, Ubuntu, monospace;
+    font-weight: normal;
+    font-size: 12px;
+    line-height: 16px;
+    margin: 0;
+  }
+
+  .debug-extras.debug-dump {
+    background: #f5f8fa;
+    border: 1px solid #ccc;
+    border-radius: 0;
+    margin-bottom: 1.5rem;
+  }
+</style>
+<!-- end of debug-extras -->

data/lib/debug_extras/version.rb

@@ -1,3 +1,3 @@
 module DebugExtras
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,117 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: debug-extras
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Avgustov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :runtime
+        version: '12.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: actionview
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
+        version: '3.7'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
+        version: '0.15'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '0.15'
 description: Provide debug helper methods for ActionController::Base and ActionView::Base.
 email:
 - vavgustov@gmail.com
@@ -132,12 +126,14 @@ files:
 - lib/debug_extras/debug_page.rb
 - lib/debug_extras/dumper.rb
 - lib/debug_extras/exceptions.rb
-- lib/debug_extras/helpers/view_helpers.rb
+- lib/debug_extras/ext/action_controller.rb
+- lib/debug_extras/ext/action_view.rb
+- lib/debug_extras/injector.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
+- lib/debug_extras/templates/styles.html
 - lib/debug_extras/version.rb
 homepage: https://github.com/vavgustov/debug-extras
 licenses:

data/lib/debug_extras/helpers/view_helpers.rb

@@ -1,13 +0,0 @@
-require "active_support/concern"
-
-module DebugExtras
-  module Helpers
-    module ViewHelpers
-      extend ActiveSupport::Concern
-
-      def dump(object, settings = {})
-        Dumper.new(object, settings).render
-      end
-    end
-  end
-end

data/lib/debug_extras/middleware/fast_better_errors.rb

@@ -1,13 +0,0 @@
-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