lsd_rails 0.1

data/Packages/mootools-more/Docs/Types/Object.Extras.md

@@ -0,0 +1,134 @@
+Type: Object {#Object}
+======================
+
+A collection of Object functions.
+
+### Tutorial/Demo
+
+* [Online Tutorial/Demo][]
+
+[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/03-native/02-hash.extras
+
+
+### See Also
+
+- [Object][]
+
+
+Object Function: getFromPath {#Object:Object-getFromPath}
+-------------------------------------
+
+Returns a value of an object by its path.
+
+### Syntax
+
+	Object.getFromPath(myObject, path);
+
+### Arguments
+
+1. object - (*object*) The object to search in
+2. path - (*string*, *array*) the path to the key for the value you wish to retrieve
+
+### Returns
+
+* (*null* or *mixed*) if the path has no value, *null* is returned; otherwise the value that corresponds to the path is returned.
+
+### Example
+
+	Object.getFromPath({
+		food: {
+			fruits: {
+				apples: "red",
+				lemon: "yellow"
+			}
+		}
+	}, 'food.fruits.apples'); // 'red'
+
+	Object.getFromPath({food: {pizza: 'yum!!'}}, ['food', 'pizza']); // 'yum!!'
+
+
+Object Function: cleanValues {#Object:Object-cleanValues}
+---------------------------------------------------------
+
+Removes values from the object.
+
+### Syntax
+
+	Object.cleanValues(myObject, method);
+
+### Arguments
+
+1. object - (*object*) The original object that should be cleaned up
+1. method - (*function*) The function that each value in the Hash is passed. If it returns `true` the value is kept. Defaults to check if the value `!= null`.
+
+### Returns
+
+* (*object*) - The cleaned object
+
+### Example
+
+	Object.cleanValues({
+		foo: 'bar',
+		something: 'else',
+		missing: null
+	});
+
+	//remove all values < 0
+	Object.cleanValues({
+		a: -1,
+		b: 2,
+		c: 0,
+		d: -5
+	}, function(value){
+		if (typeOf(value) != "number") return true;
+		return value > 0;
+	});
+
+Object Function: erase {#Object:Object-erase}
+-----------------------------------------
+
+Deletes a property from the object.
+
+### Syntax
+
+	Object.erase(object, key)
+
+### Example
+
+	var alphabet = {a: 'a', b: 'b', c: 'c'};
+	Object.erase(alphabet, 'b');
+	// alphabet == {a: 'a', c: 'c'};
+
+### Returns
+
+* (*object*) - The object.
+
+Object Function: run {#Object:Object-run}
+-----------------------------------------
+
+Runs all the methods that are values of the object while passing any additional arguments passed to this function.
+
+### Syntax
+
+	Object.run(object[, arg1[, arg2[, ...]]])
+
+### Example
+
+	var initMyPage = {
+		setupNav: function(){
+			//set up the nav
+		},
+		setupSearch: function(){
+			//set up the search
+		}
+	};
+
+	window.addEvent('domready', function(){
+		Object.run(initMyPage);
+	});
+
+### Returns
+
+* (*object*) - The object.
+
+[Object]: /core/Types/Object

data/Packages/mootools-more/Docs/Types/String.Extras.md

@@ -0,0 +1,188 @@
+Type: String {#String}
+========================
+
+A collection of the String Object prototype methods.
+
+### Tutorial/Demo
+
+* [Online Tutorial/Demo][]
+
+[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/03-native/03-string.extras
+
+### See Also
+
+- [String][]
+
+
+String Method: pad {#String:pad}
+-------------------------------------
+
+Pads a string with the specified character(s) either before or after the current value.
+
+### Syntax
+
+	myString.pad(length, string, direction);
+
+### Arguments
+
+1. length - (*number*) the number of characters to pad.
+2. string - (*string*) the string to use for padding; defaults to a space.
+3. direction - (*string*) either "left", "right" or "both" (defaults to "right"); the side to add the padding.
+
+### Example
+
+	var tonyTheTigerSez = "They're gr".pad(15, 'r') + 'eat!';
+	//returns "They're grrrrrreat!"
+
+### Returns
+
+* (*string*) a string with the specified character repeated the specified number of times either to the right or left of the current value.
+
+
+String Method: repeat {#String:repeat}
+-------------------------------------
+
+Repeats a string a specified number of times.
+
+### Syntax
+
+	myString.repeat(times);
+
+### Arguments
+
+1. times - (*number*) The number of times to repeat the string.
+
+### Example
+
+	var one = "1";
+	var eleventyOne = one.repeat(3);
+	//returns "111"
+
+### Returns
+
+* (*string*) the string repeated the specified number of times.
+
+
+String Method: standardize {#String:standardize}
+-------------------------------------
+
+Removes non-ascii characters and converts them to their most appropriate ascii character.
+
+### Syntax
+
+	myString.standardize();
+
+### Example
+
+	var bjorkProper = "Björk";
+	var bjorkAscii = bjorkProper.standardize();
+	//returns "Bjork"
+
+### Returns
+
+* (*string*) a string without any non-ascii characters.
+
+String Method: getTags {#String:getTags}
+-------------------------------------
+
+Get all the HTML tags from a given string.
+
+### Syntax
+
+	myString.getTags([tag, contents]);
+
+### Arguments
+
+1. tag - (*string*; optional) if defined, returns the tags of the specified type in an array. If not defined, returns all tags in an array.
+2. contents - (*boolean*; optional) if *true*, you are returned an array of tag matches and their contents.
+
+### Example
+
+	var html = "<b>This is a string with <i>html</i> in it.</b>"
+	var tags = html.getTags();
+	//returns ["<b>", "<i>", "</i>", "</b>"]
+	var italics = html.getTags('i');
+	//returns ["<i>", "</i>"]
+	var italicsWithContent = html.getTags('i', true);
+	//returns ["<i>html</i>"]
+
+### Returns
+
+* (*array*) An array of strings for each matched tag (important note: NOT *elements*, *strings*)
+
+### Note
+
+Currently, you cannot ask for all tags with their content. If you want the inner content of tags, you must specify the tag type.
+
+
+String Method: stripTags {#String:stripTags}
+-------------------------------------
+
+Remove all html tags from a string.
+
+### Syntax
+
+	myString.stripTags([tag, contents]);
+
+### Arguments
+
+1. tag - (*string*; optional) if defined, returns the tags of the specified type in an array. If not defined, returns all tags in an array.
+2. contents - (*boolean*; optional) if *true*, you are returned an array of tag matches and their contents.
+
+### Example
+
+	var html = "<b>This is a string with <i>html</i> in it.</b>"
+	var noHtml = html.stripTags();
+	//returns "This is a string with html in it."
+	var noItalics = html.stripTags('i');
+	//returns "<b>This is a string with html in it.</b>"
+	var noItalicsContent = html.stripTags('i', true);
+	returns "<b>This is a string with  in it.</b>"
+
+### Returns
+
+* (*string*) a string with the appropriate HTML stripped
+
+String Method: tidy {#String:tidy}
+----------------------------------
+
+Replaces common special characters with their ASCII counterparts (smart quotes, elipse characters, stuff from MS Word, etc.).
+
+### Syntax
+
+	var tidyString = stringWithBadChars.tidy();
+
+### Returns
+
+* (*string*) the string with the non-ASCII characters replaced
+
+String Method: truncate {#String:truncate}
+------------------------------------------
+
+Truncates a string after the given number of characters.
+
+### Syntax
+
+	myString.truncate(max, trail, atChar);
+
+### Arguments
+
+1. max - (*number*) the maximum length of the string.
+2. trail - (*string*, optional) the trail which will be appended to the string when it is truncated, defaults to `…` when only the `max` argument is passed.
+3. atChar - (*string*, optional) a string which be truncated after. For example before a space.
+
+### Returns
+
+* (*string*) the truncated string
+
+### Examples
+
+	'This is some random text'.truncate(15); // This is some ra…
+	'This is some random text'.truncate(15, '--'); // This is some ra--
+	'This is some random text'.truncate(15, '…', ' '); // This is some…
+
+
+
+[String]: /core/Types/String
+[Array.filter]: /core/Types/Array#Array:filter
+[encodeURIComponent]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Functions:encodeURIComponent

data/Packages/mootools-more/Docs/Types/String.QueryString.md

@@ -0,0 +1,56 @@
+Type: String {#String}
+========================
+
+A collection of the String Object prototype methods.
+
+String Method: parseQueryString {#String:parseQueryString}
+----------------------------------------------------------
+
+Turns a querystring into an object of key/value pairs.
+
+### Syntax
+
+	myString.parseQueryString(decodeKeys, decodeValues);
+
+### Arguments
+
+1. decodeKeys - (*boolean*, optional) if set to *false*, keys are passed through [decodeURIComponent][]; defaults to *true*
+1. decodeValues - (*boolean*, optional) if set to *false*, values are passed through [decodeURIComponent][]; defaults to *true*
+
+### Example
+
+	"apple=red&lemon=yellow".parseQueryString();
+	//returns { apple: "red", lemon: "yellow }
+	var fruits = "apple=red&lemon=yellow".parseQueryString();
+	//returns fruits.apple > "red"
+
+### Returns
+
+* (*object*) the querystring as key/value pairs
+
+String Method: cleanQueryString {#String:cleanQueryString}
+----------------------------------------------------------
+
+Removes from a query string any keys that have empty values.
+
+### Syntax
+
+	myQueryString.cleanQueryString([method]);
+
+### Arguments
+
+1. method - (*funciton*, optional) a method passed to [Array.filter][] that returns true if a key/value set should be included. Defaults to a method that checks that the value is not an empty string.
+
+### Example
+
+	var cleaned = "a=b&x=&z=123&e=".cleanQueryString();
+	//cleaned = "a=b&z=123"
+	var noNumberValues = "a=b&x=y&z=123&e=".cleanQueryString(function(set){
+		//set is "a=b", "x=y", "z=123", "e="
+		return !set.split("=")[1].match(/[0-9]/);
+	});
+	//noNumberValues = "a=b&x=y&e="
+
+### Returns
+
+* (*string*) the string appropriate key/values removed

data/Packages/mootools-more/Docs/Types/URI.Relative.md

@@ -0,0 +1,46 @@
+Type: URI {#URI}
+==================
+
+Extends the [URI][] class to add methods for computing relative and absolute urls.
+
+URI Method: toAbsolute {#URI:toAbsolute}
+----------------------------------------
+
+Returns the absolute path for a given url (i.e. a path beginning with '/'). If a different schemes or hosts are used, it returns the full url.
+
+### Syntax
+
+	myURI.toAbsolute([base]);
+
+### Arguments
+
+1. base - (*mixed*, optional) - either an instance of *URI* or a *string* (which will be passed to *URI*) that contains the base location for the path.
+
+### Returns
+
+* *string* - the absolute path beginning with '/'.
+
+URI Method: toRelative {#URI:toRelative}
+----------------------------------------
+
+Returns the relative path for a given url (i.e. a path that might include '../' for example). If a different schemes or hosts are used, it returns the full url.
+
+### Syntax
+
+	myURI.toRelative([base]);
+
+### Arguments
+
+1. base - (*mixed*, optional) - either an instance of *URI* or a *string* (which will be passed to *URI*) that contains a location that is relative to *myURI*.
+
+### Example
+
+	var uri1 = new URI('http://www.test.com/this/is/a/path.html');
+	var uri2 = new URI('http://www.test.com/this/is/an/adjacent/path.html')
+	uri1.toRelative(uri2); //returns "../../a/path.html"
+
+### Returns
+
+* *string* - the relative path.
+
+[URI]: /more/Types/URI

data/Packages/mootools-more/Docs/Types/URI.md

@@ -0,0 +1,213 @@
+Type: URI {#URI}
+==================
+
+Provides numerous methods useful for managing URIs.
+
+URI Method: constructor
+-----------------------
+
+Pass a *string* to the URI subclass and it will extend it, returning a new string-like object with new methods useful for managing that URI.
+
+### Syntax
+
+	new URI([strURI, options]);
+
+### Arguments
+
+1. strURI - (*string*) the URI to parse into the class.
+2. options - (*object*) a key/value set of options.
+
+### Options
+
+* base - (*mixed*) A base href for the URI (defaults to the document base location). Can be a *string* or an instance of *URI*. This is used to interpret relative urls (for instance if you were to call *new URI('/foo/bar.html')* the class will infer that this path is relative to the current document base location).
+
+### Example
+
+	var myURI = new URI('http://user:password@www.test.com:8383/the/path.html?query=value#anchor');
+
+### Returns
+
+* *URI* - (*string*; optional) - an instance of the URI class that has new methods useful for managing the URI. If not declared the window's current base location is used.
+
+URI Method: toString {#URI:toString}
+------------------------------------------
+
+Returns the URI as a *string*.
+
+### Syntax
+
+	myURI.toString(); //"http://www.test.com...etc"
+
+### Returns
+
+* (*string*) the unaltered url.
+
+URI Method: set {#URI:set}
+--------------------------
+
+Set's a portion of the URI to the specified value.
+
+### Syntax
+
+	myURI.set(part, value);
+
+### Arguments
+
+1. type - (*string*, optional) url with a query string to parse; defaults to *window.location*
+
+### Example
+
+	myURI.set('scheme', 'https');
+	myURI.set('host', 'www.foo.com');
+	//etc.
+
+### Returns
+
+* (*URI*) This instance of *URI*.
+
+### Valid parts
+
+* scheme - (*string*) 'http', 'https', 'ftp', etc.
+* user - (*string*) the username portion of the credentials
+* password - (*string*) the password portion of the credentials
+* host - (*string*) 'www.example.com', 'example.com', 'subdomain.example.com', etc.
+* port - (*string* or *number*) 80, 8080, etc.
+* directory - (*string*) '/directory/'
+* file - (*string*) 'file.html'
+* query - (*string*) 'foo=bar&something=else' (the *?* is added for you)
+* fragment - (*string*)  'anAnchor' (the *#* is added for you)
+* data - (*object*) an object of key/value pairs to set the query to (*{foo: 'bar', something: 'else'}*)
+
+URI Method: get {#URI:get}
+--------------------------
+
+Returns the current value for the specified portion of the URI.
+
+### Syntax
+
+	myURI.get(part);
+
+### Example
+
+	myURI.get('scheme'); //returns "http", for example
+	myURI.get('host'); //returns "www.example.com", for example
+
+### Returns
+
+* *mixed* - usually returns a *string*, but in the case of 'data' returns an *object*.
+
+### Valid parts
+
+* scheme - (returns *string*) 'http', 'https', 'ftp', etc.
+* user - (*string*) the username portion of the credentials
+* password - (*string*) the password portion of the credentials
+* host - (returns *string*) 'www.example.com', 'example.com', 'subdomain.example.com', etc.
+* port - (returns *string*) 80, 8080, etc.
+* directory - (returns *string*) '/directory/'
+* file - (returns *string*) 'file.html'
+* query - (returns *string*) 'foo=bar&something=else' (the *?* is added for you)
+* fragment - (returns *string*)  'anAnchor' (the *#* is added for you)
+* data - (returns *object*) an *object* of key/value pairs to set the query to (*{foo: 'bar', something: 'else'}*)
+
+URI Method: setData {#URI:setData}
+------------------------------------------
+
+Sets the query string from an *object* (much like *myURI.set('data', obj)*) but also allows merging.
+
+### Syntax
+
+	myURI.setData(data[, merge, part]);
+
+
+### Arguments
+
+1. object - (*object*) the key/values you want to set for the query string
+2. merge - (*boolean*, optional) if *true* the values will be merged with the existing query string. Defaults to *false*.
+3. part - (*string*, optional) this defaults to 'query' for setting query string data to the URI, but you could, for example specify 'fragment' to assign query string data to the '#...' portion of the URI (which is useful in ajax applications that wish to store state in the URI without reloading the document).
+
+### Alternate Syntax
+
+	myURI.setData(key, value);
+
+### Alternate Syntax Arguments
+
+1. key - (*string*) the key of the data which you wish to assign
+2. value - (*string* or *number*) the value you wish to assign
+
+### Returns
+
+* (*URI*) this instance of *URI*
+
+### Example
+
+	myURI.setData(myObject); //same as myURI.set('data', myObject);
+	myURI.setData(myObject, true); //merges myObject w/ existing query values
+	myURI.setData('foo', 'bar'); //sets foo=bar in the query string
+	myURI.setData({foo: 'bar'}, false, 'fragment'); //adds #foo=bar to the url fragment
+
+
+URI Method: getData {#URI:getData}
+----------------------------------
+
+Returns the query string values as an *object*. Same as *URI.get('data')*.
+
+### Syntax
+
+	myURI.getData([key, part]);
+
+### Arguments
+
+1. key - (*string*; optional) If specified, returns the value for the given key.
+2. part - (*string*; optional) If specified, returns the data from the given part (defaults to 'query'). This is useful if you choose to store data in the fragment (the '#...' part of the URI) which is useful in ajax applications that wish to store state in the URI without reloading the document.
+
+### Returns
+
+* *mixed* - the *string* value for the given key; if key is not specified, returns an *object* for all the query string values.
+
+URI Method: clearData {#URI:clearData}
+--------------------------------------
+
+Clears the query string values entirely.
+
+### Syntax
+
+	myURI.clearData();
+
+URI Method: go {#URI:go}
+------------------------
+
+Loads the url into the document location.
+
+### Syntax
+
+	myURI.go();
+
+URI Method: toURI {#URI:toURI}
+------------------------
+
+Returns the current instance of *URI*. Useful when a parameter type is known to be either string or URI.
+
+### Example
+
+	// Accepts either a string or URI instance
+	function(uri){
+		this.filename = uri.toURI().get('file');
+	}
+
+Type: String {#String}
+========================
+
+Adds a method to instantiate a *URI* instance from a string.
+
+String Method: toURI {#String:toURI}
+------------------------------------
+
+Returns a *URI* instance.
+
+### Syntax
+
+	"http://www.domain.com/etc".toURI()
+
+### Returns
+
+* an instance of URI