lsd_rails 0.1

data/Packages/mootools-more/Docs/Element/Element.Shortcuts.md

@@ -0,0 +1,121 @@
+Type: Element {#Element}
+==========================
+
+Extends the [Element][] Type with some basic shortcuts (like .hide and .show).
+
+### Tutorial/Demo
+
+* [Online Tutorial/Demo](http://www.clientcide.com/wiki/cnet-libraries/04-element/05-element.shortcuts)
+
+Element Method: isDisplayed {#Element:isDisplayed}
+----------------------------------------------
+
+Returns the state of the display of the element.
+
+### Syntax
+
+	myElement.isDisplayed();
+
+### Returns
+
+* (*boolean*) true if display != "none", false if display == "none".
+
+Element Method: isVisible {#Element:isVisible}
+----------------------------------------------
+
+Determines if an element is displayed using offset height/width. If both of these are zero it usually means the element is not displayed or one of its parent's is not.
+
+### Syntax
+
+	myElement.isVisible();
+
+### Returns
+
+* (*boolean*) true if visible, false if not visible.
+
+Element Method: toggle {#Element:toggle}
+----------------------------------------
+
+Toggles the state of an element from hidden (display = none) to visible (display = what it was previously or else display = block)
+
+### Syntax
+
+	myElement.toggle();
+
+### Returns
+
+* (*element*) This Element.
+
+Element Method: hide {#Element:hide}
+------------------------------------
+
+Hides an element (display = none).
+
+### Example
+
+	myElement.hide(); //same as $(id).setStyle('display', 'none');
+
+### Returns
+
+* (*element*) This Element.
+
+Element Method: show {#Element:show}
+------------------------------------
+
+Shows an element.
+
+### Syntax
+
+	myElement.show(displayString);
+
+### Arguments
+
+1. displayString - (*string*) Display value; defaults to what it was previously if [Element:hide][] was called on the element, otherwise defaults to "block".
+
+### Returns
+
+* (*element*) This Element.
+
+### Example
+
+	$(id).show(); //same as $(id).setStyle('display', 'block');
+	$(id).show('inline'); //same as $(id).setStyle('display','inline');
+
+Element Method: swapClass {#Element:swapClass}
+----------------------------------------------
+
+Removes one class and adds the other. If the one to remove is not found the one to add is still added.
+
+### Syntax
+
+	myElement.swapClass(removeClass, addClass);
+
+### Arguments
+
+1. removeClass - (*string*) the css class to remove.
+2. addClass - (*string*) the css class to add.
+
+### Returns
+
+* (*element*) This Element.
+
+### Example
+
+	$(id).swapClass('green', 'blue'); // removes green, adds blue
+
+
+Static Method: document.clearSelection {#document:clearSelection}
+----------------------------------------------
+
+Removes any document selection (text selection). **Can only be called on document**.
+
+### Syntax
+
+	document.clearSelection();
+
+### Returns
+
+* nothing
+
+[Element:hide]: #Element:hide
+[Element]: /core/Element/Element

data/Packages/mootools-more/Docs/Element/Elements.From.md

@@ -0,0 +1,32 @@
+Type: Elements {#Elements}
+==========================
+
+Extends the [Elements][] object to add a function that returns a collection of elements from a string of html.
+
+Function: Elements.from {#Elements:Elements-from}
+----------------------------------------------
+
+Returns a collection of elements from a string of html.
+
+### Syntax
+
+	Elements.from(str, excludeScripts);
+
+### Arguments
+
+1. str - (*string*) an html string.
+2. excludeScripts - (*boolean*) if *true*, the default, scripts are not included in the element collection returned.
+
+### Example
+
+	var els = Elements.from("<p>this is a <i>string</i> of <b>HTML</b>.</p><p>It has two paragraphs.</p>");
+	els.each(function(paragraph){
+		console.log(paragraph); //logs each paragraph
+	});
+	els.inject(document.body); //injects both paragraphs into the document body
+
+### Returns
+
+* (*array*) an array of elements (i.e. a collection) - an instance of [Elements][].
+
+[Elements]: /core/Element/Element#Elements

data/Packages/mootools-more/Docs/Forms/Form.Request.Append.md

@@ -0,0 +1,36 @@
+Class: Form.Request.Append {#Form-Request-Append}
+=======================================
+
+Updates a DOM element with the response from the submission of a form (via Ajax). The result is appended to the DOM element instead of replacing its contents.
+
+### Extends
+
+- [Form.Request][]
+
+Form.Request.Append Method: constructor {#Form-Request-Append:constructor}
+--------------------------------------------------
+
+### Syntax
+
+	new Form.Request.Append(form, update[, options]);
+
+### Arguments
+
+* The same as [Form.Request][]
+
+### Options
+
+* The same as [Form.Request][] in addition to:
+* useReveal - (*boolean*) Use [Fx.Reveal][] to transition the result in to the appended DOM element; defaults to *true*.
+* revealOptions - (*object*) Options passed along to [Fx.Reveal][].
+* inject - (*string*) The injection location for the returned content (see [Element.inject][]) into the *update* element specified in the arguments; defaults to 'bottom'.
+
+
+### Events
+
+* beforeEffect - (*function*) callback executed before the new element begins its reveal; passed as arguments the container that is revealing.
+* success - (*function*) callback executed after the new element is visible. Passed container of the new content, the container into which it is injected, and (passed along from Request.HTML's onSuccess method) the response tree, the response elements, the response html, and the response javascript
+
+[Form.Request]: /more/Forms/Form.Request
+[Fx.Reveal]: /more/Fx/Fx.Reveal
+[Element.inject]: /core/Element/Element#Element:inject

data/Packages/mootools-more/Docs/Forms/Form.Request.md

@@ -0,0 +1,141 @@
+Class: Form.Request {#Form-Request}
+===================================
+
+Updates a DOM element with the response from the submission of a form (via Ajax).
+
+### Demo
+
+* [Enhanced Form](http://mootools.net/demos/?demo=Enhanced-Form)
+
+
+### Implements
+
+- [Options][], [Events][], [Class.Occlude][]
+
+Form.Request Method: constructor {#Form-Request:constructor}
+--------------------------------------------------
+
+### Syntax
+
+	new Form.Request(form, update[, options]);
+
+### Arguments
+
+1. form  - (*mixed*) A form Element or the string id of a form Element to manage submissions.
+2. update - (*mixed*) An Element or the string id of an Element to update with the response.
+3. options - (*object*, optional) The options object described below:
+
+### Options
+
+* requestOptions - (*object*) The options passed on to the instance of [Request.HTML] created by the class that sends the form. Defaults to *{evalScripts: true, useSpinner: true, url: <the form url>, emulation: false, spinnerTarget: <the update argument>}*.
+* extraData - (*object*) An optional set of key/value pairs to be included with the form data submitted to the server. If keys in this collide with data in the form, the form values will be preserved and the *extraData* discarded.
+* resetForm - (*boolean*) If *true* (the default), the form is reset when the request is sent.
+
+### Events
+
+* send - (*function*) The function to execute when the request is sent. Passed the form being submitted and the data (an *object*) being submitted.
+* failure - (*function*) The function to execute when the request fails. Passed the XHR that is returned by *Request* on failure.
+* success - (*function*) The function to execute when the request succeeds. Passed the target being updated, the request text, and the request xml.
+
+Form.Request and Form.Validator {#Form-Request:Form-Validator}
+-------------------------------------------------
+
+*Form.Request* integrates with [Form.Validator][] to prevent the ajax being sent if the validation fails. It retrieves the *Form.Validator* instance from the form, so all that is required is that you instantiate the *Form.Validator* before you instantiate the instance of *Fudpate*. If the instance of *Form.Validator* has the *stopOnFailure* option set to *true* (the default) then *Form.Request* will not send the ajax request if the validator fails.
+
+Form.Request Method: setTarget {#Form-Request:setTarget}
+--------------------------------------
+
+Changes the target that the instance will update with the Request response.
+
+### Syntax
+
+	myFormRequest.setTarget(newTarget);
+
+### Arguments
+
+1. newTarget - (*mixed*) An Element or the string id of an Element to update with the response.
+
+### Returns
+
+* (*object*) - This instance of [Form.Request][]
+
+Form.Request Method: send {#Form-Request:send}
+--------------------------------------
+
+Sends the form.
+
+### Syntax
+
+	myFormRequest.send();
+
+### Returns
+
+* (*object*) - This instance of [Form.Request][]
+
+Form.Request Method: disable {#Form-Request:disable}
+--------------------------------------
+
+Detaches the Form.Request from the form (disabling the ajax).
+
+### Syntax
+
+	myFormRequest.disable();
+
+### Returns
+
+* (*object*) - This instance of [Form.Request][]
+
+Form.Request Method: enable {#Form-Request:enable}
+--------------------------------------
+
+Attaches the Form.Request to the form (enabling the ajax). Note that this is done on instantiation, so you only need to use this method if you disable the [Form.Request][] instance and want to re-enable it.
+
+### Syntax
+
+	myFormRequest.enable();
+
+### Returns
+
+* (*object*) - This instance of [Form.Request][]
+
+Type: Element {#Element}
+==========================
+
+Extends the [Element][] Type with a reference to its [Form.Request][] instance and a method to create one.
+
+Element Method: formRequest {#Element:formRequest}
+-------------------------------------
+
+Creates a new instance of [Form.Request][] and calls its *send* method.
+
+### Syntax
+
+	$(element).formRequest(update, options);
+
+### Arguments
+
+* update - (*mixed*) An Element or the string id of an Element to update with the response.
+* options - (*object*) a key/value set of options. See [Form.Request:options][].
+
+### Returns
+
+* (*element*) This Element.
+
+### Example
+
+	$(element).formRequest($('myDiv'), { requestOptions: {useSpinner: false } });
+
+Element property: form.request {#Element:form.request}
+------------------------------------------------
+
+### Syntax
+
+	myForm.retrieve('form.request'); //the instance of Form.Request for the element
+
+[Chain]: /core/Class/Class.Extras#Chain
+[Events]: /core/Class/Class.Extras#Events
+[Options]: /core/Class/Class.Extras#Options
+[Class.Occlude]: /more/Class/Class.Occlude
+[Form.Request]: #Form-Request
+[Form.Validator]: /more/Forms/Form.Validator#Form-Validator
+[Element]: /core/Type/Element

data/Packages/mootools-more/Docs/Forms/Form.Validator.Extras.md

@@ -0,0 +1,157 @@
+Additional InputValidators: {#Validators}
+=======================================
+
+### Tutorial/Demo
+
+Here are the validators that are included in this libary. Add the name to any input's data-validators property and then create a new [Form.Validator][] and these will automatically be applied.
+
+Validator: validate-nospace {#Validators:validate-nospace}
+----------------------------------------------------------
+
+Enforces that there are no spaces in the input value.
+
+Validator: validate-enforce-oncheck {#Validators:validate-enforce-oncheck}
+--------------------------------------------------------------------------
+
+When added to a checkbox/radio button, and a list (*array*) of element id's can be passed in (*toEnforce*) to enforce validation on those fields.
+
+### Example
+
+	<input type="checkbox" class="validate-enforce-oncheck toEnforce:['name','email','phone']"/>
+	//when checked, the inputs with the ids 'name', 'email', and 'phone' will also be validated on change/submit
+
+	<input type="checkbox" class="validate-enforce-oncheck enforceChildrenOf:'someParent'"/>
+	//when checked, all inputs inside $('someParent') will be validated on change/submit
+
+Validator: validate-ignore-oncheck {#Validators:validate-ignore-oncheck}
+------------------------------------------------------------------------
+
+When added to a checkbox/radio button, and a list (*array*) of element id's can be passed in (*toIgnore*) in the *validatorProps* to ignore validation on those fields.
+
+### Example
+
+	<input type="checkbox" class="validate-ignore-oncheck toIgnore:['name','email','phone']"/>
+	//when checked, the inputs with the ids 'name', 'email', and 'phone' will NOT be validated on change/submit
+
+	<input type="checkbox" class="validate-ignore-oncheck ignoreChildrenOf:'someParent'"/>
+	//when checked, all inputs inside $('someParent') will NOT be validated on change/submit
+
+
+
+Validator: validate-toggle-oncheck {#Validators:validate-toggle-oncheck}
+--------------------------------------------------------
+
+When the input is checked or un-checked, the inputs defined will be toggled from ignore (if the input is un-checked) to enforce (if it is checked).
+
+### Example
+
+	<input type="checkbox" class="validate-toggle-oncheck toToggle:['name','email','phone']"/>
+	//when checked, the inputs with the ids 'name', 'email', and 'phone' will be validated on change/submit
+	//when unchecked, they will be ignored
+
+	<input type="checkbox" class="validate-toggle-oncheck toToggleChildrenOf:'someParent'"/>
+	//when checked, all inputs inside $('someParent') will be validated on change/submit
+	//when unchecked, they will be ignored
+
+Validator: validate-required-check {#Validators:validate-required-check}
+-----------------------------------------------------
+
+Forces the user to check a checkbox (thing agreeing to terms and conditions).
+
+Validator: validate-reqchk-bynode {#Validators:validate-reqchk-bynode}
+----------------------------------------------------
+
+At least one checkbox/radio is required to be checked in this node. *nodeId* needs to be passed to the *validatorProps*.
+
+### Example
+
+	<input type="checkbox" class="validate-reqchk-bynode nodeId:'someParent'"/>
+
+	//you can also specify a selector for the parent
+	<input type="checkbox" class="validate-reqchk-bynode nodeId:'someParent' selector:'input.foo[type=checkbox]'"/>
+
+Validator: validate-reqchk-byname {#Validators:validate-reqchk-byname}
+----------------------------------------------------
+
+At least one checkbox/radio is required to be checked in this name group. You can specify an optional label that completes the error message: "Please select a *label*." - it defaults to either "checkbox" or "radio" - the type of the input. By default it uses the name of the input to find all inputs with the same name but you can specify the optional *validatorProps* name *groupName* if you prefer.
+
+### Example
+
+	<input type="checkbox" class="validate-reqchk-byname label: 'flavor'" name="favoriteFlavor"/>
+
+Validator: validate-after-date {#Validator:validate-after-date}
+-----------------------------------------
+
+Takes in the id of a start field id and compares it to make sure the given value is later than or equal to the start date. If no other input is specified it uses the current time. The other *validatorProps* option is *afterLabel* which completes the sentence "The date should be the same or after *label*." If you do not specify an *afterLabel*, either "the current time" or "the start date" is used (the latter is used if *afterElement* is specified);
+
+### Example
+
+	<input type="text" name="endDate" class="validate-after-date afterElement:'startDate'"/>
+	//if you don't include afterElement the current time is used
+
+Validator: validate-before-date {#Validator:validate-before-date}
+-----------------------------------------
+
+Takes in the id of a end field id and compares it to make sure the given value is before or equal to the end date. If no other input is specified it uses the current time. The other *validatorProps* option is *beforeLabel* which completes the sentence "The date should be the same or before *label*." If you do not specify an *beforeLabel*, either "the current time" or "the end date" is used (the latter is used if *beforeElement* is specified);
+
+### Example
+
+	<input type="text" name="startDate" class="validate-before-date beforeElement:'endDate'"/>
+	//if you don't include beforeElement the current time is used
+
+Validator: validate-custom-required {#Validators:validate-custom-required}
+--------------------------------------------------------
+Required field with an option to define what an empty value is. For example, if you have a list months in a drop down list and first option is "select month" has a value of 'null', you can define a custom-required with emptyValue='null', so it's treated as an empty value.
+
+### Example
+
+	<select class="validate-custom-required emptyValue:'null'">
+		<option value="null">Select One</option>
+		...etc.
+	</select>
+
+Validator: validate-same-month {#Validators:validate-same-month}
+--------------------------------------------------------
+
+Takes another input's id and makes sure both ranges are within the same month. Pass in the *sameMonthAs* value in the *validatorProps* as the id of the form to compare to.
+
+### Example
+
+	<input class="validate-same-month sameMonthAs:'startDate'"/>
+
+Validator: validate-match {#Validators:validate-match}
+--------------------------------------------------------
+
+Takes in an id of a field and matches them together. Can also take *matchName* that is used in the error message (i.e.: password confirmations). *matchName* defaults to the name of the other field, which isn't always very helpful, so you should specify it.
+
+	<input type="input" class="validate-match matchInput:'password' matchName:'password'"/>
+	//error msg: This field needs to match the password field.
+
+Validator: validate-cc-num {#Validators:validate-cc-num}
+--------------------------------------------------------
+
+Validates that an input is a valid credit card number (Visa, MasterCard, Amex, Discover). Note that it replaces all non-numeric characters to the value (but not to the input's displayed value) before it applies validation, so the user could put in dashes, letters, punctuation, whatever, but if the numbers in the value without those things makes a valid CC number, it will pass.
+
+	<input type="input" class="validate-cc-num"/>
+
+Form.Validator.Extras Language Localization {#Localization}
+==========================================
+
+*Form.Validator.Extras.js* includes the following key/values for localization.
+
+* noSpace - (*string*) 'There can be no spaces in this input.'
+* reqChkByNode - (*string*) 'No items are selected.'
+* requiredChk - (*string*) 'This field is required.'
+* reqChkByName - (*string*) 'Please select a {label}.'
+* match - (*string*) 'This field needs to match the {matchName} field' where *matchName* is the name of another field
+* startDate - (*string*)  'the start date'
+* endDate - (*string*)  'the end date'
+* currentDate - (*string*)  'the current date'
+* afterDate - (*string*)  'The date should be the same or after {label}.' where *label* is the name of another date field
+* beforeDate - (*string*)  'The date should be the same or before {label}.' where *label* is the name of another date field
+* startMonth - (*string*)  'Please select a start month'
+* sameMonth - (*string*)  'These two dates must be in the same month - you must change one or the other.'
+* creditcard - (*string*) 'The credit card number entered is invalid. Please check the number and try again. {length} digits entered.' where *length* is the number of integers entered.
+
+
+[Form.Validator]: /more/Forms/Form.Validator#Form-Validator

data/Packages/mootools-more/Docs/Forms/Form.Validator.Inline.md

@@ -0,0 +1,100 @@
+Class: Form.Validator.Inline {#Form-Validator-Inline}
+====================================
+
+Evaluates an entire form against all the validators that are set up *displaying messages* in-line in the page.
+
+### Extends
+
+* [Form.Validator][]
+
+### Implements
+
+* [Options][], [Events][]
+
+
+Form.Validator.Inline Method: Constructor
+------------------------------------------
+
+### Syntax
+
+	new Form.Validator.Inline(form[, options]);
+
+### Arguments
+
+1. form - (*mixed*) A string of the id for an Element or an Element reference of the form to evaluate
+2. options - (*object*) a key/value set of options
+
+### Options
+
+* all the options defined for [Form.Validator][], plus
+* scrollToErrorsOnSubmit - (*boolean*) if *true* (the default), when the user submits the form the window (or overflown parent) will scroll up to that element so it is in view. Will use [Fx.Scroll][] if it's available, otherwise it will jump to the element.
+* scrollToErrorsOnBlur - (*boolean*) Defaults false, however if true blur events will be attached to inputs, triggering a scroll to relevant errored field.
+* scrollToErrorsOnChange - (*boolean*) Defaults false, however if true change events will be attached to inputs, triggering a scroll to the relevant errored field.
+* scrollFxOptions - (*object*) options for [Fx.Scroll][] if it's available; used for scrolling to errors if *scrollToErrorsOnSubmit* is *true*.
+* showError - (*function*) the function used to show messages. Passed the message element which is injected into the document already and needs to have its display set to *block*. By default, this method uses [Fx.Reveal][] to smoothly show the message (if it is loaded), otherwise it just sets the display style to block.
+* hideError - (*function*) the function used to hide messages. Works exactly like the *showAdvice* option above, but instead is meant to hide the message. Uses [Fx.Reveal][] if possible, otherwise sets display to *none*.
+
+### Events
+
+* all the events defined for [Form.Validator][], plus
+* onShowAdvice - (*function*) callback executed when advice is shown. Passed three arguments: an Element reference for the input being validated, an Element reference to the advice element, and the failed validator's name.
+* onHideAdvice - (*function*) callback exectued when advice is shown. Passed three arguments: an Element reference for the input being validated, an Element reference to the advice element, and the failed validator's name.
+
+### Note
+
+* You can define a data-validators value called *msgPos* as the id of an element into which the validation errors for that input will be inserted. Example:
+
+		<input data-validators="validate-email msgPos:'emailAdvice'">
+		<div id="emailAdvice"></div>
+
+Form.Validator.Inline method: getAllAdviceMessages {#Form-Validator-Inline:getAllAdviceMessages}
+----------------------------------------------------------------------
+
+Returns all the messages that an input can produce, regardless of the user input.
+
+### Syntax
+
+	myFormValidator.getAllAdviceMessages(field[, force]);
+
+### Arguments
+
+1. field - (*mixed*) A string of the id for an Element or an Element reference of the input
+2. force - (*boolean*; optional) if *false*, no messages are returned if the input has the string 'ignoreValidation' in its *data-validators* property
+
+### Returns
+
+* (*object*) An object containing information about the message. See example:
+
+		{
+			message: string, //The message the user would see
+			warnOnly: boolean, //true if this should just be a warning
+			passed: boolean, //true if the current value passes validation
+			validator: validator //the InputValidator instance
+		}
+
+Form.Validator method: getAdvice {#Form-Validator-Inline:getAdvice}
+----------------------------------------------------------------------
+
+Retrieves the advice message for a field and a given validator name.
+
+### Syntax
+
+	myFormValidator.getAdvice(field, validatorName);
+
+### Example
+
+	myFormValidator.getAdvice(myInput, 'validate-email');
+
+### Arguments
+
+1. field - (*mixed*) A string of the id for an Element or an Element reference of the input.
+2. validatorName - (*string*) A string that represents the validator's name as it was added to [Form.Validator][].
+
+### Returns
+
+* (*element*) A DOM element containing the message for the user.
+
+[Form.Validator]: /more/Forms/Form.Validator
+[Options]: /core/Class/Class.Extras#Options
+[Events]: /core/Class/Class.Extras#Events
+[Fx.Scroll]: /more/Fx/Fx.Scroll