History

Update and version Sinon.JS documentation

Thibaut Courouble committed 9 years ago

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

Unified · Split

14 files
  1. assets/images/docs.png +0 −0
  2. assets/images/docs@2x.png +0 −0
  3. assets/javascripts/templates/pages/about_tmpl.coffee +2 −2
  4. assets/stylesheets/application-dark.css.scss +1 −0
  5. assets/stylesheets/application.css.scss +1 −0
  6. assets/stylesheets/global/_icons.scss +1 −1
  7. assets/stylesheets/pages/_simple.scss +0 −1
  8. assets/stylesheets/pages/_sinon.scss +5 −0
  9. lib/docs/filters/sinon/clean_html.rb +10 −4
  10. lib/docs/filters/sinon/entries.rb +16 −35
  11. lib/docs/scrapers/sinon.rb +16 −8
  12. public/icons/docs/sinon/16.png +0 −0
  13. public/icons/docs/sinon/16@2x.png +0 −0
  14. 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 'https://raw.githubusercontent.com/scikit-learn/scikit-learn/master/COPYING'531 'https://raw.githubusercontent.com/scikit-learn/scikit-learn/master/COPYING'
532 ], [532 ], [
533 'Sinon',533 'Sinon',
534 '2010-2016 Christian Johansen',534 '2010-2017 Christian Johansen',
535 'BSD',535 'BSD',
536 'https://raw.githubusercontent.com/cjohansen/Sinon.JS/master/LICENSE'536 'https://raw.githubusercontent.com/sinonjs/sinon/master/LICENSE'
537 ], [537 ], [
538 'Socket.io',538 'Socket.io',
539 '2014-2015 Automattic',539 '2014-2015 Automattic',
assets/stylesheets/application-dark.css.scss+1−0
@@ -81,6 +81,7 @@ · 80 unmodified lines
81 'pages/rfc',81 'pages/rfc',
82 'pages/rubydoc',82 'pages/rubydoc',
83 'pages/rust',83 'pages/rust',
84 'pages/sinon',
84 'pages/socketio',85 'pages/socketio',
85 'pages/sphinx',86 'pages/sphinx',
86 'pages/sphinx_simple',87 'pages/sphinx_simple',
assets/stylesheets/application.css.scss+1−0
@@ -81,6 +81,7 @@ · 80 unmodified lines
81 'pages/rfc',81 'pages/rfc',
82 'pages/rubydoc',82 'pages/rubydoc',
83 'pages/rust',83 'pages/rust',
84 'pages/sinon',
84 'pages/socketio',85 'pages/socketio',
85 'pages/sphinx',86 'pages/sphinx',
86 'pages/sphinx_simple',87 'pages/sphinx_simple',
assets/stylesheets/global/_icons.scss+1−1
@@ -93,7 +93,7 @@ · 92 unmodified lines
93._icon-haskell:before { background-position: -6rem -4rem; }93._icon-haskell:before { background-position: -6rem -4rem; }
94._icon-requirejs:before { background-position: -7rem -4rem; }94._icon-requirejs:before { background-position: -7rem -4rem; }
95._icon-chai:before { background-position: -8rem -4rem; }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._icon-cordova:before { background-position: 0 -5rem; }97._icon-cordova:before { background-position: 0 -5rem; }
98._icon-markdown:before { background-position: -1rem -5rem; @extend %darkIconFix !optional; }98._icon-markdown:before { background-position: -1rem -5rem; @extend %darkIconFix !optional; }
99._icon-django:before { background-position: -2rem -5rem; }99._icon-django:before { background-position: -2rem -5rem; }
assets/stylesheets/pages/_simple.scss+0−1
@@ -35,7 +35,6 @@ · 34 unmodified lines
35._mocha,35._mocha,
36._mongoose,36._mongoose,
37._redux,37._redux,
38._sinon,
39._typescript,38._typescript,
40._yarn {39._yarn {
41 @extend %simple;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 class Sinon2 class Sinon
3 class CleanHtmlFilter < Filter3 class CleanHtmlFilter < Filter
4 def call4 def call
5 css('> p:first-child', 'a.api', 'ul.nav').remove5 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 node.before(node.children).remove14 node.before(node.children).remove
9 end15 end
10 16
11 # Remove code highlighting17 css('h1 + h1').remove
18
12 css('pre').each do |node|19 css('pre').each do |node|
13 node.content = node.content
14 node['data-language'] = 'javascript'20 node['data-language'] = 'javascript'
15 end21 end
16 22
lib/docs/filters/sinon/entries.rb+16−35
@@ -1,46 +1,27 @@
1module Docs1module Docs
2 class Sinon2 class Sinon
3 class EntriesFilter < Docs::EntriesFilter3 class EntriesFilter < Docs::EntriesFilter
4 def additional_entries4 def get_name
5 entries = []5 at_css('h1').content.strip
6 type = config = nil6 end
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
18 7
19 entries << [type, id, 'Sections']8 def get_type
20 elsif node.name == 'h3' && node.content.include?('sinon.config')9 name
21 config = true10 end
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
31 11
32 next if name =~ /\s/12 def additional_entries
33 next if entries.any? { |entry| entry[0].casecmp(name) == 0 }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.parameterize21 next if entries.any? { |entry| entry[0].casecmp(name) == 0 }
36 code.parent['id'] = id
37 22
38 entries << [name, id, type]23 entries << [name, node.parent['id']]
39 end
40 end
41 end24 end
42
43 entries
44 end25 end
45 end26 end
46 end27 end
lib/docs/scrapers/sinon.rb+16−8
@@ -1,23 +1,31 @@
1module Docs1module Docs
2 class Sinon < UrlScraper2 class Sinon < UrlScraper
3 self.name = 'Sinon'3 self.name = 'Sinon.JS'
4 self.slug = 'sinon'
4 self.type = 'sinon'5 self.type = 'sinon'
5 self.release = '1.17.5'
6 self.base_url = 'http://sinonjs.org/docs/'
7 self.links = {6 self.links = {
8 home: 'http://sinonjs.org/',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 options[:title] = 'Sinon.JS'13 options[:title] = 'Sinon.JS'
15 options[:container] = '.docs'14 options[:container] = '.content .container'
16 options[:skip_links] = true
17 15
18 options[:attribution] = <<-HTML16 options[:attribution] = <<-HTML
19 &copy; 2010&ndash;2016 Christian Johansen<br>17 &copy; 2010&ndash;2017 Christian Johansen<br>
20 Licensed under the BSD License.18 Licensed under the BSD License.
21 HTML19 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 end30 end
23end31end
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 @@
1https://github.com/Kapeli/Dash-X-Platform-Resources/blob/master/docset_icons/sinon%402x.png1https://github.com/sinonjs/sinon/blob/master/docs/assets/images/logo.png