upjs-rails 0.1.0 → 0.2.0

data/doc/theme/partials/method.handlebars

@@ -0,0 +1,201 @@
+<div id="method_{{name}}" class="method item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
+  <h3 class="blue-method-name">{{name}}</h3>
+
+  <div class="meta method-meta">
+    {{#if overwritten_from}}
+    <p>Inherited from
+      <a href="{{crossLinkRaw overwritten_from/class}}#method_{{overwritten_from/name}}">
+        {{overwritten_from/class}}
+      </a>
+      {{#if foundAt}}
+        but overwritten in
+      {{/if}}
+    {{else}}
+      {{#if extended_from}}
+      <p>Inherited from
+        <a href="{{crossLinkRaw extended_from}}#method_{{name}}">{{extended_from}}</a>:
+      {{else}}
+        {{#providedBy}}
+          <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
+        {{/providedBy}}
+      <p>
+        {{#if foundAt}}
+          Defined in
+        {{/if}}
+      {{/if}}
+    {{/if}}
+    {{#if foundAt}}
+      <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
+    {{/if}}
+  </p>
+
+
+    {{#if deprecationMessage}}
+      <p>Deprecated: {{deprecationMessage}}</p>
+    {{/if}}
+
+    {{#if since}}
+      <p>Available since {{since}}</p>
+    {{/if}}
+  </div>
+
+  <h3>Syntax</h3>
+  <div class="blue-method-syntax">
+  <h3 class="name"><code>{{name}}</code></h3>
+
+    {{#if params}}
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+            {{#params}}
+                <li class="arg">
+                    {{#if optional}}
+                        <code class="optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
+                    {{else}}
+                        <code>{{name}}</code>
+                    {{/if}}
+                </li>
+            {{/params}}
+            </ul><span class="paren">)</span>
+        </div>
+    {{else}}
+        <span class="paren">()</span>
+    {{/if}}
+
+    {{#if return}}
+        <span class="returns-inline">
+            <span class="type">{{#crossLink returnType}}{{/crossLink}}</span>
+        </span>
+    {{/if}}
+
+    {{#if deprecated}}
+        <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
+    {{/if}}
+
+    {{#if access}}
+        <span class="flag {{access}}">{{access}}</span>
+    {{/if}}
+
+    {{#if final}}
+        <span class="flag final">final</span>
+    {{/if}}
+
+    {{#if static}}
+        <span class="flag static">static</span>
+    {{/if}}
+
+    {{#if chainable}}
+        <span class="flag chainable">chainable</span>
+    {{/if}}
+
+    {{#if async}}
+        <span class="flag async">async</span>
+    {{/if}}
+
+  </div>
+    <div class="description">
+      <h3>Summary</h3>
+        {{{methodDescription}}}
+    </div>
+
+    {{#if params}}
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+            {{#params}}
+                <li class="param">
+                    {{#if optional}}
+                        <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
+                        <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+                    {{else}}
+                        <code class="param-name">{{name}}</code>
+                        <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                    {{/if}}
+
+                    {{#if multiple}}
+                        <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+                    {{/if}}
+
+                    <div class="param-description">
+                        {{{description}}}
+                    </div>
+
+                    {{#if props}}
+                        <ul class="params-list">
+                            {{#props}}
+                            <li class="param">
+                                {{#if optional}}
+                                    <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
+                                    <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                                    <span class="flag optional" title="This parameter is optional.">optional</span>
+                                {{else}}
+                                    <code class="param-name">{{name}}</code>
+                                    <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                                {{/if}}
+
+                                <div class="param-description">
+                                    {{{description}}}
+                                </div>
+
+                                {{#if props}}
+                                    <ul class="params-list">
+                                        {{#props}}
+                                        <li class="param">
+                                            {{#if optional}}
+                                                <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
+                                                <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                                                <span class="flag optional" title="This parameter is optional.">optional</span>
+                                            {{else}}
+                                                <code class="param-name">{{name}}</code>
+                                                <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                                            {{/if}}
+
+                                            <div class="param-description">
+                                                {{{description}}}
+                                            </div>
+                                        </li>
+                                        {{/props}}
+                                    </ul>
+                                {{/if}}
+                            </li>
+                            {{/props}}
+                        </ul>
+                    {{/if}}
+                </li>
+            {{/params}}
+            </ul>
+        </div>
+    {{/if}}
+
+    {{#return}}
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+              {{#if type}}
+                <span class="type">{{#crossLink type}}{{/crossLink}}</span>:
+              {{/if}}
+              {{#if description}}
+                <div class="blue-return-desc">
+                    {{{description}}}
+                </div>
+              {{/if}}
+
+
+            </div>
+        </div>
+    {{/return}}
+
+    {{#example}}
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                {{{.}}}
+            </div>
+        </div>
+    {{/example}}
+
+    {{> exampleurl }}
+</div>

data/doc/theme/partials/module.handlebars

@@ -0,0 +1,92 @@
+<h1>{{name}} Module</h1>
+<div class="clearfix meta">
+    {{#extra}}
+        {{#selleck}}
+            <a class="button link-docs" href="/yui/docs/{{name}}">User Guide &amp; Examples</a>
+        {{/selleck}}
+    {{/extra}}
+
+    {{#if requires}}
+        <div class="uses">
+            Requires
+            <ul class="inline commas">
+                {{#requires}}
+                    <li>{{#crossLinkModule .}}{{/crossLinkModule}}</li>
+                {{/requires}}
+            </ul>
+        </div>
+    {{/if}}
+
+    {{#if foundAt}}
+        <div class="foundat">
+            Defined in: <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
+        </div>
+    {{/if}}
+
+    {{#if since}}
+        <p>Available since {{since}}</p>
+    {{/if}}
+</div>
+
+{{#if deprecated}}
+    <div class="deprecated">
+        <p>
+        {{#if deprecationMessage}}
+            <strong>Deprecated:</strong> {{deprecationMessage}}
+        {{else}}
+            This module is deprecated.
+        {{/if}}
+        </p>
+    </div>
+{{/if}}
+<h3>Summary</h3>
+<div class="intro">
+    {{{moduleDescription}}}
+</div>
+
+{{#example}}
+    <div class="example">
+        <h4>Example:</h4>
+        <div class="example-content">
+            {{{.}}}
+        </div>
+    </div>
+{{/example}}
+
+<div class="yui3-g">
+    <div class="yui3-u-1-2">
+        {{#if moduleClasses}}
+            <p>This module provides the following classes:</p>
+
+            <ul class="module-classes">
+            {{#moduleClasses}}
+                <li class="module-class">
+                    <a href="{{../projectRoot}}classes/{{name}}.html">
+                        {{displayName}}
+                    </a>
+                </li>
+            {{/moduleClasses}}
+            </ul>
+        {{/if}}
+    </div>
+
+    <div class="yui3-u-1-2">
+        {{#if subModules}}
+            <p>This module is a rollup of the following modules:</p>
+
+            <ul class="module-submodules">
+            {{#subModules}}
+                <li class="module-submodule">
+                    <a href="{{../projectRoot}}modules/{{name}}.html">
+                        {{displayName}}
+                    </a>
+
+                    <div class="module-submodule-description">
+                        {{{description}}}
+                    </div>
+                </li>
+            {{/subModules}}
+            </ul>
+        {{/if}}
+    </div>
+</div>

data/doc/theme/partials/options.handlebars

@@ -0,0 +1,23 @@
+    <div id="api-options">
+        Show:
+        <label for="api-show-inherited">
+            <input type="checkbox" id="api-show-inherited" checked>
+            Inherited
+        </label>
+
+        <label for="api-show-protected">
+            <input type="checkbox" id="api-show-protected">
+            Protected
+        </label>
+
+        <label for="api-show-private">
+            <input type="checkbox" id="api-show-private">
+            Private
+        </label>
+        <label for="api-show-deprecated">
+            <input type="checkbox" id="api-show-deprecated">
+            Deprecated
+        </label>
+
+    </div>
+

data/doc/theme/partials/props.handlebars

@@ -0,0 +1,128 @@
+<div id="property_{{name}}" class="property item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
+
+  <h3 class="blue-method-name">{{name}}</h3>
+  <div class="meta method-meta">
+    {{#if overwritten_from}}
+    <p>Inherited from
+      <a href="{{crossLinkRaw overwritten_from/class}}#property_{{overwritten_from/name}}">
+        {{overwritten_from/class}}
+      </a>
+      {{#if foundAt}}
+        but overwritten in
+      {{/if}}
+    {{else}}
+      {{#if extended_from}}
+      <p>Inherited from
+        <a href="{{crossLinkRaw extended_from}}#property_{{name}}">{{extended_from}}</a>:
+      {{else}}
+        {{#providedBy}}
+          <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
+        {{/providedBy}}
+      <p>
+        {{#if foundAt}}
+          Defined in
+        {{/if}}
+      {{/if}}
+    {{/if}}
+    {{#if foundAt}}
+      <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
+    {{/if}}
+  </p>
+
+    {{#if deprecationMessage}}
+      <p>Deprecated: {{deprecationMessage}}</p>
+    {{/if}}
+
+    {{#if since}}
+      <p>Available since {{since}}</p>
+    {{/if}}
+  </div>
+
+  <h3>Syntax</h3>
+  <div class="blue-method-syntax">
+    <h3 class="name"><code>{{name}}</code></h3>
+    <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+
+    {{#if deprecated}}
+        <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
+    {{/if}}
+
+    {{#if access}}
+        <span class="flag {{access}}">{{access}}</span>
+    {{/if}}
+
+    {{#if final}}
+        <span class="flag final">final</span>
+    {{/if}}
+
+    {{#if static}}
+        <span class="flag static">static</span>
+    {{/if}}
+
+    </div>
+
+    <div class="description">
+      <h3>Summary</h3>
+        {{{propertyDescription}}}
+    </div>
+
+    {{#if default}}
+        <p><strong>Default:</strong> {{default}}</p>
+    {{/if}}
+
+    {{#if subprops}}
+        <h4>Sub-properties:</h4>
+
+        <ul class="params-list">
+            {{#subprops}}
+            <li class="param">
+                {{#if optional}}
+                    <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
+                    <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                    <span class="flag optional" title="This property is optional.">optional</span>
+                {{else}}
+                    <code class="param-name">{{name}}</code>
+                    <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                {{/if}}
+
+                <div class="param-description">
+                    {{{description}}}
+                </div>
+
+                {{#if subprops}}
+                    <ul class="params-list">
+                        {{#subprops}}
+                        <li class="param">
+                            {{#if optional}}
+                                <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
+                                <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                                <span class="flag optional" title="This property is optional.">optional</span>
+                            {{else}}
+                                <code class="param-name">{{name}}</code>
+                                <span class="type">{{#crossLink type}}{{/crossLink}}</span>
+                            {{/if}}
+
+                            <div class="param-description">
+                                {{{description}}}
+                            </div>
+                        </li>
+                        {{/subprops}}
+                    </ul>
+                {{/if}}
+            </li>
+            {{/subprops}}
+        </ul>
+    {{/if}}
+
+  {{#example}}
+    <div class="example">
+      <h4>Example:</h4>
+
+      <div class="example-content">
+        {{{.}}}
+      </div>
+    </div>
+  {{/example}}
+
+  {{> exampleurl }}
+</div>

data/doc/theme/partials/sidebar.handlebars

@@ -0,0 +1,27 @@
+<div id="api-list">
+    <h2 class="off-left">APIs</h2>
+    <div id="api-tabview" class="tabview">
+        <ul class="tabs">
+            <li><a href="#api-classes">Classes</a></li>
+            <li><a href="#api-modules">Modules</a></li>
+        </ul>
+
+        <div id="api-tabview-filter">
+            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+        </div>
+
+        <div id="api-tabview-panel">
+            <ul id="api-classes" class="apis classes">
+            {{#classes}}
+                <li><a href="{{../projectRoot}}classes/{{name}}.html">{{displayName}}</a></li>
+            {{/classes}}
+            </ul>
+
+            <ul id="api-modules" class="apis modules">
+            {{#allModules}}
+                <li><a href="{{../projectRoot}}modules/{{name}}.html">{{displayName}}</a></li>
+            {{/allModules}}
+            </ul>
+        </div>
+    </div>
+</div>

data/doc/theme/theme.json

@@ -0,0 +1,4 @@
+{
+    "yuiGridsUrl": "http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css",
+    "yuiSeedUrl": "http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"
+}

data/doc/yuidoc.json

@@ -0,0 +1,15 @@
+{
+  "name": "up.js",
+  "description": "Fast-responding UI for server-side applications",
+  "version": "0.0",
+  "url": "https://github.com/makandra/upjs-rails",
+
+  "options": {
+    "outdir": "doc/api",
+    "syntaxtype": "coffee",
+    "extension": ".coffee",
+    "themedir": "doc/theme",
+    "paths": ["lib/assets/javascripts/**"],
+    "helpers": ["doc/yuidoc-helpers.js"]
+  }
+}

data/lib/assets/javascripts/up/browser.js.coffee

@@ -1,3 +1,9 @@
+###*
+Browser interface
+=================
+  
+@class up.browser
+###
 up.browser = (->
   
 #  safari = false
@@ -16,5 +22,10 @@ up.browser = (->
 #  detect()
 #  
 #  transitionEndEvent: transitionEndEvent
+  
+  url = ->
+    location.href
+    
+  url: url
       
 )()

data/lib/assets/javascripts/up/bus.js.coffee

@@ -1,21 +1,48 @@
 ###*
-Event bus for up-related events:
+Framework events
+================
   
+TODO: Write some documentation  
+
+This class is kind-of internal and in flux.
+This might eventually be rolled into regular document events.
+
 - `app:ready`
 - `fragment:ready` with arguments `($fragment)`
 - `fragment:destroy` with arguments `($fragment)`
-  
-TODO: This might eventually be rolled into regular document events.
-  
-@class up.bus  
+
+@class up.bus
 ###
 up.bus = (->
 
   callbacksByEvent = {}
+  defaultCallbacksByEvent = {}
 
   callbacksFor = (event) ->
     callbacksByEvent[event] ||= []
 
+  ###*
+  Makes a snapshot of the currently registered bus listeners,
+  to later be restored through [`up.bus.reset`](/up.bus#up.bus.reset)
+  
+  @private
+  @method up.bus.snapshot
+  ###
+  snapshot = ->
+    defaultCallbacksByEvent = {}
+    for event, callbacks of callbacksByEvent
+      defaultCallbacksByEvent[event] = up.util.copy(callbacks)
+  
+  ###*
+  Resets the list of registered event listeners to the
+  moment when the framework was booted.
+  
+  @private
+  @method up.bus.reset
+  ###
+  reset = ->
+    callbacksByEvent = up.util.copy(defaultCallbacksByEvent)
+
   ###*
   Registers an event handler to be called when the given
   event is triggered.
@@ -47,8 +74,9 @@ up.bus = (->
       callback(args...)
     )
 
-  return (
-    on: listen
-    emit: emit
-  )
+  listen 'framework:ready', snapshot
+  listen 'framework:reset', reset
+
+  on: listen
+  emit: emit
 )()