praxis 2.0.pre.6 → 2.0.pre.11

data/lib/api_browser/app/js/directives/menu_item.js

@@ -1,59 +0,0 @@
-app.directive('menuItem', function($compile, $stateParams) {
-
-  function checkIfShouldShow(scope, params) {
-    var currentId = params.action ? params.controller + '_action_' + params.action : (params.controller || params.type || params.trait);
-    scope.isActive = scope.link.id === currentId;
-
-    function checkLink(link) {
-      if (link.id === currentId || link.parent === currentId) {
-        return true;
-      } else {
-        if (link.parentRef) {
-          var matches = function(r) { return r.id === currentId; };
-          if (!link.isAction) {
-            if ((link.parentRef.childResources || []).some(matches)) return true;
-          }
-          if ((link.parentRef.actions || []).some(matches)) return true;
-        }
-
-        return (link.childResources || []).some(checkLink) || (link.actions || []).some(checkLink);
-      }
-    }
-    scope.shouldShow = scope.toplevel || checkLink(scope.link);
-  }
-
-  function link(scope) {
-    scope.$on('$stateChangeSuccess', function(e, state, params) {
-      checkIfShouldShow(scope, params);
-    });
-    checkIfShouldShow(scope, $stateParams);
-  }
-
-  return {
-    restrict: 'E',
-    templateUrl: 'views/directives/menu_item.html',
-    scope: {
-      link: '=',
-      toplevel: '='
-    },
-    // hackery to make a recursive directive
-    compile: function(element) {
-      var contents = element.contents().remove();
-      var compiledContents;
-      return {
-        post: function(scope, element){
-          // Compile the contents
-          if(!compiledContents) {
-            compiledContents = $compile(contents);
-          }
-          // Re-add the compiled contents to the element
-          compiledContents(scope, function(clone) {
-            element.append(clone);
-          });
-
-          link(scope, element);
-        }
-      };
-    }
-  };
-});

data/lib/api_browser/app/js/directives/no_container.js

@@ -1,8 +0,0 @@
-app.directive('noContainer', function() {
-  return {
-    restrict: 'A',
-    link: function(scope, element){
-      element.replaceWith(element.children());
-    }
-  };
-});

data/lib/api_browser/app/js/directives/readable_list.js

@@ -1,87 +0,0 @@
-app.factory('Repeater', function() {
-  function Repeater(expression) {
-    var match = expression.match(/^\s*([\s\S]+?)\s+in\s+([\s\S]+?)(?:\s+as\s+([\s\S]+?))?(?:\s+track\s+by\s+([\s\S]+?))?\s*$/);
-
-    var lhs = match[1];
-    this.rhs = match[2];
-    this.aliasAs = match[3];
-    this.trackByExp = match[4];
-
-    match = lhs.match(/^(?:(\s*[\$\w]+)|\(\s*([\$\w]+)\s*,\s*([\$\w]+)\s*\))$/);
-
-    this.valueIdentifier = match[3] || match[1];
-    this.keyIdentifier = match[2];
-  }
-
-  Repeater.prototype.$watch = function(fn) {
-    this.$scope.$watchCollection(this.rhs, fn);
-  };
-
-  Repeater.prototype.$transclude = function(length, value, key, index, fn) {
-    var self = this;
-    self._transclude(function(clone, scope) {
-      scope[self.valueIdentifier] = value;
-      if (self.keyIdentifier) scope[self.keyIdentifier] = key;
-      scope.$index = index;
-      scope.$first = (index === 0);
-      scope.$last = (index === (length - 1));
-      scope.$middle = !(scope.$first || scope.$last);
-      // jshint bitwise: false
-      scope.$odd = !(scope.$even = (index&1) === 0);
-      // jshint bitwise: true
-      fn(clone, scope);
-    });
-  };
-
-  return {
-    compile: function(repeatAttr, linkFn) {
-      return function(element, attrs) {
-        var expression = attrs[repeatAttr];
-        var repeater = new Repeater(expression);
-        return function($scope, $element, $attr, ctrl, $transclude) {
-          repeater._transclude = $transclude;
-          repeater.$scope = $scope;
-          linkFn($scope, $element, $attr, ctrl, repeater);
-        };
-      };
-    }
-  };
-});
-app.directive('readableList', function(Repeater) {
-
-  return {
-    restrict: 'E',
-    transclude: true,
-    compile: Repeater.compile('repeat', function($scope, $element, $attr, ctrl, $repeat) {
-      $repeat.$watch(function(inputList) {
-        $element.empty();
-        if (inputList.length == 1) {
-          $repeat.$transclude(1, inputList[0], null, 0, function(clone) {
-            $element.append(clone);
-          });
-        } else {
-          var finalJoin = ' and ';
-
-          var join = ', ',
-              arr = inputList.slice(0),
-              last = arr.pop(),
-              beforeLast = arr.pop();
-
-          _.each(arr, function(data, index) {
-            $repeat.$transclude(inputList.length, data, null, index, function(clone) {
-              $element.append(clone);
-              $element.append(document.createTextNode(join));
-            });
-          });
-          $repeat.$transclude(inputList.length, beforeLast, null, inputList.length - 2, function(clone) {
-            $element.append(clone);
-            $element.append(document.createTextNode(finalJoin));
-          });
-          $repeat.$transclude(inputList.length, last, null, inputList.length - 1, function(clone) {
-            $element.append(clone);
-          });
-        }
-      });
-    })
-  };
-});

data/lib/api_browser/app/js/directives/request_examples.js

@@ -1,31 +0,0 @@
-app.directive('requestExamples', function(Examples, $timeout) {
-  return {
-    restrict: 'E',
-    scope: {
-      action: '=',
-      resource: '=',
-      version: '='
-    },
-    template: '<tabset><tab ng-repeat="example in examples" heading="{{example.displayName}}" select="select(example.template)"></tab></tabset>',
-    link: function(scope, element) {
-      scope.examples = Examples.forContext(scope.action, scope.version, scope.resource);
-      var keys = _.keys(scope.examples);
-      if (keys.length === 1) {
-        scope.examples[keys[0]].template.then(function(templateFn) {
-          $timeout(function() {
-            element.empty().append(templateFn(scope));
-          }, 100);
-        });
-      } else {
-        scope.select = function(template) {
-          template.then(function(templateFn) {
-            $timeout(function() {
-              element.find('.tab-content:eq(0)>.tab-pane.active:not(.initialized)').append(templateFn(scope)).addClass('initialized');
-              template.then = _.noop;
-            }, 100);
-          });
-        };
-      }
-    }
-  };
-});

data/lib/api_browser/app/js/directives/type_placeholder.js

@@ -1,30 +0,0 @@
-/**
- * This directive replaces itself with a specialised type template based on the
- * type it is displaying.
- */
-app.directive('typePlaceholder', function(templateFor, $stateParams) {
-  return {
-    restrict: 'EA',
-    scope: {
-      type: '=',
-      template: '@',
-      details: '=?',
-      name: '=?',
-      parentRequirements: '=?',
-    },
-    link: function(scope, element) {
-
-      scope.apiVersion = $stateParams.version;
-
-      if( typeof scope.parentRequirements === 'undefined' ){
-        if( typeof scope.type.requirements !== 'undefined' && scope.type.requirements.length > 0 ){
-          scope.parentRequirements = scope.type.requirements;
-        }
-      }
-
-      templateFor(scope.type, scope.template).then(function(templateFn) {
-        element.replaceWith(templateFn(scope));
-      });
-    }
-  };
-});

data/lib/api_browser/app/js/directives/url.js

@@ -1,15 +0,0 @@
-/**
- * This directive is responsible to render a URL for an action
- */
-app.directive('url', function() {
-  return {
-    restrict: 'EA',
-    scope: {
-      action: '='
-    },
-    templateUrl: 'views/directives/url.html',
-    link: function(scope, element, attrs) {
-      scope.showExample = 'example' in attrs;
-    }
-  };
-});

data/lib/api_browser/app/js/factories/Configuration.js

@@ -1,12 +0,0 @@
-// Use this to provide settings for the doc browser
-app.provider('Configuration', function() {
-  this.title = 'API Browser';
-  this.versionLabel = 'API Version';
-  this.expandChildren = true;
-
-  this.$get = function() {
-    return this;
-  };
-}).run(function(Configuration, $rootScope) {
-  _.extend($rootScope, _.omit(Configuration, '$get'));
-});

data/lib/api_browser/app/js/factories/Documentation.js

@@ -1,61 +0,0 @@
-/**
- * This service gives access to the documentation metadata
- */
-app.factory('Documentation', function($http, $q) {
-  var versions = $q.when($http.get('api/index-new.json', { cache: true }).then(function(data) {
-    return $q.all(_.map(data.data.versions, function(version) {
-      return $http.get('api/' + version + '.json', {cache: true}).then(function(versionData) {
-        return [version, versionData.data];
-      });
-    })).then(_.zipObject);
-  }));
-
-  return {
-    /**
-     * Returns an array of version strings
-     */
-    versions: function() {
-      return versions.then(_.keys);
-    },
-    /**
-     * Returns the info for the requested version
-     */
-    info: function(version) {
-      return versions.then(function(v) { return v[version].info; });
-    },
-    /**
-     * Returns a list of controllers and types, useful for generating navigation
-     */
-    items: function(version) {
-      return versions.then(function(v) { return v[version]; });
-    },
-    /**
-     * Returns description of a controller
-     */
-    controller: function(version, name) {
-      return this.items(version).then(function(v) {
-        var controller = v.resources[name];
-        controller.id = name;
-        return controller;
-      });
-    },
-
-    /**
-     * Returns a description of a type
-     */
-    type: function(version, name) {
-      return versions.then(function(v) {
-        return v[version].schemas[name];
-      });
-    },
-
-    /**
-     * Returns a description of a trait
-     */
-    trait: function(version, name) {
-      return versions.then(function(v) {
-        return v[version].traits[name];
-      });
-    }
-  };
-});

data/lib/api_browser/app/js/factories/Example.js

@@ -1,51 +0,0 @@
-app.provider('Examples', function() {
-  var registry = {};
-
-  this.register = function(key, displayName, handler) {
-    registry[key] = registry[key] || [];
-    registry[key].unshift({
-      key: key,
-      displayName: displayName,
-      handler: handler
-    });
-  };
-
-  this.removeHandlersForKey = function(key) {
-    registry[key] = [];
-  };
-
-  this.register('general', 'General', function() {
-    return 'views/examples/general.html';
-  });
-
-  this.$get = function(prepareTemplate, $injector) {
-    return {
-      forContext: function(action, version, resource) {
-        var results = {};
-        for (var key in registry) {
-          for (var i = 0; i < registry[key].length; i++) {
-            var result = $injector.invoke(registry[key][i].handler, this, {
-              $action: action,
-              $version: version,
-              $context: {
-                resource: resource,
-                action: action,
-                version: version
-              }
-            });
-            if (result) {
-              results[key] = {
-                key: key,
-                displayName: registry[key][i].displayName,
-                template: prepareTemplate(result)
-              };
-              break;
-            }
-          }
-        }
-        return results;
-      }
-    };
-  };
-
-});

data/lib/api_browser/app/js/factories/PageInfo.js

@@ -1,9 +0,0 @@
-app.service('PageInfo', function($rootScope) {
-  this.title = null;
-  var self = this;
-  $rootScope.$watch(function() {
-    return self.title;
-  }, function() {
-    $rootScope.subtitle = self.title;
-  });
-});

data/lib/api_browser/app/js/factories/normalize_attributes.js

@@ -1,20 +0,0 @@
-app.factory('normalizeAttributes', function() {
-  function normalize(type, attributes, parent) {
-    _.forEach(attributes, function(attribute, name) {
-      var path = parent.concat([name]);
-      if (!attribute.options) attribute.options = {};
-      if (attribute.values != null) attribute.options.values = attribute.values;
-      if (attribute.default != null) attribute.options.default = attribute.default;
-      if (attribute.example != null) attribute.options.example = attribute.example;
-      if ( attribute.type.attributes ) {
-        normalize(attribute.type, attribute.type.attributes, path);
-      }else if( attribute.type.member_attribute ){
-        normalize(attribute.type.member_attribute.type, attribute.type.member_attribute.type.attributes, path);
-      }
-    });
-  }
-
-  return function(type, attributes) {
-    normalize(type, attributes, []);
-  };
-});

data/lib/api_browser/app/js/factories/prepare_template.js

@@ -1,15 +0,0 @@
-app.factory('prepareTemplate', function($q, $http, $templateCache, $compile) {
-  return function(result) {
-    return $q.when(result).then(function(template) {
-      if (_.isFunction(template)) {
-        return template;
-      } else if (_.isString(template)) {
-        return $http.get(template, {cache: $templateCache}).then(function(response) {
-          return $compile(response.data);
-        });
-      } else {
-        throw 'Resolver returned an unknown type';
-      }
-    });
-  };
-});

data/lib/api_browser/app/js/factories/template_for.js

@@ -1,128 +0,0 @@
-/**
- * Allows dynamic UI based on resolvers. You can customise the way templates
- * work in the doc browser by registering your own template resolver.
- *
- * A template resolver is dependency injected function that has several special
- * arguments that can be injected. These are:
- *
- * Name                | Type    | Description
- * --------------------|---------|----------------------------------------------
- * $type               | String  | The name of a type.
- * $family             | String  | The family or group of types this type belongs to.
- * $typeDefinition     | Object  | The full definition of the type as available.
- * $requestedTemplate  | String  | This is the kind of template that we want. Possible values are: standalone, embedded and label. Embedded templates represent types that are attributes of another type. The template thus should assume that it is being rendered in a table row. Label templates display a human readable name of a type. Standalone templates are used when a type is displayed by itself (i.e. a request payload).
- *
- * The type resolver should return either a $compiled template, or a url of a
- * template or a promise for one of those. In that case the template resolution
- * procedure will halt and the returned template will be displayed. If `undefined`
- * is passed, the next resolver will be invoked. A promise for undefined is currently
- * not supported.
- */
-app.provider('templateFor', function() {
-
-  var resolvers = [];
-  /**
-   * Register a custom template resolver.
-   * @param {function} resolver
-   *    A function that returns undefined or a promise for a compiled template or a template url.
-   */
-  this.register = function(resolver) {
-    resolvers.unshift(resolver);
-  };
-
-  this.register(function payloadResolver($family, $requestedTemplate) {
-    'ngInject';
-    if ($requestedTemplate === 'standalone') {
-      switch ($family) {
-        case 'hash':
-          return 'views/types/standalone/struct.html';
-        case 'array':
-          return 'views/types/standalone/array.html';
-        default:
-          return 'views/types/standalone/default.html';
-      }
-    }
-  });
-
-  this.register(function typeResolver($family, $type, $requestedTemplate) {
-    'ngInject';
-    if ($requestedTemplate === 'embedded') {
-      if ($type === 'Links') {
-        return 'views/types/embedded/links.html';
-      }
-      if ($type === 'Praxis::Extensions::FieldSelection::FieldSelector') {
-        return 'views/types/embedded/field-selector.html';
-      }
-      switch ($family) {
-        case 'hash':
-          return 'views/types/embedded/struct.html';
-        case 'array':
-          return 'views/types/embedded/array.html';
-        default:
-          return 'views/types/embedded/default.html';
-      }
-    }
-  });
-
-  this.register(function labelResolver($typeDefinition, $requestedTemplate, primitives) {
-    'ngInject';
-    if ($requestedTemplate === 'label') {
-      if ( $typeDefinition.member_attribute !== undefined) {
-        if ($typeDefinition.member_attribute.anonymous || _.contains(primitives, $typeDefinition.member_attribute.type.name)) {
-          return 'views/types/label/primitive_collection.html';
-        } else{
-          return 'views/types/label/type_collection.html';
-        }
-      } else if ($typeDefinition.anonymous || _.contains(primitives, $typeDefinition.name)) {
-        return 'views/types/label/primitive.html';
-      } else if ($typeDefinition.link_to) {
-        return 'views/types/label/link.html';
-      }
-      return 'views/types/label/type.html';
-    }
-  });
-
-  this.register(function mainPageResolver($family, $requestedTemplate) {
-    'ngInject';
-    if ($requestedTemplate === 'main') {
-      switch ($family) {
-        case 'hash':
-          return 'views/types/main/hash.html';
-        case 'array':
-          return 'views/types/main/array.html';
-        default:
-          return 'views/types/main/default.html';
-      }
-    }
-  });
-
-  this.$get = function($injector, prepareTemplate) {
-    return function(type, templateType) {
-      for (var i = 0; i < resolvers.length; i++) {
-        var result = $injector.invoke(resolvers[i], this, {
-          $type: type.name,
-          $typeDefinition: type,
-          $family: type.family || type.name,
-          $requestedTemplate: templateType
-        });
-        if (result) {
-          return prepareTemplate(result);
-        }
-      }
-      throw 'Template did not match any resolver.';
-    };
-  };
-})
-.constant('primitives', [
-  'Boolean',
-  'CSV',
-  'DateTime',
-  'Float',
-  'Hash',
-  'Ids',
-  'Integer',
-  'Object',
-  'String',
-  'Struct',
-  'URI'
-]);