pry-docmore 0.0.1

data/pry-docmore.wiki/Ruby Keyword: def.md

@@ -0,0 +1,14 @@
+Define a method.
+
+# TODO:
+# Describe various signatures
+#   def foo
+#   def foo arg
+#   def foo arg, arg2
+#   def foo *args
+#   def foo arg, *args, arg3
+#   …Ruby 2.0 keyword args?
+# Talk about eigenclasses
+
+Doesn't work inside another `def`, but can work inside blocks. Compare to
+Module#define_method, which is capable of doing more dynamic tricks.

data/pry-docmore.wiki/Ruby Keyword: defined?.md

@@ -0,0 +1,13 @@
+    defined? nil ⇒ "nil"
+    defined? self ⇒ "self"
+    defined? true ⇒ "true"
+    defined? false ⇒ "false"
+    # ____ ⇒ "expression"
+    defined? printf ⇒ "method"
+    printf = 3
+    defined? printf ⇒ "local-variable"
+    defined? a = 3 ⇒ "assignment" # but doesn't actually set a to 3.
+
+What the heck is this thing good for?
+
+Please answer at: https://github.com/rking/pry-docmore/wiki

data/pry-docmore.wiki/Ruby Keyword: do.md

@@ -0,0 +1,3 @@
+The beginning of a block, to be passed to a method call.
+
+TODO - https://github.com/rking/pry-docmore/wiki

data/pry-docmore.wiki/Ruby Keyword: else.md

@@ -0,0 +1,4 @@
+The part of a condition that happens when none if the `if` or `elsif` parts
+hold true. Also works with `case` and `rescue`.
+
+TODO - https://github.com/rking/pry-docmore/wiki

data/pry-docmore.wiki/Ruby Keyword: elsif.md

@@ -0,0 +1,3 @@
+Is only checked when the preceding `if`/`elsif` conditions evaluated false.
+
+TODO - https://github.com/rking/pry-docmore/wiki

data/pry-docmore.wiki/Ruby Keyword: end.md

@@ -0,0 +1,2 @@
+The single biggest wart in the Ruby syntax (because sleeker languages, such as
+CoffeeScript, imply it by indentation.)

data/pry-docmore.wiki/Ruby Keyword: ensure.md

@@ -0,0 +1 @@
+The sibling of `require` that is run when there is or isn't an exception.

data/pry-docmore.wiki/Ruby Keyword: false.md

@@ -0,0 +1,9 @@
+In Ruby, only `false` and `nil` evaluate to false.
+
+    def false_check x
+      return if nil == x
+      return if false == x
+      unless x
+        puts "This will never ever get reached."
+      end
+    end

data/pry-docmore.wiki/Ruby Keyword: for.md

@@ -0,0 +1,14 @@
+A fairly rarely used keyword in Ruby, because we like to write the Enumerable
+on the left side to remind us that we're not programming in some other lanuage.
+
+But, actually, it is a golf win:
+
+    (2..5).each do |i|
+      p i
+    end
+
+Is equivalent to:
+
+    for i in 2..5
+      p i
+    end

data/pry-docmore.wiki/Ruby Keyword: if.md

@@ -0,0 +1,5 @@
+That most fundamental of computing tools.
+
+See: https://en.wikipedia.org/wiki/Turing_completeness
+
+But also see: http://www.refactoring.com/catalog/replaceConditionalWithPolymorphism.html

data/pry-docmore.wiki/Ruby Keyword: in.md

@@ -0,0 +1,3 @@
+Goes with the `for` keyword.
+
+# Anything else?  If so, let us know: https://github.com/rking/pry-docmore/wiki

data/pry-docmore.wiki/Ruby Keyword: module.md

@@ -0,0 +1,3 @@
+Defines a Module, which is like a Class but can never be instantiated.
+
+TODO - https://github.com/rking/pry-docmore/wiki

data/pry-docmore.wiki/Ruby Keyword: next.md

@@ -0,0 +1,15 @@
+Skip to the next iteration of the inner-most loop.
+
+For example:
+
+    10.times do |i|
+      next unless 0 == i % 3
+      print i
+    end
+    puts
+
+Prints:
+
+    0369
+
+Compare with: break, last

data/pry-docmore.wiki/Ruby Keyword: nil.md

@@ -0,0 +1,3 @@
+Represents "nothing whatsoever".
+
+Along with `false`, is the other value that evaluates to false in conditionals.

data/pry-docmore.wiki/Ruby Keyword: not.md

@@ -0,0 +1,10 @@
+Boolean negation.
+
+    if not x
+
+is equivalent to:
+
+    unless x
+
+Note that the precedence is lower than for `!`. # TODO: elaborate, w/ examples.
+See: http://phrogz.net/ProgrammingRuby/language.html#table_18.4

data/pry-docmore.wiki/Ruby Keyword: or.md

@@ -0,0 +1,18 @@
+Boolean disjunction.
+
+  Evaluates to true if either its left or right side are true.
+
+    Remember that the 'or' operator is lower precedence operator than '||', so
+
+  an_expression or another_expression
+    is roughly equivalent to:
+  (an_expression) || (another_expression)
+
+@example Truth table
+  true  or true  ⇒ true
+  false or true  ⇒ true
+  false or false ⇒ false
+@example Precedence
+  true or false ? 'yes' : 'no' ⇒ true
+  true || false ? 'yes' : 'no' ⇒ "yes"
+@see http://phrogz.net/ProgrammingRuby/language.html#table_18.4

data/pry-docmore.wiki/Ruby Keyword: redo.md

@@ -0,0 +1,16 @@
+Jump back to the top of the inner-most block. E.g.:
+
+    2.times do |i|
+      3.times do |j|
+        print i,j
+        j += 1
+        redo if 1 == j
+      end
+    end
+    puts
+
+Prints:
+
+    0001010210111112
+
+# TODO: Pick a better example

data/pry-docmore.wiki/Ruby Keyword: rescue.md

@@ -0,0 +1,55 @@
+Catch exceptions.
+
+Usage:
+
+    begin
+      1/0
+    rescue => e
+      puts "No division by zero ever bothered me."
+    end
+
+Or
+
+    def foo
+      1/0
+    rescue
+      puts "Yep, works on 'def's, too."
+    end
+
+This is the basic exception heirarchy:
+
+   Exception
+    NoMemoryError
+    ScriptError:
+      LoadError
+      NotImplementedError
+      SyntaxError
+    SignalException
+      Interrupt
+    StandardError
+      ArgumentError
+      IOError
+        EOFError
+      IndexError
+      LocalJumpError
+      NameError
+        NoMethodError
+      RangeError
+        FloatDomainError
+      RegexpError
+      RuntimeError
+      SecurityError
+      SystemCallError
+      SystemStackError
+      ThreadError
+      TypeError
+      ZeroDivisionError
+    SystemExit
+    fatal
+
+More in Avdi Grimm's book, Exceptional Ruby: http://pragprog.com/book/ager/exceptional-ruby
+# TODO:
+#   Explain the args syntax
+#   Talk about Standard
+
+See: ensure, else, retry

data/pry-docmore.wiki/Ruby Keyword: retry.md

@@ -0,0 +1,20 @@
+Re-run the block that raised an Exception.
+
+For example:
+
+    tries = 3
+    begin
+      puts "Try ##{tries}."
+      1/0
+    rescue => e
+      tries -= 1
+      retry unless tries.zero?
+    end
+
+This will output:
+
+    Try #3.
+    Try #2.
+    Try #1.
+
+See also: begin, rescue, else, ensure

data/pry-docmore.wiki/Ruby Keyword: return.md

@@ -0,0 +1,38 @@
+Leave the current method, making the given value.
+
+Keep in mind that the last statement in a Ruby method is its implied value, so
+these are equivalent:
+
+    def f x
+      if 0 == x % 3
+        return true
+      else
+        return false
+      end
+    end
+
+    def f x
+      if 0 == x % 3
+        true
+      else
+        false
+      end
+    end
+
+…but, then, you might as well go all the way with it, as this is equivalent:
+
+    def f x
+      0 == x % 3
+    end
+
+So, usually, it's only useful as an "early return" in Ruby, such as:
+
+    return if arg > 3
+    # rest of method here
+
+Note that you can return out of lambdas but not proc's, e.g.:
+
+    -> { return 3 }.()
+    # ⇒ 3
+    proc { return 3 }.()
+    # ⇒ LocalJumpError: unexpected return

data/pry-docmore.wiki/Ruby Keyword: self.md

@@ -0,0 +1,15 @@
+An ever-present variable in Ruby. At the very top level, it is the "(main)"
+self, but everywhere else its value is very important to know.
+
+Within a method, it is the instance that received the method.
+
+Within a class defintion, it is the class itself. This explains why:
+
+    class Foo
+      def self.hi; 'hi' end # this is equivalent to:
+      def Foo.hi; 'hi' end # this.
+    end
+
+# TODO:
+#  Explain eigenclasses
+#  …?

data/pry-docmore.wiki/Ruby Keyword: super.md

@@ -0,0 +1,34 @@
+Call the current method, but using the superclass's implementation. Can be
+useful so that subclasses can 'decorate' their parent class's functionality.
+
+A subtle syntax issue is that, when this is called with no arguments, all
+arguments are passed up.
+
+For example:
+
+    class Dad
+      def f *args; p args end
+    end
+    class Kid < Dad
+      def f *args; super end
+    end
+    Kid.new.f 1, 2
+
+Outputs:
+
+    [1, 2]
+
+The way to stop this behavior is to use something Ruby almost never requires:
+empty parens:
+
+    class Dad
+      def f *args; p args end
+    end
+    class Kid < Dad
+      def f *args; super() end
+    end
+    Kid.new.f 1, 2
+
+Outputs:
+
+    []

data/pry-docmore.wiki/Ruby Keyword: then.md

@@ -0,0 +1,17 @@
+A keyword that is generally needless. For example, these all work:
+
+    if 3 then
+      puts 'hi'
+    end
+    if 3
+      puts 'hi'
+    end
+
+    if 3 then 'yes' else 'no' end
+    if 3; 'yes' else 'no' end
+    3 ? 'yes' : 'no'
+
+    case x
+    when 3 then puts 'yo' end
+    when 4; puts 'yo' end
+    end

data/pry-docmore.wiki/Ruby Keyword: true.md

@@ -0,0 +1,7 @@
+not false.  Everything in Ruby (except `false` and `nil`) are true.
+
+    if 0
+      puts "Ruby."
+    else
+      puts "Perl."
+    end

data/pry-docmore.wiki/Ruby Keyword: undef.md

@@ -0,0 +1,5 @@
+Opposite of `def` — removes a method definition.
+
+   def foo; end
+   undef foo
+   foo ⇒ NameError: undefined local variable or method `foo' for main:Object`

data/pry-docmore.wiki/Ruby Keyword: unless.md

@@ -0,0 +1,4 @@
+Equivalent to `if not`, but with very clear precedence. Especially popular in
+the "Yoda if" form:
+
+    fail "Oh no!" unless valid?

data/pry-docmore.wiki/Ruby Keyword: until.md

@@ -0,0 +1,6 @@
+Negated `while`.
+
+    puts 'Guess a letter.'
+    until 'y' == $stdin.readline.chomp
+      puts 'Guess again.'
+    end

data/pry-docmore.wiki/Ruby Keyword: when.md

@@ -0,0 +1 @@
+Specific condition of a `case` statement. (See: case)

data/pry-docmore.wiki/Ruby Keyword: while.md

@@ -0,0 +1,6 @@
+Loop as long as the condition holds.
+
+   puts 'Guess a letter.'
+   while 'y' == $stdin.readline.chomp
+     puts 'Anything but that one.'
+   end

data/pry-docmore.wiki/Ruby Keyword: yield.md

@@ -0,0 +1,16 @@
+Run the block passed to a method.
+
+    def foo
+      p 1
+      yield 2
+      p 3
+    end
+    foo do |i|
+      p i
+    end
+
+Prints:
+
+    1
+    2
+    3

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: pry-docmore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ☈king
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '$-0 $0 $1 $2 $3 $4 $5 $6 $7 $8 $9 $-a $-d $DEBUG $& $@ $\ $` $! $:
+  $, $$ $. $= $> $< $? $+ $" $; $⁄ $~ $* $'' $_ $-F $FILENAME $-i $-I $KCODE $-K $-l
+  $LOADED_FEATURES $LOAD_PATH $-p $PROGRAM_NAME $SAFE $stderr $stdin $stdout $-v $VERBOSE
+  $-w $-W alias and begin BEGIN break case class defined? def do else elsif __ENCODING__
+  end END ensure false __FILE__ for if in __LINE__ module next nil not or redo rescue
+  retry return self super then true undef unless until when while yield '
+email: pry-docmore@sharpsaw.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pry-docmore.rb
+- pry-docmore.wiki/Home.md
+- pry-docmore.wiki/Ruby Global $! (DollarBang).md
+- pry-docmore.wiki/Ruby Global $" (DollarQuote).md
+- pry-docmore.wiki/Ruby Global $$ (DollarDollar).md
+- pry-docmore.wiki/Ruby Global $& (DollarAmpersand).md
+- pry-docmore.wiki/Ruby Global $' (DollarTick).md
+- pry-docmore.wiki/Ruby Global $* (DollarStar).md
+- pry-docmore.wiki/Ruby Global $+ (DollarPlus).md
+- pry-docmore.wiki/Ruby Global $, (DollarComma).md
+- pry-docmore.wiki/Ruby Global $-0 (DollarDashZero).md
+- pry-docmore.wiki/Ruby Global $-F (DollarDashF).md
+- pry-docmore.wiki/Ruby Global $-I (DollarDashI).md
+- pry-docmore.wiki/Ruby Global $-K (DollarDashK).md
+- pry-docmore.wiki/Ruby Global $-W (DollarDashW).md
+- pry-docmore.wiki/Ruby Global $-a (DollarDasha).md
+- pry-docmore.wiki/Ruby Global $-d (DollarDashd).md
+- pry-docmore.wiki/Ruby Global $-i (DollarDashi).md
+- pry-docmore.wiki/Ruby Global $-l (DollarDashl).md
+- pry-docmore.wiki/Ruby Global $-p (DollarDashp).md
+- pry-docmore.wiki/Ruby Global $-v (DollarDashv).md
+- pry-docmore.wiki/Ruby Global $-w (DollarDashw).md
+- pry-docmore.wiki/Ruby Global $. (DollarDot).md
+- pry-docmore.wiki/Ruby Global $0 (DollarZero).md
+- pry-docmore.wiki/Ruby Global $1 (DollarOne).md
+- pry-docmore.wiki/Ruby Global $2 (DollarTwo).md
+- pry-docmore.wiki/Ruby Global $3 (DollarThree).md
+- pry-docmore.wiki/Ruby Global $4 (DollarFour).md
+- pry-docmore.wiki/Ruby Global $5 (DollarFive).md
+- pry-docmore.wiki/Ruby Global $6 (DollarSix).md
+- pry-docmore.wiki/Ruby Global $7 (DollarSeven).md
+- pry-docmore.wiki/Ruby Global $8 (DollarEight).md
+- pry-docmore.wiki/Ruby Global $9 (DollarNine).md
+- ! 'pry-docmore.wiki/Ruby Global $: (DollarColon).md'
+- pry-docmore.wiki/Ruby Global $; (DollarSemicolon).md
+- pry-docmore.wiki/Ruby Global $< (DollarLessthan).md
+- pry-docmore.wiki/Ruby Global $= (DollarEquals).md
+- pry-docmore.wiki/Ruby Global $> (DollarGreaterthan).md
+- pry-docmore.wiki/Ruby Global $? (Dollar?).md
+- pry-docmore.wiki/Ruby Global $@ (DollarAt).md
+- pry-docmore.wiki/Ruby Global $DEBUG (DollarDEBUG).md
+- pry-docmore.wiki/Ruby Global $FILENAME (DollarFILENAME).md
+- pry-docmore.wiki/Ruby Global $KCODE (DollarKCODE).md
+- pry-docmore.wiki/Ruby Global $LOADED_FEATURES (DollarLOADEDUnderscoreFEATURES).md
+- pry-docmore.wiki/Ruby Global $LOAD_PATH (DollarLOADUnderscorePATH).md
+- pry-docmore.wiki/Ruby Global $PROGRAM_NAME (DollarPROGRAMUnderscoreNAME).md
+- pry-docmore.wiki/Ruby Global $SAFE (DollarSAFE).md
+- pry-docmore.wiki/Ruby Global $VERBOSE (DollarVERBOSE).md
+- pry-docmore.wiki/Ruby Global $\ (DollarBackslash).md
+- pry-docmore.wiki/Ruby Global $_ (DollarUnderscore).md
+- pry-docmore.wiki/Ruby Global $` (DollarBacktick).md
+- pry-docmore.wiki/Ruby Global $stderr (Dollarstderr).md
+- pry-docmore.wiki/Ruby Global $stdin (Dollarstdin).md
+- pry-docmore.wiki/Ruby Global $stdout (Dollarstdout).md
+- pry-docmore.wiki/Ruby Global $~ (DollarSquiggle).md
+- pry-docmore.wiki/Ruby Global $⁄ (DollarSlash).md
+- ! 'pry-docmore.wiki/Ruby Keyword: BEGIN.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: END.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: __ENCODING__.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: __FILE__.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: __LINE__.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: alias.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: and.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: begin.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: break.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: case.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: class.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: def.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: defined?.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: do.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: else.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: elsif.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: end.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: ensure.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: false.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: for.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: if.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: in.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: module.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: next.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: nil.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: not.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: or.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: redo.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: rescue.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: retry.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: return.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: self.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: super.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: then.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: true.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: undef.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: unless.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: until.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: when.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: while.md'
+- ! 'pry-docmore.wiki/Ruby Keyword: yield.md'
+homepage: https://github.com/rking/pry-docmore/wiki
+licenses:
+- CC0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Documents keywords and special vars. Currently uses the `,?` command, but
+  soon plain `?`
+test_files: []
+has_rdoc: