sc-docs 0.0.1

data/lib/sc_docs/docs/apps/docs/core.js

@@ -0,0 +1,148 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+
+/*globals Docs */
+
+/** @namespace
+
+  Docs is a documentation viewer for SproutCore-based Apps and for the
+  SproutCore framework itself. It runs alongside the sc-docs script (Which
+  ships with the same sc-docs.git repository this app is contained within),
+  and uses a nodejs-based jsdoc-toolkit engine to parse and generate the 
+  fixtures data this app will render.
+
+  Known Issues:
+  ----
+
+  - The app currently suffers from some performance problems.
+  - The app lacks proper usage of SC.Routes to make symbols bookmarkable
+     and shareable.
+  - The app lacks an organizational feature (organize by framework)
+  - The app lacks a search feature
+
+  If you encounter any other issues, please let me know (majd@sproutcore.com)
+  
+  @extends SC.Object
+*/
+Docs = SC.Application.create(
+  /** @scope Docs.prototype */ {
+
+  NAMESPACE: 'Docs',
+  VERSION: '0.1.0',
+
+  /**
+    A hash used to quickly inspect all the data associated with the doc viewer.
+
+    ex. 
+
+    {
+      "SC.Set": [
+        "add", 
+        "edit"
+      ],
+
+      "SC.Enumerable": [
+        "find", 
+        "findProperty"
+      ]
+    }
+  */
+  indexHash: null,
+
+  buildIndex: function(/** SC.RecordArray */classes) {
+    var hash = {};
+
+    classes.forEach(function(object, index){
+      var name = object.get('displayName');
+
+      hash[name] = object.get('storeKey');
+    });
+
+    this.set('indexHash',hash);
+  },
+
+  /** record array representing all the classes */
+  allClassesRecordArray: null,
+
+  wasRouted: NO,
+
+  // This is your application store.  You will use this store to access all
+  // of your model data.  You can also set a data source on this store to
+  // connect to a backend server.  The default setup below connects the store
+  // to any fixtures you define.
+  store: SC.Store.create().from(SC.Record.fixtures),
+
+  routeToClass: function(params){ 
+    Docs.set('wasRouted',YES);
+
+    var className = params['class'];
+    if(!className) {return;}
+
+    query = SC.Query.local(Docs.Class,{
+      conditions: 'displayName = "%@"'.fmt(className)
+    });
+    var items = Docs.store.find(query);
+    var firstObject = items.get('firstObject');
+
+    if(Docs.classesController.getPath('selection.firstObject') === firstObject) {
+      return;
+    }
+
+    var collection = Docs.mainPage.getPath('mainPane.sidebar.classList.contentView');
+    var itemView = collection.itemViewForContentObject(firstObject);
+    Docs.classesController.selectObject(firstObject);
+    collection.scrollToItemView(itemView);
+
+    return items.get('firstObject');
+  },
+
+  routeToSymbol: function(params){
+
+    // If no className is provided, assume that the currently selected
+    // class contains the symbol
+    var className = params['class'];
+    var symbolName = params['symbol'];
+
+    var selectedClass = this.routeToClass(params);
+
+    if(!selectedClass || !symbolName) {
+      return;
+    }
+  
+    var that = this;
+    // We have to wait for the class selection to propagate
+    this.invokeLater(function(){
+
+      var symbols = Docs.selectedClassController.get('symbols');
+      var matches = symbols.filterProperty('name',symbolName);
+
+      var firstObject = matches.get('firstObject');
+
+      if (!firstObject) {
+        return NO;
+      }
+
+      if(Docs.selectedClassController.getPath('symbolSelection.firstObject') === firstObject) {
+        return NO;
+      }
+
+      var sel = SC.SelectionSet.create();
+      sel.addObjects([firstObject]).freeze();
+
+      Docs.selectedClassController.set('symbolSelection',sel);
+    });
+
+    return YES;
+  }
+
+}) ;
+
+Handlebars.registerHelper('debug', function(object) {
+
+  console.log(this.get(object));
+
+  return '';
+});

data/lib/sc_docs/docs/apps/docs/main.js

@@ -0,0 +1,41 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+
+/*globals Docs */
+
+// This is the function that will start your app running.  The default
+// implementation will load any fixtures you have created then instantiate
+// your controllers and awake the elements on your page.
+//
+// As you develop your application you will probably want to override this.
+// See comments for some pointers on what to do next.
+//
+Docs.main = function main() {
+
+  Docs.getPath('mainPage.mainPane').append() ;
+
+  var query  = SC.Query.local(Docs.Class);
+  var output = Docs.store.find(query);
+
+  Docs.buildIndex(output);
+
+  Docs.allClassesRecordArray = output = output.sortProperty('displayName');
+  Docs.classesController.set('content',output);
+
+  SC.routes.add(':class/:symbol',Docs,'routeToSymbol');
+  SC.routes.add(':class',Docs,'routeToClass');
+
+  if(!window.location.hash){
+    Docs.classesController.selectObject(output.firstObject());
+  }
+
+  var view = Docs.getPath('mainPage.mainPane.sidebar.classList.contentView');
+  view.becomeFirstResponder();
+
+
+} ;
+
+function main() { Docs.main(); }

data/lib/sc_docs/docs/apps/docs/models/class.js

@@ -0,0 +1,63 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+/*globals Docs */
+
+/** @class
+
+  (Document your Model here)
+
+  @extends SC.Record
+  @version 0.1
+*/
+Docs.Class = SC.Record.extend(
+/** @scope Docs.Class.prototype */ {
+
+  //childRecordNamespace: Docs,
+
+  name: SC.Record.attr(String),
+  displayName: SC.Record.attr(String),
+  objectType: SC.Record.attr(String),
+  filePath: SC.Record.attr(String),
+
+  isNamespace: SC.Record.attr(Boolean, {defaultValue: NO}),
+  isPrivate: SC.Record.attr(Boolean, {defaultValue: NO}),
+  isStatic: SC.Record.attr(Boolean, {defaultValue: NO}),
+
+  author: SC.Record.attr(String),
+  see: SC.Record.attr(Array, {defaultValue: []}),
+  since: SC.Record.attr(String),
+  version: SC.Record.attr(String),
+  deprecated: SC.Record.attr(String),
+
+  overview: SC.Record.attr(String),
+  augments: SC.Record.toMany('Docs.Entity',{isMaster: YES, nested: YES}),
+  methods: SC.Record.toMany('Docs.Method',{isMaster: YES, nested: YES}),
+  properties: SC.Record.toMany('Docs.Property',{isMaster: YES, nested: YES}),
+
+  hasProperties: function() {
+    return this.getPath('properties.length');
+  }.property('properties').cacheable(),
+
+  hasMethods: function() {
+    return this.getPath('methods.length');
+  }.property('methods').cacheable(),
+
+  extendsFrom: function(){
+    var augments = this.get('augments');
+
+    return augments.getEach('desc');
+  }.property('augments').cacheable(),
+
+  formattedOverview: function() {
+    var overview = this.get('overview');
+
+    var converter = new Showdown.converter();
+    var html = converter.makeHtml(overview);
+
+    return html;
+  }.property('overview').cacheable()
+
+}) ;

data/lib/sc_docs/docs/apps/docs/models/entity.js

@@ -0,0 +1,29 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+/*globals Docs */
+
+/** @class
+
+  (Document your Model here)
+
+  @extends SC.Record
+  @version 0.1
+*/
+Docs.Entity = SC.Record.extend(
+/** @scope Docs.Entity.prototype */ {
+
+  childRecordNamespace: Docs,
+
+  type: 'Entity',
+
+  title: SC.Record.attr(String),
+  objectType: SC.Record.attr(String, {key: 'type'}),
+  name: SC.Record.attr(String),
+  isOptional: SC.Record.attr(Boolean, {defaultValue: NO}),
+  defaultValue: SC.Record.attr(String),
+  desc: SC.Record.attr(String)
+
+}) ;

data/lib/sc_docs/docs/apps/docs/models/method.js

@@ -0,0 +1,79 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+/*globals Docs */
+
+/** @class
+
+  (Document your Model here)
+
+  @extends SC.Record
+  @version 0.1
+*/
+Docs.Method = SC.Record.extend(
+/** @scope Docs.Method.prototype */ {
+
+  childRecordNamespace: Docs,
+  type: 'Method',
+
+  name: SC.Record.attr(String),
+  displayName: SC.Record.attr(String),
+  objectType: SC.Record.attr(String),
+  isPrivate: SC.Record.attr(Boolean, {defaultValue: NO}),
+  isStatic: SC.Record.attr(Boolean, {defaultValue: NO}),
+  author: SC.Record.attr(String),
+  see: SC.Record.attr(Array, {defaultValue: []}),
+  since: SC.Record.attr(String),
+  version: SC.Record.attr(String),
+  deprecated: SC.Record.attr(String),
+  augments: SC.Record.toMany(Docs.Entity, {isMaster: YES}),
+  overview: SC.Record.attr(String),
+  exceptions: SC.Record.toMany(Docs.Entity, {isMaster: YES}),
+  returns: SC.Record.toMany(Docs.Entity, {isMaster: YES}),
+  icon: sc_static('images/method_icon.png'),
+
+  returnType: function() {
+    return this.getPath('returns.lastObject.objectType');
+  }.property('returns').cacheable(),
+
+  returnText: function() {
+    console.log('returnText',this.getPath('returns'));
+    return this.getPath('returns.lastObject.desc');
+  }.property('returns').cacheable(),
+
+  signature: function() {
+    return 'signature';
+  }.property('name','params').cacheable(),
+
+  params: function() {
+    var dataHash = Docs.store.readDataHash(this.get('storeKey'));
+    var params = dataHash.params || [];
+
+    var simpleParams = params.map(function(item,index){
+      return {type: item.type, name: item.name};
+    });
+
+    return simpleParams;
+  }.property().cacheable(),
+
+  returns: function() {
+    var dataHash = Docs.store.readDataHash(this.get('storeKey'));
+    var returns = dataHash.returns || [];
+
+    var returnObj = returns[returns.length-1];
+
+    return returnObj;
+  }.property().cacheable(),
+
+  formattedOverview: function() {
+    var overview = this.get('overview');
+
+    var converter = new Showdown.converter();
+    var html = converter.makeHtml(overview);
+
+    return html;
+  }.property('overview').cacheable()
+
+}) ;

data/lib/sc_docs/docs/apps/docs/models/property.js

@@ -0,0 +1,48 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+/*globals Docs */
+
+/** @class
+
+  (Document your Model here)
+
+  @extends SC.Record
+  @version 0.1
+*/
+Docs.Property = SC.Record.extend(
+/** @scope Docs.Property.prototype */ {
+
+  childRecordNamespace: Docs,
+
+  type: 'Property',
+
+  icon: sc_static('images/property_icon.png'),
+
+  name: SC.Record.attr(String),
+  displayName: SC.Record.attr(String),
+  objectType: SC.Record.attr(String),
+  propertyType: SC.Record.attr(String),
+  author: SC.Record.attr(String),
+  see: SC.Record.attr(Array, {defaultValue: []}),
+  since: SC.Record.attr(String),
+  version: SC.Record.attr(String),
+  deprecated: SC.Record.attr(String),
+  memberOf: SC.Record.attr(String),
+  overview: SC.Record.attr(String),
+  defaultValue: SC.Record.attr(String),
+  isConstant: SC.Record.attr(Boolean, {defaultValue: NO}),
+  isPrivate: SC.Record.attr(Boolean, {defaultValue: NO}),
+
+  formattedOverview: function() {
+    var overview = this.get('overview');
+
+    var converter = new Showdown.converter();
+    var html = converter.makeHtml(overview);
+
+    return html;
+  }.property('overview').cacheable()
+
+}) ;

data/lib/sc_docs/docs/apps/docs/resources/loading.rhtml

@@ -0,0 +1,9 @@
+<% content_for :loading do %>
+<% # Any HTML in this file will be visible on screen while your page loads
+   # its application JavaScript.  SproutCore applications are optimized for 
+   # caching and startup very fast, so your users will often only see this 
+   # content for a brief moment on their first app load, if at all.
+%>
+<p class="loading">Loading...<p>
+
+<% end %>

data/lib/sc_docs/docs/apps/docs/resources/main_page.css

@@ -0,0 +1,156 @@
+/*
+  ==========================================================================
+  Project:   SproutCore - JavaScript Application Framework
+  Copyright: ©2008-2011 Apple Inc. All rights reserved.
+  License:   Licensed under MIT license (see license.js)
+  ==========================================================================
+*/
+#mainPane {
+  font-family: "Helvetica Neue", "Helvetica", Verdana;
+}
+
+#mainPane .class-detail {
+  position: absolute;
+  top:0;
+  left:190px;
+  right:0;
+  bottom:0;
+  background: white;
+  overflow:auto;
+  font-size:14px;
+  -webkit-user-select: text;
+}
+
+#mainPane .class-detail #class-details {
+  background: #f2f2f2;
+  border-bottom: 1px #cccccc solid;
+  padding:15px 15px 0 15px;
+}
+
+#mainPane .class-detail #class-details .extends .name,
+#mainPane .class-detail #class-details .since .name {
+  font-weight:bolder;
+}
+
+#mainPane .class-detail #class-details .extends,
+#mainPane .class-detail #class-details .since {
+  margin-bottom:15px;
+}
+
+#mainPane .class-detail #class-info {
+  padding: 20px;
+}
+
+#mainPane .class-detail #class-info h2 {
+  color: #2b4270;
+  margin-bottom:10px;
+}
+
+#mainPane .class-header {
+  background: #e1e7ee;
+  border-bottom: 1px #a8b0ba solid;
+  z-index: 4;
+}
+
+#mainPane .class-header .class-name {
+  font-weight:bolder;
+  font-size:25px;
+}
+
+#mainPane .symbol-list {
+  background: #eef3f6;
+}
+
+#mainPane #class-info .subtitles {
+  color: gray;
+  margin-bottom:5px;
+  margin-left:15px;
+}
+
+#mainPane #class-info .subtitles .name {
+  font-weight:bolder;
+}
+
+#mainPane #class-info .subtitles .value {
+
+}
+
+#mainPane #class-info .overview {
+  margin-left:15px;
+  margin-bottom:15px;
+}
+
+#mainPane #class-info .header {
+  font-weight:bolder;
+  margin-bottom:10px;
+
+}
+
+#mainPane ul {
+  margin:0;
+}
+
+#mainPane .data-type {
+  margin-right: 5px;
+  color:gray;
+  border-radius:4px;
+  background: #f3f3f3;
+  padding:2px;
+  border:1px #ccc solid;
+}
+
+#mainPane .data-type.clickable {
+
+  color:blue;
+  text-decoration:underline;
+  /*border:1px #8E4602 solid;*/
+  /*color:white;*/
+  /*box-shadow: 0px 1px 2px #8E4602;*/
+  /*background: #DD8304; [> old browsers <]*/
+  /*background: -moz-linear-gradient(top, #DD8304 0%, #C64800 100%); [> firefox <]*/
+
+  /*background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#DD8304), color-stop(100%,#C64800)); [> webkit <]*/
+
+  /*filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#DD8304', endColorstr='#C64800',GradientType=0 ); [> ie <]*/
+
+  /*background: -o-linear-gradient(top, #DD8304 0%,#C64800 100%); [> opera <]*/
+}
+
+
+#mainPane .method-signature {
+  font-weight:bolder;
+}
+
+#mainPane #class-info hr {
+  border: none;
+  background:#a8b0ba;
+  height: 1px;
+  margin:15px 0;
+}
+
+#mainPane #class-info .returns {
+  margin-left: 15px;
+}
+
+#mainPane #class-info .returns .name {
+  /*color: gray;*/
+  font-weight:bolder;
+}
+
+#mainPane #class-info ul {
+  margin-left:15px;
+}
+
+#mainPane #class-info li {
+  list-style: circle;
+}
+
+#mainPane #class-info li.symbol {
+  list-style: none;
+}
+
+#mainPane #class-info pre {
+  background: #E1EBF2;
+  padding:5px;
+  overflow:auto
+}