debugging 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f540cf321629826fd4539a2460b2b42f91726eec
+  data.tar.gz: 96bade08c3b33fd008c6057f4e0c0abd40c2f133
+SHA512:
+  metadata.gz: 525abd17e17c032113e739150b84f390c98c71b5e7ce4c1f03773aa879ca117d43006150b0a146206011e83e4c9b3a0c21785b847b73daddd2b5d0018ed693b9
+  data.tar.gz: f11f34f6d50cb16bc4be14890fd9ba6aa98bcdc84f92eeb0b916c3e5f713a0c5dbe45c5055f4798d2c4dd0ae4f136c79efdc9bfb70fd9378c6f8791a05e7fcc1

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+- ruby-head
+- 2.1.0
+- 2.0.0
+- 1.9.3
+- 1.9.2
+- jruby
+- jruby-19mode
+- rbx
+
+bundler_args: --without full_support

data/ChangeLog.rdoc

@@ -0,0 +1,17 @@
+=== 1.0.0 / 2014-01-19
+
+* Adjusted concept: Only helper method style
+* Removed:
+  * dd
+  * binding.vars
+* Added:
+  * beep
+  * repl
+* Renamed:
+  * oo -> at
+  * cc -> callstack
+  * mm -> mof
+  * regexp_visualize -> re
+* Method List: Display all available ancestors by default and add third argument for grepping
+* Moved from zucker 13.1 gem into its own gem
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :full_support do
+  gem 'binding_of_caller'
+end
+
+platform :rbx do
+  gem 'rubysl-singleton'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    debugging (1.0.0)
+      binding.repl (~> 0)
+      paint (~> 0, >= 0.8.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    binding.repl (0.9.0)
+      toml (~> 0.0.3)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    blankslate (2.1.2.4)
+    debug_inspector (0.0.2)
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    paint (0.8.7)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubygems-tasks (0.2.4)
+    rubysl-singleton (2.0.0)
+    toml (0.0.4)
+      parslet
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binding_of_caller
+  bundler (~> 1.0)
+  debugging!
+  rake (~> 10.1)
+  rdoc (~> 3.0)
+  rspec (~> 2.4)
+  rubygems-tasks (~> 0.2)
+  rubysl-singleton

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Jan Lelis
+
+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.rdoc

@@ -0,0 +1,102 @@
+= Ruby Print Debugging {<img src="https://travis-ci.org/janlelis/debugging.png" />}[https://travis-ci.org/janlelis/debugging]
+
+
+== Setup
+
+    $ gem install debugging binding_of_caller
+
+
+Or in your Gemfile:
+
+    gem 'debugging'
+    gem 'binding_of_caller'
+
+
+In Ruby:
+
+    require 'debugging/all'
+
+
+== Methods
+
+=== at(label = nil)
+
+    [label] @ method `...', line ... of file ....
+
+
+=== beep
+
+    Lets your terminal bell ring.
+
+
+=== callstack
+
+    <main>
+      start
+        catch
+          block in start
+            eval_input
+              each_top_level_statement
+                catch
+                  block in each_top_level_statement
+                    loop
+                      block (2 levels) in each_top_level_statement
+                        block in eval_input
+                          signal_status
+                            block (2 levels) in eval_input
+                              evaluate
+                                evaluate
+                                  eval
+                                    irb_binding
+
+
+=== mof(obj, depth = nil)
+
+Methods of:
+
+    >> mof [1,2,3]
+    ###
+    Eigenclass
+
+    Array
+    inspect  to_s  to_a  to_h  to_ary  frozen?  ==  eql?  hash  []  []=  at  fetch  first  last  concat  <<  push  pop  shift  unshift  insert  each  each_index  reverse_each  length  size  empty?  find_index  index  rindex  join  reverse  reverse!  rotate  rotate!  sort  sort!  sort_by!  collect  collect!  map  map!  select  select!  keep_if  values_at  delete  delete_at  delete_if  reject  reject!  zip  transpose  replace  clear  fill  include?  <=>  slice  slice!  assoc  rassoc  +  *  -  &  |  uniq  uniq!  compact  compact!  flatten  flatten!  count  shuffle!  shuffle  sample  cycle  permutation  combination  repeated_permutation  repeated_combination  product  take  take_while  drop  drop_while  bsearch  pack
+
+    Enumerable
+    to_a  entries  to_h  sort  sort_by  grep  count  find  detect  find_index  find_all  select  reject  collect  map  flat_map  collect_concat  inject  reduce  partition  group_by  first  all?  any?  one?  none?  min  max  minmax  min_by  max_by  minmax_by  member?  include?  each_with_index  reverse_each  each_entry  each_slice  each_cons  each_with_object  zip  take  take_while  drop  drop_while  cycle  chunk  slice_before  lazy
+
+    Object
+
+    Debugging
+
+    Kernel
+    nil?  ===  =~  !~  eql?  hash  <=>  class  singleton_class  clone  dup  taint  tainted?  untaint  untrust  untrusted?  trust  freeze  frozen?  to_s  inspect  methods  singleton_methods  protected_methods  private_methods  public_methods  instance_variables  instance_variable_get  instance_variable_set  instance_variable_defined?  remove_instance_variable  instance_of?  kind_of?  is_a?  tap  send  public_send  respond_to?  extend  display  method  public_method  singleton_method  define_singleton_method  object_id  to_enum  enum_for
+
+    BasicObject
+    ==  equal?  !  !=  instance_eval  instance_exec  __send__  __id__
+
+
+=== q(*args)
+
+    q :is_like, ?p, "but on one line"
+
+
+=== re(string, regex, groups = nil)
+
+An utility to assist you matching regexes againts strings. Try this one:
+
+    >> re "mail@janlelis.de", /\b([A-Z0-9._%+-]+)@([A-Z0-9.-]+\.[A-Z]{2,10})\b/i, 0..2
+
+
+=== repl
+
+    Starts your favorite IRB session.
+
+
+== Also See
+
+https://github.com/davejacobs/letters
+
+
+== J-_-L
+
+Copyright (c) 2010-2014 Jan Lelis. MIT License. Originated from the zucker gem.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title = "ruby_version"
+end
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/debugging.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/debugging/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "debugging"
+  gem.version       = Debugging::VERSION
+  gem.summary       = 'Print debugging helpers.'
+  gem.description   = 'Provides useful print debugging helpers.'
+  gem.license       = "MIT"
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = "mail@janlelis.de"
+  gem.homepage      = "https://github.com/janlelis/debugging"
+
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'paint', '~> 0', '>= 0.8.7'
+  gem.add_dependency 'binding.repl', '~> 0'
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 10.1'
+  gem.add_development_dependency 'rdoc', '~> 3.0'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/lib/debugging/all.rb

@@ -0,0 +1,9 @@
+%w[
+  at
+  beep
+  callstack
+  mof
+  q
+  re
+  repl
+].each{ |m| require_relative(m) }

data/lib/debugging/at.rb

@@ -0,0 +1,12 @@
+require 'debugging'
+
+module Debugging
+  private
+
+  def at(label = nil)
+    caller[0].rindex( /:(\d+)(:in (`.*'))?$/ )
+    puts "#{ label && Paint["#{label} ", :yellow] }@"\
+         " #{ $3 && "method #{ Paint[$3, :red] }, " }line "\
+         "#{ Paint[$1, :blue]} of file #{ Paint[$`, :green]}"
+  end
+end

data/lib/debugging/beep.rb

@@ -0,0 +1,9 @@
+require 'debugging'
+
+module Debugging
+  private
+
+  def beep
+    $stdout.print "\a"
+  end
+end

data/lib/debugging/callstack.rb

@@ -0,0 +1,16 @@
+require 'debugging'
+
+module Debugging
+  private
+
+  def callstack
+    caller.reverse.map{ |m|
+      m.rindex( /:\d+(:in `(.*)')?$/ )
+      $2
+    }.compact.each.with_index{ |m, i|
+      puts "  "*i + m
+    }
+
+    nil
+  end
+end

data/lib/debugging/mof.rb

@@ -0,0 +1,35 @@
+require 'debugging'
+
+module Debugging
+  private
+
+  def mof(obj, depth = nil, grep_for = //)
+    grep_for = Regexp.new(grep_for)
+    puts Paint["###", :red, :bold]
+
+    eigen_methods = obj.singleton_methods.grep(grep_for)
+    if eigen_methods.empty?
+      puts Paint['Eigenclass', :yellow]
+    else
+      puts Paint['Eigenclass', :green, :underline], eigen_methods.map(&:to_s)*'  '
+    end
+    puts
+
+    if obj.is_a? Module
+      klass, method_function = obj, :public_methods
+    else
+      klass, method_function = obj.class, :public_instance_methods
+    end
+
+    (depth || klass.ancestors.size).times{ |level|
+      if cur = klass.ancestors[level]
+        level_methods = cur.send(method_function, false).grep(grep_for)
+        colors = level_methods.empty? ? [:yellow] : [:green, :underline]
+        puts Paint["#{cur}", *colors], level_methods.map(&:to_s)*'  '
+        puts unless level_methods.empty?
+      end
+    }
+
+    nil
+  end
+end

data/lib/debugging/q.rb

@@ -0,0 +1,9 @@
+require 'debugging'
+
+module Debugging
+  private
+
+  def q(*args)
+    puts args.map{ |e| Paint[e.inspect, :random] }*'  ' unless args.empty?
+  end
+end

data/lib/debugging/re.rb

@@ -0,0 +1,29 @@
+require 'debugging'
+
+module Debugging
+  private
+
+  def re(string, regex, groups = nil)
+    if regex =~ string
+      if !groups
+        puts $` + Paint[$&, :green] + $'
+      else
+        Array( groups ).each{ |group_nr|
+          begin
+            raise IndexError unless $~[group_nr]
+            gr_string = string.dup
+            gr_string[ $~.end( group_nr ),   0 ] = Paint::NOTHING
+            gr_string[ $~.begin( group_nr ), 0 ] = Paint.color(:green)
+            puts group_nr.to_s + ': ' + gr_string
+          rescue IndexError
+            puts group_nr.to_s + ': ' + Paint['no match', :red]
+          end
+        }
+      end
+    else
+      puts Paint['no match', :red]
+    end
+
+    nil
+  end
+end

data/lib/debugging/repl.rb

@@ -0,0 +1,16 @@
+require 'debugging'
+require 'binding.repl'
+
+begin
+  require 'binding_of_caller'
+rescue LoadError
+  warn 'Using Debugging#repl requires the "binding_of_caller" gem. Please install it or add it to your Gemfile!'
+end
+
+module Debugging
+  private
+
+  def repl
+    binding.of_caller(1).repl.auto
+  end
+end

data/lib/debugging/version.rb

@@ -0,0 +1,3 @@
+module Debugging
+  VERSION = "1.0.0"
+end

data/lib/debugging.rb

@@ -0,0 +1,4 @@
+require_relative 'debugging/version'
+require 'paint'
+
+Object.send :include, Debugging

data/spec/q_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'debugging/q'
+
+describe 'q' do
+  it 'should output the same as p for a single arg' do
+    Paint.unpaint(capture_stdout{q /some object/}).should ==
+    capture_stdout{p /some object/}
+  end
+
+  it "should output the same as p but for multiple args one one line, values separated by two spaces" do
+    Paint.unpaint(capture_stdout do
+      q 1, "1", 2..5, [], {:hallo => :du}, nil, true
+    end).chop.should ==
+    capture_stdout do
+      p 1, "1", 2..5, [], {:hallo => :du}, nil, true
+    end.chop.gsub( "\n", '  ' )
+  end
+end
+

data/spec/re_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'debugging/re'
+
+describe 're' do
+  let :regex do /\b([A-Z0-9._%+-]+)@([A-Z0-9.-]+\.[A-Z]{2,4})\b/i end # r from regular-expressions.info/email.html
+
+  it 'should display a string where mark the found regex in green' do
+    capture_stdout do
+      re 'I do not contain an email address.', regex
+    end.chomp.should == Paint.color(:red) + 'no match' + Paint::NOTHING
+  end
+
+  it 'should display "no match" if the regex could not be matched' do
+    capture_stdout do
+      re 'I contain an email address: mail@example.com', regex
+    end.chomp.should == 'I contain an email address: ' + Paint.color(:green) + 'mail@example.com' + Paint::NOTHING + ''
+  end
+
+  it 'should display a string and mark the found regex group in green if group identifier is given as arg2' do
+    capture_stdout do
+      re 'mail@example.com', regex, 1
+    end.chomp.should == '1: ' + Paint.color(:green) + 'mail' + Paint::NOTHING + '@example.com'
+  end
+
+  it 'should display "group identifier: no match" if the arg2 group could not be matched' do
+    capture_stdout do
+      re 'mail@example.com', regex, 3
+    end.chomp.should == '3: ' + Paint.color(:red) + 'no match' + Paint::NOTHING
+  end
+
+  it 'should also take an array of group identfiers as arg2' do
+    capture_stdout do
+      re 'mail@example.com', regex, [0,1,2]
+    end.chomp.should == '0: ' + Paint.color(:green) + 'mail@example.com' + Paint::NOTHING + "\n" +
+                        '1: ' + Paint.color(:green) + 'mail' + Paint::NOTHING + '@example.com' + "\n" +
+                        '2: mail@' + Paint.color(:green) + 'example.com' + Paint::NOTHING
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rspec'
+require 'stringio'
+
+def capture_stdout
+  capture = StringIO.new
+  restore, $stdout = $stdout, capture
+  yield
+  $stdout = restore
+  capture.string
+end
+
+def capture_stderr
+  capture = StringIO.new
+  restore, $stderr = $stderr, capture
+  yield
+  $stderr = restore
+  capture.string
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: debugging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: binding.repl
+  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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Provides useful print debugging helpers.
+email: mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ChangeLog.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- debugging.gemspec
+- lib/debugging.rb
+- lib/debugging/all.rb
+- lib/debugging/at.rb
+- lib/debugging/beep.rb
+- lib/debugging/callstack.rb
+- lib/debugging/mof.rb
+- lib/debugging/q.rb
+- lib/debugging/re.rb
+- lib/debugging/repl.rb
+- lib/debugging/version.rb
+- spec/q_spec.rb
+- spec/re_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/janlelis/debugging
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Print debugging helpers.
+test_files:
+- spec/q_spec.rb
+- spec/re_spec.rb
+- spec/spec_helper.rb