pry-docmore 0.0.4 → 0.1.0

data/pry-docmore.wiki/Ruby Global $KCODE (DollarKCODE).md

@@ -1 +0,0 @@
-The $KCODE global ...pry-docmore TODO!

data/pry-docmore.wiki/Ruby Global $LOADED_FEATURES (DollarLOADEDUnderscoreFEATURES).md

@@ -1 +0,0 @@
-Aliased to $"

data/pry-docmore.wiki/Ruby Global $LOAD_PATH (DollarLOADUnderscorePATH).md

@@ -1 +0,0 @@
-Aliased to $:

data/pry-docmore.wiki/Ruby Global $PROGRAM_NAME (DollarPROGRAMUnderscoreNAME).md

@@ -1 +0,0 @@
-The $PROGRAM_NAME global Same as $0 - Contains the name of the script being executed. May be assignable.

data/pry-docmore.wiki/Ruby Global $SAFE (DollarSAFE).md

@@ -1,4 +0,0 @@
-This variable determines the "level of paranoia", restricting the set of legal
-operations.
-
-See: http://www.ruby-doc.org/docs/ProgrammingRuby/html/taint.html

data/pry-docmore.wiki/Ruby Global $VERBOSE (DollarVERBOSE).md

@@ -1 +0,0 @@
-The $VERBOSE global is the verbose flag, which is set by the -v switch.

data/pry-docmore.wiki/Ruby Global $// (DollarBackslash).md"

@@ -1 +0,0 @@
-The $\ global is the output record separator for the print and IO#write. Default is nil.

data/pry-docmore.wiki/Ruby Global $_ (DollarUnderscore).md

@@ -1 +0,0 @@
-The $_ global is the last input line of string by `gets` or `readline`.

data/pry-docmore.wiki/Ruby Global $` (DollarBacktick).md

@@ -1,16 +0,0 @@
-The $` global is the string to the left of the last successful match.
-
-If you do this:
-
-    str = 'hello goodbye'; str[/good/]
-
-Then this:
-
-    [ $`, $&, $' ]
-
-Yields this:
-[
-    "hello ",
-    "good",
-    "bye"
-]

data/pry-docmore.wiki/Ruby Global $stderr (Dollarstderr).md

@@ -1 +0,0 @@
-The $stderr global is the current standard error output.

data/pry-docmore.wiki/Ruby Global $stdin (Dollarstdin).md

@@ -1 +0,0 @@
-The $stdin global is the current standard input.

data/pry-docmore.wiki/Ruby Global $stdout (Dollarstdout).md

@@ -1 +0,0 @@
-The $stdout global is the current standard output.

data/pry-docmore.wiki/Ruby Global $~ (DollarSquiggle).md

@@ -1 +0,0 @@
-The $~ global is the match-data about the last match in the current scope.

data/pry-docmore.wiki/Ruby Global $/342/201/204 (DollarSlash).md"

@@ -1,3 +0,0 @@
-The $/ global is the input record separator, newline by default.
-
-This affects String#each_lines, String#lines, and String#chomp

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

@@ -1,14 +0,0 @@
-Like Perl and Awk before that, defines a block to be run before the others:
-
-    p 3
-    BEGIN { p 1 }
-    p 4
-    BEGIN { p 2 }
-    # …prints these out as 1, 2, 3, 4
-
-This works because the whole file gets parsed at the beginning (even though
-'class' and 'def' lines are not executed early), so the interpreter can reorder
-these statements.
-
-See also: `END`
-(Not to be confused with lower-case `begin`)

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

@@ -1,10 +0,0 @@
-Like Perl and Awk before that, defines a block to be run after the others:
-
-    p 1
-    END { p 4 }
-    p 2
-    END { p 3 }
-    # …prints these out as 1, 2, 3, 4
-
-See also: `BEGIN`
-(Not to be confused with lower-case `end`)

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

@@ -1,8 +0,0 @@
-Read-only value of the current Encoding object (which has methods:
-ascii_compatible?  dummy?  inspect  name  names  replicate  to_s)
-
-By default is: #<Encoding:US-ASCII>
-
-But can be affected by the 1st or 2nd line of the file being something like:
-
-# encoding: utf-8

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

@@ -1,5 +0,0 @@
-The filename of the code being evaluated. Evaluates to "(pry)" within the REPL.
-
-Useful especially for code to locate parts nearby, such as:
-
-    File.dirname(__FILE__)

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

@@ -1,12 +0,0 @@
-The code's current line number. Can be a handy way to pepper what would
-otherwise be `print "Got here 1"` statements in your code, e.g.:
-
-    if a
-        p __LINE__
-        # some stuff
-    else
-        p __LINE__
-        # some other stuff
-    end
-
-…but you use the pry-debugger gem instead, don't you?

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

@@ -1,38 +0,0 @@
-The alias keyword is used to make synonyms of methods.
-
-  If you are used to the semantics of the `/bin/ln` command, get it out of your
-  head right now: Ruby does the opposite. That is, instead of `ln existing
-  new`, Ruby's semantics are `alias new existing`. (Mnested Mnemonic: this `new`
-  sorting is the b`a`-`n`-`e` of my `exist`ence.)
-
-  Also take particular note that this is not a method call, but a keyword, so
-  it can do things method calls cannot. The args are not :symbols (though they
-  are permitted to be), and it is a SyntaxError to attempt to place a comma
-  between the args.
-
-  Note that, this being a keyword and happening at compile-time, is not enough
-  to make dynamic assignments. See {Module#alias_method} for that kind of
-  trickery.
-
-Basic Usage
-
-  def foo; 3 end
-  alias boo foo
-  boo
-  ⇒ 3
-
-Symbols as args
-
-  alias :zoo :boo # or even mix and match, if you want to for some reason.
-  zoo
-  ⇒ 3
-
-Some decorating!
-
-  alias orig_foo foo
-  def foo; 4 + orig_foo end
-  foo
-  ⇒ 7
-  # See also Rails's alias_method_chain for a formalization of this idiom.
-
-See also: http://kresimirbojcic.com/2011/12/01/decorators-in-ruby.html

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

@@ -1,29 +0,0 @@
-Boolean conjunction.
-
-  Only evaluates to `true` if both its left and right side are true.
-
-  Remember that the 'and' operator is lower precedence operator than '&&', so
-
-  an_expression and another_expression
-    is roughly equivalent to:
-  (an_expression) && (another_expression)
-
-Truth table
-
-  true  and true  ⇒ true
-  false and true  ⇒ false
-  false and false ⇒ false
-
-Precedence
-
-  true and not false ⇒ true
-  true && not false ⇒ SyntaxError
-  a = true and false; a ⇒ true
-  a = true && false; a ⇒ false
-
-The fowl chain
-
-  if false or true && false then false elsif true and false or true then true end
-  ⇒ true
-
-See http://phrogz.net/ProgrammingRuby/language.html#table_18.4

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

@@ -1,24 +0,0 @@
-Opens a block when `def` or `do` isn't already opening one for you.
-
-Uses include:
-
-    begin
-      1/0
-    rescue => e
-      p e
-    else
-      puts 'Cannot get here with that 1/0'
-    ensure
-      puts 'OK then.'
-    end
-
-Or something like:
-
-    x = something_falsy || begin
-      several_steps
-      go_here
-      3
-    end
-    # Now x == 3
-
-(Not to be confused with the BEGIN keyword.)

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

@@ -1,22 +0,0 @@
-Hops out of the inner-most loop. Like this:
-
-    %w(a b c).each do |i|
-      print i
-      32343.times do |j|
-        break if j > 2
-        print j
-      end
-    end
-    puts
-
-Prints:
-
-    a012b012c012
-
-Also note that the keyword accepts an argument:
-
-    x = loop do break 3 end
-    p x
-    # ⇒ 3
-
-Compare with: next, last

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

@@ -1,25 +0,0 @@
-A convenient conditional that doesn't require the "subject" to be repeated.
-
-Uses #=== for comparison ("the threequals"), which is defined specially for
-various objects.
-
-    x = 'asdf'
-    case x
-    when 'asdf'; puts 'Found it!'
-    when 'fghj'; puts 'Impossible.'
-    else puts 'Also impossible.'
-    end
-
-    case x
-    when String; puts 'Yep, will get here.'
-    when Array; puts 'Actually, wait a minute.'
-    when Hash; puts 'This is pretty bad OO.'
-    else puts 'But, the code works'
-    end
-
-    case x
-    when /^[fdsa]{4}/; puts 'Whoa, works with regexes.'
-    else puts 'Will not get here.'
-    end
-
-Also works with `Range`s

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

@@ -1,4 +0,0 @@
-- Opens a class definition
-- class << self ← Opens the eigenclass of 'self'
-
-TODO - https://github.com/rking/pry-docmore/wiki

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

@@ -1,14 +0,0 @@
-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

@@ -1,29 +0,0 @@
-    defined? nil ⇒ "nil"
-    defined? self ⇒ "self"
-    defined? true ⇒ "true"
-    defined? false ⇒ "false"
-    defined? "asdf" ⇒ "expression"
-    defined? a = 3 ⇒ "assignment" # but doesn't actually set a to 3.
-    defined? printf ⇒ "method"
-    printf = 3
-    defined? printf ⇒ "local-variable" # nil if there is no local or method with that name
-    defined? $foo ⇒ "global-variable"  # nil if $foo has not been assigned to
-    defined? Object ⇒ "constant"       # nil if there is no constant with that name
-    defined? super ⇒ "super"           # nil if there is no super method.
-    defined? yield ⇒ "yield"           # nil if no block was passed to this method
-
-defined? is most often used to determine whether a constant or global variable is defined. For example ruby-1.8.7 didn't have a RUBY_ENGINE constant, so jruby was often detected using:
-
-    defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
-
-Another idiomatic use is to safely call a super-method:
-
-    super if defined?(super)
-
-It can be used to detect whether a block was passed to this method, though `block_given?` is usually preferred.
-
-    yield if defined?(yield)
-
-Although the return value of `defined?` is a string, this is usually ignored and only the truthiness of the result considered.
-
-Improve these docs at https://github.com/rking/pry-docmore/wiki

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

@@ -1,3 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

@@ -1,2 +0,0 @@
-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

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

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

@@ -1,9 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

@@ -1,31 +0,0 @@
-Usage: module ModuleName; module-contents end
-
-Defines a new Module, or re-opens an existing module. Modules in ruby are
-collections of code, they have two distinct use-cases:
-
-1. As a Namespace. Often all of the code in a rubygem will be written in the
-same module to avoid naming collisions with code not in that Gem.
-
-2. As a set of shared functions. Modules can be included into Classes, which
-makes all of the methods defined in the module available to instances of the
-class. This can be used to emulate multiple-inheritance, or to divide one large
-class into more manageable chunks.
-
-Note that, though the class `Class` inherits from `Module`, this is more of an
-implementation detail than a direct, Liskov-substitutable interface: modules
-can be `include`d, `extend`ed or `using`d, while classes cannot. (On the other
-hand, classes can be instantiated, where modules cannot).
-
-    module X
-      def foo; 2 end
-    end
-    class Y; include X end
-    class Z; extend X end
-    # Now, these work:
-    Y.new.foo
-    Z.foo
-    # "extend just calls include on the eigenclass"
-    #   Mnemonic! INclude for INstances, Extend for sElf
-
-For all you ever wanted to know about constant lookup, see:
-http://cirw.in/blog/constant-lookup

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

@@ -1,15 +0,0 @@
-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

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

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

@@ -1,10 +0,0 @@
-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