betterp 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58eaa19df226afd2a1c13607d5f0bd2922ba5dbf
-  data.tar.gz: 11ea87d1d868e5a57290b287213a80af3de9e534
+SHA256:
+  metadata.gz: 14eca65c37298f3f7f28bd0ea317eb12fcc739db2e7502a0487addeef5997c90
+  data.tar.gz: b6fc5f08ca75600e220cc153593ca0b1bdec8a239e7af9266d4301792ba46484
 SHA512:
-  metadata.gz: 9733a777982e76a05dc0eb54a02da495717709afaa0ff2fec42e6232ea9075e94554ea88afa178e3a800c71818bb6ac8a27fb77c11c43a6c27167f8bec42ce88
-  data.tar.gz: 5ef71acdfcc923dc64ede41d117b1bc91c477210396556122aa0b098b593d41d765e806572279b63fe9c5ad127960f21a8b62b6b25db79031a207984beafd0d4
+  metadata.gz: 782f0b93d39771daaa86e13b8655a13aa1ac41c349bef5e04a0e93015ff65475a2561bdf8beda5b03b314804591b8fb75a60b7a1a942940f9aaefaffdcf22431
+  data.tar.gz: 509b64a135cc221547a497c1e6f94edf0d5cceb2a9528c0b117b95c482de535a0861b4573211ec475518d2cf4353d07e178829561c5e7cd0707c2c981e2a60e8

data/.gitignore

@@ -8,7 +8,7 @@
 
 Gemfile.lock
 
-# rspec failure tracking
+.ruby-version
 .rspec_status
 .byebug_history
 *.swp

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

@@ -1,11 +1,5 @@
 # betterp
 
-```
-If we can find the light
-We'll find the light, come on
-                 --Nickelback
-```
-
 ## Overview
 
 _betterp_ emulates  _Ruby_'s default `p` with a few extra goodies.
@@ -22,7 +16,7 @@ The original semantics of `Kernel#p` are still applied, i.e. it returns the valu
 Add the gem to your `Gemfile`
 
 ```ruby
-gem 'strong_versions', '~> 0.3.0'
+gem 'betterp', '~> 0.1.6'
 ```
 
 And rebuild your bundle:
@@ -31,9 +25,9 @@ And rebuild your bundle:
 $ bundle install
 ```
 
-Or install yourself:
+Or install standalone:
 ```bash
-$ gem install strong_versions -v '0.3.0'
+$ gem install betterp -v '0.1.6'
 ```
 
 ## Usage

data/betterp.gemspec

@@ -6,6 +6,7 @@ require 'betterp/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'betterp'
+  spec.licenses      = ['MIT']
   spec.version       = Betterp::VERSION
   spec.authors       = ['Bob Farrell']
   spec.email         = ['bob@homeflow.co.uk']
@@ -29,5 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   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 'rubocop', '~> 0.77.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/doc/testp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'betterp'
 
 class MyCustomClass
@@ -6,8 +8,8 @@ end
 p 'hello'
 p 'hi'
 p 'debug output'
-p *%w[hello bob how are you]
-p({ i: 'am', a: 'hash' })
+p 'hello', 'bob', 'how', 'are', 'you'
+p(i: 'am', a: 'hash')
 p MyCustomClass.new
 p 'hello again'
 p 'etc.'

data/lib/betterp.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'digest'
+require 'pathname'
+require 'pp'
+require 'stringio'
 
 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]
+      (@pretty ? args : args.map(&:inspect)).map do |arg|
+        style = %i[yellow]
+        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, :cyan],
+        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,24 +71,21 @@ 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, color, effect],
+        path: [@source.path],
+        line_no: [@source.line_no],
+        method_name: [@source.method_name],
 
-        method_pointer: [' => ', :default, :reset, :bright],
-        separator: [':', :default, :reset],
-        terminator: [' :: ', :default, :reset]
+        method_pointer: [' => ', :reset, :bright],
+        separator: [':', :reset],
+        terminator: [' :: ', :reset]
       }
     end
 

data/lib/betterp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Betterp
-  VERSION = '0.1.1'
+  VERSION = '0.1.6'
 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.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -86,14 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.77.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
@@ -119,7 +137,8 @@ files:
 - lib/betterp/version.rb
 - lib/kernel.rb
 homepage: https://github.com/bobf/betterp
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -136,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Enhanced debug output