debug-extras 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e28babbb91f3d8087f3fed430c67c8c4f6ab32d6
-  data.tar.gz: 29c8e723fc8c897a55150d4ebe5e81c0a6146adb
+  metadata.gz: 22f0e2df357a2929bee4703f660b777bad7eae9c
+  data.tar.gz: 37da334a490125800388a00ce5dee88b0eed0362
 SHA512:
-  metadata.gz: 31b4776464461e21d70791796ee805bd7282a47d48cd3a31ce94ea4fa0a36f7414ec475750b72b222febac4451732b281bf1d8acb34299b9d480d3f631f7f01e
-  data.tar.gz: f9ff33003fbb0559a1100ab9bd3ec051b3c9ddf9a95008e8e035fece2adab39f5446363c7e296a31135eddf237122a5a82874d69583748108e063ac394017dcc
+  metadata.gz: e44b543a282aa88c2d10111afc9e1270ab5320b6cb06a2c2a3151b67af925437c770fb754fe3c83de19c7afaa0d8f306a7e0edab8b8fc2f09292e39ffedbd49b
+  data.tar.gz: bac5229d5b6bde0dee0bbcca118b8e9439cba96ef42cd16a72fe7ad2ee964cfc2c1a3f22cb16461ef21c1a767f50fda4cec16c76135c4765c9f7e81b3a67ffd9

data/README.md

@@ -1,21 +1,58 @@
+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 rails debugging.
+Extras for Ruby on Rails debugging.
+
+TODO: add image here with dd results
+
+## Features
+
+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/).
+
+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
 
 ## Installation
 
+Add this line to your Gemfile:
+
 ```ruby
-gem 'debug-extras'
+gem 'debug-extras', group: :development
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or you can install it using [rgversion](https://github.com/vavgustov/rgversion) like any other gems.
+
+## Samples
+
+```ruby
+dd self.instance_variables
+```
+
+![image](https://user-images.githubusercontent.com/312873/28998770-ddfc7b74-7a3b-11e7-905b-52b3c1c797a4.png)
+
+```erb
+<%= rap self.instance_variables %>
+```
+
+![image](https://user-images.githubusercontent.com/312873/28998927-9111f88a-7a3f-11e7-9c8d-cb825472d8ca.png)
+
 
-    $ gem install debug-extras
 
-## Usage
 
-Coming soon...

data/debug-extras.gemspec

@@ -1,32 +1,32 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'debug_extras/version'
+require "debug_extras/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "debug-extras"
-  spec.version       = DebugExtras.version
+  spec.version       = DebugExtras::VERSION
   spec.authors       = ["Vladimir Avgustov"]
   spec.email         = ["vavgustov@gmail.com"]
 
-  spec.summary       = 'Extras for rails debugging.'
-  spec.description   = 'Provide debug helper methods for ActionController::Base and ActionView::Base.'
-  spec.homepage      = 'https://github.com/vavgustov/debug-extras'
-  spec.license       = 'MIT'
+  spec.summary       = "Extras for rails debugging."
+  spec.description   = "Provide debug helper methods for ActionController::Base and ActionView::Base."
+  spec.homepage      = "https://github.com/vavgustov/debug-extras"
+  spec.license       = "MIT"
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = ">= 2.1.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_runtime_dependency 'awesome_print', '~> 1.8'
-  spec.add_runtime_dependency 'actionview', '> 4.0', '< 6'
-  spec.add_runtime_dependency 'activesupport', '> 4.0', '< 6'
+  spec.add_runtime_dependency "awesome_print", "~> 1.8"
+  spec.add_runtime_dependency "actionview", "> 4.0", "< 6"
+  spec.add_runtime_dependency "activesupport", "> 4.0", "< 6"
 end

data/lib/debug-extras.rb

@@ -1,21 +1,19 @@
-require "debug_extras/version"
-require "active_support/concern"
-require "active_support/core_ext/string/output_safety"
 require "active_support/dependencies/autoload"
 require "active_support/lazy_load_hooks"
-require "action_view/helpers/output_safety_helper"
-require "awesome_print"
-require "debug_extras/middleware"
-require "debug_extras/core_ext/object"
-require "debug_extras/helpers/view_helpers"
+require "debug_extras/core_ext/kernel"
+require "debug_extras/version"
 
 module DebugExtras
   extend ActiveSupport::Autoload
 
+  autoload :DebugPage
+  autoload :Dumper
+  autoload :Middleware
   autoload :Settings
 
   ActiveSupport.on_load :action_view do
-    ActionView::Base.send :include, DebugExtras::Helpers::ViewHelpers
+    require "debug_extras/helpers/view_helpers"
+    ::ActionView::Base.send :include, DebugExtras::Helpers::ViewHelpers
   end
 end
 

data/lib/debug_extras/core_ext/kernel.rb

@@ -0,0 +1,10 @@
+require "debug_extras/exceptions"
+
+module Kernel
+  # dump object through exception message
+  def dd(dump, settings = {})
+    DebugExtras::Dumper.new(dump, settings).render do |message|
+      raise DebugExtras::DebugData, message
+    end
+  end
+end

data/lib/debug_extras/{error_page.rb → debug_page.rb}

@@ -1,15 +1,15 @@
 require "erb"
 
 module DebugExtras
-  class ErrorPage
+  class DebugPage
     def initialize(exception, request_path)
       @exception = exception
       @request_path = request_path
-      @template = File.read(File.expand_path("../templates/main.html.erb", __FILE__))
+      @template = File.read(File.expand_path("../templates/debug.html.erb", __FILE__))
     end
 
     def render
-      ERB.new(@template).result( binding )
+      ERB.new(@template).result(binding)
     end
   end
-end
+end

data/lib/debug_extras/dumper.rb

@@ -0,0 +1,64 @@
+require "action_view"
+require "awesome_print"
+
+module DebugExtras
+  class Dumper
+    include ActionView::Context
+    include ActionView::Helpers::TagHelper
+
+    def initialize(dump, settings)
+      @dump = dump
+      @settings = settings
+    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
+      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"
+          v.sub!(">", "")
+        else
+          output << "<" unless k.zero?
+        end
+        output << v
+      end
+
+      output
+    end
+  end
+end

data/lib/debug_extras/helpers/view_helpers.rb

@@ -1,10 +1,12 @@
+require "active_support/concern"
+
 module DebugExtras
   module Helpers
     module ViewHelpers
       extend ActiveSupport::Concern
 
-      def rap(object)
-        raw ap(object, DebugExtras::Settings.ap_options)
+      def dump(object, settings = {})
+        Dumper.new(object, settings).render
       end
     end
   end

data/lib/debug_extras/middleware.rb

@@ -1,5 +1,3 @@
-require 'debug_extras/error_page'
-
 module DebugExtras
   class Middleware
     def initialize(app)
@@ -7,15 +5,22 @@ module DebugExtras
     end
 
     def call(env)
-      env['puma.config'].options.user_options.delete(:app) if env.has_key?('puma.config')
+      better_errors_fix env
       @app.call env
     rescue StandardError => ex
-      if [ex.class, ex.cause.class].map(&:to_s).include? 'DebugExtras::DebugData'
-        error_page = ErrorPage.new(ex, Rails.env["PATH_INFO"])
-        [200, { "Content-Type" => "text/html; charset=utf-8" }, [error_page.render]]
+      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]]
       else
         @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

data/lib/debug_extras/settings.rb

@@ -2,8 +2,34 @@ module DebugExtras
   module Settings
     class << self
       def ap_options
-        { html: true, color: { array: :red } }
+        { 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
     end
   end
-end
+end

data/lib/debug_extras/templates/{main.html.erb → debug.html.erb}

@@ -11,23 +11,15 @@
       margin: 0;
       padding: 15px;
       color: #c52f24;
-      font-weight: bold;
-      font-size: 12px;
-      font-family: Menlo, Consolas, Ubuntu, monospace;
       background: #f5f8fa;
     }
 
-    .container {
-      width: 100%;
-    }
-
     pre {
-      white-space: pre-wrap;
+      border: 0 !important;
     }
 
-    kbd {
-      background: none;
-      shadow: none;
+    .container {
+      width: 100%;
     }
   </style>
 </head>
@@ -36,4 +28,4 @@
   <%= @exception.message %>
 </div>
 </body>
-</html>
+</html>

data/lib/debug_extras/version.rb

@@ -1,7 +1,3 @@
-require_relative 'gem_version'
-
 module DebugExtras
-  def self.version
-    gem_version
-  end
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug-extras
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Avgustov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-05 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,15 +122,15 @@ files:
 - Rakefile
 - debug-extras.gemspec
 - lib/debug-extras.rb
-- lib/debug_extras/core_ext/object.rb
-- lib/debug_extras/error_page.rb
+- lib/debug_extras/core_ext/kernel.rb
+- lib/debug_extras/debug_page.rb
+- lib/debug_extras/dumper.rb
 - lib/debug_extras/exceptions.rb
-- lib/debug_extras/gem_version.rb
 - lib/debug_extras/helpers/view_helpers.rb
 - lib/debug_extras/middleware.rb
 - lib/debug_extras/railtie.rb
 - lib/debug_extras/settings.rb
-- lib/debug_extras/templates/main.html.erb
+- lib/debug_extras/templates/debug.html.erb
 - lib/debug_extras/version.rb
 homepage: https://github.com/vavgustov/debug-extras
 licenses:

data/lib/debug_extras/core_ext/object.rb

@@ -1,11 +0,0 @@
-require 'debug_extras/exceptions'
-
-class Object
-  def dd(message, settings = {})
-    prefix = message.class.to_s
-    prefix << "##{message.length}" if message.respond_to? :length
-    settings.merge! DebugExtras::Settings.ap_options
-    output = prefix + message.ai(settings)
-    raise DebugExtras::DebugData.new(output)
-  end
-end

data/lib/debug_extras/gem_version.rb

@@ -1,13 +0,0 @@
-module DebugExtras
-  def self.gem_version
-    Gem::Version.new VERSION::STRING
-  end
-
-  module VERSION
-    MAJOR = 0
-    MINOR = 2
-    TINY  = 0
-
-    STRING = [MAJOR, MINOR, TINY].compact.join('.')
-  end
-end