Update and version Sinon.JS documentation

Thibaut Courouble committed 9 years ago

Commit 7e5c3fc1 parent 458000314 files · +49 −48Browse files

Unified · Split

14 files

assets/images/docs.png +0 −0
assets/images/docs@2x.png +0 −0
assets/javascripts/templates/pages/about_tmpl.coffee +2 −2
assets/stylesheets/application-dark.css.scss +1 −0
assets/stylesheets/application.css.scss +1 −0
assets/stylesheets/global/_icons.scss +1 −1
assets/stylesheets/pages/_simple.scss +0 −1
assets/stylesheets/pages/_sinon.scss +5 −0
lib/docs/filters/sinon/clean_html.rb +10 −4
lib/docs/filters/sinon/entries.rb +16 −35
lib/docs/scrapers/sinon.rb +16 −8
public/icons/docs/sinon/16.png +0 −0
public/icons/docs/sinon/16@2x.png +0 −0
public/icons/docs/sinon/SOURCE +1 −1

assets/images/docs.png+0−0

Binary file not shown.

assets/images/docs@2x.png+0−0

Binary file not shown.

assets/javascripts/templates/pages/about_tmpl.coffee+2−2

@@ -531,9 +531,9 @@ credits = [ · 530 unmodified lines
531	531	'https://raw.githubusercontent.com/scikit-learn/scikit-learn/master/COPYING'
532	532	], [
533	533	'Sinon',
534		− '2010-2016 Christian Johansen',
	534	+ '2010-2017 Christian Johansen',
535	535	'BSD',
536		− 'https://raw.githubusercontent.com/cjohansen/Sinon.JS/master/LICENSE'
	536	+ 'https://raw.githubusercontent.com/sinonjs/sinon/master/LICENSE'
537	537	], [
538	538	'Socket.io',
539	539	'2014-2015 Automattic',

assets/stylesheets/application-dark.css.scss+1−0

@@ -81,6 +81,7 @@ · 80 unmodified lines
81	81	'pages/rfc',
82	82	'pages/rubydoc',
83	83	'pages/rust',
	84	+ 'pages/sinon',
84	85	'pages/socketio',
85	86	'pages/sphinx',
86	87	'pages/sphinx_simple',

assets/stylesheets/application.css.scss+1−0

@@ -81,6 +81,7 @@ · 80 unmodified lines
81	81	'pages/rfc',
82	82	'pages/rubydoc',
83	83	'pages/rust',
	84	+ 'pages/sinon',
84	85	'pages/socketio',
85	86	'pages/sphinx',
86	87	'pages/sphinx_simple',

assets/stylesheets/global/_icons.scss+1−1

@@ -93,7 +93,7 @@ · 92 unmodified lines
93	93	._icon-haskell:before { background-position: -6rem -4rem; }
94	94	._icon-requirejs:before { background-position: -7rem -4rem; }
95	95	._icon-chai:before { background-position: -8rem -4rem; }
96		−._icon-sinon:before { background-position: -9rem -4rem; @extend %darkIconFix !optional; }
	96	+._icon-sinon:before { background-position: -9rem -4rem; }
97	97	._icon-cordova:before { background-position: 0 -5rem; }
98	98	._icon-markdown:before { background-position: -1rem -5rem; @extend %darkIconFix !optional; }
99	99	._icon-django:before { background-position: -2rem -5rem; }

assets/stylesheets/pages/_simple.scss+0−1

@@ -35,7 +35,6 @@ · 34 unmodified lines
35	35	._mocha,
36	36	._mongoose,
37	37	._redux,
38		−._sinon,
39	38	._typescript,
40	39	._yarn {
41	40	@extend %simple;

assets/stylesheets/pages/_sinon.scss+5−0

@@ -0,0 +1,5 @@
	1	+._sinon {
	2	+ @extend %simple;
	3	+
	4	+ h4 { @extend %block-label;}
	5	+}

lib/docs/filters/sinon/clean_html.rb+10−4

@@ -2,15 +2,21 @@ module Docs · 1 unmodified line
2	2	class Sinon
3	3	class CleanHtmlFilter < Filter
4	4	def call
5		− css('> p:first-child', 'a.api', 'ul.nav').remove
	5	+ if root_page?
	6	+ at_css('h1').content = 'Sinon.JS'
	7	+ else
	8	+ css('h1').each do \|node\|
	9	+ node.content = node.content.remove(' - Sinon.JS')
	10	+ end
	11	+ end
6	12
7		− css('.section', 'h2 code', 'h3 code').each do \|node\|
	13	+ css('.post', '.post-header', '.post-content', 'pre code').each do \|node\|
8	14	node.before(node.children).remove
9	15	end
10	16
11		− # Remove code highlighting
	17	+ css('h1 + h1').remove
	18	+
12	19	css('pre').each do \|node\|
13		− node.content = node.content
14	20	node['data-language'] = 'javascript'
15	21	end
16	22

lib/docs/filters/sinon/entries.rb+16−35

@@ -1,46 +1,27 @@
1	1	module Docs
2	2	class Sinon
3	3	class EntriesFilter < Docs::EntriesFilter
4		− def additional_entries
5		− entries = []
6		− type = config = nil
7		−
8		− css('*').each do \|node\|
9		− if node.name == 'h2'
10		− config = false
11		− type = node.content.strip
12		− type.remove! 'Test '
13		− type.remove! 'Sinon.JS '
14		− type = type[0].upcase + type.from(1)
15		−
16		− id = type.parameterize
17		− node['id'] = id
	4	+ def get_name
	5	+ at_css('h1').content.strip
	6	+ end
18	7
19		− entries << [type, id, 'Sections']
20		− elsif node.name == 'h3' && node.content.include?('sinon.config')
21		− config = true
22		− elsif node.name == 'dl'
23		− node.css('dt > code').each do \|code\|
24		− name = code.content.strip
25		− name.sub! %r{\(.*\);?}, '()'
26		− name.sub! %r{\Aserver.(\w+)\s=.*\z}, 'server.\1'
27		− name.remove! '`'
28		− name.remove! %r{\A.+?\=\s+}
29		− name.remove! %r{\A\w+?\s}
30		− name.prepend 'sinon.config.' if config
	8	+ def get_type
	9	+ name
	10	+ end
31	11
32		− next if name =~ /\s/
33		− next if entries.any? { \|entry\| entry[0].casecmp(name) == 0 }
	12	+ def additional_entries
	13	+ css('h4 > code').each_with_object [] do \|node, entries\|
	14	+ name = node.content.strip
	15	+ name.sub! %r{\s\(.\);?}, '()'
	16	+ name.sub! %r{\A(\w+\.\w+)\s+\=.*}, '\1'
	17	+ name.remove! %r{\A.+?\=\s+}
	18	+ name.remove! %r{\A\w+?\s}
	19	+ name.remove! %r{;\z}
34	20
35		− id = name.parameterize
36		− code.parent['id'] = id
	21	+ next if entries.any? { \|entry\| entry[0].casecmp(name) == 0 }
37	22
38		− entries << [name, id, type]
39		− end
40		− end
	23	+ entries << [name, node.parent['id']]
41	24	end
42		−
43		− entries
44	25	end
45	26	end
46	27	end

lib/docs/scrapers/sinon.rb+16−8

@@ -1,23 +1,31 @@
1	1	module Docs
2	2	class Sinon < UrlScraper
3		− self.name = 'Sinon'
	3	+ self.name = 'Sinon.JS'
	4	+ self.slug = 'sinon'
4	5	self.type = 'sinon'
5		− self.release = '1.17.5'
6		− self.base_url = 'http://sinonjs.org/docs/'
7	6	self.links = {
8	7	home: 'http://sinonjs.org/',
9		− code: 'https://github.com/cjohansen/Sinon.JS'
	8	+ code: 'https://github.com/sinonjs/sinon'
10	9	}
11	10
12		− html_filters.push 'sinon/clean_html', 'sinon/entries', 'title'
	11	+ html_filters.push 'sinon/clean_html', 'sinon/entries'
13	12
14	13	options[:title] = 'Sinon.JS'
15		− options[:container] = '.docs'
16		− options[:skip_links] = true
	14	+ options[:container] = '.content .container'
17	15
18	16	options[:attribution] = <<-HTML
19		− © 2010–2016 Christian Johansen<br>
	17	+ © 2010–2017 Christian Johansen<br>
20	18	Licensed under the BSD License.
21	19	HTML
	20	+
	21	+ version '2' do
	22	+ self.release = '2.1.0'
	23	+ self.base_url = "http://sinonjs.org/releases/v#{release}/"
	24	+ end
	25	+
	26	+ version '1' do
	27	+ self.release = '1.17.7'
	28	+ self.base_url = "http://sinonjs.org/releases/v#{release}/"
	29	+ end
22	30	end
23	31	end

public/icons/docs/sinon/16.png+0−0

Binary file not shown.

public/icons/docs/sinon/16@2x.png+0−0

Binary file not shown.

public/icons/docs/sinon/SOURCE+1−1

@@ -1 +1 @@
1		−https://github.com/Kapeli/Dash-X-Platform-Resources/blob/master/docset_icons/sinon%402x.png
	1	+https://github.com/sinonjs/sinon/blob/master/docs/assets/images/logo.png