Skip to content

Commit 899aee8

Browse files
ThibautThibaut
committed
Finish Falcon scraper
1 parent f424256 commit 899aee8

10 files changed

Lines changed: 31 additions & 19 deletions

File tree

‎assets/images/docs-2.png‎

215 Bytes
Loading

‎assets/images/[email protected]‎

627 Bytes
Loading

‎assets/javascripts/news.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[
22
[
33
"2017-06-04",
4-
"New documentations: <a href=\"/electron/\">Electron</a>, <a href=\"/pug/\">Pug</a>"
4+
"New documentations: <a href=\"/electron/\">Electron</a>, <a href=\"/pug/\">Pug</a>, and <a href=\"/falcon/\">Falcon</a>"
55
], [
66
"2017-05-14",
77
"New documentations: <a href=\"/jest/\">Jest</a>, <a href=\"/jasmine/\">Jasmine</a> and <a href=\"/liquid/\">Liquid</a>"

‎assets/javascripts/templates/pages/about_tmpl.coffee‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,11 @@ credits = [
243243
'2016 StrongLoop, IBM, and other expressjs.com contributors.',
244244
'CC BY-SA',
245245
'https://raw.githubusercontent.com/expressjs/expressjs.com/gh-pages/LICENSE.md'
246+
], [
247+
'Falcon',
248+
'2012-2016 by Rackspace Hosting, Inc. and other contributors',
249+
'Apache',
250+
'https://raw.githubusercontent.com/falconry/falcon/master/LICENSE'
246251
], [
247252
'Fish',
248253
'2005-2009 Axel Liljencrantz',

‎assets/stylesheets/global/_icons.scss‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,3 +174,4 @@
174174
._icon-jasmine:before { background-position: 0 -2rem; @extend %doc-icon-2; }
175175
._icon-pug:before { background-position: -1rem -2rem; @extend %doc-icon-2; }
176176
._icon-electron:before { background-position: -2rem -2rem; @extend %doc-icon-2; }
177+
._icon-falcon:before { background-position: -3rem -2rem; @extend %doc-icon-2; }

‎lib/docs/filters/falcon/entries.rb‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,44 @@ def get_name
99

1010
def get_type
1111
case slug.split('/').first
12-
when 'community'
13-
'Community Guide'
1412
when 'user'
15-
'User Guide'
13+
'Guide'
1614
when 'api'
17-
'Classes and Functions'
18-
else
19-
'Other'
15+
'API'
2016
end
2117
end
2218

2319
def additional_entries
2420
entries = []
2521

2622
css('.class').each do |node|
23+
namespace = node.at_css('.descclassname').content.strip.remove(/\.\z/)
2724
class_name = node.at_css('dt > .descname').content
2825
class_id = node.at_css('dt[id]')['id']
29-
entries << [class_name, class_id]
26+
entries << ["#{namespace}.#{class_name}", class_id, namespace]
27+
28+
node.css('.attribute').each do |n|
29+
next unless n.at_css('dt[id]')
30+
name = n.at_css('.descname').content
31+
name = "#{namespace}.#{class_name}.#{name}"
32+
id = n.at_css('dt[id]')['id']
33+
entries << [name, id, namespace]
34+
end
3035

3136
node.css('.method').each do |n|
3237
next unless n.at_css('dt[id]')
3338
name = n.at_css('.descname').content
34-
name = "#{class_name}.#{name}()"
39+
name = "#{namespace}.#{class_name}.#{name}()"
3540
id = n.at_css('dt[id]')['id']
36-
entries << [name, id]
41+
entries << [name, id, namespace]
3742
end
3843
end
3944

4045
css('.function').each do |node|
41-
name = "#{node.at_css('.descname').content}()"
46+
namespace = node.at_css('.descclassname').content.strip.remove(/\.\z/)
47+
name = "#{namespace}.#{node.at_css('.descname').content}()"
4248
id = node.at_css('dt[id]')['id']
43-
entries << [name, id]
49+
entries << [name, id, namespace]
4450
end
4551

4652
entries

‎lib/docs/scrapers/falcon.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ class Falcon < UrlScraper
1111

1212
options[:container] = '.body'
1313

14-
options[:skip_patterns] = [/\Achanges/, /\A_modules/]
14+
options[:skip] = %w(user/index.html api/index.html)
15+
options[:skip_patterns] = [/\Achanges/, /\A_modules/, /\Acommunity/]
1516

1617
options[:attribution] = <<-HTML
17-
&copy; 2016 Falcon Contributors<br>
18-
Licensed under the Apache 2 License.
18+
&copy; 2012&ndash;2016 by Rackspace Hosting, Inc. and other contributors<br>
19+
Licensed under the Apache License, Version 2.0.
1920
HTML
2021

21-
version '1.2.0' do
22+
version '1.2' do
2223
self.release = '1.2.0'
23-
self.base_url = "https://falcon.readthedocs.io/en/#{self.version}/"
24+
self.base_url = "https://falcon.readthedocs.io/en/#{self.release}/"
2425
end
25-
2626
end
2727
end

‎public/icons/docs/falcon/16.png‎

297 Bytes
Loading

‎public/icons/docs/falcon/[email protected]‎

703 Bytes
Loading

‎public/icons/docs/falcon/SOURCE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
https://github.com/falconry/falcon/blob/master/docs/_static/img/logo.jpg
1+
https://github.com/falconry/falconry.github.io

0 commit comments

Comments
 (0)