betterp 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ede79516da0652f02b85606bc9ba0ad436a08fc2
-  data.tar.gz: b5e74b88668472fe64850a3d7f1d2371b78f6554
+SHA256:
+  metadata.gz: 77fbb36e55d0c863d7451219b231702f1520ea7abfd97997863be1da860b9a3f
+  data.tar.gz: 234ade8966e9e3e61b88d70e4143915bc842e814abdab13e5bcecb44970024cc
 SHA512:
-  metadata.gz: 3613c1f03a649f804a62a53591222b9705c98d6a5ac7b3a551dc4ba591ef0a31ba6b6d341b960b88d78e24d1f5e17e8c0f0c6ce32c56ab9b3fe122404fa8905c
-  data.tar.gz: 2e7d82ae3d46978d104f2bc92b6c61b19198f9fb60d1737ef8905b2fc33c346f7db2241e85e79258b1e347710d24705d7a661560fa445794ce0ac7053136121d
+  metadata.gz: 843988be19cc12f78344cd6392ea98ea636acef8e70f71a12dbb2193ced6fed064dc4ca8fba8a220f420368135c262883fe0faa2285bfcf5e3996cce0e83a2ef
+  data.tar.gz: e16a4d415911c0ae530e3aaae83bcfacabaddc2a8a9de5d28ac003f576094458f70377be7903632f337bfc62597baa3b1299b234a0de453f4d78987a463ec4a0

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Exclude:
+    - 'lib/betterp/output.rb'
+
+Style/FormatString:
+  Exclude:
+    - 'lib/betterp/output.rb'
+
+Style/FormatStringToken:
+  Exclude:
+    - 'lib/betterp/output.rb'
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'

data/Makefile

@@ -1,4 +1,5 @@
 .PHONY: test
 test:
-	bundle exec rspec
-	bundle exec rubocop
+	bin/rspec
+	bin/rubocop
+	bin/strong_versions

data/README.md

@@ -22,7 +22,7 @@ The original semantics of `Kernel#p` are still applied, i.e. it returns the valu
 Add the gem to your `Gemfile`
 
 ```ruby
-gem 'betterp', '~> 0.1.1'
+gem 'betterp', '~> 0.1.2'
 ```
 
 And rebuild your bundle:
@@ -33,7 +33,7 @@ $ bundle install
 
 Or install standalone:
 ```bash
-$ gem install betterp -v '0.1.1'
+$ gem install betterp -v '0.1.2'
 ```
 
 ## Usage

data/betterp.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
   spec.add_development_dependency 'rubocop', '~> 0.60.0'
+  spec.add_development_dependency 'strong_versions', '~> 0.3.2'
 end

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/strong_versions

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'strong_versions' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("strong_versions", "strong_versions")

data/lib/betterp.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'digest'
+require 'pathname'
+require 'pp'
 
 require 'paint'
 

data/lib/betterp/output.rb

@@ -5,23 +5,64 @@ module Betterp
     COLORS = %i[red green yellow blue magenta cyan].freeze
     EFFECTS = [:bright, nil].freeze
 
-    def initialize(raw, source)
+    def initialize(raw, source, options = {})
       @raw = raw
       @source = source
       @color = color
       @effect = effect
+      @pretty = options.fetch(:pretty, false)
     end
 
     def format(args)
       args.map do |arg|
-        colorize(prefix) + Paint[arg.inspect, :default, :bright]
+        style = %i[cyan black]
+        header + colorize(prefix) + caller_code + Paint[pretty(arg), *style]
       end
     end
 
     private
 
+    def pretty(arg)
+      return arg unless @pretty
+
+      io = StringIO.new
+      PP.pp(arg, io)
+      return io.string unless io.string.include?("\n")
+
+      "\n" + io.string.split("\n").map { |line| "    #{line}" }.join("\n")
+    end
+
+    def caller_code
+      return '' unless @raw.include?(':')
+
+      path, line, *_rest = @raw.split(':')
+      return '' unless Pathname.new(path).readable? && line.to_i.positive?
+
+      Paint % [
+        +'%{open}%{code}%{close}',
+        :default,
+        open: ['{ ', :white, :default],
+        code: [find_caller(line.to_i, path).to_s.strip, :blue, :black],
+        close: [' } ', :white, :default]
+      ]
+    end
+
+    def find_caller(line_number, path)
+      lines = File.readlines(path)
+      token = @pretty ? 'pp' : 'p'
+      lines[0...line_number].reverse.find { |line| line.match(/\b#{token}\b/) }
+    end
+
+    def header
+      Paint % [
+        +"%{standard}%{relevant}",
+        :default,
+        standard: ['   ', :default],
+        relevant: ['•••• ', @color, @effect]
+      ]
+    end
+
     def prefix
-      # rubocop:disable Style/FormatStringToken
       [
         '%{path}',
         '%{separator}',
@@ -30,20 +71,17 @@ module Betterp
         '%{method_name}',
         '%{terminator}'
       ].join
-      # rubocop:enable Style/FormatStringToken
     end
 
     def colorize(string)
-      # rubocop:disable Style/FormatString
-      Paint % [string, color, mapping]
-      # rubocop:enable Style/FormatString
+      Paint % [string, :default, mapping]
     end
 
     def mapping
       {
-        path: [@source.path, color, :underline, effect],
-        line_no: [@source.line_no, :underline, color, effect],
-        method_name: [@source.method_name, :reset, color, effect],
+        path: [@source.path],
+        line_no: [@source.line_no],
+        method_name: [@source.method_name],
 
         method_pointer: [' => ', :reset, :bright],
         separator: [':', :reset],

data/lib/betterp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Betterp
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/kernel.rb

@@ -3,10 +3,20 @@
 module Kernel
   def p(*args)
     raw = caller(1..1).first
+    _betterp(raw, args)
+  end
+
+  def pp(*args)
+    raw = caller(1..1).first
+    _betterp(raw, args, pretty: true)
+  end
+
+  def _betterp(raw, args, options = {})
     source = Betterp::Source.new(raw, Dir.pwd)
+    pretty = options.fetch(:pretty, false)
 
-    Betterp::Output.new(raw, source).format(args).each do |output|
-      STDOUT.write(output + "\n")
+    Betterp::Output.new(raw, source, pretty: pretty).format(args).each do |str|
+      STDOUT.write(str + "\n")
     end
 
     args.size > 1 ? args : args.first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2019-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.60.0
+- !ruby/object:Gem::Dependency
+  name: strong_versions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 description: Replaces Kernel#p with a fancier version
 email:
 - bob@homeflow.co.uk
@@ -103,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - Makefile
@@ -110,7 +125,10 @@ files:
 - Rakefile
 - betterp.gemspec
 - bin/console
+- bin/rspec
+- bin/rubocop
 - bin/setup
+- bin/strong_versions
 - doc/images/screenshot.png
 - doc/testp.rb
 - lib/betterp.rb
@@ -138,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Enhanced debug output