pry-docmore 0.0.1 → 0.0.2

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.
Files changed (9) hide show
  1. data/lib/pry-docmore.rb +5 -4
  2. data/pry-docmore.wiki/Ruby Global $LOADED_FEATURES (DollarLOADEDUnderscoreFEATURES).md +1 -1
  3. data/pry-docmore.wiki/Ruby Global $SAFE (DollarSAFE).md +1 -1
  4. data/pry-docmore.wiki/Ruby Global $_ (DollarUnderscore).md +1 -1
  5. data/pry-docmore.wiki/Ruby Keyword: alias.md +10 -7
  6. data/pry-docmore.wiki/Ruby Keyword: and.md +10 -4
  7. data/pry-docmore.wiki/Ruby Keyword: case.md +2 -0
  8. data/pry-docmore.wiki/Ruby Keyword: or.md +7 -3
  9. metadata +88 -87
data/lib/pry-docmore.rb CHANGED
@@ -26,8 +26,10 @@ class Pry
26
26
  def self.raw; @DOCS end
27
27
  def self.explain thing
28
28
  @DOCS.each do |label, docs|
29
- # TODO: colored label
30
- return docs[:explanations][thing] if docs[:explanations].has_key? thing
29
+ # TODO: URL for each
30
+ if explanation = docs[:explanations][thing]
31
+ return Pry::Helpers::Text.yellow(thing) + $/ + explanation
32
+ end
31
33
  end
32
34
  nil
33
35
  end
@@ -41,7 +43,6 @@ class Pry
41
43
  def process arg_string
42
44
  if docmore = Pry::Docmore.explain(arg_string)
43
45
  _pry_.output.puts docmore
44
- $/
45
46
  else
46
47
  ORIGINAL_SHOW_DOC.new(context).call_safely(arg_string)
47
48
  end
@@ -53,7 +54,7 @@ class Pry
53
54
  Pry::Docmore.raw.each do |label, docs|
54
55
  # Pry needs a general mechanism to columnize things, and when it gets
55
56
  # one, this can use it:
56
- _pry_.output.puts "#{label}s".yellow + ': ' +
57
+ _pry_.output.puts Pry::Helpers::Text.yellow("#{label}s") + ': ' +
57
58
  docs[:explanations].keys.join(' ')
58
59
  end
59
60
  end
data/pry-docmore.wiki/Ruby Global $LOADED_FEATURES (DollarLOADEDUnderscoreFEATURES).md CHANGED
@@ -1 +1 @@
1
- The $LOADED_FEATURES global ...pry-docmore TODO!
1
+ Aliased to $"
data/pry-docmore.wiki/Ruby Global $SAFE (DollarSAFE).md CHANGED
@@ -1,4 +1,4 @@
1
1
  This variable determines the "level of paranoia", restricting the set of legal
2
2
  operations.
3
3
 
4
- @see: http://www.ruby-doc.org/docs/ProgrammingRuby/html/taint.html
4
+ See: http://www.ruby-doc.org/docs/ProgrammingRuby/html/taint.html
data/pry-docmore.wiki/Ruby Global $_ (DollarUnderscore).md CHANGED
@@ -1 +1 @@
1
- The $_ global is the last input line of string by gets or readline.
1
+ The $_ global is the last input line of string by `gets` or `readline`.
data/pry-docmore.wiki/Ruby Keyword: alias.md CHANGED
@@ -14,22 +14,25 @@ The alias keyword is used to make synonyms of methods.
14
14
  to make dynamic assignments. See {Module#alias_method} for that kind of
15
15
  trickery.
16
16
 
17
- @example Basic Usage
17
+ Basic Usage
18
+
18
19
  def foo; 3 end
19
20
  alias boo foo
20
21
  boo
21
22
  ⇒ 3
22
- @example Symbols as args
23
+
24
+ Symbols as args
25
+
23
26
  alias :zoo :boo # or even mix and match, if you want to for some reason.
24
27
  zoo
25
28
  ⇒ 3
26
- @example Some decorating!
29
+
30
+ Some decorating!
31
+
27
32
  alias orig_foo foo
28
33
  def foo; 4 + orig_foo end
29
34
  foo
30
35
  ⇒ 7
31
36
  # See also Rails's alias_method_chain for a formalization of this idiom.
32
- @param [unadorned symbol] New name
33
- @param [unadorned symbol] Existing name
34
- @return [NilClass] nil
35
- @see http://kresimirbojcic.com/2011/12/01/decorators-in-ruby.html
37
+
38
+ See also: http://kresimirbojcic.com/2011/12/01/decorators-in-ruby.html
data/pry-docmore.wiki/Ruby Keyword: and.md CHANGED
@@ -8,16 +8,22 @@ Boolean conjunction.
8
8
  is roughly equivalent to:
9
9
  (an_expression) && (another_expression)
10
10
 
11
- @example Truth table
11
+ Truth table
12
+
12
13
  true and true ⇒ true
13
14
  false and true ⇒ false
14
15
  false and false ⇒ false
15
- @example Precedence
16
+
17
+ Precedence
18
+
16
19
  true and not false ⇒ true
17
20
  true && not false ⇒ SyntaxError
18
21
  a = true and false; a ⇒ true
19
22
  a = true && false; a ⇒ false
20
- @example The fowl chain
23
+
24
+ The fowl chain
25
+
21
26
  if false or true && false then false elsif true and false or true then true end
22
27
  ⇒ true
23
- @see http://phrogz.net/ProgrammingRuby/language.html#table_18.4
28
+
29
+ See http://phrogz.net/ProgrammingRuby/language.html#table_18.4
data/pry-docmore.wiki/Ruby Keyword: case.md CHANGED
@@ -21,3 +21,5 @@ various objects.
21
21
  when /^[fdsa]{4}/; puts 'Whoa, works with regexes.'
22
22
  else puts 'Will not get here.'
23
23
  end
24
+
25
+ Also works with `Range`s
data/pry-docmore.wiki/Ruby Keyword: or.md CHANGED
@@ -8,11 +8,15 @@ Boolean disjunction.
8
8
  is roughly equivalent to:
9
9
  (an_expression) || (another_expression)
10
10
 
11
- @example Truth table
11
+ Truth table
12
+
12
13
  true or true ⇒ true
13
14
  false or true ⇒ true
14
15
  false or false ⇒ false
15
- @example Precedence
16
+
17
+ Precedence
18
+
16
19
  true or false ? 'yes' : 'no' ⇒ true
17
20
  true || false ? 'yes' : 'no' ⇒ "yes"
18
- @see http://phrogz.net/ProgrammingRuby/language.html#table_18.4
21
+
22
+ See http://phrogz.net/ProgrammingRuby/language.html#table_18.4
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pry-docmore
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -43,114 +43,115 @@ dependencies:
43
43
  - - ! '>='
44
44
  - !ruby/object:Gem::Version
45
45
  version: '0'
46
- description: ! '$-0 $0 $1 $2 $3 $4 $5 $6 $7 $8 $9 $-a $-d $DEBUG $& $@ $\ $` $! $:
47
- $, $$ $. $= $> $< $? $+ $" $; $⁄ $~ $* $'' $_ $-F $FILENAME $-i $-I $KCODE $-K $-l
48
- $LOADED_FEATURES $LOAD_PATH $-p $PROGRAM_NAME $SAFE $stderr $stdin $stdout $-v $VERBOSE
49
- $-w $-W alias and begin BEGIN break case class defined? def do else elsif __ENCODING__
50
- end END ensure false __FILE__ for if in __LINE__ module next nil not or redo rescue
51
- retry return self super then true undef unless until when while yield '
46
+ description: ! 'Enhanced show-doc (a.k.a ? command) for: $-0 $0 $1 $2 $3 $4 $5 $6
47
+ $7 $8 $9 $-a $-d $DEBUG $& $@ $\ $` $! $: $, $$ $. $= $> $< $? $+ $" $; $⁄ $~ $*
48
+ $'' $_ $-F $FILENAME $-i $-I $KCODE $-K $-l $LOADED_FEATURES $LOAD_PATH $-p $PROGRAM_NAME
49
+ $SAFE $stderr $stdin $stdout $-v $VERBOSE $-w $-W alias and begin BEGIN break case
50
+ class defined? def do else elsif __ENCODING__ end END ensure false __FILE__ for
51
+ if in __LINE__ module next nil not or redo rescue retry return self super then true
52
+ undef unless until when while yield '
52
53
  email: pry-docmore@sharpsaw.org
53
54
  executables: []
54
55
  extensions: []
55
56
  extra_rdoc_files: []
56
57
  files:
57
58
  - lib/pry-docmore.rb
58
- - pry-docmore.wiki/Home.md
59
- - pry-docmore.wiki/Ruby Global $! (DollarBang).md
60
- - pry-docmore.wiki/Ruby Global $" (DollarQuote).md
61
- - pry-docmore.wiki/Ruby Global $$ (DollarDollar).md
62
- - pry-docmore.wiki/Ruby Global $& (DollarAmpersand).md
63
- - pry-docmore.wiki/Ruby Global $' (DollarTick).md
64
- - pry-docmore.wiki/Ruby Global $* (DollarStar).md
65
- - pry-docmore.wiki/Ruby Global $+ (DollarPlus).md
59
+ - pry-docmore.wiki/Ruby Global $stdout (Dollarstdout).md
60
+ - pry-docmore.wiki/Ruby Global $< (DollarLessthan).md
61
+ - ! 'pry-docmore.wiki/Ruby Keyword: case.md'
62
+ - ! 'pry-docmore.wiki/Ruby Keyword: next.md'
63
+ - ! 'pry-docmore.wiki/Ruby Keyword: begin.md'
66
64
  - pry-docmore.wiki/Ruby Global $, (DollarComma).md
67
- - pry-docmore.wiki/Ruby Global $-0 (DollarDashZero).md
68
- - pry-docmore.wiki/Ruby Global $-F (DollarDashF).md
69
- - pry-docmore.wiki/Ruby Global $-I (DollarDashI).md
70
- - pry-docmore.wiki/Ruby Global $-K (DollarDashK).md
65
+ - ! 'pry-docmore.wiki/Ruby Keyword: or.md'
66
+ - pry-docmore.wiki/Ruby Global $@ (DollarAt).md
67
+ - pry-docmore.wiki/Ruby Global $-p (DollarDashp).md
68
+ - ! 'pry-docmore.wiki/Ruby Keyword: do.md'
69
+ - ! 'pry-docmore.wiki/Ruby Keyword: __LINE__.md'
70
+ - ! 'pry-docmore.wiki/Ruby Keyword: module.md'
71
+ - pry-docmore.wiki/Ruby Global $-v (DollarDashv).md
72
+ - ! 'pry-docmore.wiki/Ruby Keyword: when.md'
71
73
  - pry-docmore.wiki/Ruby Global $-W (DollarDashW).md
74
+ - ! 'pry-docmore.wiki/Ruby Keyword: for.md'
72
75
  - pry-docmore.wiki/Ruby Global $-a (DollarDasha).md
73
- - pry-docmore.wiki/Ruby Global $-d (DollarDashd).md
74
- - pry-docmore.wiki/Ruby Global $-i (DollarDashi).md
76
+ - ! 'pry-docmore.wiki/Ruby Keyword: def.md'
77
+ - pry-docmore.wiki/Ruby Global $LOADED_FEATURES (DollarLOADEDUnderscoreFEATURES).md
78
+ - pry-docmore.wiki/Ruby Global $6 (DollarSix).md
79
+ - pry-docmore.wiki/Ruby Global $' (DollarTick).md
80
+ - pry-docmore.wiki/Ruby Global $> (DollarGreaterthan).md
81
+ - ! 'pry-docmore.wiki/Ruby Keyword: if.md'
82
+ - pry-docmore.wiki/Ruby Global $\ (DollarBackslash).md
83
+ - ! 'pry-docmore.wiki/Ruby Keyword: class.md'
84
+ - ! 'pry-docmore.wiki/Ruby Keyword: not.md'
85
+ - pry-docmore.wiki/Ruby Global $` (DollarBacktick).md
86
+ - ! 'pry-docmore.wiki/Ruby Keyword: redo.md'
75
87
  - pry-docmore.wiki/Ruby Global $-l (DollarDashl).md
76
- - pry-docmore.wiki/Ruby Global $-p (DollarDashp).md
77
- - pry-docmore.wiki/Ruby Global $-v (DollarDashv).md
78
- - pry-docmore.wiki/Ruby Global $-w (DollarDashw).md
79
- - pry-docmore.wiki/Ruby Global $. (DollarDot).md
80
- - pry-docmore.wiki/Ruby Global $0 (DollarZero).md
81
- - pry-docmore.wiki/Ruby Global $1 (DollarOne).md
82
- - pry-docmore.wiki/Ruby Global $2 (DollarTwo).md
83
- - pry-docmore.wiki/Ruby Global $3 (DollarThree).md
88
+ - ! 'pry-docmore.wiki/Ruby Keyword: until.md'
89
+ - ! 'pry-docmore.wiki/Ruby Keyword: BEGIN.md'
90
+ - ! 'pry-docmore.wiki/Ruby Keyword: undef.md'
91
+ - pry-docmore.wiki/Ruby Global $DEBUG (DollarDEBUG).md
84
92
  - pry-docmore.wiki/Ruby Global $4 (DollarFour).md
85
- - pry-docmore.wiki/Ruby Global $5 (DollarFive).md
86
- - pry-docmore.wiki/Ruby Global $6 (DollarSix).md
93
+ - ! 'pry-docmore.wiki/Ruby Keyword: return.md'
94
+ - pry-docmore.wiki/Ruby Global $2 (DollarTwo).md
95
+ - ! 'pry-docmore.wiki/Ruby Keyword: false.md'
96
+ - pry-docmore.wiki/Ruby Global $-i (DollarDashi).md
97
+ - pry-docmore.wiki/Ruby Global $! (DollarBang).md
98
+ - pry-docmore.wiki/Ruby Global $= (DollarEquals).md
99
+ - pry-docmore.wiki/Ruby Global $; (DollarSemicolon).md
100
+ - ! 'pry-docmore.wiki/Ruby Keyword: break.md'
87
101
  - pry-docmore.wiki/Ruby Global $7 (DollarSeven).md
102
+ - pry-docmore.wiki/Ruby Global $-d (DollarDashd).md
103
+ - pry-docmore.wiki/Ruby Global $-F (DollarDashF).md
104
+ - ! 'pry-docmore.wiki/Ruby Keyword: defined?.md'
105
+ - ! 'pry-docmore.wiki/Ruby Keyword: __FILE__.md'
106
+ - pry-docmore.wiki/Home.md
88
107
  - pry-docmore.wiki/Ruby Global $8 (DollarEight).md
89
108
  - pry-docmore.wiki/Ruby Global $9 (DollarNine).md
109
+ - ! 'pry-docmore.wiki/Ruby Keyword: retry.md'
110
+ - pry-docmore.wiki/Ruby Global $VERBOSE (DollarVERBOSE).md
111
+ - ! 'pry-docmore.wiki/Ruby Keyword: rescue.md'
112
+ - pry-docmore.wiki/Ruby Global $-I (DollarDashI).md
113
+ - ! 'pry-docmore.wiki/Ruby Keyword: elsif.md'
114
+ - pry-docmore.wiki/Ruby Global $5 (DollarFive).md
115
+ - pry-docmore.wiki/Ruby Global $0 (DollarZero).md
116
+ - ! 'pry-docmore.wiki/Ruby Keyword: nil.md'
117
+ - ! 'pry-docmore.wiki/Ruby Keyword: true.md'
118
+ - ! 'pry-docmore.wiki/Ruby Keyword: super.md'
119
+ - ! 'pry-docmore.wiki/Ruby Keyword: alias.md'
90
120
  - ! 'pry-docmore.wiki/Ruby Global $: (DollarColon).md'
91
- - pry-docmore.wiki/Ruby Global $; (DollarSemicolon).md
92
- - pry-docmore.wiki/Ruby Global $< (DollarLessthan).md
93
- - pry-docmore.wiki/Ruby Global $= (DollarEquals).md
94
- - pry-docmore.wiki/Ruby Global $> (DollarGreaterthan).md
121
+ - pry-docmore.wiki/Ruby Global $-0 (DollarDashZero).md
95
122
  - pry-docmore.wiki/Ruby Global $? (Dollar?).md
96
- - pry-docmore.wiki/Ruby Global $@ (DollarAt).md
97
- - pry-docmore.wiki/Ruby Global $DEBUG (DollarDEBUG).md
98
- - pry-docmore.wiki/Ruby Global $FILENAME (DollarFILENAME).md
99
- - pry-docmore.wiki/Ruby Global $KCODE (DollarKCODE).md
100
- - pry-docmore.wiki/Ruby Global $LOADED_FEATURES (DollarLOADEDUnderscoreFEATURES).md
101
- - pry-docmore.wiki/Ruby Global $LOAD_PATH (DollarLOADUnderscorePATH).md
102
123
  - pry-docmore.wiki/Ruby Global $PROGRAM_NAME (DollarPROGRAMUnderscoreNAME).md
103
- - pry-docmore.wiki/Ruby Global $SAFE (DollarSAFE).md
104
- - pry-docmore.wiki/Ruby Global $VERBOSE (DollarVERBOSE).md
105
- - pry-docmore.wiki/Ruby Global $\ (DollarBackslash).md
106
- - pry-docmore.wiki/Ruby Global $_ (DollarUnderscore).md
107
- - pry-docmore.wiki/Ruby Global $` (DollarBacktick).md
108
- - pry-docmore.wiki/Ruby Global $stderr (Dollarstderr).md
109
- - pry-docmore.wiki/Ruby Global $stdin (Dollarstdin).md
110
- - pry-docmore.wiki/Ruby Global $stdout (Dollarstdout).md
111
- - pry-docmore.wiki/Ruby Global $~ (DollarSquiggle).md
112
- - pry-docmore.wiki/Ruby Global $⁄ (DollarSlash).md
113
- - ! 'pry-docmore.wiki/Ruby Keyword: BEGIN.md'
124
+ - pry-docmore.wiki/Ruby Global $" (DollarQuote).md
125
+ - ! 'pry-docmore.wiki/Ruby Keyword: while.md'
114
126
  - ! 'pry-docmore.wiki/Ruby Keyword: END.md'
115
- - ! 'pry-docmore.wiki/Ruby Keyword: __ENCODING__.md'
116
- - ! 'pry-docmore.wiki/Ruby Keyword: __FILE__.md'
117
- - ! 'pry-docmore.wiki/Ruby Keyword: __LINE__.md'
118
- - ! 'pry-docmore.wiki/Ruby Keyword: alias.md'
127
+ - pry-docmore.wiki/Ruby Global $-w (DollarDashw).md
128
+ - ! 'pry-docmore.wiki/Ruby Keyword: self.md'
129
+ - pry-docmore.wiki/Ruby Global $FILENAME (DollarFILENAME).md
130
+ - pry-docmore.wiki/Ruby Global $_ (DollarUnderscore).md
119
131
  - ! 'pry-docmore.wiki/Ruby Keyword: and.md'
120
- - ! 'pry-docmore.wiki/Ruby Keyword: begin.md'
121
- - ! 'pry-docmore.wiki/Ruby Keyword: break.md'
122
- - ! 'pry-docmore.wiki/Ruby Keyword: case.md'
123
- - ! 'pry-docmore.wiki/Ruby Keyword: class.md'
124
- - ! 'pry-docmore.wiki/Ruby Keyword: def.md'
125
- - ! 'pry-docmore.wiki/Ruby Keyword: defined?.md'
126
- - ! 'pry-docmore.wiki/Ruby Keyword: do.md'
127
- - ! 'pry-docmore.wiki/Ruby Keyword: else.md'
128
- - ! 'pry-docmore.wiki/Ruby Keyword: elsif.md'
129
- - ! 'pry-docmore.wiki/Ruby Keyword: end.md'
132
+ - pry-docmore.wiki/Ruby Global $. (DollarDot).md
133
+ - ! 'pry-docmore.wiki/Ruby Keyword: __ENCODING__.md'
134
+ - pry-docmore.wiki/Ruby Global $KCODE (DollarKCODE).md
130
135
  - ! 'pry-docmore.wiki/Ruby Keyword: ensure.md'
131
- - ! 'pry-docmore.wiki/Ruby Keyword: false.md'
132
- - ! 'pry-docmore.wiki/Ruby Keyword: for.md'
133
- - ! 'pry-docmore.wiki/Ruby Keyword: if.md'
136
+ - pry-docmore.wiki/Ruby Global $3 (DollarThree).md
137
+ - pry-docmore.wiki/Ruby Global $1 (DollarOne).md
138
+ - pry-docmore.wiki/Ruby Global $stdin (Dollarstdin).md
139
+ - ! 'pry-docmore.wiki/Ruby Keyword: yield.md'
140
+ - pry-docmore.wiki/Ruby Global $+ (DollarPlus).md
141
+ - pry-docmore.wiki/Ruby Global $$ (DollarDollar).md
142
+ - pry-docmore.wiki/Ruby Global $LOAD_PATH (DollarLOADUnderscorePATH).md
143
+ - ! 'pry-docmore.wiki/Ruby Keyword: unless.md'
144
+ - pry-docmore.wiki/Ruby Global $-K (DollarDashK).md
145
+ - pry-docmore.wiki/Ruby Global $~ (DollarSquiggle).md
134
146
  - ! 'pry-docmore.wiki/Ruby Keyword: in.md'
135
- - ! 'pry-docmore.wiki/Ruby Keyword: module.md'
136
- - ! 'pry-docmore.wiki/Ruby Keyword: next.md'
137
- - ! 'pry-docmore.wiki/Ruby Keyword: nil.md'
138
- - ! 'pry-docmore.wiki/Ruby Keyword: not.md'
139
- - ! 'pry-docmore.wiki/Ruby Keyword: or.md'
140
- - ! 'pry-docmore.wiki/Ruby Keyword: redo.md'
141
- - ! 'pry-docmore.wiki/Ruby Keyword: rescue.md'
142
- - ! 'pry-docmore.wiki/Ruby Keyword: retry.md'
143
- - ! 'pry-docmore.wiki/Ruby Keyword: return.md'
144
- - ! 'pry-docmore.wiki/Ruby Keyword: self.md'
145
- - ! 'pry-docmore.wiki/Ruby Keyword: super.md'
147
+ - pry-docmore.wiki/Ruby Global $stderr (Dollarstderr).md
148
+ - ! 'pry-docmore.wiki/Ruby Keyword: end.md'
149
+ - ! 'pry-docmore.wiki/Ruby Keyword: else.md'
146
150
  - ! 'pry-docmore.wiki/Ruby Keyword: then.md'
147
- - ! 'pry-docmore.wiki/Ruby Keyword: true.md'
148
- - ! 'pry-docmore.wiki/Ruby Keyword: undef.md'
149
- - ! 'pry-docmore.wiki/Ruby Keyword: unless.md'
150
- - ! 'pry-docmore.wiki/Ruby Keyword: until.md'
151
- - ! 'pry-docmore.wiki/Ruby Keyword: when.md'
152
- - ! 'pry-docmore.wiki/Ruby Keyword: while.md'
153
- - ! 'pry-docmore.wiki/Ruby Keyword: yield.md'
151
+ - pry-docmore.wiki/Ruby Global $* (DollarStar).md
152
+ - pry-docmore.wiki/Ruby Global $& (DollarAmpersand).md
153
+ - pry-docmore.wiki/Ruby Global $SAFE (DollarSAFE).md
154
+ - pry-docmore.wiki/Ruby Global $⁄ (DollarSlash).md
154
155
  homepage: https://github.com/rking/pry-docmore/wiki
155
156
  licenses:
156
157
  - CC0