betterp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55c8d01c5d2b646fe695c25f21fcbf3087256693
-  data.tar.gz: c41bbb1ac04217b8deb4012d928ef54fb0d19e1c
+  metadata.gz: 58eaa19df226afd2a1c13607d5f0bd2922ba5dbf
+  data.tar.gz: 11ea87d1d868e5a57290b287213a80af3de9e534
 SHA512:
-  metadata.gz: fded6c3023ff132759b372eefc9627e148625fb1276c044ed425ebfc026869dd9d69ffc3a08402ae51200cbb1e76971e488a4e7ca9ee314351f0ffa2ad776929
-  data.tar.gz: d6d04561089b7d778b8e31d8638b71372352f4636357a81d17cf0a3413718dc95a0ccfa5688f690b6a4b9bcdf2e8b50ec7a04f10966e64df0f231c722d1afb3a
+  metadata.gz: 9733a777982e76a05dc0eb54a02da495717709afaa0ff2fec42e6232ea9075e94554ea88afa178e3a800c71818bb6ac8a27fb77c11c43a6c27167f8bec42ce88
+  data.tar.gz: 5ef71acdfcc923dc64ede41d117b1bc91c477210396556122aa0b098b593d41d765e806572279b63fe9c5ad127960f21a8b62b6b25db79031a207984beafd0d4

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/
@@ -14,3 +13,4 @@ Gemfile.lock
 .byebug_history
 *.swp
 *.swo
+betterp-*.gem

data/Makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+test:
+	bundle exec rspec
+	bundle exec rubocop

data/README.md

@@ -1,5 +1,11 @@
 # 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.
@@ -35,6 +41,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

@@ -28,5 +28,6 @@ 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 'rspec-its', '~> 1.2'
   spec.add_development_dependency 'rubocop', '~> 0.60.0'
 end

data/doc/testp.rb

@@ -0,0 +1,19 @@
+require 'betterp'
+
+class MyCustomClass
+end
+
+p 'hello'
+p 'hi'
+p 'debug output'
+p *%w[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

@@ -6,7 +6,11 @@ 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,62 @@
+# 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)
+      @raw = raw
       @source = source
+      @color = color
+      @effect = effect
     end
 
     def format(args)
       args.map do |arg|
-        colorize("#{@source}: ") + arg.inspect
+        colorize(prefix) + Paint[arg.inspect, :default, :bright]
       end
     end
 
     private
 
+    def prefix
+      # rubocop:disable Style/FormatStringToken
+      [
+        '%{path}',
+        '%{separator}',
+        '%{line_no}',
+        '%{method_pointer}',
+        '%{method_name}',
+        '%{terminator}'
+      ].join
+      # rubocop:enable Style/FormatStringToken
+    end
+
     def colorize(string)
-      Paint[string, color, effect]
+      # rubocop:disable Style/FormatString
+      Paint % [string, color, mapping]
+      # rubocop:enable Style/FormatString
+    end
+
+    def mapping
+      {
+        path: [@source.path, color, :underline, effect],
+        line_no: [@source.line_no, :underline, color, effect],
+        method_name: [@source.method_name, color, effect],
+
+        method_pointer: [' => ', :default, :reset, :bright],
+        separator: [':', :default, :reset],
+        terminator: [' :: ', :default, :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.1'
 end

data/lib/kernel.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 module Kernel
   def p(*args)
-    Betterp::Output.new(caller(1..1).first).format(args).each do |output|
+    raw = caller(1..1).first
+    source = Betterp::Source.new(raw, Dir.pwd)
+
+    Betterp::Output.new(raw, source).format(args).each do |output|
       STDOUT.write(output + "\n")
     end
+
     args.size > 1 ? args : args.first
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: betterp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bob Farrell
@@ -66,6 +66,20 @@ 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
@@ -91,13 +105,17 @@ files:
 - ".rspec"
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - betterp.gemspec
 - bin/console
 - bin/setup
+- 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