caller_with_context 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f75e141846c7fd3c421c26d2c7e9e05d87cc71b8d030846df1944dd51c46d7e
+  data.tar.gz: 499ae81a8626a6c103fc97185d1720f48b24ef25831faed0f6793bf79979af62
+SHA512:
+  metadata.gz: aa7b3b28a75e5a7c2507239b58a0772b8dd2621c134a8791c29c6eb5cd6c7979475c9b93b2f11119298063de1d93a2bbb6141f2f0934e01171cdd274a15a5d94
+  data.tar.gz: dc168e288708f2d9fbff7095b2fc94a6fae31e2d86c60a2909491d9b2758a44db4037d3687ad27f0641b3f6e027ea5521c273ea9ebc3f1076deb28f446d04d08

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeff@jeffroush.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    caller_with_context (0.1.0)
+      colorize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.17)
+  caller_with_context!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jeff Roush
+
+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,72 @@
+# CallerWithContext
+
+Adds lines of context from the source file around each of the lines in a stack trace.
+
+So, this:
+
+```
+/home/jeff/projects/backtrace/caller_with_context/lib/caller_with_context/caller.rb:24:in `show'
+/home/jeff/projects/backtrace/caller_with_context/spec/caller_spec.rb:13:in `block (2 levels) in <module:CallerWithContext>'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example.rb:254:in `instance_exec'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example.rb:254:in `block in run'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example.rb:500:in `block in with_around_and_singleton_context_hooks'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example.rb:457:in `block in with_around_example_hooks'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/hooks.rb:464:in `block in run'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/hooks.rb:602:in `run_around_example_hooks_for'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/hooks.rb:464:in `run'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example.rb:457:in `with_around_example_hooks'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example.rb:500:in `with_around_and_singleton_context_hooks'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example.rb:251:in `run'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example_group.rb:629:in `block in run_examples'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example_group.rb:625:in `map'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example_group.rb:625:in `run_examples'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/example_group.rb:591:in `run'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:116:in `block (3 levels) in run_specs'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:116:in `map'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:116:in `block (2 levels) in run_specs'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/configuration.rb:2008:in `with_suite_hooks'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:111:in `block in run_specs'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/reporter.rb:74:in `report'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:110:in `run_specs'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:87:in `run'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:71:in `run'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/lib/rspec/core/runner.rb:45:in `invoke'
+/home/jeff/.rvm/gems/ruby-2.6.3/gems/rspec-core-3.8.1/exe/rspec:4:in `<top (required)>'
+/home/jeff/.rvm/gems/ruby-2.6.3/bin/rspec:23:in `load'
+/home/jeff/.rvm/gems/ruby-2.6.3/bin/rspec:23:in `<main>'
+/home/jeff/.rvm/gems/ruby-2.6.3/bin/ruby_executable_hooks:24:in `eval'
+/home/jeff/.rvm/gems/ruby-2.6.3/bin/ruby_executable_hooks:24:in `<main>'
+```
+
+becomes this:
+
+```
+/home/jeff/projects/backtrace/caller_with_context/lib/caller_with_context/caller.rb:24:in `show'
+    def show
+      locations.each do |location|
+        format_single_location location
+
+/home/jeff/projects/backtrace/caller_with_context/spec/caller_spec.rb:13:in `block (2 levels) in <module:CallerWithContext>'
+    it 'adds lines of context to each element' do
+      Caller.new(only_cwd: true, lines_of_context: 1).show
+    end
+```
+
+Usage:
+
+```
+CallerWithContext::CallerWithContext::Caller.new.show
+```
+
+## Options
+
+There are three options:
+
+* only_cwd: filter out stack trace lines that don't arise from the current directory tree (default: false)
+* lines_of_context: the number of lines of context above and below (default: 1)
+* colorize: Colorize the stack trace line (default: true)
+
+```
+CallerWithContext::Caller.new(colorize: true, only_cwd: true, lines_of_context: 1).show
+```
+

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "caller_with_context/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "caller_with_context"
+  spec.version       = CallerWithContext::VERSION
+  spec.authors       = ["Jeff Roush"]
+  spec.email         = ["jeff@jeffroush.com"]
+
+  spec.summary       = %q{Pretty-print callstack, including lines of context from the source file around each location.}
+  spec.description   = %q{Pretty-print callstack, including lines of context from the source file around each location.}
+  spec.homepage      = "https://github.com/jeff-r/caller_with_context"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "colorize"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "awesome_print"
+end

data/lib/caller_with_context.rb

@@ -0,0 +1,7 @@
+require "caller_with_context/version"
+require "caller_with_context/location"
+require "caller_with_context/caller"
+
+module CallerWithContext
+  class Error < StandardError; end
+end

data/lib/caller_with_context/caller.rb

@@ -0,0 +1,49 @@
+require 'awesome_print'
+require 'colorize'
+
+module CallerWithContext
+  class Caller
+    attr_reader :options
+
+    def initialize(options={})
+      @options = {
+        colorize: true,
+        only_cwd: false,
+        lines_of_context: 1
+      }.merge(options)
+    end
+
+    def locations
+      return @locations if @locations
+      locations = caller_locations
+      if @options[:only_cwd]
+        locations.select! { |l| l.to_s.include?(Dir.pwd) }
+      end
+      @locations ||= locations.map { |location| Location.new(location, options[:lines_of_context]) }
+    end
+
+    def show
+      locations.each do |location|
+        format_single_location location
+      end
+    end
+
+    def output(string, color)
+      if options[:colorize]
+        puts string.send(color)
+      else
+        puts string
+      end
+    end
+
+    def format_single_location(location)
+      output(location.to_s, :light_blue)
+      if options[:lines_of_context] > 0
+        location.context_lines.each do |line|
+          puts line
+        end
+        puts
+      end
+    end
+  end
+end

data/lib/caller_with_context/location.rb

@@ -0,0 +1,28 @@
+module CallerWithContext
+  class Location
+    attr_reader :caller_location, :lines_of_context
+
+    def initialize(caller_location, lines_of_context=1)
+      @caller_location  = caller_location
+      @lines_of_context = lines_of_context
+    end
+
+    def context_lines
+      line_indexes.each.map {|line_number| lines_in_file[line_number]&.chomp }
+    end
+
+    def line_indexes(lineno=caller_location.lineno-lines_of_context)
+      min = lineno < lines_of_context ? 0 : lineno - lines_of_context
+      max = lineno >= lines_in_file.count ? lines_in_file.count : lineno + lines_of_context
+      min..max
+    end
+
+    def lines_in_file
+      @lines_in_file ||= File.readlines caller_location.absolute_path
+    end
+
+    def to_s
+      caller_location.to_s
+    end
+  end
+end

data/lib/caller_with_context/version.rb

@@ -0,0 +1,3 @@
+module CallerWithContext
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: caller_with_context
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Roush
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pretty-print callstack, including lines of context from the source file
+  around each location.
+email:
+- jeff@jeffroush.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- caller_with_context.gemspec
+- lib/caller_with_context.rb
+- lib/caller_with_context/caller.rb
+- lib/caller_with_context/location.rb
+- lib/caller_with_context/version.rb
+homepage: https://github.com/jeff-r/caller_with_context
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Pretty-print callstack, including lines of context from the source file around
+  each location.
+test_files: []