(function() { fancy.fdoc({title:"Fancy Documentation", classes:{"File":{instance_methods:{"lstat":{lines:[988, 988], file:"kernel/common/file.rb"}, ":newline":{arg:[], lines:[180, 180], doc:"
Writes a newline character to the File
.
\"\"\nWrites a given argument as a String followed by a newline into the\nFile.\n\"\"
\n\n\n\n", file:"lib/file.fy"}, ":eof?":{lines:[859, 859], file:"kernel/common/io.rb"}, "chown":{lines:[974, 974], file:"kernel/common/file.rb"}, ":modes":{arg:[], lines:[143, 143], doc:"\"\"
\n\nReturns the File
access modes Array
.\n\"\"
\"\"
\n\nIndicates, if a File
is opened.\n\"\"
\"\"
\n\nSets the File
access modes Array
.\n\"\"
\"\"
\n\nWrites a given String
to a File
.\n\"\"
Same as File#writeln:.
\n\n\n\n", file:"lib/file.fy"}, "inspect":{lines:[1011, 1011], file:"kernel/common/file.rb"}, "stat":{lines:[996, 996], file:"kernel/common/file.rb"}, "truncate":{lines:[1000, 1000], file:"kernel/common/file.rb"}, "path":{}, "print:":{arg:["x"], lines:[47, 47], doc:"Same as File#write:.
\n\n\n\n", file:"lib/file.fy"}, "reopen":{lines:[965, 965], file:"kernel/common/file.rb"}, ":close":{arg:[], lines:[61, 61], doc:"\"\"\nCloses an opened File
.\n\"\"
\"\"
\n\nIndicates, if a File
is a Directory
.\n\"\"
\"\"\nInstances of File represent files in the filesystem of the operating\nsystem on which Fancy is running.\n\"\"
\n\n\n\n", methods:{"split":{lines:[765, 765], file:"kernel/common/file.rb"}, "lchown":{lines:[245, 245], file:"kernel/common/file.rb"}, "delete":{lines:[859, 859], file:"kernel/common/file.rb"}, "modes_str:":{arg:["modes_arr"], lines:[93, 93], doc:"\"\"
\n\nReturns the appropriate String
representation of the modes_arr
.\n\"\"
\"\"\nReads all the contens (in ASCII mode) of a given file and returns\nthem as an Array of lines being read.\n\"\"
\n\n\n\n", file:"lib/file.fy"}, "delete:":{arg:["filename"], lines:[112, 112], doc:"\"\"
\n\nDeletes a File
with a given filename
.\n\"\"
\"\"
\n\nRenames a File
on the filesystem.\n\"\"
\"\"
\n\nSimilar to open:modes:with: but takes no Block
argument to be\ncalled with the File
instance.\nReturns the opened File
instead and expects the caller to close
it manually.\n\"\"
\"\"
\n\nIndicates if the File
with the given filename
exists.\n\"\"
\"\"
\n\nOpens a File with a given filename
, a modes_arr
(Array
) and a block
.
E.g. to open a File with read access and read all lines and print them to STDOUT:
\n\nFile open: \"foo.txt\" modes: [:read] with: |f| {
\n\n{ f eof? } while_false: {\n f readln println\n}\n
\n\n}\n\"\"
\n\n \n\n", file:"lib/rbx/file.fy"}, "executable?":{lines:[329, 329], file:"kernel/common/file.rb"}, "setgid?":{lines:[926, 926], file:"kernel/common/file.rb"}, "__class_init__":{lines:[5, 5], file:"lib/file.fy"}, "directory?:":{arg:["path"], lines:[123, 123], doc:"\"\"
\n\nIndicates, if a given path
refers to a Directory
.\n\"\"
Initialize a new Set with a given Array of values.
\n\n\n\n", file:"lib/set.fy"}, ":values":{}, ":initialize":{arg:[], lines:[14, 14], doc:"Initialize a new empty Set.
\n\n\n\n", file:"lib/set.fy"}, "unknown_message:with_params:":{lines:[45, 45], file:"lib/set.fy"}, ":==":{arg:["other"], lines:[22, 22], doc:"Indicates, if two Sets are equal.
\n\n\n\n", file:"lib/set.fy"}, "each:":{arg:["block"], lines:[41, 41], doc:"Calls a given Block for each element of the Set.
\n\n\n\n", file:"lib/set.fy"}, "includes?:":{arg:["value"], lines:[36, 36], doc:"Indicates, if the Set includes a given value.
\n\n\n\n", file:"lib/set.fy"}, ":to_s":{arg:[], lines:[54, 54], doc:"Returns a String representation of a Set.
\n\n\n\n", file:"lib/set.fy"}, ":inspect":{arg:[], lines:[59, 59], doc:"Returns a detailed String representation of a Set.
\n\n\n\n", file:"lib/set.fy"}, "method_missing":{}, ":<<":{arg:["value"], lines:[31, 31], doc:"Insert a value into the Set.
\n\n\n\n", file:"lib/set.fy"}}, doc:"A simple Set data structure class.
\n\n\n\n", methods:{"__class_init__":{lines:[2, 2], file:"lib/set.fy"}, ":[]":{arg:["arr"], lines:[26, 26], doc:"Initialize a new Array with a given Array of values.
\n\n\n\n", file:"lib/set.fy"}}, ancestors:["Set", "FancyEnumerable", "Object", "Object", "Kernel"]}, "Fancy Package":{instance_methods:{}, doc:"\"\"
\n\nThe Fancy Package System.
\n\nThis class is used for installing and uninstalling fancy packages on\nthe system.
\n\nExample:
\n\n$ fancy install bakkdoor/mongo.fy\n
\n\nWill install the mongo.fy package from http://github.com/bakkdoor/mongo.fy\nin the latest released version or get the current HEAD (master\nbranch) revision.
\n\nYou can then load the package in your source file via
\n\nrequire: \"mongo.fy\"\n
\n\n\"\"
\n\n\n\n", methods:{":package_root_dir":{lines:[44, 44], file:"lib/package.fy"}, ":add_to_loadpath":{arg:[], lines:[57, 57], doc:"\"\"\nAdds the Fancy Package install dir to the loadpath so you can\neasily require:
packages into your code.\n\"\"
\"\"\nInstalls a package with a given name.\nExpects package_name to be a string in the form of:
\n\nuser/repo\n
\n\nWhich would get the package code from github.com/user/repo\n\"\"
\n\n\n\n", file:"lib/package.fy"}}, ancestors:["Fancy Package", "Object", "Kernel"]}, "Fancy Package RubyDependency":{instance_methods:{"initialize:":{lines:[22, 22], file:"lib/package/dependency.fy"}, "initialize:version:":{lines:[null, null], file:"lib/package/dependency.fy"}, ":gem_name":{}, ":version":{}}, doc:"\"\"\nSame as Fancy
Package
Dependency
, just for rubygem packages.\n\"\"
Returns the absolute (positive) value of a Number.
\n\n\n\n", file:"lib/number.fy"}, ":negate":{arg:[], lines:[32, 32], doc:"Negates a Number (-1 becomes 1 and vice versa).
\n\n\n\n", file:"lib/number.fy"}, ":even?":{arg:[], lines:[38, 38], doc:"Indicates, if a Number is even.
\n\n\n\n", file:"lib/number.fy"}, ":to_num":{lines:[48, 48], file:"lib/number.fy"}, ":odd?":{arg:[], lines:[44, 44], doc:"Indicates, if a Number is odd.
\n\n\n\n", file:"lib/number.fy"}, ":squared":{arg:[], lines:[10, 10], doc:"Returns the square of a Number.
\n\n\n\n", file:"lib/number.fy"}, ":doubled":{arg:[], lines:[16, 16], doc:"Returns the double value of a Number.
\n\n\n\n", file:"lib/number.fy"}}, doc:"\"\"\nNumber is a mixin-class for all number values (integer & floats for\nnow).\n\"\"
\n\n\n\n", methods:{"__class_init__":{lines:[5, 5], file:"lib/number.fy"}}, ancestors:["Number", "Object", "Kernel"]}, "Array":{instance_methods:{"remove_if:":{arg:["condition"], lines:[161, 161], doc:"\"\"
\n\nLike Array
remove:
, but taking a condition Block
.\nRemoves all elements that meet the given condition Block
.\n\"\"
Returns an Array of all indices of this item. Empty Array if item does not occur.
\n\n\n\n", file:"lib/rbx/array.fy"}, "each:":{arg:["block"], lines:[50, 50], doc:"Calls a given Block with each element in the Array.
\n\n\n\n", file:"lib/rbx/array.fy"}, "reject:":{arg:["block"], lines:[206, 206], doc:"\"\"\nReturns a new Array with all the elements which yield nil or false\nwhen called with the given Block.\n\"\"
\n\n\n\n", file:"lib/rbx/array.fy"}, "join:":{arg:["join_str"], lines:[220, 220], doc:"\"\"Joins all elements in the Array by a given String.\nE.g.: [1,2,3] join: ', ' # => '1,2,3'\"\"
\n\n\n\n", file:"lib/rbx/array.fy"}, "remove_at:":{arg:["index"], lines:[76, 76], doc:"\"\"Removes an element at a given index.\nIf given an Array of indices, removes all the elements with these indices.\nReturns the deleted object if an index was given, the last deleted object for an Array given.\"\"
\n\n\n\n", file:"lib/rbx/array.fy"}, "&":{lines:[353, 353], file:"kernel/common/array.rb"}, "permutation":{lines:[1184, 1184], file:"kernel/common/array.rb"}, "start":{}, "unshift":{lines:[1684, 1684], file:"kernel/common/array.rb"}, "uniq":{lines:[1595, 1595], file:"kernel/common/array.rb"}, "insert":{lines:[970, 970], file:"kernel/common/array.rb"}, "flatten":{lines:[835, 835], file:"kernel/common/array.rb"}, "sort_inplace":{lines:[1519, 1519], file:"kernel/common/array.rb"}, "collect":{lines:[87, 87], file:"kernel/bootstrap/array.rb"}, "collect!":{lines:[97, 97], file:"kernel/bootstrap/array.rb"}, "reverse_each":{lines:[1365, 1365], file:"kernel/common/array.rb"}, "inspect":{lines:[988, 988], file:"kernel/common/array.rb"}, ":reverse!":{lines:[1353, 1353], file:"kernel/common/array.rb"}, "to_s":{lines:[1567, 1567], file:"kernel/common/array.rb"}, "new_range":{lines:[16, 16], file:"kernel/bootstrap/array.rb"}, "join":{lines:[1005, 1005], file:"kernel/common/array.rb"}, "|":{lines:[366, 366], file:"kernel/common/array.rb"}, "rindex":{lines:[1384, 1384], file:"kernel/common/array.rb"}, "size":{}, "total=":{}, "replace":{lines:[1334, 1334], file:"kernel/common/array.rb"}, ":join":{arg:[], lines:[114, 114], doc:"\"\"
\n\nJoins all elements with the empty String
.
[\"hello\", \"world\", \"!\"] join # => \"hello, world!\"\n
\n\n\"\"
\n\n \n\n", file:"lib/array.fy"}, "first":{lines:[824, 824], file:"kernel/common/array.rb"}, ":second":{arg:[], lines:[99, 99], doc:"Returns the second element in the Array
\n\n\n\n", file:"lib/rbx/array.fy"}, "include?":{lines:[919, 919], file:"kernel/common/array.rb"}, ":clear":{lines:[506, 506], file:"kernel/common/array.rb"}, "uniq!":{lines:[1600, 1600], file:"kernel/common/array.rb"}, "[]=":{lines:[187, 187], file:"kernel/common/array.rb"}, ":compact!":{arg:[], lines:[136, 136], doc:"\"\"
\n\nRemoves all nil-value elements in place.\n\"\"
\n\n \n\n\n\n", file:"lib/array.fy"}, "__matches_when__":{lines:[80, 80], file:"kernel/bootstrap/array.rb"}, "==":{lines:[458, 458], file:"kernel/common/array.rb"}, "cycle":{lines:[574, 574], file:"kernel/common/array.rb"}, "pop":{lines:[1237, 1237], file:"kernel/common/array.rb"}, ":last":{lines:[1055, 1055], file:"kernel/common/array.rb"}, ":product":{arg:[], lines:[236, 236], doc:"\"\"Calculates the product of all the elements in the Enumerable\n(assuming them to be Numbers (implementing '+' & '*')).\"\"
\n\n\n\n", file:"lib/rbx/array.fy"}, "at:":{arg:["idx"], lines:[83, 83], doc:"Returns the element in the Array at a given index.
\n\n\n\n", file:"lib/rbx/array.fy"}, "rassoc":{lines:[1301, 1301], file:"kernel/common/array.rb"}, ":pop":{lines:[1237, 1237], file:"kernel/common/array.rb"}, ":indices":{arg:[], lines:[199, 199], doc:"Returns an Array
of all the indices of an Array
.
Inserts a given object at a given index (position) in the Array.
\n\n\n\n", file:"lib/rbx/array.fy"}, "to_ary":{lines:[1561, 1561], file:"kernel/common/array.rb"}, "concat":{lines:[562, 562], file:"kernel/common/array.rb"}, "__marshal__":{lines:[147, 147], file:"kernel/common/marshal.rb"}, ":rest":{arg:[], lines:[28, 28], doc:"Returns all elements except the first one as a new Array.
\n\n\n\n", file:"lib/array.fy"}, ":println":{arg:[], lines:[169, 169], doc:"Prints each element on a seperate line.
\n\n\n\n", file:"lib/array.fy"}, "find:":{arg:["item"], lines:[61, 61], doc:"\"\"
\n\nReturns the item, if it's in the Array or nil (if not found).\n\"\"
\n\n \n\n", file:"lib/array.fy"}, "find_by:":{arg:["block"], lines:[71, 71], doc:"\"\"
\n\nLike find: but takes a block that gets called with each element to find it.\n\"\"
\n\n \n\n", file:"lib/array.fy"}, "empty?":{lines:[706, 706], file:"kernel/common/array.rb"}, ":size":{}, ":*":{arg:["num"], lines:[183, 183], doc:"\"\"\nReturns a new Array
that contains the elements of self num times\nin a row.\n\"\"
Takes condition-block and returns true if any element meets it.
\n\n\n\n", file:"lib/rbx/array.fy"}, "reverse":{lines:[1347, 1347], file:"kernel/common/array.rb"}, "reject!":{lines:[1321, 1321], file:"kernel/common/array.rb"}, "at":{lines:[490, 490], file:"kernel/common/array.rb"}, ":clone":{arg:[], lines:[40, 40], doc:"Clones (shallow copy) the Array.
\n\n\n\n", file:"lib/rbx/array.fy"}, "reject!:":{arg:["block"], lines:[212, 212], doc:"Same as Array#reject: but doing so in-place (destructive).
\n\n\n\n", file:"lib/rbx/array.fy"}, ":<<":{lines:[343, 343], file:"kernel/common/array.rb"}, ":[]":{arg:["index"], lines:[23, 23], doc:"\"\"\nGiven an Array of 2 Numbers, it returns the sub-array between the\ngiven indices.\nIf given a Number, returns the element at that index.\n\"\"
\n\n\n\n", file:"lib/array.fy"}, "select:":{arg:["block"], lines:[175, 175], doc:"\"\"\nReturns a new Array with all the elements in self that yield a\ntrue-ish value when called with the given Block.\n\"\"
\n\n\n\n", file:"lib/rbx/array.fy"}, ":third":{arg:[], lines:[104, 104], doc:"Returns the third element in the Array
\n\n\n\n", file:"lib/rbx/array.fy"}, "zip":{lines:[1666, 1666], file:"kernel/common/array.rb"}, "includes?:":{arg:["obj"], lines:[35, 35], doc:"Indicates, if an Array includes a given value.
\n\n\n\n", file:"lib/rbx/array.fy"}, "values_at":{lines:[1618, 1618], file:"kernel/common/array.rb"}, "indexes":{lines:[948, 948], file:"kernel/common/array.rb"}, ":fourth":{arg:[], lines:[109, 109], doc:"Returns the fourth element in the Array
\n\n\n\n", file:"lib/rbx/array.fy"}, "*":{lines:[377, 377], file:"kernel/common/array.rb"}, "transpose":{lines:[1575, 1575], file:"kernel/common/array.rb"}, "eql?":{lines:[692, 692], file:"kernel/common/array.rb"}, "shift":{lines:[1431, 1431], file:"kernel/common/array.rb"}, "compact":{lines:[541, 541], file:"kernel/common/array.rb"}, "assoc":{lines:[479, 479], file:"kernel/common/array.rb"}, "index":{lines:[936, 936], file:"kernel/common/array.rb"}, "reverse!":{lines:[1353, 1353], file:"kernel/common/array.rb"}, "map":{lines:[87, 87], file:"kernel/bootstrap/array.rb"}, "sort!":{lines:[1519, 1519], file:"kernel/common/array.rb"}, "indices":{lines:[948, 948], file:"kernel/common/array.rb"}, ":==":{lines:[458, 458], file:"kernel/common/array.rb"}, "flatten!":{lines:[842, 842], file:"kernel/common/array.rb"}, "each_index":{lines:[676, 676], file:"kernel/common/array.rb"}, "-":{lines:[413, 413], file:"kernel/common/array.rb"}, "select!:":{arg:["condition"], lines:[125, 125], doc:"\"\"
\n\nRemoves all elements in place, that don't meet the condition.\n\"\"
\n\n \n\n", file:"lib/array.fy"}, "to_yaml":{lines:[107, 107], file:"lib/yaml/rubytypes.rb"}, "push":{lines:[1291, 1291], file:"kernel/common/array.rb"}, "append:":{arg:["arr"], lines:[27, 27], doc:"Appends another Array onto this one.
\n\n\n\n", file:"lib/rbx/array.fy"}, "to_a":{lines:[1552, 1552], file:"kernel/common/array.rb"}, "all?:":{arg:["block"], lines:[167, 167], doc:"Takes condition-block and returns true if all elements meet it.
\n\n\n\n", file:"lib/rbx/array.fy"}, "combination":{lines:[519, 519], file:"kernel/common/array.rb"}, "clear":{lines:[506, 506], file:"kernel/common/array.rb"}, "fetch":{lines:[714, 714], file:"kernel/common/array.rb"}, "<=>":{lines:[430, 430], file:"kernel/common/array.rb"}, "<<":{lines:[343, 343], file:"kernel/common/array.rb"}, "remove:":{arg:["obj"], lines:[148, 148], doc:"\"\"
\n\nRemoves all occurances of obj in the Array.\n\"\"
\n\n \n\n", file:"lib/array.fy"}, "[]":{lines:[92, 92], file:"kernel/common/array.rb"}, "reject":{lines:[1314, 1314], file:"kernel/common/array.rb"}, "each":{lines:[64, 64], file:"kernel/bootstrap/array.rb"}, ":sort":{lines:[1514, 1514], file:"kernel/common/array.rb"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, "shuffle":{lines:[1494, 1494], file:"kernel/common/array.rb"}, ":+":{arg:["other_arr"], lines:[193, 193], doc:"Returns concatenation with another Array
.
\"\"
\n\nReturns new Array with elements of other_arr appended to these.\n\"\"
\n\n \n\n", file:"lib/array.fy"}, "each_with_index:":{arg:["block"], lines:[114, 114], doc:"Iterate over all elements in Array. Calls a given Block with each element and its index.
\n\n\n\n", file:"lib/rbx/array.fy"}, "yaml_initialize":{lines:[null, null], file:"lib/yaml/rubytypes.rb"}, "last:":{arg:["count"], lines:[157, 157], doc:"Returns new Array with last n elements specified.
\n\n\n\n", file:"lib/rbx/array.fy"}, ":to_s":{arg:[], lines:[175, 175], doc:"Returns String
representation of Array
.
Returns the index of an item (or nil, if it isn't in the Array).
\n\n\n\n", file:"lib/rbx/array.fy"}, "start=":{}, "compact!":{lines:[547, 547], file:"kernel/common/array.rb"}, "select_with_index:":{arg:["block"], lines:[190, 190], doc:"\"\"\nSame as select, just gets also called with an additional argument\nfor each element's index value.\n\"\"
\n\n\n\n", file:"lib/rbx/array.fy"}, "+":{lines:[405, 405], file:"kernel/common/array.rb"}, ":first":{arg:[], lines:[94, 94], doc:"Returns the first element in the Array.
\n\n\n\n", file:"lib/rbx/array.fy"}, "__rescue_match__":{lines:[1913, 1913], file:"kernel/common/array.rb"}, "tuple":{}, "to_generator":{lines:[1940, 1940], file:"kernel/common/array.rb"}, "delete_at":{lines:[625, 625], file:"kernel/common/array.rb"}, "last":{lines:[1055, 1055], file:"kernel/common/array.rb"}, "values_at:":{arg:["idx_arr"], lines:[86, 86], doc:"\"\"
\n\nReturns new Array
with elements at given indices.\n\"\"
Returns sub-array starting at from: and going to to:
\n\n\n\n", file:"lib/rbx/array.fy"}, "taguri=":{}, "product":{lines:[1269, 1269], file:"kernel/common/array.rb"}, ":sum":{arg:[], lines:[229, 229], doc:"\"\"\nCalculates the sum of all the elements in the Enumerable\n(assuming them to be Numbers (implementing '+' & '*')).\n\"\"
\n\n\n\n", file:"lib/rbx/array.fy"}, "choice":{lines:[1406, 1406], file:"kernel/common/array.rb"}, "total":{}, "shuffle!":{lines:[1499, 1499], file:"kernel/common/array.rb"}, ":=?":{arg:["other"], lines:[44, 44], doc:"\"\"
\n\nCompares two Arrays where order does not matter.\n\"\"
\n\n \n\n", file:"lib/array.fy"}}, doc:"\"\"\nArray class.\nArrays are dynamically resizable containers with a constant-time\nindex-based access to members.\n\"\"
\n\n\n\n", methods:{"allocate":{lines:[11, 11], file:"kernel/bootstrap/array.rb"}, "yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, "new:":{arg:["size"], lines:[21, 21], doc:"Creates a new Array with a given size (default value is nil).
\n\n\n\n", file:"lib/rbx/array.fy"}, "[]":{lines:[22, 22], file:"kernel/common/array.rb"}, "coerce_into_array":{lines:[20, 20], file:"kernel/bootstrap/array.rb"}, "__class_init__":{lines:[104, 104], file:"lib/yaml/rubytypes.rb"}, "new:with:":{arg:["size", "default"], lines:[15, 15], doc:"Creates a new Array with a given size and default-value.
\n\n\n\n", file:"lib/rbx/array.fy"}}, ancestors:["Array", "FancyEnumerable", "Object", "Enumerable", "Object", "Kernel"]}, "FancySpec":{instance_methods:{"initialize:":{lines:[9, 9], file:"lib/fancy_spec.fy"}, "it:for:when:":{lines:[39, 39], file:"lib/fancy_spec.fy"}, ":run":{lines:[52, 52], file:"lib/fancy_spec.fy"}, "initialize:test_obj:":{lines:[15, 15], file:"lib/fancy_spec.fy"}, "it:when:":{lines:[33, 33], file:"lib/fancy_spec.fy"}}, doc:"\"\"\nThe FancySpec class is used for defining FancySpec testsuites.\nHave a look at the tests/ directory to see some examples.\n\"\"
\n\n\n\n", methods:{"describe:for:with:":{lines:[27, 27], file:"lib/fancy_spec.fy"}, "__class_init__":{lines:[5, 5], file:"lib/fancy_spec.fy"}, "describe:with:":{lines:[21, 21], file:"lib/fancy_spec.fy"}, "new:test_obj:":{}}, ancestors:["FancySpec", "Object", "Kernel"]}, "Rubinius Tuple":{instance_methods:{"initialize:":{arg:["size"], lines:[21, 21], doc:"\"\"
\n\nInitializes a new Tuple
with a given amount of element slots.\nE.g. if size
is 2
, creates a 2-Tuple.\n\"\"
\"\"
\n\nReturns an element at a given indes.\nPossibly throws an Rubinius
ObjectBoundsExceededError
.\n\"\"
\"\"
\n\nCompares two Tuple
s with each other.\n\"\"
\"\"
\n\nSets a value for a given index within a Tuple
.\n\"\"
\"\"\nForwards to Tuple
at:
.\n\"\"
\"\"\nTuples are fixed-size containers providing index-based access to its\nelements.\n\"\"
\n\n\n\n", methods:{"allocate":{lines:[5, 5], file:"kernel/bootstrap/tuple.rb"}, "new":{lines:[10, 10], file:"kernel/bootstrap/tuple.rb"}, "[]":{lines:[14, 14], file:"kernel/common/tuple.rb"}, "create_weakref":{lines:[162, 162], file:"kernel/bootstrap/tuple.rb"}, "pattern":{lines:[15, 15], file:"kernel/bootstrap/tuple.rb"}, "__class_init__":{lines:[6, 6], file:"lib/rbx/tuple.fy"}, "_load":{lines:[140, 140], file:"kernel/common/tuple.rb"}}, ancestors:["Rubinius Tuple", "FancyEnumerable", "Object", "Enumerable", "Object", "Kernel"]}, "Directory":{instance_methods:{}, doc:"\"\"\nInstances of Directory
represent directories in the filesystem of\nthe operating system, in which Fancy is being run.\n\"\"
\"\"
\n\nDeletes a directory with a given name, if it's empty.\n\"\"
\n\n \n\n", file:"lib/rbx/directory.fy"}, "create:":{arg:["dirname"], lines:[15, 15], doc:"\"\"
\n\nCreates a new Directory
on the filesystem, possibly throwing\nIOError Exceptions that might occur.\n\"\"
\"\"
\n\nIndicates, if a Directory exists with a given pathname.\n\"\"
\n\n \n\n", file:"lib/directory.fy"}, "create!:":{arg:["dirname"], lines:[30, 30], doc:"\"\"
\n\nCreates a new Directory
on the filesystem, ignoring any\nExceptions that might occur.\nBasically works like running mkdir -p
on the shell.\n\"\"
Same as Block#while_false:
\n\n\n\n", file:"lib/block.fy"}, "call:with_receiver:":{}, "call:":{}, "until_do:":{arg:["block"], lines:[51, 51], doc:"\"\"\nCalls a given Block as long as self
returns nil
or false
.\n\"\"
Calls itself if the given object is true-ish.
\n\n\n\n", file:"lib/block.fy"}, "method=":{}, "call_under":{lines:[15, 15], file:"kernel/bootstrap/block_environment.rb"}, ":&&":{arg:["other_block"], lines:[63, 63], doc:"\"\"\nShort-circuiting && (boolean AND).\n\"\"
\n\n\n\n", file:"lib/block.fy"}, "arity":{lines:[56, 56], file:"kernel/common/block_environment.rb"}, "from_eval!":{lines:[42, 42], file:"kernel/common/block_environment.rb"}, "under_context":{lines:[20, 20], file:"kernel/common/block_environment.rb"}, "file":{lines:[65, 65], file:"kernel/common/block_environment.rb"}, "local_count":{}, "top_scope":{}, "proc_environment":{}, ":argcount":{arg:[], lines:[8, 8], doc:"Returns the amount of arguments (arity) a Block takes.
\n\n\n\n", file:"lib/rbx/block.fy"}, "call":{lines:[10, 10], file:"kernel/bootstrap/block_environment.rb"}, "while_do:":{}, "proc_environment=":{}, "while_true:":{}, ":||":{arg:["other_block"], lines:[75, 75], doc:"\"\"\nShort-circuiting || (boolean OR).\n\"\"
\n\n\n\n", file:"lib/block.fy"}, "top_scope=":{}, "method":{}, ":call":{lines:[10, 10], file:"kernel/bootstrap/block_environment.rb"}, "from_proc?":{lines:[16, 16], file:"kernel/common/block_environment.rb"}, "call_with_receiver:":{}, "metadata_container=":{}, "receiver=":{lines:[30, 30], file:"kernel/common/block_environment.rb"}, "call_on_instance":{lines:[52, 52], file:"kernel/common/block_environment.rb"}, "unless:":{arg:["obj"], lines:[87, 87], doc:"Opposite of Block#if:. Calls itself if the given object is false-ish.
\n\n\n\n", file:"lib/block.fy"}, "local_count=":{}, "while_false:":{arg:["block"], lines:[28, 28], doc:"\"\"\nExecutes a given Block while self evals to nil\nExample:\n i = 0\n { i >= 10 } while_false: {
\n\ni println\ni = i + 1\n
\n\n}\n\"\"
\n\n\n\n", file:"lib/block.fy"}, "from_eval?":{lines:[38, 38], file:"kernel/common/block_environment.rb"}}, doc:"\"\"\nThe Block class (also BlockEnvironment) is the class of all\nBlock-literal values.\nA Block is a piece of unevaluated code, that can be passed around as\nany other value and evaluated by calling the +call+ or +call:+ methods.
\n\nBlocks also work properly with their enclosing environment in that\nthey preserve any local variables that get used within the Block,\neven if the context in which they got defined has been destroyed.\n=> Blocks are proper closures.
\n\nSee: http://en.wikipedia.org/wiki/Closure_(computer_science) for\nmore information.\n\"\"
\n\n\n\n", methods:{"allocate":{lines:[5, 5], file:"kernel/bootstrap/block_environment.rb"}, "of_sender":{lines:[20, 20], file:"kernel/bootstrap/block_environment.rb"}, "__class_init__":{lines:[15, 15], file:"lib/block.fy"}}, ancestors:["Rubinius BlockEnvironment", "Object", "Kernel"]}, "Method":{instance_methods:{"documentation:":{lines:[7, 7], file:"lib/rbx/method.fy"}, "[]":{lines:[68, 68], file:"kernel/common/method.rb"}, "name":{lines:[31, 31], file:"kernel/common/method.rb"}, "source_location":{lines:[101, 101], file:"kernel/common/method.rb"}, "to_proc":{lines:[142, 142], file:"kernel/common/method.rb"}, "initialize":{lines:[20, 20], file:"kernel/common/method.rb"}, "call":{lines:[68, 68], file:"kernel/common/method.rb"}, "test:":{lines:[18, 18], file:"lib/method.fy"}, "defined_in":{}, "==":{lines:[39, 39], file:"kernel/common/method.rb"}, "executable":{}, "receiver":{}, "inspect":{lines:[78, 78], file:"kernel/common/method.rb"}, "to_s":{lines:[78, 78], file:"kernel/common/method.rb"}, "owner":{lines:[131, 131], file:"kernel/common/method.rb"}, "unbind":{lines:[153, 153], file:"kernel/common/method.rb"}, "arity":{lines:[59, 59], file:"kernel/common/method.rb"}, ":documentation":{lines:[3, 3], file:"lib/rbx/method.fy"}, "source":{lines:[109, 109], file:"kernel/common/method.rb"}, "parameters":{lines:[117, 117], file:"kernel/common/method.rb"}, ":tests":{arg:[], lines:[13, 13], doc:"\"\"\nReturns an Array of all the FancySpec SpecTests defined for a\nMethod.\n\"\"
\n\n\n\n", file:"lib/method.fy"}}, doc:"\"\"\nAn instance of Method represents a method on a Class.\nEvery method in Fancy is an instance of the Method class.\n\"\"
\n\n\n\n", methods:{"__class_init__":{lines:[5, 5], file:"lib/method.fy"}}, ancestors:["Method", "Unmarshalable", "Object", "Kernel"]}, "FalseClass":{instance_methods:{"if_nil:":{arg:["block"], lines:[23, 23], doc:"Calls the block.
\n\n\n\n", file:"lib/rbx/false_class.fy"}, "taguri=":{}, "^":{lines:[7, 7], file:"kernel/bootstrap/false.rb"}, ":not":{arg:[], lines:[56, 56], doc:"\"\"
\n\nBoolean negation of false
=> true
.\n\"\"
Returns nil.
\n\n\n\n", file:"lib/rbx/false_class.fy"}, "if_true:else:":{arg:["then_block", "else_block"], lines:[8, 8], doc:"Calls else_block.
\n\n\n\n", file:"lib/rbx/false_class.fy"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, ":to_a":{lines:[46, 46], file:"lib/rbx/false_class.fy"}, ":false?":{arg:[], lines:[33, 33], doc:"Returns true.
\n\n\n\n", file:"lib/rbx/false_class.fy"}, "if_false:":{arg:["block"], lines:[18, 18], doc:"Calls the block.
\n\n\n\n", file:"lib/rbx/false_class.fy"}, ":nil?":{arg:[], lines:[28, 28], doc:"Returns true.
\n\n\n\n", file:"lib/rbx/false_class.fy"}, "inspect":{lines:[7, 7], file:"kernel/common/false.rb"}, "to_s":{lines:[11, 11], file:"kernel/bootstrap/false.rb"}, ":true?":{arg:[], lines:[38, 38], doc:"Returns nil.
\n\n\n\n", file:"lib/rbx/false_class.fy"}, "|":{lines:[7, 7], file:"kernel/bootstrap/false.rb"}, "to_yaml":{lines:[395, 395], file:"lib/yaml/rubytypes.rb"}, "&":{lines:[3, 3], file:"kernel/bootstrap/false.rb"}, ":to_s":{lines:[42, 42], file:"lib/rbx/false_class.fy"}, "__marshal__":{lines:[31, 31], file:"kernel/common/marshal.rb"}}, doc:"\"\"\nFalseClass extensions for Fancy on rbx.\n\"\"
\n\n\n\n", methods:{"yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, "__class_init__":{lines:[394, 394], file:"lib/yaml/rubytypes.rb"}}, ancestors:["FalseClass", "ImmediateValue", "Object", "Kernel"]}, "FancySpec PositiveMatcher":{instance_methods:{"initialize:":{lines:[139, 139], file:"lib/fancy_spec.fy"}, "unknown_message:with_params:":{arg:["msg", "params"], lines:[161, 161], doc:"\"\"Forwardy any other message and parameters to the object itself\nand checks the return value.\"\"
\n\n\n\n", file:"lib/fancy_spec.fy"}, ":==":{lines:[143, 143], file:"lib/fancy_spec.fy"}, ":!=":{lines:[149, 149], file:"lib/fancy_spec.fy"}, "be:":{lines:[164, 164], file:"lib/fancy_spec.fy"}, "method_missing":{}}, doc:"\"\"PositiveMatcher expects its actual value to be equal to an\nexpected value.\nIf the values are not equal, a SpecTest failure is generated.\"\"
\n\n\n\n", methods:{"__class_init__":{lines:[136, 136], file:"lib/fancy_spec.fy"}}, ancestors:["FancySpec PositiveMatcher", "Object", "Kernel"]}, "NilClass":{instance_methods:{"to_a":{lines:[25, 25], file:"kernel/bootstrap/nil.rb"}, "if_nil:":{arg:["block"], lines:[27, 27], doc:"Calls the block.
\n\n\n\n", file:"lib/nil_class.fy"}, "taguri=":{}, "^":{lines:[7, 7], file:"kernel/bootstrap/nil.rb"}, ":not":{lines:[54, 54], file:"lib/nil_class.fy"}, "if_true:":{arg:["block"], lines:[17, 17], doc:"Returns nil.
\n\n\n\n", file:"lib/nil_class.fy"}, "to_f":{lines:[29, 29], file:"kernel/bootstrap/nil.rb"}, "if_true:else:":{arg:["then_block", "else_block"], lines:[12, 12], doc:"Calls else_block.
\n\n\n\n", file:"lib/nil_class.fy"}, "nil?":{lines:[19, 19], file:"kernel/bootstrap/nil.rb"}, "__nil__":{lines:[19, 19], file:"kernel/bootstrap/nil.rb"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, ":to_a":{lines:[50, 50], file:"lib/nil_class.fy"}, ":false?":{arg:[], lines:[37, 37], doc:"Returns true.
\n\n\n\n", file:"lib/nil_class.fy"}, "if_false:":{arg:["block"], lines:[22, 22], doc:"Calls the block.
\n\n\n\n", file:"lib/nil_class.fy"}, ":nil?":{arg:[], lines:[32, 32], doc:"Returns true.
\n\n\n\n", file:"lib/nil_class.fy"}, "inspect":{lines:[15, 15], file:"kernel/bootstrap/nil.rb"}, "to_s":{lines:[11, 11], file:"kernel/bootstrap/nil.rb"}, ":true?":{arg:[], lines:[42, 42], doc:"Returns nil.
\n\n\n\n", file:"lib/nil_class.fy"}, "to_i":{lines:[33, 33], file:"kernel/bootstrap/nil.rb"}, "|":{lines:[7, 7], file:"kernel/bootstrap/nil.rb"}, "to_yaml":{lines:[404, 404], file:"lib/yaml/rubytypes.rb"}, "&":{lines:[3, 3], file:"kernel/bootstrap/nil.rb"}, ":to_s":{lines:[46, 46], file:"lib/nil_class.fy"}, "__marshal__":{lines:[19, 19], file:"kernel/common/marshal.rb"}}, doc:"NilClass. The class of the singleton nil value.
\n\n\n\n", methods:{"yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, ":new":{lines:[7, 7], file:"lib/nil_class.fy"}, "__class_init__":{lines:[403, 403], file:"lib/yaml/rubytypes.rb"}}, ancestors:["NilClass", "ImmediateValue", "Object", "Kernel"]}, "Fancy Package Uninstaller":{instance_methods:{"initialize:":{lines:[null, null], file:"lib/package/uninstaller.fy"}, ":run":{lines:[null, null], file:"lib/package/uninstaller.fy"}}, doc:"\"\"
\n\nFancy
Package@ Uninstaller.
\"\"
\n\n\n\n", methods:{"__class_init__":{lines:[7, 7], file:"lib/package/uninstaller.fy"}}, ancestors:["Fancy Package Uninstaller", "Object", "Kernel"]}, "Fancy Documentation RDiscount":{instance_methods:{}, doc:"A documentation formatter using ruby's RDiscount markdown
\n\n\n\n", methods:{"__class_init__":{lines:[100, 100], file:"lib/documentation.fy"}, "rdiscount:":{arg:["doc"], lines:[109, 109], doc:"Format string as HTML using RDiscount ruby gem.
\n\n\n\n", file:"lib/documentation.fy"}}, ancestors:["Fancy Documentation RDiscount", "Object", "Kernel"]}, "TCPServer":{instance_methods:{":accept":{lines:[453, 453], file:"lib/socket.rb"}}, doc:"TCP Server
\n\n\n\n", methods:{"__class_init__":{lines:[4, 4], file:"lib/rbx/tcp_server.fy"}}, ancestors:["TCPServer", "Socket ListenAndAccept", "IO Socketable", "TCPSocket", "IPSocket", "BasicSocket", "IO", "Unmarshalable", "File Constants", "Object", "Kernel"]}, "Fancy FDoc":{instance_methods:{}, doc:"\"\"
\n\nFDoc is a tool to generate API documentation from Fancy source.
\n\nWorks as follows:
\n\n\"\"
\n\n\n\n", methods:{":main":{arg:[], lines:[32, 32], doc:"\"\"\nFDoc will load all .fy files you give to it, and optionally run\nany specified FancySpec, and later produce documentation output.
\n\n\"\"\n
\n\n\n\n", file:"lib/fdoc.fy"}, "__class_init__":{lines:[22, 22], file:"lib/fdoc.fy"}}, ancestors:["Fancy FDoc", "Object", "Kernel"]}, "Object":{instance_methods:{"message_name:":{lines:[106, 106], file:"lib/rbx/object.fy"}, ":to_a":{lines:[90, 90], file:"lib/object.fy"}, "or_take:":{arg:["other"], lines:[83, 83], doc:"Returns self if it's non-nil, otherwise returns the given object.
\n\n\n\n", file:"lib/object.fy"}, "while:do:":{arg:["cond_block", "body_block"], lines:[129, 129], doc:"\"\"\nSame as:\n cond_block while_do: body_block\n\"\"
\n\n\n\n", file:"lib/object.fy"}, "metaclass":{lines:[3, 3], file:"kernel/bootstrap/object.rb"}, "ruby:args:with_block:":{}, ":==":{lines:[5, 5], file:"kernel/bootstrap/kernel.rb"}, ":to_num":{lines:[86, 86], file:"lib/object.fy"}, ":&&":{arg:["other"], lines:[105, 105], doc:"Same as Object#and:
\n\n\n\n", file:"lib/object.fy"}, "to_yaml":{lines:[15, 15], file:"lib/yaml/rubytypes.rb"}, "loop:":{arg:["block"], lines:[9, 9], doc:"Infinitely calls the block (loops).
\n\n\n\n", file:"lib/object.fy"}, "ruby:args:":{}, ":dclone":{arg:[], lines:[27, 27], doc:"Returns a deep clone of self using Ruby's Marshal class.
\n\n\n\n", file:"lib/rbx/object.fy"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, "send:":{lines:[98, 98], file:"lib/rbx/object.fy"}, ":nil?":{arg:[], lines:[41, 41], doc:"Returns nil.
\n\n\n\n", file:"lib/object.fy"}, "if_do:":{arg:["block"], lines:[57, 57], doc:"If the object is non-nil, it calls the given block with itself as argument.
\n\n\n\n", file:"lib/object.fy"}, "set_slot:value:":{lines:[43, 43], file:"lib/rbx/object.fy"}, ":true?":{arg:[], lines:[51, 51], doc:"Returns nil.
\n\n\n\n", file:"lib/object.fy"}, ":!=":{arg:["other"], lines:[26, 26], doc:"Indicates, if two objects are unequal.
\n\n\n\n", file:"lib/object.fy"}, "responds_to?:":{lines:[115, 115], file:"lib/rbx/object.fy"}, ":to_s":{lines:[35, 35], file:"lib/rbx/object.fy"}, "protected":{lines:[32, 32], file:"/Users/backtype/projects/fancy/boot/fancy_ext/object.rb"}, "define_singleton_method:with:":{lines:[80, 80], file:"lib/rbx/object.fy"}, "if:then:":{arg:["cond", "block"], lines:[112, 112], doc:"\"\"\nSame as:
\n\ncond if_do: block\n
\n\n\"\"
\n\n\n\n", file:"lib/object.fy"}, ":print":{arg:[], lines:[21, 21], doc:"Same as Console print: self. Prints the object on STDOUT.
\n\n\n\n", file:"lib/object.fy"}, "until:do:":{arg:["cond_block", "body_block"], lines:[138, 138], doc:"\"\"\nSame as:\n cond_block until_do: body_block\n\"\"
\n\n\n\n", file:"lib/object.fy"}, "documentation:":{arg:["str"], lines:[163, 163], doc:"Sets the documentation string for an Object.
\n\n\n\n", file:"lib/object.fy"}, ":class":{lines:[143, 143], file:"kernel/alpha.rb"}, "send:params:":{lines:[102, 102], file:"lib/rbx/object.fy"}, "if_do:else:":{arg:["then_block", "else_block"], lines:[68, 68], doc:"\"\"If the object is non-nil, it calls the given then_block with itself as argument.\nOtherwise it calls the given else_block.\"\"
\n\n\n\n", file:"lib/object.fy"}, "is_a?:":{arg:["class"], lines:[90, 90], doc:"Indicates, if an object is an instance of a given Class.
\n\n\n\n", file:"lib/rbx/object.fy"}, ":should_not":{arg:[], lines:[216, 216], doc:"Returns a NegativeMatcher for self.
\n\n\n\n", file:"lib/fancy_spec.fy"}, "if:then:else:":{arg:["cond", "then_block", "else_block"], lines:[120, 120], doc:"\"\"\nSame as:
\n\ncond if_do: then_block else: else_block\n
\n\n\"\"
\n\n\n\n", file:"lib/object.fy"}, "to_yaml_properties":{lines:[null, null], file:"lib/yaml/rubytypes.rb"}, "unless:do:":{arg:["cond", "block"], lines:[147, 147], doc:"\"\"\nSame as:\n cond if_do: { nil } else: block\n\"\"
\n\n\n\n", file:"lib/object.fy"}, "ruby:with_block:":{}, ":documentation":{arg:[], lines:[158, 158], doc:"Returns the documentation string for an Object.
\n\n\n\n", file:"lib/object.fy"}, ":===":{lines:[402, 402], file:"kernel/common/kernel.rb"}, "__show__":{lines:[63, 63], file:"kernel/alpha.rb"}, "kind_of?:":{arg:["class"], lines:[95, 95], doc:"Indicates, if an object is an instance of a given Class.
\n\n\n\n", file:"lib/rbx/object.fy"}, "__marshal__":{lines:[3, 3], file:"kernel/common/marshal.rb"}, ":println":{arg:[], lines:[16, 16], doc:"Same as Console println: self. Prints the object on STDOUT, followed by a newline.
\n\n\n\n", file:"lib/object.fy"}, ":should":{arg:[], lines:[211, 211], doc:"Returns a PositiveMatcher for self.
\n\n\n\n", file:"lib/fancy_spec.fy"}, "to_yaml_style":{lines:[null, null], file:"lib/yaml/rubytypes.rb"}, "if_nil:":{arg:["block"], lines:[36, 36], doc:"Returns nil.
\n\n\n\n", file:"lib/object.fy"}, ":initialize":{lines:[22, 22], file:"lib/rbx/object.fy"}, "taguri=":{}, "undefine_singleton_method:":{lines:[84, 84], file:"lib/rbx/object.fy"}, "public":{lines:[26, 26], file:"/Users/backtype/projects/fancy/boot/fancy_ext/object.rb"}, "__metaclass__":{lines:[3, 3], file:"kernel/bootstrap/object.rb"}, ":inspect":{lines:[39, 39], file:"lib/rbx/object.fy"}, ":false?":{arg:[], lines:[46, 46], doc:"Returns nil.
\n\n\n\n", file:"lib/object.fy"}, "private":{lines:[29, 29], file:"/Users/backtype/projects/fancy/boot/fancy_ext/object.rb"}, "__fixnum__":{lines:[9, 9], file:"kernel/bootstrap/object.rb"}, ":||":{arg:["other"], lines:[100, 100], doc:"Same as Object#or:
\n\n\n\n", file:"lib/object.fy"}, "if_false:":{arg:["block"], lines:[31, 31], doc:"Calls the block.
\n\n\n\n", file:"lib/object.fy"}, ":to_i":{lines:[94, 94], file:"lib/object.fy"}, "and:":{arg:["other"], lines:[56, 56], doc:"\"\"\nBoolean conjunction.\nReturns true if self and other are true, otherwise nil.\n\"\"
\n\n\n\n", file:"lib/rbx/object.fy"}, ":++":{lines:[31, 31], file:"lib/rbx/object.fy"}, "or:":{arg:["other"], lines:[69, 69], doc:"\"\"\nBoolean disjunction.\nReturns true if either self or other is true, otherwise nil.\n\"\"
\n\n\n\n", file:"lib/rbx/object.fy"}, "get_slot:":{lines:[47, 47], file:"lib/rbx/object.fy"}, "method:":{arg:["method_name"], lines:[154, 154], doc:"Returns the method with a given name for self, if defined.
\n\n\n\n", file:"lib/object.fy"}}, doc:"\"\"\nRoot class of Fancy's class hierarchy.\nAll classes inherit from Object.\n\"\"
\n\n\n\n", methods:{"yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, "__class_init__":{lines:[53, 53], file:"lib/digest.rb"}}, ancestors:["Object", "Kernel"]}, "Fancy Documentation":{instance_methods:{"initialize:":{lines:[7, 7], file:"lib/rbx/documentation.fy"}, "object:":{}, ":object":{}, ":meta":{lines:[null, null], file:"lib/rbx/documentation.fy"}, "specs:":{}, "meta:":{lines:[null, null], file:"lib/rbx/documentation.fy"}, "docs:":{}, "format:":{arg:["format"], lines:[55, 55], doc:"\"\"\nIf format is specified, the documentation string will be\nconverted using the corresponding formatter. This allows\nyou to extend Fancy documentation system, and produce\nhtml documents, man pages, or anything you can imagine.
\n\n\"\"\n
\n\n\n\n", file:"lib/documentation.fy"}, ":docs":{doc:"\"\"\nAn array of docstrings for the object beind documented.
\n\nWe have an array of docstrings because in Fancy, some\nthings like classes can be re-openned and the user may\nspecify new documentation for it each time. Thus we dont\nwant to loose the previous documentation but rather build\nupon it. That is, fancy supports incremental documentation.\n \"\"
\n\n\n\n"}, ":to_s":{lines:[null, null], file:"lib/documentation.fy"}, ":specs":{doc:"\"\"\nAn array of associated Fancy specs for the object\nbeing documented.
\n\nIts a lot better to keep the associated specs in\nFancy Documentation objects instead of just having them\nin method instances. This allows us to associate any object\nwith an spec example.
\n\nThis way you can have a single Fancy spec example that\nis related to many objects (methods, constants, classes)\nthat are being specified. Later in documentation, we can\nprovide links to all specs where an object is being exercised.\n \"\"
\n\n\n\n"}}, doc:"\"\"\nA Fancy Documentation object is a holder for docstrings and specs.\nKeeps a registry of documentation for anything Fancy.
\n\nProvides methods for searching and formatting objects' docstrings\nthis can be be handy for users of interactive Fancy REPL,\ndocument generators, instrospection toos, IDEs, anything!.
\n\nThis object can be converted to just anything by using its format:\nmethod. formatters can be registered with Fancy Documentation formatter:is:
\n\nBy default two formatters are defined:
\n\n 'fancy => Returns the Fancy::Documentation object\n 'string => Returns the docs string representation\n
\n\n\"\"
\n\n\n\n", methods:{"for:append:":{arg:["obj", "docstring"], lines:[65, 65], doc:"\"\"\nAppend docstring to the documentation for obj.\nIf obj has no documentation, one is created for it.
\n\n\"\"\n
\n\n\n\n", file:"lib/documentation.fy"}, "remove:":{arg:["obj"], lines:[55, 55], doc:"Removes the documentation for obj.
\n\n\n\n", file:"lib/rbx/documentation.fy"}, "formatter:is:":{arg:["name", "callable"], lines:[81, 81], doc:"Register a callable object as formatter under name.
\n\n\n\n", file:"lib/documentation.fy"}, ":formatters":{arg:[], lines:[87, 87], doc:"Obtain the hash of known documentation formatters.
\n\n\n\n", file:"lib/documentation.fy"}, "for:is:":{arg:["obj", "docstring"], lines:[37, 37], doc:"\"\"\nCreate a Fancy::Documentation instance.
\n\nNote: As we're bootstrapping, we cannot set documentation here as\nan string literal.
\n\nWe are the very first thing to load, so just create a new\nFancy::Documentation object without using new:, and set it as\nfancy docs.\n\"\"
\n\n\n\n", file:"lib/rbx/documentation.fy"}, "documentation_for:set_to:":{lines:[22, 22], file:"lib/rbx/documentation.fy"}, "__class_init__":{lines:[18, 18], file:"lib/documentation.fy"}, "on_documentation_set:":{lines:[18, 18], file:"lib/rbx/documentation.fy"}, "for:":{arg:["obj"], lines:[50, 50], doc:"Obtains the Fancy Documentation for obj.
\n\n\n\n", file:"lib/rbx/documentation.fy"}, "formatter:":{arg:["name"], lines:[76, 76], doc:"Obtain a formatter by the given name. Returns a callable object
\n\n\n\n", file:"lib/documentation.fy"}}, ancestors:["Fancy Documentation", "Object", "Kernel"]}, "TrueClass":{instance_methods:{"taguri=":{}, "^":{lines:[7, 7], file:"kernel/bootstrap/true.rb"}, ":not":{lines:[41, 41], file:"lib/true_class.fy"}, "if_true:":{arg:["block"], lines:[17, 17], doc:"Calls the block.
\n\n\n\n", file:"lib/true_class.fy"}, "if_true:else:":{arg:["then_block", "else_block"], lines:[12, 12], doc:"Calls the then_block.
\n\n\n\n", file:"lib/true_class.fy"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, ":false?":{arg:[], lines:[32, 32], doc:"Returns nil.
\n\n\n\n", file:"lib/true_class.fy"}, "if_false:":{arg:["block"], lines:[22, 22], doc:"Returns nil.
\n\n\n\n", file:"lib/true_class.fy"}, ":nil?":{arg:[], lines:[27, 27], doc:"Returns nil.
\n\n\n\n", file:"lib/true_class.fy"}, "inspect":{lines:[5, 5], file:"kernel/common/true.rb"}, "to_s":{lines:[15, 15], file:"kernel/bootstrap/true.rb"}, ":true?":{arg:[], lines:[37, 37], doc:"Returns true.
\n\n\n\n", file:"lib/true_class.fy"}, "|":{lines:[11, 11], file:"kernel/bootstrap/true.rb"}, "to_yaml":{lines:[386, 386], file:"lib/yaml/rubytypes.rb"}, "&":{lines:[3, 3], file:"kernel/bootstrap/true.rb"}, "__marshal__":{lines:[25, 25], file:"kernel/common/marshal.rb"}}, doc:"TrueClass. The class of the singleton true value.
\n\n\n\n", methods:{"yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, ":new":{lines:[7, 7], file:"lib/true_class.fy"}, "__class_init__":{lines:[385, 385], file:"lib/yaml/rubytypes.rb"}}, ancestors:["TrueClass", "ImmediateValue", "Object", "Kernel"]}, "Fancy FDoc Formatter":{instance_methods:{}, doc:"\"\"\nA documentation formater intended to be used by FDoc
.
This formatter makes some transformations on a docstring\nand then converts it to html using markdown.\n\"\"
\n\n\n\n", methods:{"create_code:":{lines:[336, 336], file:"lib/fdoc.fy"}, "remove_indentation:":{arg:["str"], lines:[212, 212], doc:"\"\"\nRemove leading white space for multi-line strings.\nThis method expects the first character to be an line return.\n\"\"
\n\n\n\n", file:"lib/fdoc.fy"}, "remove_tags:into:":{lines:[313, 313], file:"lib/fdoc.fy"}, "create_tags:with:":{lines:[326, 326], file:"lib/fdoc.fy"}, "create_method_references:":{lines:[348, 348], file:"lib/fdoc.fy"}, "format:":{lines:[195, 195], file:"lib/fdoc.fy"}, "__class_init__":{lines:[189, 189], file:"lib/fdoc.fy"}, "create_class_references:":{arg:["str"], lines:[270, 270], doc:"\"\"\nCreates class references for Fancy class names.
\n\nA docstring may contain class names sorounded by @\nwithout space between the @.
\n\nNested classes can be indicated by using :: like
\n\nFoo::Bar
\n\nThis will create references for both, Foo
and Bar
Instance methods should be written:
\n\nFoo::Bar#baz
\n\nClass methods should be written:
\n\nFoo::Bar.baz
\n\nSome examples:
\n\nA simple class reference:
\n\nFancy
Nested class reference:
\n\nFancy
FDoc
A fancy method without arguments:
\n\nFancy
FDoc
JSON
generate_map
A ruby method reference (will link to ruby docs if available)
\n\nString
split
A fancy method with many arguments:
\n\nFancy
Package
Installer
initialize:version:install_path:
A singleton method:
\n\nFancy
FDoc
Formatter
format:
\"\"
\n\n\n\n", file:"lib/fdoc.fy"}, "htmlize:":{lines:[342, 342], file:"lib/fdoc.fy"}}, ancestors:["Fancy FDoc Formatter", "Object", "Kernel"]}, "Console":{instance_methods:{}, doc:"Console class. Used for STDIO
.
Prints a newline to STDOUT
.
\"\"
\n\nPrints a given object on STDOUT
, followed by a newline.\n\"\"
\"\"
\n\nReads a line from STDIN
and returns it as a String
.\n\"\"
\"\"
\n\nPrints a given object on STDOUT
.\n\"\"
Clears the Console
.
\"\"
\n\nPrints a given message to STDOUT
, followed by reading a line from\nSTDIN
.\n\"\"
\"\"\nLoads the @.fancypack file within the downloaded package directory.\nIf no @.fancypack file is found, raise an error.\n\"\"
\n\n\n\n", file:"lib/package/installer.fy"}, ":tags":{arg:[], lines:[77, 77], doc:"Returns a list of tags the repository has on Github.
\n\n\n\n", file:"lib/package/installer.fy"}, "fulfill_spec:":{lines:[166, 166], file:"lib/package/installer.fy"}, "download_tgz:":{arg:["version"], lines:[102, 102], doc:"\"\"\nDownloads the .tar.gz file from Github with the given version\n(tag or branch name) and saves it to the specified install_path
.
The Default install_path is ~/.fancy/packages/.\nIf an environment variable FANCY_PACKAGE_DIR
is defined, it\nwill get used.\n\"\"
\"\"\nReturns the download url for a given version of the package\nto be installed.\n\"\"
\n\n\n\n", file:"lib/package/installer.fy"}, "rename_dir:":{arg:["dirname"], lines:[134, 134], doc:"\"\"\nRenames a given directory to a common way within the install path.\n=> It will rename the given dirname to $user/$repo-$version.\n\"\"
\n\n\n\n", file:"lib/package/installer.fy"}, ":latest_tag":{arg:[], lines:[68, 68], doc:"Returns the latest tag (sorted alphabetically).
\n\n\n\n", file:"lib/package/installer.fy"}, ":run":{arg:[], lines:[49, 49], doc:"\"\"\nRuns the installer & installs the package into\n$FANCY_PACKAGE_DIR
.\n\"\"
\"\"
\n\nFancy
Package
installer.
Downloads packages from Github (usually the latest tagged version,\nif no version is specified, or the latest HEAD revision in the\nmaster branch) and install it to the FANCY_PACKAGE_DIR
.
\"\"
\n\n\n\n", methods:{"new:version:":{}, "__class_init__":{lines:[14, 14], file:"lib/package/installer.fy"}, "new:version:install_path:":{}}, ancestors:["Fancy Package Installer", "Object", "Kernel"]}, "FancyEnumerable":{instance_methods:{"all?:":{arg:["condition"], lines:[60, 60], doc:"\"\"\nSimilar to FancyEnumerable
any?:
just checking for all elements.\nIndicates, if all elements meet the condition.\n\"\"
\"\"\nSimilar to find:
but takes a block that is called for each element to find it.\n\"\"
Returns nil
, if the given object isn't found, or the object, if it is found.
Returns the size of an Enumerable.
\n\n\n\n", file:"lib/enumerable.fy"}, "any?:":{arg:["condition"], lines:[46, 46], doc:"\"\"
\n\nIndicates, if any element meets the condition.\n\"\"
\n\n \n\n", file:"lib/enumerable.fy"}, "drop_while:":{arg:["condition"], lines:[137, 137], doc:"Returns a new Array
by skipping elements from the beginning as long as they meet the given condition block.
\"\"Calculates the sum of all the elements in the Enumerable
\n(assuming them to be Number
s (implementing '+' & '*')).\"\"
\"\"\nSimilar to each:
but calls an additional Block
between\ncalling the first Block
for each element in self.\n\"\"
Returns a new Array
with the results of calling a given block for every element
Returns the maximum value in the Enumerable (via the '>' comparison message).
\n\n\n\n", file:"lib/enumerable.fy"}, ":uniq":{arg:[], lines:[168, 168], doc:"Returns a new Array with all unique values (double entries are skipped).
\n\n\n\n", file:"lib/enumerable.fy"}, ":last":{arg:[], lines:[201, 201], doc:"Returns the last element in an Enumerable.
\n\n\n\n", file:"lib/enumerable.fy"}, "take_while:":{arg:["condition"], lines:[123, 123], doc:"Returns a new Array
by taking elements from the beginning as long as they meet the given condition block.
\"\"Calculates the product of all the elements in the Enumerable
\n(assuming them to be Number
s (implementing +
& *
)).\"\"
Returns a new Array
with all elements that meet the given condition block.
Returns a new Array
with all elements that don't meet the given condition block.
Indicates, if the Enumerable is empty (has no elements).
\n\n\n\n", file:"lib/enumerable.fy"}, "includes?:":{arg:["item"], lines:[14, 14], doc:"\"\"
\n\nIndicates, if a collection includes a given element.\n\"\"
\n\n \n\n", file:"lib/enumerable.fy"}, "reduce:init_val:":{arg:["block", "init_val"], lines:[158, 158], doc:"Calculates a value based on a given block to be called on an accumulator value and an initial value.
\n\n\n\n", file:"lib/enumerable.fy"}, ":compact":{arg:[], lines:[212, 212], doc:"Returns a new Array
with all values removed that are nil
( return true
on nil?
).
Returns the superiour element in the Enumerable
that has met the given comparison block with all other elements.
Returns the minimum value in the Enumerable (via the '<' comparison message).
\n\n\n\n", file:"lib/enumerable.fy"}}, doc:"\"\"\nMixin-Class with useful methods for collections that implement an each:
method.\n\"\"
Returns an Array of the key-value pairs in a Hash.
\n\n\n\n", file:"lib/hash.fy"}, "select":{lines:[590, 590], file:"kernel/common/hash.rb"}, "store":{lines:[194, 194], file:"kernel/common/hash.rb"}, "sort":{lines:[634, 634], file:"kernel/common/hash.rb"}, "map:":{lines:[36, 36], file:"lib/rbx/hash.fy"}, "hash":{lines:[174, 174], file:"kernel/common/hash.rb"}, "__store__":{lines:[194, 194], file:"kernel/common/hash.rb"}, "indices":{lines:[667, 667], file:"kernel/common/hash.rb"}, "has_value?":{lines:[655, 655], file:"kernel/common/hash.rb"}, "each:":{arg:["block"], lines:[27, 27], doc:"Calls a given Block with each key and value.
\n\n\n\n", file:"lib/hash.fy"}, "each_value":{lines:[344, 344], file:"kernel/common/hash.rb"}, "to_yaml":{lines:[38, 38], file:"lib/yaml/rubytypes.rb"}, "to_a":{lines:[638, 638], file:"kernel/common/hash.rb"}, "clear":{lines:[232, 232], file:"kernel/common/hash.rb"}, "fetch":{lines:[358, 358], file:"kernel/common/hash.rb"}, "each_entry":{lines:[292, 292], file:"kernel/common/hash.rb"}, "[]":{lines:[186, 186], file:"kernel/common/hash.rb"}, "reject":{lines:[547, 547], file:"kernel/common/hash.rb"}, "each":{lines:[308, 308], file:"kernel/common/hash.rb"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, "keys":{lines:[448, 448], file:"kernel/common/hash.rb"}, "to_iter":{lines:[643, 643], file:"kernel/common/hash.rb"}, "inspect":{lines:[413, 413], file:"kernel/common/hash.rb"}, ":keys":{lines:[448, 448], file:"kernel/common/hash.rb"}, "member?":{lines:[434, 434], file:"kernel/common/hash.rb"}, "length":{}, "to_s":{lines:[651, 651], file:"kernel/common/hash.rb"}, "yaml_initialize":{lines:[29, 29], file:"lib/yaml/rubytypes.rb"}, ":to_s":{arg:[], lines:[54, 54], doc:"Returns a string representation of a Hash.
\n\n\n\n", file:"lib/hash.fy"}, "size":{}, "delete_if":{lines:[283, 283], file:"kernel/common/hash.rb"}, "replace":{lines:[567, 567], file:"kernel/common/hash.rb"}, "rehash":{lines:[522, 522], file:"kernel/common/hash.rb"}, "include?":{lines:[434, 434], file:"kernel/common/hash.rb"}, "[]=":{lines:[194, 194], file:"kernel/common/hash.rb"}, "find_entry":{lines:[370, 370], file:"kernel/common/hash.rb"}, "to_hash":{lines:[647, 647], file:"kernel/common/hash.rb"}, "==":{lines:[126, 126], file:"kernel/common/hash.rb"}, "redistribute":{lines:[496, 496], file:"kernel/common/hash.rb"}, ":values":{lines:[663, 663], file:"kernel/common/hash.rb"}, "at:":{lines:[186, 186], file:"kernel/common/hash.rb"}, "update":{lines:[456, 456], file:"kernel/common/hash.rb"}, "default=":{lines:[247, 247], file:"kernel/common/hash.rb"}, "at:put:":{lines:[194, 194], file:"kernel/common/hash.rb"}, "__marshal__":{lines:[165, 165], file:"kernel/common/marshal.rb"}, "each_value:":{arg:["block"], lines:[40, 40], doc:"Calls a given Block with each value.
\n\n\n\n", file:"lib/hash.fy"}, "taguri=":{}, "empty?":{lines:[354, 354], file:"kernel/common/hash.rb"}, "invert":{lines:[426, 426], file:"kernel/common/hash.rb"}, "has_key?":{lines:[434, 434], file:"kernel/common/hash.rb"}, ":size":{}, "reject!":{lines:[555, 555], file:"kernel/common/hash.rb"}, "merge":{lines:[452, 452], file:"kernel/common/hash.rb"}, ":inspect":{lines:[11, 11], file:"lib/rbx/hash.fy"}, ":[]":{arg:["key"], lines:[13, 13], doc:"Returns the value for a given key.
\n\n\n\n", file:"lib/hash.fy"}, "value?":{lines:[655, 655], file:"kernel/common/hash.rb"}, "merge!":{lines:[456, 456], file:"kernel/common/hash.rb"}, "each_key:":{arg:["block"], lines:[32, 32], doc:"Calls a given Block with each key.
\n\n\n\n", file:"lib/hash.fy"}, "values_at":{lines:[667, 667], file:"kernel/common/hash.rb"}, "indexes":{lines:[667, 667], file:"kernel/common/hash.rb"}, "default_proc":{lines:[252, 252], file:"kernel/common/hash.rb"}, "values":{lines:[663, 663], file:"kernel/common/hash.rb"}, "default":{lines:[239, 239], file:"kernel/common/hash.rb"}, "each_key":{lines:[328, 328], file:"kernel/common/hash.rb"}}, doc:"\"\"\nClass for Hashes (HashMaps / Dictionaries).\nMaps a key to a value.\n\"\"
\n\n\n\n", methods:{"new_from_literal":{lines:[115, 115], file:"kernel/common/hash.rb"}, "allocate":{lines:[120, 120], file:"kernel/common/hash.rb"}, "yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, "[]":{lines:[78, 78], file:"kernel/common/hash.rb"}, "__class_init__":{lines:[27, 27], file:"lib/yaml/rubytypes.rb"}}, ancestors:["Hash", "FancyEnumerable", "Object", "Enumerable", "Object", "Kernel"]}, "Symbol":{instance_methods:{"is_ivar?":{lines:[14, 14], file:"kernel/bootstrap/symbol.rb"}, "taguri=":{}, "intern":{lines:[378, 378], file:"kernel/alpha.rb"}, "to_proc":{lines:[48, 48], file:"kernel/common/symbol.rb"}, ":eval":{lines:[3, 3], file:"lib/rbx/symbol.fy"}, "index":{lines:[9, 9], file:"kernel/bootstrap/symbol.rb"}, "call:":{arg:["arg"], lines:[21, 21], doc:"\"\"\nThis allows Symbols to be used like Blocks\n(e.g. in all methods of Enumerable).\nExample: [1, 2, 3] map: 'squared # => [1, 4, 9]\n\"\"
\n\n\n\n", file:"lib/symbol.fy"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, ":inspect":{lines:[10, 10], file:"lib/rbx/symbol.fy"}, "to_sym":{lines:[378, 378], file:"kernel/alpha.rb"}, "inspect":{lines:[25, 25], file:"kernel/common/symbol.rb"}, "to_s":{lines:[372, 372], file:"kernel/alpha.rb"}, "id2name":{lines:[372, 372], file:"kernel/alpha.rb"}, "===":{lines:[5, 5], file:"kernel/bootstrap/kernel.rb"}, "is_cvar?":{lines:[19, 19], file:"kernel/bootstrap/symbol.rb"}, "is_constant?":{lines:[24, 24], file:"kernel/bootstrap/symbol.rb"}, "to_yaml":{lines:[194, 194], file:"lib/yaml/rubytypes.rb"}, "__marshal__":{lines:[56, 56], file:"kernel/common/marshal.rb"}}, doc:"\"\"\nSymbols are unique identifiers and only created once.
\n\nIf there are several occurrances of the same Symbol literal within\nFancy code, they all refer to the same Symbol object.\n\"\"
\n\n\n\n", methods:{"yaml_new":{lines:[186, 186], file:"lib/yaml/rubytypes.rb"}, "yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, "all_symbols":{lines:[18, 18], file:"kernel/common/symbol.rb"}, "===":{lines:[4, 4], file:"kernel/bootstrap/symbol.rb"}, "__class_init__":{lines:[184, 184], file:"lib/yaml/rubytypes.rb"}}, ancestors:["Symbol", "ImmediateValue", "Object", "Kernel"]}, "Fancy Package Dependency":{instance_methods:{"initialize:":{lines:[11, 11], file:"lib/package/dependency.fy"}, "initialize:version:":{lines:[null, null], file:"lib/package/dependency.fy"}, ":name":{}, ":version":{}}, doc:"\"\"\nPackage Dependency.\nRepresents a Dependency to another Package with a given version.\n\"\"
\n\n\n\n", methods:{"new:version:":{}, "__class_init__":{lines:[6, 6], file:"lib/package/dependency.fy"}}, ancestors:["Fancy Package Dependency", "Object", "Kernel"]}, "NoMethodError":{instance_methods:{"name":{}, ":method_name":{arg:[], lines:[13, 13], doc:"\"\"
\n\nReturns the name of the method that was not found as a String
.\n\"\"
\"\"\nException class that gets thrown when a method wasn't found within a class.\n\"\"
\n\n\n\n", methods:{"__class_init__":{lines:[4, 4], file:"lib/rbx/no_method_error.fy"}}, ancestors:["NoMethodError", "NameError", "StandardError", "Exception", "Object", "Kernel"]}, "String":{instance_methods:{"%":{lines:[60, 60], file:"kernel/common/string.rb"}, "start_with?":{lines:[1816, 1816], file:"kernel/common/string.rb"}, "modify!":{lines:[2476, 2476], file:"kernel/common/string.rb"}, "data":{}, "chars":{lines:[660, 660], file:"kernel/common/string.rb"}, ":=~":{lines:[186, 186], file:"kernel/common/string.rb"}, "swapcase!":{lines:[2059, 2059], file:"kernel/common/string.rb"}, "delete":{lines:[602, 602], file:"kernel/common/string.rb"}, "partition":{lines:[1360, 1360], file:"kernel/common/string.rb"}, "succ":{lines:[1968, 1968], file:"kernel/common/string.rb"}, "delete!":{lines:[608, 608], file:"kernel/common/string.rb"}, "full_to_i":{lines:[2593, 2593], file:"kernel/common/string.rb"}, "each:":{lines:[29, 29], file:"lib/rbx/string.fy"}, ":split":{lines:[null, null], file:"lib/rbx/string.fy"}, "find_string_reverse":{lines:[65, 65], file:"kernel/bootstrap/string.rb"}, "end_with?":{lines:[811, 811], file:"kernel/common/string.rb"}, "lines":{lines:[719, 719], file:"kernel/common/string.rb"}, "secure_compare":{lines:[76, 76], file:"kernel/bootstrap/string.rb"}, ":raise!":{arg:[], lines:[51, 51], doc:"Raises a new StdError with self as the message.
\n\n\n\n", file:"lib/string.fy"}, "rstrip!":{lines:[1445, 1445], file:"kernel/common/string.rb"}, "tr":{lines:[2123, 2123], file:"kernel/common/string.rb"}, "gsub":{lines:[852, 852], file:"kernel/common/string.rb"}, "tr_s":{lines:[2141, 2141], file:"kernel/common/string.rb"}, "dup":{lines:[26, 26], file:"kernel/bootstrap/string.rb"}, "find_character":{lines:[92, 92], file:"kernel/bootstrap/string.rb"}, "count_table":{lines:[2410, 2410], file:"kernel/common/string.rb"}, "data=":{}, "insert":{lines:[1115, 1115], file:"kernel/common/string.rb"}, "next":{lines:[1968, 1968], file:"kernel/common/string.rb"}, "justify":{lines:[2438, 2438], file:"kernel/common/string.rb"}, "rjust":{lines:[1426, 1426], file:"kernel/common/string.rb"}, "strip":{lines:[1829, 1829], file:"kernel/common/string.rb"}, "strip!":{lines:[1835, 1835], file:"kernel/common/string.rb"}, "inspect":{lines:[1157, 1157], file:"kernel/common/string.rb"}, ":upcase":{lines:[2156, 2156], file:"kernel/common/string.rb"}, "tr_trans":{lines:[2199, 2199], file:"kernel/common/string.rb"}, ":whitespace?":{arg:[], lines:[22, 22], doc:"Indicates, if a String is empty or a single whitespace character.
\n\n\n\n", file:"lib/string.fy"}, "to_s":{lines:[2107, 2107], file:"kernel/common/string.rb"}, "__data__":{}, "to_i":{lines:[2099, 2099], file:"kernel/common/string.rb"}, "rindex":{lines:[1304, 1304], file:"kernel/common/string.rb"}, "splice!":{lines:[2523, 2523], file:"kernel/common/string.rb"}, "is_binary_data?":{lines:[147, 147], file:"lib/yaml/rubytypes.rb"}, "size":{lines:[85, 85], file:"kernel/bootstrap/string.rb"}, "sub!":{lines:[1912, 1912], file:"kernel/common/string.rb"}, "subpattern_set":{lines:[2506, 2506], file:"kernel/common/string.rb"}, "rstrip":{lines:[1435, 1435], file:"kernel/common/string.rb"}, "replace":{lines:[1250, 1250], file:"kernel/common/string.rb"}, "lstrip":{lines:[1180, 1180], file:"kernel/common/string.rb"}, "=~":{lines:[186, 186], file:"kernel/common/string.rb"}, "downcase!":{lines:[646, 646], file:"kernel/common/string.rb"}, "num_bytes":{}, "dump":{lines:[2568, 2568], file:"kernel/common/string.rb"}, "include?":{lines:[1048, 1048], file:"kernel/common/string.rb"}, "next!":{lines:[1974, 1974], file:"kernel/common/string.rb"}, "[]=":{lines:[322, 322], file:"kernel/common/string.rb"}, "num_bytes=":{}, "==":{lines:[165, 165], file:"kernel/common/string.rb"}, "unpack":{lines:[2757, 2757], file:"kernel/common/string.rb"}, "each_line":{lines:[719, 719], file:"kernel/common/string.rb"}, "at:":{lines:[33, 33], file:"lib/rbx/string.fy"}, "upcase!":{lines:[2164, 2164], file:"kernel/common/string.rb"}, "split:":{lines:[37, 37], file:"lib/rbx/string.fy"}, "copy_from":{lines:[31, 31], file:"kernel/bootstrap/string.rb"}, "rpartition":{lines:[1397, 1397], file:"kernel/common/string.rb"}, "concat":{lines:[105, 105], file:"kernel/common/string.rb"}, "__marshal__":{lines:[69, 69], file:"kernel/common/marshal.rb"}, "crypt":{lines:[585, 585], file:"kernel/common/string.rb"}, "append":{lines:[21, 21], file:"kernel/bootstrap/string.rb"}, "casecmp":{lines:[429, 429], file:"kernel/common/string.rb"}, "empty?":{lines:[807, 807], file:"kernel/common/string.rb"}, "prefix?":{lines:[2550, 2550], file:"kernel/common/string.rb"}, ":*":{arg:["num"], lines:[38, 38], doc:"Returns a string that is the num-fold concatenation of itself.
\n\n\n\n", file:"lib/string.fy"}, "squeeze":{lines:[1787, 1787], file:"kernel/common/string.rb"}, "reverse":{lines:[1274, 1274], file:"kernel/common/string.rb"}, "tr!":{lines:[2130, 2130], file:"kernel/common/string.rb"}, ":downcase":{lines:[636, 636], file:"kernel/common/string.rb"}, "scan":{lines:[1491, 1491], file:"kernel/common/string.rb"}, "to_sexp":{lines:[19, 19], file:"lib/melbourne.rb"}, ":to_f":{lines:[9, 9], file:"kernel/bootstrap/string.rb"}, ":[]":{arg:["index"], lines:[22, 22], doc:"\"\"Given an Array of 2 Numbers, it returns the substring between the given indices.\nIf given a Number, returns the character at that index.\"\"
\n\n\n\n", file:"lib/rbx/string.fy"}, "swapcase":{lines:[2053, 2053], file:"kernel/common/string.rb"}, ":to_sexp":{lines:[56, 56], file:"lib/rbx/string.fy"}, "count":{lines:[566, 566], file:"kernel/common/string.rb"}, "subpattern":{lines:[2488, 2488], file:"kernel/common/string.rb"}, "gsub!":{lines:[951, 951], file:"kernel/common/string.rb"}, "*":{lines:[78, 78], file:"kernel/common/string.rb"}, "split":{lines:[1611, 1611], file:"kernel/common/string.rb"}, "eql?":{lines:[822, 822], file:"kernel/common/string.rb"}, "to_f":{lines:[9, 9], file:"kernel/bootstrap/string.rb"}, "lstrip!":{lines:[1190, 1190], file:"kernel/common/string.rb"}, "intern":{lines:[402, 402], file:"kernel/alpha.rb"}, "apply_and!":{lines:[2398, 2398], file:"kernel/common/string.rb"}, "index":{lines:[1069, 1069], file:"kernel/common/string.rb"}, "reverse!":{lines:[1279, 1279], file:"kernel/common/string.rb"}, "to_sub_replacement":{lines:[2271, 2271], file:"kernel/common/string.rb"}, ":==":{lines:[165, 165], file:"kernel/common/string.rb"}, "transform":{lines:[98, 98], file:"kernel/bootstrap/string.rb"}, "to_yaml":{lines:[165, 165], file:"lib/yaml/rubytypes.rb"}, "characters":{}, "chop":{lines:[535, 535], file:"kernel/common/string.rb"}, ":chomp":{lines:[476, 476], file:"kernel/common/string.rb"}, "<=>":{lines:[143, 143], file:"kernel/common/string.rb"}, "capitalize!":{lines:[413, 413], file:"kernel/common/string.rb"}, "<<":{lines:[105, 105], file:"kernel/common/string.rb"}, "[]":{lines:[243, 243], file:"kernel/common/string.rb"}, "each":{lines:[719, 719], file:"kernel/common/string.rb"}, "chop!":{lines:[542, 542], file:"kernel/common/string.rb"}, "to_inum":{lines:[2312, 2312], file:"kernel/common/string.rb"}, "taguri":{lines:[64, 64], file:"lib/yaml/tag.rb"}, "sum":{lines:[2037, 2037], file:"kernel/common/string.rb"}, "suffix?":{lines:[2556, 2556], file:"kernel/common/string.rb"}, "characters=":{}, "each_char":{lines:[660, 660], file:"kernel/common/string.rb"}, "slice":{lines:[243, 243], file:"kernel/common/string.rb"}, ":+":{lines:[92, 92], file:"kernel/common/string.rb"}, "slice!":{lines:[1548, 1548], file:"kernel/common/string.rb"}, "split_on_string":{lines:[1753, 1753], file:"kernel/common/string.rb"}, "length":{lines:[85, 85], file:"kernel/bootstrap/string.rb"}, "to_str":{lines:[2107, 2107], file:"kernel/common/string.rb"}, "shorten!":{lines:[2562, 2562], file:"kernel/common/string.rb"}, "center":{lines:[459, 459], file:"kernel/common/string.rb"}, "convert_float":{lines:[9, 9], file:"kernel/bootstrap/string.rb"}, "ljust":{lines:[1171, 1171], file:"kernel/common/string.rb"}, ":eval":{lines:[45, 45], file:"lib/rbx/string.fy"}, "+":{lines:[92, 92], file:"kernel/common/string.rb"}, "substring":{lines:[37, 37], file:"kernel/bootstrap/string.rb"}, "hex":{lines:[1038, 1038], file:"kernel/common/string.rb"}, "__data__=":{}, "compare_substring":{lines:[2403, 2403], file:"kernel/common/string.rb"}, "each_byte":{lines:[681, 681], file:"kernel/common/string.rb"}, "tr_s!":{lines:[2147, 2147], file:"kernel/common/string.rb"}, ":words":{lines:[46, 46], file:"lib/string.fy"}, "__crypt__":{lines:[16, 16], file:"kernel/bootstrap/string.rb"}, "bytesize":{lines:[85, 85], file:"kernel/bootstrap/string.rb"}, "capitalize":{lines:[393, 393], file:"kernel/common/string.rb"}, ":blank?":{arg:[], lines:[28, 28], doc:"Indicates, if a String consists only of whitespace.
\n\n\n\n", file:"lib/string.fy"}, "from:to:":{lines:[25, 25], file:"lib/rbx/string.fy"}, "initialize_copy":{lines:[1250, 1250], file:"kernel/common/string.rb"}, "downcase":{lines:[636, 636], file:"kernel/common/string.rb"}, "taguri=":{}, "bytes":{lines:[681, 681], file:"kernel/common/string.rb"}, "to_ast":{lines:[15, 15], file:"lib/melbourne.rb"}, "upto":{lines:[2183, 2183], file:"kernel/common/string.rb"}, "oct":{lines:[1240, 1240], file:"kernel/common/string.rb"}, "shared!":{lines:[2575, 2575], file:"kernel/common/string.rb"}, "upcase":{lines:[2156, 2156], file:"kernel/common/string.rb"}, "tr_expand!":{lines:[2434, 2434], file:"kernel/common/string.rb"}, "chomp!":{lines:[486, 486], file:"kernel/common/string.rb"}, "is_complex_yaml?":{lines:[143, 143], file:"lib/yaml/rubytypes.rb"}, "get_pattern":{lines:[2579, 2579], file:"kernel/common/string.rb"}, "squeeze!":{lines:[1793, 1793], file:"kernel/common/string.rb"}, "to_sym":{lines:[402, 402], file:"kernel/alpha.rb"}, ":to_i":{lines:[2099, 2099], file:"kernel/common/string.rb"}, "match":{lines:[1219, 1219], file:"kernel/common/string.rb"}, "succ!":{lines:[1974, 1974], file:"kernel/common/string.rb"}, "sub":{lines:[1864, 1864], file:"kernel/common/string.rb"}, ":++":{arg:["other"], lines:[16, 16], doc:"Concatenate the String with another String
\n\n\n\n", file:"lib/string.fy"}, "chomp":{lines:[476, 476], file:"kernel/common/string.rb"}, ":eval_global":{lines:[52, 52], file:"lib/rbx/string.fy"}}, doc:"\"\"\nStrings are sequences of characters and behave as such.\nAll literal Strings within Fancy code are instances of the String\nclass.
\n\nThey also include FancyEnumerable, which means you can use all the\ncommon sequence methods on them, like +map:+, +select:+ etc.\n\"\"
\n\n\n\n", methods:{"clone":{lines:[34, 34], file:"kernel/common/string.rb"}, "yaml_new":{lines:[150, 150], file:"lib/yaml/rubytypes.rb"}, "allocate":{lines:[17, 17], file:"kernel/common/string.rb"}, "yaml_tag_subclasses?":{lines:[null, null], file:"lib/yaml/tag.rb"}, "dup":{lines:[34, 34], file:"kernel/common/string.rb"}, "pattern":{lines:[4, 4], file:"kernel/bootstrap/string.rb"}, "from_bytearray":{lines:[29, 29], file:"kernel/common/string.rb"}, "__class_init__":{lines:[140, 140], file:"lib/yaml/rubytypes.rb"}}, ancestors:["String", "FancyEnumerable", "Object", "Enumerable", "Comparable", "Object", "Kernel"]}, "Stack":{instance_methods:{"initialize:":{arg:["size"], lines:[13, 13], doc:"Initializes a new Stack with a given size.
\n\n\n\n", file:"lib/stack.fy"}, ":initialize":{lines:[7, 7], file:"lib/stack.fy"}, ":top":{arg:[], lines:[37, 37], doc:"Returns the top-of-stack element.
\n\n\n\n", file:"lib/stack.fy"}, ":size":{arg:[], lines:[43, 43], doc:"Returns the size of the Stack.
\n\n\n\n", file:"lib/stack.fy"}, "push:":{arg:["obj"], lines:[19, 19], doc:"Pushes a value onto the Stack.
\n\n\n\n", file:"lib/stack.fy"}, ":pop":{arg:[], lines:[31, 31], doc:"Pops the top-of-stack element from the Stack and returns it.
\n\n\n\n", file:"lib/stack.fy"}, ":empty?":{arg:[], lines:[49, 49], doc:"Indicates, if the Stack is empty.
\n\n\n\n", file:"lib/stack.fy"}, ":<<":{arg:["obj"], lines:[25, 25], doc:"Same as Stack#push:.
\n\n\n\n", file:"lib/stack.fy"}}, doc:"\"\"\nA simple Stack container class.\n\"\"
\n\n\n\n", methods:{"__class_init__":{lines:[4, 4], file:"lib/stack.fy"}}, ancestors:["Stack", "Object", "Kernel"]}, "Class":{instance_methods:{"alias_method:for:":{arg:["new_method_name", "old_method_name"], lines:[105, 105], doc:"\"\"
\n\nDefines an alias method for another method.\n\"\"
\n\n \n\n", file:"lib/class.fy"}, "define_constructor_class_method:":{}, "define_slot_reader:":{arg:["slotname"], lines:[23, 23], doc:"\"\"
\n\nDefines a slot reader method with a given name.\nE.g. for a slotname count
it will define the following method:
def count {\n get_slot: 'count\n}\n
\n\n\"\"
\n\n \n\n", file:"lib/class.fy"}, "initialize":{lines:[56, 56], file:"kernel/common/class.rb"}, "subclass:":{arg:["body_block"], lines:[96, 96], doc:"\"\"
\n\nCreates a new Class
with self
as superclass and the given body.\n\"\"
\"\"
\n\nReturns an instance method for a Class
with a given name.\n\"\"
\"\"
\n\nDefines slot reader & writer methods for all given slotnames.\n\"\"
\n\n \n\n", file:"lib/class.fy"}, "instance_flags":{}, ":nested_classes":{arg:[], lines:[106, 106], doc:"\"\"
\n\nReturns all the nested classes within a Class
as an Array
.\n\"\"
\"\"
\n\nDefines a class method on a Class
(a singleton method) with a\ngiven name and body.\n\"\"
\"\"
\n\nCreates a new Class
instance by subclassing Object
.\n\"\"
\"\"
\n\nIndicates, if a Class is a subclass of another Class.\n\"\"
\n\n \n\n", file:"lib/class.fy"}, "allocate":{lines:[80, 80], file:"kernel/alpha.rb"}, "initialize_copy":{lines:[75, 75], file:"kernel/common/class.rb"}, "packed!":{lines:[18, 18], file:"kernel/bootstrap/class.rb"}, "undefine_method:":{arg:["name"], lines:[64, 64], doc:"\"\"
\n\nUndefines an instance method on a Class with a given name.\n\"\"
\n\n \n\n", file:"lib/rbx/class.fy"}, "undefine_class_method:":{arg:["name"], lines:[86, 86], doc:"\"\"
\n\nUndefines a class method on a Class
with a given name.\n\"\"
\"\"
\n\nDefines slot writer methods for all given slotnames.\n\"\"
\n\n \n\n", file:"lib/class.fy"}, "define_slot_writer:":{arg:["slotname"], lines:[39, 39], doc:"\"\"
\n\nDefines a slot writer method with a given name.\nE.g. for a slotname count
it will define the following method:
def count: c {\n set_slot: 'count value: c\n}\n
\n\n\"\"
\n\n \n\n", file:"lib/class.fy"}, "read_slots:":{arg:["slots"], lines:[48, 48], doc:"\"\"
\n\nDefines slot reader methods for all given slotnames.\n\"\"
\n\n \n\n", file:"lib/class.fy"}, "new":{lines:[92, 92], file:"kernel/alpha.rb"}, "new:":{arg:["superclass"], lines:[26, 26], doc:"\"\"
\n\nCreates a new Class
instance by subclassing superclass
.\n\"\"
\"\"
\n\nDefines an instance method on a Class
with a given name and\nbody.\n\"\"
\"\"\nRbx specific version of alias_method:for: due to bootstrap order\nreasons. Should not be used directly.\n\"\"
\n\n\n\n", file:"lib/rbx/class.fy"}, "superclass":{lines:[84, 84], file:"kernel/common/class.rb"}}, doc:"\"\"\nThis class is the class of Class
objects - e.g. Object
, Array
,\nString
etc.\nAny class in the language is an instance of this class, as in Ruby\nor Smalltalk.\n\"\"
\"\"
\n\nCreates a new Class
by subclassing superclass
and using\n\"\"
\"\"Forwardy any other message and parameters to the object itself\nand checks the return value.\"\"
\n\n\n\n", file:"lib/fancy_spec.fy"}, ":==":{lines:[180, 180], file:"lib/fancy_spec.fy"}, ":!=":{lines:[186, 186], file:"lib/fancy_spec.fy"}, "be:":{lines:[201, 201], file:"lib/fancy_spec.fy"}, "method_missing":{}}, doc:"\"\"NegativeMatcher expects its actual value to be unequal to an\nexpected value.\nIf the values are equal, a SpecTest failure is generated.\"\"
\n\n\n\n", methods:{"__class_init__":{lines:[173, 173], file:"lib/fancy_spec.fy"}}, ancestors:["FancySpec NegativeMatcher", "Object", "Kernel"]}}, objects:{}, date:"Sat Jan 15 22:40:27 -0800 2011", methods:{"System#do:":{args:["command_str"], doc:"Runs the given string as a system() command.
\n\n\n\n"}, "Fancy Package Specification#add_dependency:":{args:["name"], doc:"Forward to message add_dependency:version:
\n\n\n\n"}, "StandardError#initialize:":{args:["msg"], doc:"\"\"
\n\nCreates a new Exception with a given message.\n\"\"
\n\n \n\n"}, "String#:raise!":{args:[], doc:"Raises a new StdError with self as the message.
\n\n\n\n"}, "Object#for_options:do:":{args:["op_names", "block"], doc:"Runs a given block if any of the given options is in ARGV.
\n\n\n\n"}, "Object#for_option:do:":{args:["op_name", "block"], doc:"Runs a given block if an option is in ARGV.
\n\n\n\n"}, "System#pipe:":{args:["command_str"], doc:"\"\"\nRuns the given string as a popen() call and returns a IO handle\nthat can be read from\n\"\"
\n\n\n\n"}, "StandardError#:raise!":{args:[], doc:"\"\"\nRaises (throws) an Exception to be caught somewhere up the\ncallstack.\n\"\"
\n\n\n\n"}, "System#piperead:":{args:["command_str"], doc:"\"\"\nRuns the given string as a popen() call and returns the output\nof the call as a string.\n\"\"
\n\n\n\n"}, "System#:exit":{args:[], doc:"Exit the running Fancy process.
\n\n\n\n"}, "Fancy FDoc JSON#write:":{args:["filename"], doc:"Forward to message write:call:
\n\n\n\n"}, "Fancy Package Specification#add_ruby_dependency:":{args:["gem_name"], doc:"Forward to message add_ruby_dependency:version:
\n\n\n\n"}, "System#sleep:":{args:["n_ms"], doc:"Sets the Fancy process for a given amount of milliseconds to sleep.
\n\n\n\n"}, "StandardError#:initialize":{args:[], doc:"Creates a new Exception with an empty message.
\n\n\n\n"}}}); })();