aboutsummaryrefslogtreecommitdiffstats
path: root/docs/src/gen-docs.js
blob: 2915e110316938bd162021edb2c3ec93ee39834a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
var reader = require('./reader.js'),
    ngdoc = require('./ngdoc.js'),
    writer = require('./writer.js'),
    SiteMap = require('./SiteMap.js').SiteMap,
    appCache = require('./appCache.js').appCache,
    Q = require('qq');

process.on('uncaughtException', function(err) {
  console.error(err.stack || err);
});

var start = now();
var docs;

writer.makeDir('build/docs/syntaxhighlighter').then(function() {
  console.log('Generating Angular Reference Documentation...');
  return reader.collect();
}).then(function generateHtmlDocPartials(docs_) {
  docs = docs_;
  ngdoc.merge(docs);
  var fileFutures = [];
  docs.forEach(function(doc){
    // this hack is here because on OSX angular.module and angular.Module map to the same file.
    var id = doc.id.replace('angular.Module', 'angular.IModule');
    fileFutures.push(writer.output('partials/' + doc.section + '/' + id + '.html', doc.html()));
  });

  writeTheRest(fileFutures);

  return Q.deep(fileFutures);
}).then(function generateManifestFile() {
  return appCache('build/docs/').then(function(list) {
    writer.output('appcache-offline.manifest', list);
  });
}).then(function printStats() {
  console.log('DONE. Generated ' + docs.length + ' pages in ' + (now()-start) + 'ms.' );
}).end();


function writeTheRest(writesFuture) {
  var metadata = ngdoc.metadata(docs);

  writesFuture.push(writer.copyDir('img'));
  writesFuture.push(writer.copyDir('examples'));

  var manifest = 'manifest="/build/docs/appcache.manifest"';

  writesFuture.push(writer.copy('docs/src/templates/index.html', 'build/docs/index.html',
                                writer.replace, {'doc:manifest': ''})); //manifest //TODO(i): enable

  writesFuture.push(writer.copy('docs/src/templates/index.html', 'build/docs/index-nocache.html',
                                writer.replace, {'doc:manifest': ''}));


  writesFuture.push(writer.copy('docs/src/templates/index.html', 'build/docs/index-jq.html',
                                writer.replace, {'doc:manifest': manifest}));

  writesFuture.push(writer.copy('docs/src/templates/index.html', 'build/docs/index-jq-nocache.html',
                                writer.replace, {'doc:manifest': ''}));


  writesFuture.push(writer.copy('docs/src/templates/index.html', 'build/docs/index-debug.html',
                                writer.replace, {'doc:manifest': ''}));

  writesFuture.push(writer.copy('docs/src/templates/index.html', 'build/docs/index-jq-debug.html',
                                writer.replace, {'doc:manifest': ''}));

  writesFuture.push(writer.copyTpl('offline.html'));
  writesFuture.push(writer.copyTpl('docs-scenario.html'));
  writesFuture.push(writer.copyTpl('jquery.min.js'));

  writesFuture.push(writer.output('docs-keywords.js',
                                ['NG_PAGES=', JSON.stringify(metadata).replace(/{/g, '\n{'), ';']));
  writesFuture.push(writer.output('sitemap.xml', new SiteMap(docs).render()));
  writesFuture.push(writer.output('docs-scenario.js', ngdoc.scenarios(docs)));
  writesFuture.push(writer.output('robots.txt', 'Sitemap: http://docs.angularjs.org/sitemap.xml\n'));
  writesFuture.push(writer.output('appcache.manifest',appCache()));
  writesFuture.push(writer.copyTpl('.htaccess'));

  writesFuture.push(writer.merge(['docs.js',
                                  'doc_widgets.js'],
                                  'docs-combined.js'));
  writesFuture.push(writer.merge(['docs.css',
                                  'doc_widgets.css'],
                                  'docs-combined.css'));
  writesFuture.push(writer.merge(['syntaxhighlighter/shCore.js',
                                  'syntaxhighlighter/shBrushJScript.js',
                                  'syntaxhighlighter/shBrushXml.js'],
                                  'syntaxhighlighter/syntaxhighlighter-combined.js'));
  writesFuture.push(writer.merge(['syntaxhighlighter/shCore.css',
                                  'syntaxhighlighter/shThemeDefault.css'],
                                  'syntaxhighlighter/syntaxhighlighter-combined.css'));
}


function now() { return new Date().getTime(); }

function noop() {};
on', HTTP_ACCEPT='application/xml') # # output = xml2dict(resp.content) # # self.assertEquals(self.input, output) # # #def test_encode_xml_decode_xml(self): # # content = dict2xml(self.input) # # resp = self.client.put(reverse(views.WriteOnlyResource), content, 'application/json', HTTP_ACCEPT='application/xml') # # output = xml2dict(resp.content) # # self.assertEquals(self.input, output) # #class ModelTests(TestCase): # def test_create_container(self): # content = json.dumps({'name': 'example'}) # resp = self.client.post(reverse(views.ContainerFactory), content, 'application/json') # output = json.loads(resp.content) # self.assertEquals(resp.status_code, 201) # self.assertEquals(output['name'], 'example') # self.assertEquals(set(output.keys()), set(('absolute_uri', 'name', 'key'))) # #class CreatedModelTests(TestCase): # def setUp(self): # content = json.dumps({'name': 'example'}) # resp = self.client.post(reverse(views.ContainerFactory), content, 'application/json', HTTP_ACCEPT='application/json') # self.container = json.loads(resp.content) # # def test_read_container(self): # resp = self.client.get(self.container["absolute_uri"]) # self.assertEquals(resp.status_code, 200) # container = json.loads(resp.content) # self.assertEquals(container, self.container) # # def test_delete_container(self): # resp = self.client.delete(self.container["absolute_uri"]) # self.assertEquals(resp.status_code, 204) # self.assertEquals(resp.content, '') # # def test_update_container(self): # self.container['name'] = 'new' # content = json.dumps(self.container) # resp = self.client.put(self.container["absolute_uri"], content, 'application/json') # self.assertEquals(resp.status_code, 200) # container = json.loads(resp.content) # self.assertEquals(container, self.container) #above testcases need to probably moved to the core class TestRotation(TestCase): """For the example the maximum amount of Blogposts is capped off at views.MAX_POSTS. Whenever a new Blogpost is posted the oldest one should be popped.""" def setUp(self): self.factory = RequestFactory() models.BlogPost.objects.all().delete() def test_get_to_root(self): '''Simple test to demonstrate how the requestfactory needs to be used''' request = self.factory.get('/blog-post') view = views.BlogPosts.as_view() response = view(request) self.assertEqual(response.status_code, 200) def test_blogposts_not_exceed_MAX_POSTS(self): '''Posting blog-posts should not result in more than MAX_POSTS items stored.''' for post in range(views.MAX_POSTS + 5): form_data = {'title': 'This is post #%s' % post, 'content': 'This is the content of post #%s' % post} request = self.factory.post('/blog-post', data=form_data) view = views.BlogPosts.as_view() view(request) self.assertEquals(len(models.BlogPost.objects.all()),views.MAX_POSTS) def test_fifo_behaviour(self): '''It's fine that the Blogposts are capped off at MAX_POSTS. But we want to make sure we see FIFO behaviour.''' for post in range(15): form_data = {'title': '%s' % post, 'content': 'This is the content of post #%s' % post} request = self.factory.post('/blog-post', data=form_data) view = views.BlogPosts.as_view() view(request) request = self.factory.get('/blog-post') view = views.BlogPosts.as_view() response = view(request) response_posts = json.loads(response.content) response_titles = [d['title'] for d in response_posts] self.assertEquals(response_titles, ['%s' % i for i in range(views.MAX_POSTS - 5, views.MAX_POSTS + 5)])