super_awesome_print 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 34d264ee0c1c98ab9bf51ff823019fb9ae8733a2
-  data.tar.gz: 5df02c87f4e02beff1b81eb707f81e1401d5e338
+SHA256:
+  metadata.gz: 8dcbcd2d03a3005179e357dba79cac9ff235c4ef582aaaeaec9723191f7e6b14
+  data.tar.gz: 410e5466d12988d153b738f05381dbf9e920b7e0b0817bf7ec50997fd928f5cd
 SHA512:
-  metadata.gz: 54874f1aa1b87400a77c7c05131f23bf203b69961d154bfcf189644e478056bbf0b3ce1228db5d353c7c24b2a5023f5b3b2a2bffe6d051ddba40d7c7cbd90877
-  data.tar.gz: 68957448dd7b8b0ea25a45f0cc56e051bbffb58acd17ce627f740a2085fc42a60fdef18aa4487604b03af68fa1940c0b877a824bd9aed1afc0b2a195eaac0d63
+  metadata.gz: 85a06d0fbe8691681ceab0bf43bcfc58c78dfc98122d2e32240c6a805f8eaea0aa93a9c9a4f043e6f525dad18d39452219b68ab2a657c423c1f42e90358bbf65
+  data.tar.gz: '008722bc3e34bb2955a4fb16656067136bcf9967cc9507660bdec2ff068c742cc9b6146fd7f57e226930094ed6cef50fc3f57458251cbfe68e3cfc27d9eed2b6'

data/README.md

@@ -1,8 +1,11 @@
 # SuperAwesomePrint
 
-Add colored '*********', time and line number around printed value. It's easier to find such output in a long console output.
+[![CI](https://github.com/olegantonyan/super_awesome_print/actions/workflows/ci.yml/badge.svg)](https://github.com/olegantonyan/super_awesome_print/actions/workflows/ci.yml)
+
+Prints values with [awesome_print](https://github.com/awesome-print/awesome_print), framed by colored `***` markers, a timestamp and the caller location, so they're easy to spot in long console output.
+
+![screenshot](https://cloud.githubusercontent.com/assets/2301579/12552398/45e9fa4c-c37a-11e5-8113-a9014d153ebb.png)
 
-![alt tag](https://cloud.githubusercontent.com/assets/2301579/12552398/45e9fa4c-c37a-11e5-8113-a9014d153ebb.png)
 ```ruby
 def index
   @posts = Post.all
@@ -18,50 +21,58 @@ Add this line to your application's Gemfile:
 gem 'super_awesome_print'
 ```
 
-And then execute:
+And then run:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install super_awesome_print
 
-You can optionally customize configuration in an initializer.<br/>
-In Rails, you can add the following to `config/initializers/super_awesome_print.rb`:
+Requires Ruby 2.7 or newer.
+
+## Configuration
+
+Optionally, customize it in an initializer. In Rails, add the following to `config/initializers/super_awesome_print.rb`:
 
 ```ruby
 SuperAwesomePrint.configure do |config|
-  config.caller_lines = 3 # defaults to 1
+  config.caller_lines = 3 # number of backtrace lines to print, defaults to 1
   config.blank_lines_top = 2 # defaults to 0
   config.blank_lines_bottom = 2 # defaults to 0
-  config.root_path = Rails.root.to_s # this path will be removed from caller's files path, defaults to Rails.root.to_s
-  config.log_file_path = '/some/path/to/log/file' # override default log file for `sapf`
+  config.root_path = Rails.root.to_s # stripped from caller paths, defaults to Rails.root
+  config.log_file_path = '/some/path/to/log/file' # where `sapf` writes
 end
 ```
 
 ## Usage
 
-Just use `sap` global function to print any variable.
+Call `sap` anywhere to print a value. It returns its argument, so you can wrap an expression without changing it:
 
-You can also print to a file
+```ruby
+total = sap(items.sum(&:price))
+```
+
+To write to a file instead, use `sapf`:
 
 ```ruby
 sapf 'hello world'
 ```
 
-By default it will print everything to `sapf.log` file in current directory or to `log/sapf.log` if you're on Rails. See `log_file_path` config option to override this.
+By default, `sapf` appends to `sapf.log` in the current directory, or to `log/sapf.log` in Rails. Set `log_file_path` to change it.
+
+To keep `sap` from leaking into production, see the [RuboCop cop](https://github.com/olegantonyan/super_awesome_print_rubocop).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies, then `bundle exec rake test` to run the tests. Run `bin/console` for an interactive prompt.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, then run `bundle exec rake release`. This creates a git tag for the version, pushes git commits and tags, and pushes the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/olegantonyan/super_awesome_print. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://www.contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/olegantonyan/super_awesome_print. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/super_awesome_print/configuration.rb

@@ -1,11 +1,19 @@
-class Configuration
-  attr_accessor :caller_lines, :blank_lines_top, :blank_lines_bottom, :root_path, :log_file_path
+module SuperAwesomePrint
+  class Configuration
+    attr_accessor :caller_lines, :blank_lines_top, :blank_lines_bottom, :root_path, :log_file_path
 
-  def initialize
-    @caller_lines = 1
-    @blank_lines_top = 0
-    @blank_lines_bottom = 0
-    @root_path = defined?(Rails) ? Rails.root.to_s : ''
-    @log_file_path = @root_path.empty? ? Dir.pwd + '/sapf.log' : @root_path + '/log/sapf.log'
+    def initialize
+      @caller_lines = 1
+      @blank_lines_top = 0
+      @blank_lines_bottom = 0
+      @root_path = rails_root
+      @log_file_path = @root_path.empty? ? File.join(Dir.pwd, 'sapf.log') : File.join(@root_path, 'log', 'sapf.log')
+    end
+
+    private
+
+    def rails_root
+      defined?(::Rails) && ::Rails.respond_to?(:root) ? ::Rails.root.to_s : ''
+    end
   end
 end

data/lib/super_awesome_print/version.rb

@@ -1,3 +1,3 @@
 module SuperAwesomePrint
-  VERSION = '0.2.5'.freeze
+  VERSION = '0.2.7'.freeze
 end

data/lib/super_awesome_print.rb

@@ -3,33 +3,29 @@ require 'super_awesome_print/configuration'
 require 'awesome_print'
 
 module Kernel
+  private
+
   def sap(msg)
     SuperAwesomePrint.blank_lines_top
-    ap "*** #{Time.now} ***", :color => { :string => :green }
-    ap msg.class if msg.respond_to?(:class)
-    SuperAwesomePrint.print_caller_lines(caller)
+    ap "*** #{Time.now} ***", color: { string: :green }
+    ap msg.class
+    SuperAwesomePrint.trace(caller).each { |line| ap line, color: { string: :purpleish } }
     ap msg
-    ap '*** END ***', :color => { :string => :green }
+    ap '*** END ***', color: { string: :green }
     SuperAwesomePrint.blank_lines_bottom
+    msg
   end
 
   def sapf(msg)
-    file = File.open(SuperAwesomePrint.config.log_file_path , 'a')
-    file.puts("*** #{Time.now} ***")
-    file.puts(" class: #{msg.class}") if msg.respond_to?(:class)
-    lines = caller[0...SuperAwesomePrint.config.caller_lines].map do |line|
-      root_path = SuperAwesomePrint.config.root_path
-      if root_path.empty?
-        line
-      else
-        line.gsub(root_path + '/', '')
-      end
+    trace = SuperAwesomePrint.trace(caller)
+    File.open(SuperAwesomePrint.config.log_file_path, 'a') do |file|
+      file.puts("*** #{Time.now} ***")
+      file.puts(" class: #{msg.class}")
+      trace.each { |line| file.puts(" trace: #{line}") }
+      file.puts(msg.inspect)
+      file.puts('*** END ***')
     end
-    lines.each { |l| file.puts(' trace: ' + l) }
-    file.puts(msg.inspect)
-    file.puts('*** END ***')
-  ensure
-    file.close 
+    msg
   end
 end
 
@@ -38,17 +34,16 @@ module SuperAwesomePrint
     attr_writer :configuration
   end
 
-  def self.print_caller_lines(caller_array)
-    number_of_lines = config.caller_lines
-    lines = caller_array[0...number_of_lines].map do |line|
-      line.gsub(config.root_path + '/', '')
-    end
-    lines.each { |line| ap line, :color => { :string => :purpleish } }
+  def self.trace(backtrace)
+    lines = backtrace.first(config.caller_lines)
+    root = config.root_path.to_s.chomp('/')
+    return lines if root.empty?
+
+    lines.map { |line| line.sub(%r{\A#{Regexp.escape(root)}/}, '') }
   end
 
   def self.blank_lines_top
-    # The first puts has no visible effect
-    # So we want to puts once regardless of config
+    # the first puts has no visible effect, so always print one
     puts
     config.blank_lines_top.times { puts }
   end
@@ -58,7 +53,7 @@ module SuperAwesomePrint
   end
 
   def self.config
-    SuperAwesomePrint.configuration
+    configuration
   end
 
   def self.configuration

metadata

@@ -1,84 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: super_awesome_print
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Oleg Antonyan
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Add colored '*********', time and line number around printed value
+description: Prints values with awesome_print, framed by colored markers, a timestamp
+  and the caller location.
 email:
 - oleg.b.antonyan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/super_awesome_print.rb
 - lib/super_awesome_print/configuration.rb
 - lib/super_awesome_print/version.rb
-- sapf.log
-- super_awesome_print.gemspec
-homepage: http://github.com/olegantonyan/super_awesome_print
+homepage: https://github.com/olegantonyan/super_awesome_print
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -86,16 +75,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Simple wrapper around awesome_print for easier look in long log
+summary: awesome_print wrapper that makes debug output easy to spot in long logs
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in super_awesome_print.gemspec
-gemspec

data/Rakefile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'super_awesome_print'
-
-# 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

data/bin/setup

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

data/sapf.log

@@ -1,5 +0,0 @@
-*** 2017-03-17 18:40:40 +0200 ***
- class: Fixnum
- trace: (irb):1:in `irb_binding'
-1
-*** END ***

data/super_awesome_print.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'super_awesome_print/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'super_awesome_print'
-  spec.version       = SuperAwesomePrint::VERSION
-  spec.authors       = ['Oleg Antonyan']
-  spec.email         = ['oleg.b.antonyan@gmail.com']
-
-  spec.summary       = 'Simple wrapper around awesome_print for easier look in long log'
-  spec.description   = "Add colored '*********', time and line number around printed value"
-  spec.homepage      = 'http://github.com/olegantonyan/super_awesome_print'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-
-  if RUBY_VERSION < '1.9.3'
-    spec.add_runtime_dependency 'awesome_print', '1.2.0'
-  else
-    spec.add_runtime_dependency 'awesome_print'
-  end
-end