deprecatable 1.0.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/.autotest +9 -0
- data/.gemtest +1 -0
- data/HISTORY.rdoc +4 -0
- data/Manifest.txt +26 -0
- data/README.rdoc +175 -0
- data/Rakefile +33 -0
- data/examples/alert_frequency.rb +101 -0
- data/examples/at_exit.rb +68 -0
- data/examples/caller_context_padding.rb +97 -0
- data/lib/deprecatable.rb +106 -0
- data/lib/deprecatable/alerter.rb +162 -0
- data/lib/deprecatable/call_site.rb +91 -0
- data/lib/deprecatable/call_site_context.rb +112 -0
- data/lib/deprecatable/deprecated_method.rb +210 -0
- data/lib/deprecatable/options.rb +138 -0
- data/lib/deprecatable/registry.rb +55 -0
- data/lib/deprecatable/util.rb +26 -0
- data/test/helpers.rb +18 -0
- data/test/test_deprecatable.rb +149 -0
- data/test/test_deprecatable_alerter.rb +41 -0
- data/test/test_deprecatable_call_site.rb +28 -0
- data/test/test_deprecatable_call_site_context.rb +57 -0
- data/test/test_deprecatable_deprecated_method.rb +61 -0
- data/test/test_deprecatable_options.rb +83 -0
- data/test/test_deprecatable_registry.rb +32 -0
- data/test/test_deprecatable_util.rb +13 -0
- metadata +146 -0
@@ -0,0 +1,13 @@
|
|
1
|
+
require "helpers"
|
2
|
+
|
3
|
+
class TestDeprecatableUtil < MiniTest::Unit::TestCase
|
4
|
+
def i_was_called
|
5
|
+
Deprecatable::Util.location_of_caller
|
6
|
+
end
|
7
|
+
|
8
|
+
def test_location_of_caller
|
9
|
+
file, line = i_was_called
|
10
|
+
assert_equal( File.expand_path(__FILE__), file )
|
11
|
+
assert_equal( 9, line )
|
12
|
+
end
|
13
|
+
end
|
metadata
ADDED
@@ -0,0 +1,146 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: deprecatable
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Jeremy Hinegardner
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2011-08-09 00:00:00.000000000Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: minitest
|
16
|
+
requirement: &2152869700 !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.6'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: *2152869700
|
25
|
+
- !ruby/object:Gem::Dependency
|
26
|
+
name: rcov
|
27
|
+
requirement: &2152869160 !ruby/object:Gem::Requirement
|
28
|
+
none: false
|
29
|
+
requirements:
|
30
|
+
- - ~>
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 0.9.10
|
33
|
+
type: :development
|
34
|
+
prerelease: false
|
35
|
+
version_requirements: *2152869160
|
36
|
+
- !ruby/object:Gem::Dependency
|
37
|
+
name: hoe
|
38
|
+
requirement: &2152868640 !ruby/object:Gem::Requirement
|
39
|
+
none: false
|
40
|
+
requirements:
|
41
|
+
- - ~>
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
version: '2.11'
|
44
|
+
type: :development
|
45
|
+
prerelease: false
|
46
|
+
version_requirements: *2152868640
|
47
|
+
description: ! 'Deprecatable is a library to help you, as a developer, deprecate your
|
48
|
+
API and be
|
49
|
+
|
50
|
+
proactive about helping people who use your library find where they need to
|
51
|
+
|
52
|
+
update.
|
53
|
+
|
54
|
+
|
55
|
+
When using Deprecatable, you mark methods as ''deperecated'' and then the users
|
56
|
+
of
|
57
|
+
|
58
|
+
your API will receive a helpful alert showing the exact line of code where they
|
59
|
+
|
60
|
+
called the deprecated API, and what they need to do to fix it (although you need
|
61
|
+
|
62
|
+
to supply this piece of information).
|
63
|
+
|
64
|
+
|
65
|
+
Users will receive, by default, a single alert for each unique location a
|
66
|
+
|
67
|
+
deprecated API method is invoked. They will also receive a final report
|
68
|
+
|
69
|
+
detailing all the locations where deprecated APIs were invoked.
|
70
|
+
|
71
|
+
|
72
|
+
The "noisiness" of the alerting and the final report is all configurable, via
|
73
|
+
|
74
|
+
both code, and environment variables. See Deprecatable::Options.'
|
75
|
+
email:
|
76
|
+
- jeremy@copiousfreetime.org
|
77
|
+
executables: []
|
78
|
+
extensions: []
|
79
|
+
extra_rdoc_files:
|
80
|
+
- Manifest.txt
|
81
|
+
- README.rdoc
|
82
|
+
- HISTORY.rdoc
|
83
|
+
files:
|
84
|
+
- .autotest
|
85
|
+
- .gemtest
|
86
|
+
- HISTORY.rdoc
|
87
|
+
- Manifest.txt
|
88
|
+
- README.rdoc
|
89
|
+
- Rakefile
|
90
|
+
- examples/alert_frequency.rb
|
91
|
+
- examples/at_exit.rb
|
92
|
+
- examples/caller_context_padding.rb
|
93
|
+
- lib/deprecatable.rb
|
94
|
+
- lib/deprecatable/alerter.rb
|
95
|
+
- lib/deprecatable/call_site.rb
|
96
|
+
- lib/deprecatable/call_site_context.rb
|
97
|
+
- lib/deprecatable/deprecated_method.rb
|
98
|
+
- lib/deprecatable/options.rb
|
99
|
+
- lib/deprecatable/registry.rb
|
100
|
+
- lib/deprecatable/util.rb
|
101
|
+
- test/helpers.rb
|
102
|
+
- test/test_deprecatable.rb
|
103
|
+
- test/test_deprecatable_alerter.rb
|
104
|
+
- test/test_deprecatable_call_site.rb
|
105
|
+
- test/test_deprecatable_call_site_context.rb
|
106
|
+
- test/test_deprecatable_deprecated_method.rb
|
107
|
+
- test/test_deprecatable_options.rb
|
108
|
+
- test/test_deprecatable_registry.rb
|
109
|
+
- test/test_deprecatable_util.rb
|
110
|
+
homepage: http://github.com/copiousfreetime/deprecatable
|
111
|
+
licenses: []
|
112
|
+
post_install_message:
|
113
|
+
rdoc_options:
|
114
|
+
- --main
|
115
|
+
- README.rdoc
|
116
|
+
require_paths:
|
117
|
+
- lib
|
118
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
119
|
+
none: false
|
120
|
+
requirements:
|
121
|
+
- - ! '>='
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '0'
|
124
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
125
|
+
none: false
|
126
|
+
requirements:
|
127
|
+
- - ! '>='
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: '0'
|
130
|
+
requirements: []
|
131
|
+
rubyforge_project: deprecatable
|
132
|
+
rubygems_version: 1.8.5
|
133
|
+
signing_key:
|
134
|
+
specification_version: 3
|
135
|
+
summary: Deprecatable is a library to help you, as a developer, deprecate your API
|
136
|
+
and be proactive about helping people who use your library find where they need
|
137
|
+
to update
|
138
|
+
test_files:
|
139
|
+
- test/test_deprecatable.rb
|
140
|
+
- test/test_deprecatable_alerter.rb
|
141
|
+
- test/test_deprecatable_call_site.rb
|
142
|
+
- test/test_deprecatable_call_site_context.rb
|
143
|
+
- test/test_deprecatable_deprecated_method.rb
|
144
|
+
- test/test_deprecatable_options.rb
|
145
|
+
- test/test_deprecatable_registry.rb
|
146
|
+
- test/test_deprecatable_util.rb
|