debug_print 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +54 -0
- data/Rakefile +1 -0
- data/debug_print.gemspec +24 -0
- data/lib/debug_print.rb +52 -0
- data/lib/debug_print/version.rb +3 -0
- metadata +104 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Eric Beland
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,54 @@
|
|
1
|
+
# DebugPrint
|
2
|
+
|
3
|
+
TODO: Write a gem description
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'debug_print'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install debug_print
|
18
|
+
|
19
|
+
|
20
|
+
## Optional Configuration
|
21
|
+
|
22
|
+
To configure output method (default is puts):
|
23
|
+
|
24
|
+
DebugPrint.debug_output do |output|
|
25
|
+
::Rails.logger.debug output
|
26
|
+
end
|
27
|
+
|
28
|
+
## Usage
|
29
|
+
|
30
|
+
@foo = 'bar'
|
31
|
+
|
32
|
+
# If you want to log what @foo is
|
33
|
+
d :@foo
|
34
|
+
|
35
|
+
Log output ->
|
36
|
+
|
37
|
+
<String> @foo = 'bar'
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
NOTE:
|
42
|
+
|
43
|
+
Because this uses binding_of_caller, it should only be used in development
|
44
|
+
|
45
|
+
|
46
|
+
TODO: Write usage instructions here
|
47
|
+
|
48
|
+
## Contributing
|
49
|
+
|
50
|
+
1. Fork it
|
51
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
52
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
53
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
54
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/debug_print.gemspec
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'debug_print/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "debug_print"
|
8
|
+
spec.version = DebugPrint::VERSION
|
9
|
+
spec.authors = ["Eric Beland"]
|
10
|
+
spec.email = ["ebeland@gmail.com"]
|
11
|
+
spec.description = %q{A simple gem to provide a method named d, to log a string expression's value in development}
|
12
|
+
spec.summary = %q{Provides method named d, to log a string expression and its value in development}
|
13
|
+
spec.homepage = "http://github.com/ericbeland/debug_print"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
spec.add_development_dependency "binding_of_caller"
|
24
|
+
end
|
data/lib/debug_print.rb
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
require "debug_print/version"
|
2
|
+
|
3
|
+
# A module to add the helper debug method d to Kernel.
|
4
|
+
|
5
|
+
# to configure output:
|
6
|
+
# DebugPrint.debug_output do |output|
|
7
|
+
# ::Rails.logger.debug output
|
8
|
+
# end
|
9
|
+
|
10
|
+
# because this uses binding_of_caller, it should only be used in development
|
11
|
+
|
12
|
+
module DebugPrint
|
13
|
+
|
14
|
+
@@debug_output_block = nil
|
15
|
+
|
16
|
+
# Set a block to be used for debug output. Call the Rails logger, write to a DB, etc.
|
17
|
+
# debug_output do |output|
|
18
|
+
# ::Rails.logger.debug output
|
19
|
+
# end
|
20
|
+
def self.debug_output(&debug_output_block)
|
21
|
+
@@debug_output_block = debug_output_block
|
22
|
+
end
|
23
|
+
|
24
|
+
# Output a result via the debug_output configuration, or
|
25
|
+
def self.out(value)
|
26
|
+
if @@debug_output_block
|
27
|
+
@@debug_output_block.call value
|
28
|
+
else
|
29
|
+
puts value
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
private
|
34
|
+
# Takes an expression (variable, etc.) and evaluates it in the binding of the caller.
|
35
|
+
# Then it does a debug printing the variable name, and value
|
36
|
+
def d(expression)
|
37
|
+
result = binding.of_caller(1).eval(expression.to_s)
|
38
|
+
inspection = result.inspect
|
39
|
+
if result.inspect.length < 50
|
40
|
+
sout = "\t<#{result.class.name}> #{expression} = #{inspection}"
|
41
|
+
else
|
42
|
+
sout = "\n<#{result.class.name}> #{expression} =\n"
|
43
|
+
sout += inspection + "\n\n"
|
44
|
+
end
|
45
|
+
DebugPrint.out(sout)
|
46
|
+
end
|
47
|
+
|
48
|
+
end
|
49
|
+
|
50
|
+
class Object
|
51
|
+
include DebugPrint
|
52
|
+
end
|
metadata
ADDED
@@ -0,0 +1,104 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: debug_print
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Eric Beland
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-08-14 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.3'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.3'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rake
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: binding_of_caller
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
description: A simple gem to provide a method named d, to log a string expression's
|
63
|
+
value in development
|
64
|
+
email:
|
65
|
+
- ebeland@gmail.com
|
66
|
+
executables: []
|
67
|
+
extensions: []
|
68
|
+
extra_rdoc_files: []
|
69
|
+
files:
|
70
|
+
- .gitignore
|
71
|
+
- Gemfile
|
72
|
+
- LICENSE.txt
|
73
|
+
- README.md
|
74
|
+
- Rakefile
|
75
|
+
- debug_print.gemspec
|
76
|
+
- lib/debug_print.rb
|
77
|
+
- lib/debug_print/version.rb
|
78
|
+
homepage: http://github.com/ericbeland/debug_print
|
79
|
+
licenses:
|
80
|
+
- MIT
|
81
|
+
post_install_message:
|
82
|
+
rdoc_options: []
|
83
|
+
require_paths:
|
84
|
+
- lib
|
85
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
86
|
+
none: false
|
87
|
+
requirements:
|
88
|
+
- - ! '>='
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
92
|
+
none: false
|
93
|
+
requirements:
|
94
|
+
- - ! '>='
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
requirements: []
|
98
|
+
rubyforge_project:
|
99
|
+
rubygems_version: 1.8.25
|
100
|
+
signing_key:
|
101
|
+
specification_version: 3
|
102
|
+
summary: Provides method named d, to log a string expression and its value in development
|
103
|
+
test_files: []
|
104
|
+
has_rdoc:
|