betterp 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 55c8d01c5d2b646fe695c25f21fcbf3087256693
-  data.tar.gz: c41bbb1ac04217b8deb4012d928ef54fb0d19e1c
+SHA256:
+  metadata.gz: e5abc15316aa50a89ef3f7da15d2a6a48d27ec84ab57b82633a9cd1d67e644e2
+  data.tar.gz: ca846c0f3140aa40a562ad21b9679de04425e9d33cb6e6ee1258529555bfc60a
 SHA512:
-  metadata.gz: fded6c3023ff132759b372eefc9627e148625fb1276c044ed425ebfc026869dd9d69ffc3a08402ae51200cbb1e76971e488a4e7ca9ee314351f0ffa2ad776929
-  data.tar.gz: d6d04561089b7d778b8e31d8638b71372352f4636357a81d17cf0a3413718dc95a0ccfa5688f690b6a4b9bcdf2e8b50ec7a04f10966e64df0f231c722d1afb3a
+  metadata.gz: e1bc1be485f36644cd93c2f180a1ba494f676cb89886abadaafdbfc0174f3e55629274d9e4c20b43745e9a10ca060f8b5a6573754526b37da0f417f64ee464f9
+  data.tar.gz: 0af13aa85b55f786590fdb57ca8dad23941669c8ca4c20045f35f1f7d0b9c71adbb9ae8c393b0e1a0f0f34b8f19436fa580ee24331263274393d968e7774521c

data/.gitignore

@@ -2,15 +2,15 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/
 
 Gemfile.lock
 
-# rspec failure tracking
+.ruby-version
 .rspec_status
 .byebug_history
 *.swp
 *.swo
+betterp-*.gem

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

@@ -0,0 +1,5 @@
+.PHONY: test
+test:
+	bin/rspec
+	bin/rubocop
+	bin/strong_versions

data/README.md

@@ -16,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.5'
 ```
 
 And rebuild your bundle:
@@ -25,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.5'
 ```
 
 ## Usage
@@ -35,6 +35,8 @@ $ gem install strong_versions -v '0.3.0'
 Call `p` from anywhere in your code just as you normally would:
 
 ```ruby
+require 'betterp'
+
 p 'hello'
 ```
 

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']
@@ -28,5 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.60.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'betterp'
+
+class MyCustomClass
+end
+
+p 'hello'
+p 'hi'
+p 'debug output'
+p 'hello', 'bob', 'how', 'are', 'you'
+p(i: 'am', a: 'hash')
+p MyCustomClass.new
+p 'hello again'
+p 'etc.'
+
+def foo
+  p 'hi from a method'
+end
+
+foo

data/lib/betterp.rb

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
 require 'digest'
+require 'pathname'
+require 'pp'
+require 'stringio'
 
 require 'paint'
 
 require 'kernel'
 require 'betterp/output'
+require 'betterp/source'
 require 'betterp/version'
 
 module Betterp
+  def self.root
+    Pathname.new(File.dirname(__dir__))
+  end
 end

data/lib/betterp/output.rb

@@ -1,38 +1,100 @@
+# frozen_string_literal: true
+
 module Betterp
   class Output
-    COLORS = %i[
-      red
-      green
-      yellow
-      blue
-      magenta
-      cyan
-    ].freeze
-
+    COLORS = %i[red green yellow blue magenta cyan].freeze
     EFFECTS = [:bright, nil].freeze
 
-    def initialize(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("#{@source}: ") + arg.inspect
+      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
+      [
+        '%{path}',
+        '%{separator}',
+        '%{line_no}',
+        '%{method_pointer}',
+        '%{method_name}',
+        '%{terminator}'
+      ].join
+    end
+
     def colorize(string)
-      Paint[string, color, effect]
+      Paint % [string, :default, mapping]
+    end
+
+    def mapping
+      {
+        path: [@source.path],
+        line_no: [@source.line_no],
+        method_name: [@source.method_name],
+
+        method_pointer: [' => ', :reset, :bright],
+        separator: [':', :reset],
+        terminator: [' :: ', :reset]
+      }
     end
 
     def color
-      COLORS[hash(@source).hex % COLORS.size]
+      COLORS[hash(@raw).hex % COLORS.size]
     end
 
     def effect
-      EFFECTS[hash(hash(@source)).hex % EFFECTS.size]
+      EFFECTS[hash(hash(@raw)).hex % EFFECTS.size]
     end
 
     def hash(input)

data/lib/betterp/source.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Betterp
+  class Source
+    def initialize(source, base_path)
+      @source = source
+      @base_path = base_path
+      @path, @line_no, @method_info = source.split(':')
+    end
+
+    def path
+      Pathname.new(@path).relative_path_from(Pathname.new(@base_path)).to_s
+    rescue ArgumentError
+      @path
+    end
+
+    def line_no
+      @line_no.to_i
+    end
+
+    def method_name
+      @method_info.partition('`').last.chomp("'")
+    end
+  end
+end

data/lib/betterp/version.rb

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

data/lib/kernel.rb

@@ -1,8 +1,24 @@
+# frozen_string_literal: true
+
 module Kernel
   def p(*args)
-    Betterp::Output.new(caller(1..1).first).format(args).each do |output|
-      STDOUT.write(output + "\n")
+    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, pretty: pretty).format(args).each do |str|
+      STDOUT.write(str + "\n")
     end
+
     args.size > 1 ? args : args.first
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -66,20 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     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.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.60.0
+        version: 0.3.2
 description: Replaces Kernel#p with a fancier version
 email:
 - bob@homeflow.co.uk
@@ -89,19 +117,28 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - betterp.gemspec
 - bin/console
+- bin/rspec
+- bin/rubocop
 - bin/setup
+- bin/strong_versions
+- doc/images/screenshot.png
+- doc/testp.rb
 - lib/betterp.rb
 - lib/betterp/output.rb
+- lib/betterp/source.rb
 - lib/betterp/version.rb
 - lib/kernel.rb
 homepage: https://github.com/bobf/betterp
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -118,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