betterp 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in betterp.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 Robert Farrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# betterp
+
+## Overview
+
+_betterp_ emulates  _Ruby_'s default `p` with a few extra goodies.
+
+The standard `Kernel#p` method is overwritten with a version that provides the following features:
+
+* All output is prefixed with the file and line number that made the call to `p`
+* The output prefix is colourised. The colour is selected using a hash of the file path and line number so the colours are stable between each run.
+
+The original semantics of `Kernel#p` are still applied, i.e. it returns the value(s) passed to it and the result of `#inspect` on each argument is output to a separate line.
+
+## Installation
+
+Add the gem to your `Gemfile`
+
+```ruby
+gem 'strong_versions', '~> 0.3.0'
+```
+
+And rebuild your bundle:
+
+```bash
+$ bundle install
+```
+
+Or install yourself:
+```bash
+$ gem install strong_versions -v '0.3.0'
+```
+
+## Usage
+
+Call `p` from anywhere in your code just as you normally would:
+
+```ruby
+p 'hello'
+```
+
+![betterp](doc/images/screenshot.png)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bobf/betterp
+
+## License
+
+[MIT License](LICENSE)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/betterp.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'betterp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'betterp'
+  spec.version       = Betterp::VERSION
+  spec.authors       = ['Bob Farrell']
+  spec.email         = ['bob@homeflow.co.uk']
+
+  spec.summary       = 'Enhanced debug output'
+  spec.description   = 'Replaces Kernel#p with a fancier version'
+  spec.homepage      = 'https://github.com/bobf/betterp'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'paint', '~> 2.0'
+
+  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'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'betterp'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/betterp.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+require 'paint'
+
+require 'kernel'
+require 'betterp/output'
+require 'betterp/version'
+
+module Betterp
+end

data/lib/betterp/output.rb

@@ -0,0 +1,42 @@
+module Betterp
+  class Output
+    COLORS = %i[
+      red
+      green
+      yellow
+      blue
+      magenta
+      cyan
+    ].freeze
+
+    EFFECTS = [:bright, nil].freeze
+
+    def initialize(source)
+      @source = source
+    end
+
+    def format(args)
+      args.map do |arg|
+        colorize("#{@source}: ") + arg.inspect
+      end
+    end
+
+    private
+
+    def colorize(string)
+      Paint[string, color, effect]
+    end
+
+    def color
+      COLORS[hash(@source).hex % COLORS.size]
+    end
+
+    def effect
+      EFFECTS[hash(hash(@source)).hex % EFFECTS.size]
+    end
+
+    def hash(input)
+      Digest::MD5.hexdigest(input)
+    end
+  end
+end

data/lib/betterp/version.rb

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

data/lib/kernel.rb

@@ -0,0 +1,8 @@
+module Kernel
+  def p(*args)
+    Betterp::Output.new(caller(1..1).first).format(args).each do |output|
+      STDOUT.write(output + "\n")
+    end
+    args.size > 1 ? args : args.first
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: betterp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+description: Replaces Kernel#p with a fancier version
+email:
+- bob@homeflow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- betterp.gemspec
+- bin/console
+- bin/setup
+- lib/betterp.rb
+- lib/betterp/output.rb
+- lib/betterp/version.rb
+- lib/kernel.rb
+homepage: https://github.com/bobf/betterp
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.2
+signing_key: 
+specification_version: 4
+summary: Enhanced debug output
+test_files: []