@bennerinformatics/ember-fw-table 2.0.21 → 2.1.0

package/yuidoc-ember-theme/helpers/helpers.js

@@ -0,0 +1,236 @@
+var PROJECT;
+
+module.exports = {
+  log: function() {
+    var slicedArgs = Array.prototype.slice.call(arguments, 0, arguments.length - 1);
+    console.log.apply(console, slicedArgs);
+  },
+
+  setupGlobals: function() {
+    PROJECT = this;
+    return '';
+  },
+
+  setupClass: function() {
+    var classes = this.classes;
+
+    for(var i = 0; i < classes.length; i++) {
+      if(classes[i].name === this.name) {
+        this.isPrivate = !isPublic(classes[i]);
+        break;
+      }
+    }
+  },
+
+  setupModule: function() {
+    var self = this;
+    var moduleClasses = [];
+
+    this.classes.forEach(function(c) {
+      if(c.module === self.name) {
+        moduleClasses.push(c);
+      }
+    });
+
+    this.filteredModuleClasses = moduleClasses;
+  },
+
+  isPrivate: function(context, options) {
+    return isPublic(context) ? options.inverse(this) : options.fn(this);
+  },
+
+  publicClasses: function(context, options) {
+    'use strict';
+    var ret = "";
+
+    for (var i = 0; i < context.length; i++) {
+      if (isPublic(context[i])) {
+        ret = ret + options.fn(context[i]);
+      }
+    }
+
+    return ret;
+  },
+
+  /**
+   * Hack for:
+   * https://github.com/yui/yuidoc/issues/198
+   *
+   * Usage:
+   *   {{#crossLinkWrapper type}}{{#crossLink type}}{{/crossLink}}{{/crossLinkWrapper}}
+   */
+  crossLinkWrapper: function(context, options) {
+    if (!context) return '';
+    var types_raw = context.split('|');
+    var types_linked = options.fn(this).split('|');
+
+    return types_raw.map(function(type, i) {
+      if (/\[\]/.test(type)) {
+        if (/<\/a>/.test(types_linked[i])) {
+          return types_linked[i].replace('</a>', '[]</a>');
+        } else {
+          return types_linked[i].trim() + '[]';
+        }
+      } else {
+        return types_linked[i];
+      }
+    }).join(' | ');
+  },
+
+  notEmpty: function(context, options) {
+    'use strict';
+
+    if(context && Array.isArray(context)) {
+      return context.length > 0 ? options.fn(this) : options.inverse(this);
+    } else {
+      return (!context || !String(context).replace(/\s/g, '')) ? options.inverse(this) : options.fn(this);
+    }
+  },
+
+  hasStaticMethods: function(context, options) {
+    'use strict';
+    var hasStatic = false;
+    if (!context) return '';
+    for (var i = 0; i < context.length; i++) {
+      if (context[i]['static']) {
+        hasStatic = true;
+        break;
+      }
+    }
+    if (hasStatic) {
+      return options.fn(this);
+    }
+    return '';
+  },
+
+  hasInstanceMethods: function(context, options) {
+    'use strict';
+    var hasInstance = false;
+    if (!context) return '';
+    for (var i = 0; i < context.length; i++) {
+      if (!context[i]['static']) {
+        hasInstance = true;
+        break;
+      }
+    }
+    if (hasInstance) {
+      return options.fn(this);
+    }
+    return '';
+  },
+
+  search: function(classes, modules) {
+    'use strict';
+    var ret = '';
+
+    for (var i = 0; i < classes.length; i++) {
+      if (i > 0) {
+        ret += ', ';
+      }
+      ret += "\"" + 'classes/' + classes[i].displayName + "\"";
+    }
+
+    if (ret.length > 0 && modules.length > 0) {
+      ret += ', ';
+    }
+
+    for (var j = 0; j < modules.length; j++) {
+      if (j > 0) {
+        ret += ', ';
+      }
+      ret += "\"" + 'modules/' + modules[j].displayName + "\"";
+    }
+
+    return ret;
+  },
+
+  or: function(a, b, options) {
+    if(a || b) {
+      return options.fn(this);
+    }
+    return '';
+  },
+
+  eq: function(v1, v2, options) {
+    if(v1 == v2) {
+      return options.fn(this);
+    } else {
+      return options.inverse(this);
+    }
+  },
+
+  deEmberifiedName: function() {
+    var name = this.projectName || '';
+
+    var delimiter = name.indexOf('-') > -1 ? '-' : ' ';
+    var segments = name.split(delimiter);
+
+    if(segments[0].toLowerCase() === 'ember') {
+      name = segments.slice(1, segments.length).join(delimiter).trim();
+    }
+
+    return name;
+  },
+
+  projectTag: function() {
+    return getTagFromVersion(PROJECT.projectVersion);
+  },
+
+  githubFoundAt: function() {
+    var meta = getFileMeta(this.file);
+    return generateGhFileUrl(meta.url, meta.version, meta.file, this.line);
+  },
+
+  fileName: function() {
+    var meta = getExternalFileMeta(this.file);
+    return meta ? this.file.replace(new RegExp(meta.path, 'i'), meta.name) : this.file;
+  },
+
+  forwardToIndexModule: function() {
+    return '<script type="text/javascript">' +
+              'window.location.replace("modules/' + this.projectIndexModule + '.html");' +
+           '</script>'
+  }
+};
+
+function getTagFromVersion(version) {
+  if (version === 'master' || version.charAt(0).toLowerCase() === 'v') {
+    return version;
+  } else {
+    return version.split('.').pop();
+  }
+}
+
+function isPublic(context) {
+  return context.itemtype || (!context.itemtype && context.access === 'public');
+}
+
+function getFileMeta(file) {
+  var externalMeta = getExternalFileMeta(file)
+
+  if (externalMeta) {
+    return {
+      file: file.replace(new RegExp(externalMeta.path, 'i'), ''),
+      version: getTagFromVersion(externalMeta.version),
+      url: externalMeta.url
+    };
+  } else {
+    return {
+      file: file,
+      version: getTagFromVersion(PROJECT.projectVersion),
+      url: PROJECT.projectUrl
+    };
+  }
+}
+
+function getExternalFileMeta(file) {
+  var externalDocs = PROJECT.projectExternalDocs || [];
+
+  return externalDocs.find(function(externalDoc) {
+    return !!(file || '').match(new RegExp(externalDoc.path, 'i'));
+  });
+}
+
+function generateGhFileUrl(baseUrl, version, file, line) {
+  return baseUrl + '/blob/' + version + '/' + file + '#L' + line;
+}

package/yuidoc-ember-theme/layouts/main.handlebars

@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>{{htmlTitle}}</title>
+    <meta name="description" content="{{projectDescription}}">
+    <link rel="stylesheet" href="{{yuiGridsUrl}}">
+    <link rel="stylesheet" href="{{projectAssets}}/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="{{projectAssets}}/css/main.css" id="site_styles">
+    <link rel="stylesheet" href="{{projectAssets}}/css/custom.css">
+    <link rel="stylesheet" href="{{projectAssets}}/vendor/bootstrap/css/bootstrap.css">
+    <link rel="stylesheet" href="{{projectAssets}}/vendor/font-awesome/css/font-awesome.min.css">
+    <link rel="stylesheet" href="{{projectAssets}}/css/theme.css">
+    <link href='https://fonts.googleapis.com/css?family=Open+Sans:300,400,500,600,700' rel='stylesheet' type='text/css'>
+    {{!-- <link rel="shortcut icon" type="image/png" href="{{projectAssets}}/favicon.png"> --}}
+    <!-- favicon information -->
+    <link rel="apple-touch-icon" sizes="57x57" href="/assets/icons/apple-icon-57x57.png">
+    <link rel="apple-touch-icon" sizes="60x60" href="/assets/icons/apple-icon-60x60.png">
+    <link rel="apple-touch-icon" sizes="72x72" href="/assets/icons/apple-icon-72x72.png">
+    <link rel="apple-touch-icon" sizes="76x76" href="/assets/icons/apple-icon-76x76.png">
+    <link rel="apple-touch-icon" sizes="114x114" href="/assets/icons/apple-icon-114x114.png">
+    <link rel="apple-touch-icon" sizes="120x120" href="/assets/icons/apple-icon-120x120.png">
+    <link rel="apple-touch-icon" sizes="144x144" href="/assets/icons/apple-icon-144x144.png">
+    <link rel="apple-touch-icon" sizes="152x152" href="/assets/icons/apple-icon-152x152.png">
+    <link rel="apple-touch-icon" sizes="180x180" href="/assets/icons/apple-icon-180x180.png">
+    <link rel="icon" type="image/png" sizes="192x192"  href="/assets/icons/android-icon-192x192.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="/assets/icons/favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="96x96" href="/assets/icons/favicon-96x96.png">
+    <link rel="icon" type="image/png" sizes="16x16" href="/assets/icons/favicon-16x16.png">
+    <link rel="manifest" href="/assets/icons/manifest.json">
+    <meta name="msapplication-TileImage" content="/assets/icons/ms-icon-144x144.png">
+    {{setupGlobals}}
+
+    {{#if projectPrimaryColor}}
+      <style>
+        body a {
+          color: {{projectPrimaryColor}};
+        }
+        body a:hover {
+          color: {{projectPrimaryColor}};
+          opacity: 0.5;
+        }
+        .navbar.navbar-default .navbar-nav> li> a:focus, .navbar.navbar-default .navbar-nav> li> a:hover {
+          color: {{projectPrimaryColor}};
+        }
+        .navbar.navbar-default .navbar-nav> .active> a, .navbar.navbar-default .navbar-nav> .active> a:focus, .navbar.navbar-default .navbar-nav> .active> a:hover {
+          color: {{projectPrimaryColor}};
+        }
+        #docs-main .page-header {
+          color: {{projectPrimaryColor}};
+        }
+        #docs-main .page-section .nav-tabs {
+          border-bottom: 1px solid {{projectPrimaryColor}};
+        }
+        #docs-main .page-section .nav-tabs> li.active a {
+          background: {{projectPrimaryColor}};
+          border: 1px solid {{projectPrimaryColor}};
+        }
+        #sidebar li.panel .panel-body ol> li.active, #sidebar li.panel .panel-body ol> li:hover {
+          background: #efefef;
+        }
+      </style>
+    {{/if}}
+</head>
+<body>
+    <nav class="navbar navbar-default">
+      <div class="container-fluid">
+        <div class="navbar-header">
+          <a href="{{projectRoot}}" class="navbar-brand">
+            {{#if projectLogo}}
+              <img src="{{projectLogo}}" alt="enterprise logo">
+            {{else}}
+              <img src="{{projectAssets}}/img/ember-logo.png" alt="enterprise logo">
+            {{/if}}
+            <span>{{projectName}} (API)</span>
+          </a>
+        </div>
+
+        <div class="collapse navbar-collapse" id="nav">
+          <ul class="nav navbar-nav navbar-right">
+            <li><a href="https://linformatics.bitbucket.io/docs/">Docs</a></li>
+            <li><a href="https://linformatics.bitbucket.io/downloads/">Downloads</a></li>
+            <li><a href="https://linformatics.bitbucket.io/api/">API</a></li>
+            <li><a href="{{projectUrl}}" class="fa fa-github github"></a></li>
+          </ul>
+        </div>
+      </div>
+    </nav>
+    <div id="main-wrapper" class="row">
+        <div id="content-wrapper">
+            {{>sidebar}}
+            <div class="content-container">
+                <div class="apidocs">
+                    <div id="docs-main">
+                        <div class="content">
+{{>layout_content}}
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+    <script src="{{projectAssets}}/vendor/prettify/prettify-min.js"></script>
+    <script>prettyPrint();</script>
+    <script src="{{projectAssets}}/vendor/jquery/jquery.min.js"></script>
+    <script src="{{projectAssets}}/vendor/jquery-ui/jquery-ui.min.js"></script>
+    <script src="{{projectAssets}}/vendor/bootstrap/js/bootstrap.js"></script>
+    <script src="{{projectAssets}}/vendor/github-slugger/slugger.js"></script>
+    <script src="{{projectAssets}}/js/yuidoc-bootstrap.js"></script>
+</body>
+</html>

package/yuidoc-ember-theme/layouts/xhr.handlebars

@@ -0,0 +1,7 @@
+<div id="docs-main">
+    <div class="content">
+        {{>layout_content}}
+    </div>
+</div>
+
+<div id="xhr-title" class="hidden">{{title}}</div>

package/yuidoc-ember-theme/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "yuidoc-ember-theme",
+  "version": "2.0.1",
+  "description": "YUIDoc theme for ember addons",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/offirgolan/yuidoc-ember-theme.git"
+  },
+  "keywords": [
+    "yuidoc"
+  ],
+  "author": {
+    "name": "Offir Golan"
+  }
+}

package/yuidoc-ember-theme/partials/attrs.handlebars

@@ -0,0 +1,144 @@
+<div id="attr_{{name}}" class="attr item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
+    <a name="config_{{name}}"></a> {{! For backwards compatibility }}
+    <h3 class="name anchorable-toc">
+        <a class="fa fa-link toc-anchor" href="#attr_{{name}}"></a>
+        {{name}}
+    </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}}
+
+    {{#if optional}}
+        <span class="flag optional">optional</span>
+    {{/if}}
+
+    {{#if required}}
+        <span class="flag required">required</span>
+    {{/if}}
+
+    {{#if readonly}}
+        <span class="flag readonly">readonly</span>
+    {{/if}}
+
+    <div class="meta">
+        {{#if overwritten_from}}
+            <p>Inherited from
+            <a href="{{crossLinkRaw overwritten_from/class}}#attr_{{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}}#attr_{{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="{{githubFoundAt}}">{{fileName}}:{{{line}}}</a>
+        {{/if}}
+        </p>
+
+        {{#if deprecationMessage}}
+            <p>Deprecated: {{deprecationMessage}}</p>
+        {{/if}}
+
+        {{#if since}}
+            <p>Available since {{since}}</p>
+        {{/if}}
+    </div>
+
+    <div class="description">
+        {{{attrDescription}}}
+    </div>
+
+    {{#if default}}
+        <p><strong>Default:</strong> {{default}}</p>
+    {{/if}}
+
+    {{#if emit}}
+        <div class="emits box">
+            <h4>Fires event <code>{{name}}Change</code></h4>
+
+            <p>
+            Fires when the value for the configuration attribute `{{{name}}}` is
+            changed. You can listen for the event using the `on` method if you
+            wish to be notified before the attribute's value has changed, or
+            using the `after` method if you wish to be notified after the
+            attribute's value has changed.
+            </p>
+
+            <div class="params">
+                <h4>Parameters:</h4>
+
+                <ul class="params-list">
+                    <li class="param">
+                        <code class="param-name">e</code>
+                        <span class="type">{{#crossLink "EventFacade"}}{{/crossLink}}</span>
+
+                        <div class="param-description">
+                            An Event Facade object with the following
+                            attribute-specific properties added:
+                        </div>
+
+                        <ul class="params-list">
+                            <li class="param">
+                                <code class="param-name">prevVal</code>
+                                <span class="type">Any</span>
+                                <div class="param-description">The value of the attribute, prior to it being set.</div>
+                            </li>
+                            <li class="param">
+                                <code class="param-name">newVal</code>
+                                <span class="type">Any</span>
+                                <div class="param-description">The value the attribute is to be set to.</div>
+                            </li>
+                            <li class="param">
+                                <code class="param-name">attrName</code>
+                                <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>
+                                <div class="param-description">The name of the attribute being set.</div>
+                            </li>
+                            <li class="param">
+                                <code class="param-name">subAttrName</code>
+                                <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>
+                                <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+                            </li>
+                        </ul>
+                    </li>
+                </ul>
+            </div>
+        </div>
+    {{/if}}
+
+    {{#example}}
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                {{{.}}}
+            </div>
+        </div>
+    {{/example}}
+</div>