Finish CodeIgniter scraper

Thibaut Courouble committed 10 years ago

Commit 0efa4c31 parent 8232a0517 files · +59 −44Browse files

Unified · Split

17 files

assets/images/icons.png +0 −0
assets/images/icons@2x.png +0 −0
assets/javascripts/news.json +3 −0
assets/javascripts/templates/pages/about_tmpl.coffee +5 −0
assets/javascripts/views/pages/codeigniter.coffee +0 −6
assets/javascripts/views/pages/sphinx.coffee +1 −0
assets/stylesheets/application-dark.css.scss +0 −1
assets/stylesheets/application.css.scss +0 −1
assets/stylesheets/global/_icons.scss +1 −0
assets/stylesheets/pages/_codeigniter.scss +0 −6
assets/stylesheets/pages/_sphinx.scss +3 −2
lib/docs/filters/codeigniter/clean_html.rb +10 −4
lib/docs/filters/codeigniter/entries.rb +22 −17
lib/docs/scrapers/codeigniter.rb +19 −12
public/icons/docs/codeigniter/16.png +0 −0
public/icons/docs/codeigniter/16@2.png +0 −0
public/icons/docs/codeigniter/16@2x.png +0 −0

assets/images/icons.png+0−0

Binary file not shown.

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

Binary file not shown.

assets/javascripts/news.json+3−0

@@ -1,5 +1,8 @@
1	1	[
2	2	[
	3	+ "2016-02-28",
	4	+ "New documentation: <a href=\"/codeigniter/\">CodeIgniter</a>"
	5	+ ], [
3	6	"2016-02-15",
4	7	"New documentations: <a href=\"/cakephp/\">CakePHP</a>, <a href=\"/chef/\">Chef</a> and <a href=\"/ramda/\">Ramda</a>"
5	8	], [

assets/javascripts/templates/pages/about_tmpl.coffee+5−0

@@ -119,6 +119,11 @@ credits = [ · 118 unmodified lines
119	119	'Rich Hickey',
120	120	'EPL',
121	121	'https://github.com/clojure/clojure/blob/master/epl-v10.html'
	122	+ ], [
	123	+ 'CodeIgniter',
	124	+ '2014-2016 British Columbia Institute of Technology',
	125	+ 'MIT',
	126	+ 'https://raw.githubusercontent.com/bcit-ci/CodeIgniter/develop/license.txt'
122	127	], [
123	128	'CoffeeScript',
124	129	'2009-2015 Jeremy Ashkenas',

assets/javascripts/views/pages/codeigniter.coffee+0−6

@@ -1,6 +0,0 @@
1		−#= require views/pages/base
2		−
3		−class app.views.CodeigniterPage extends app.views.BasePage
4		− prepare: ->
5		− @highlightCode @findAllByTag('pre'), 'php'
6		− return

assets/javascripts/views/pages/sphinx.coffee+1−0

@@ -4,4 +4,5 @@ class app.views.SphinxPage extends app.views.BasePage · 3 unmodified lines
4	4	prepare: ->
5	5	@highlightCode @findAll('pre.python'), 'python'
6	6	@highlightCode @findAll('pre.markup'), 'markup'
	7	+ @highlightCode @findAll('pre.php'), 'php'
7	8	return

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

@@ -36,7 +36,6 @@ · 35 unmodified lines
36	36	'pages/cakephp',
37	37	'pages/chai',
38	38	'pages/clojure',
39		− 'pages/codeigniter',
40	39	'pages/coffeescript',
41	40	'pages/d3',
42	41	'pages/dojo',

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

@@ -36,7 +36,6 @@ · 35 unmodified lines
36	36	'pages/cakephp',
37	37	'pages/chai',
38	38	'pages/clojure',
39		− 'pages/codeigniter',
40	39	'pages/coffeescript',
41	40	'pages/d3',
42	41	'pages/dojo',

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

@@ -126,3 +126,4 @@ · 125 unmodified lines
126	126	._icon-erlang:before { background-position: -1rem -10rem; }
127	127	._icon-chef:before { background-position: -2rem -10rem; }
128	128	._icon-ramda:before { background-position: -3rem -10rem; @extend %darkIconFix !optional; }
	129	+._icon-codeigniter:before { background-position: -4rem -10rem; @extend %darkIconFix !optional; }

assets/stylesheets/pages/_codeigniter.scss+0−6

@@ -1,6 +0,0 @@
1		−._codeigniter {
2		− @extend %sphinx;
3		−
4		− .important { @extend %note-orange; }
5		− .warning { @extend %note-red; }
6		−}

assets/stylesheets/pages/_sphinx.scss+3−2

@@ -4,7 +4,8 @@ · 3 unmodified lines
4	4	dt + dt { margin-top: -.5em; }
5	5
6	6	.note, .admonition, .versionadded, .versionchanged, .deprecated-removed { @extend %note; }
7		− .deprecated-removed { @extend %note-red; }
	7	+ .important { @extend %note-orange; }
	8	+ .warning, .deprecated-removed { @extend %note-red; }
8	9	.versionmodified { font-weight: bold; }
9	10
10	11	p > code, li > code { @extend %label; }
@@ -26,5 +27,5 @@ · 15 unmodified lines
26	27	}
27	28
28	29	._sphinx {
29		− @extend %sphinx
	30	+ @extend %sphinx;
30	31	}

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

@@ -8,16 +8,22 @@ module Docs · 7 unmodified lines
8	8	node.content = node.content
9	9	end
10	10
	11	+ css('div[class^="highlight-"]').each do \|node\|
	12	+ node.content = node.content.strip
	13	+ node.name = 'pre'
	14	+ node['class'] = 'php' if node['class'].include?('highlight-ci')
	15	+ end
	16	+
11	17	css('table').each do \|node\|
12	18	node.remove_attribute 'border'
13	19	end
14	20
15		− css('.section > h2', '.section > h3', '.section > h4', '.section > h5').each do \|node\|
16		− node['id'] = node.parent['id']
17		− node.parent.remove_attribute 'id'
	21	+ css('.section').each do \|node\|
	22	+ node.first_element_child['id'] = node['id'] if node['id']
	23	+ node.before(node.children).remove
18	24	end
19	25
20		− doc.children
	26	+ doc
21	27	end
22	28	end
23	29	end

lib/docs/filters/codeigniter/entries.rb+22−17

@@ -1,38 +1,43 @@
1	1	module Docs
2	2	class Codeigniter
3	3	class EntriesFilter < Docs::EntriesFilter
4		− def include_default_entry?
5		− not slug.ends_with? 'index'
6		− end
7		−
8	4	def get_name
9	5	at_css('h1').content.strip
10	6	end
11	7
12	8	def get_type
13		− slug.split('/')[0].capitalize
	9	+ type = slug.split('/').first.capitalize
	10	+
	11	+ if type.in? %w(Tutorial Installation Overview General)
	12	+ type.prepend 'User guide: '
	13	+ elsif type.in? %w(Libraries Helpers)
	14	+ type = name.remove %r{\ (?:Helper\|Class\|Classes\|Library\|Driver)\z}
	15	+ end
	16	+
	17	+ type
14	18	end
15	19
16	20	def additional_entries
17	21	entries = []
18	22
19		− css('.class').each do \|c_node\|
20		− c_name = c_node.at_css('dt > .descname').content
21		− c_id = c_node.at_css('dt')['id']
22		− entries << [c_name, c_id, get_type]
	23	+ css('.class').each do \|node\|
	24	+ class_name = node.at_css('dt > .descname').content
	25	+ class_id = node.at_css('dt[id]')['id']
	26	+ entries << [class_name, class_id]
23	27
24		− c_node.css('.method').each do \|node\|
25		− m_name = node.at_css('.descname').content
26		− name = c_name + '::' + m_name + '()'
27		− id = node.at_css('dt')['id']
28		− entries << [name, id, get_type]
	28	+ node.css('.method').each do \|n\|
	29	+ name = n.at_css('.descname').content
	30	+ name = "#{class_name}::#{name}()"
	31	+ id = node.at_css('dt[id]')['id']
	32	+ entries << [name, id]
29	33	end
30	34	end
31	35
32	36	css('.function').each do \|node\|
33		− name = node.at_css('.descname').content + '()'
34		− id = node.at_css('dt')['id']
35		− entries << [name, id, get_type]
	37	+ name = "#{node.at_css('.descname').content}()"
	38	+ id = node.at_css('dt[id]')['id']
	39	+ type = self.type.start_with?('User guide') ? 'Functions' : self.type
	40	+ entries << [name, id, type]
36	41	end
37	42
38	43	entries

lib/docs/scrapers/codeigniter.rb+19−12

@@ -1,12 +1,11 @@
1	1	module Docs
2	2	class Codeigniter < UrlScraper
3	3	self.name = 'CodeIgniter'
4		− self.type = 'codeigniter'
5		− self.release = '3.0'
6		− self.base_url = 'http://www.codeigniter.com/user_guide/'
	4	+ self.type = 'sphinx'
	5	+ self.base_url = 'https://www.codeigniter.com/user_guide/'
7	6	self.root_path = 'index.html'
8	7	self.links = {
9		− home: 'http://codeigniter.com/',
	8	+ home: 'https://codeigniter.com/',
10	9	code: 'https://github.com/bcit-ci/CodeIgniter'
11	10	}
12	11
@@ -14,22 +13,30 @@ module Docs · 1 unmodified line
14	13
15	14	options[:container] = '.document'
16	15
17		− options[:only_patterns] = [
18		− /\Ageneral/,
19		− /\Alibraries/,
20		− /\Adatabase/,
21		− /\Ahelpers/
22		− ]
23		−
24	16	options[:skip] = %w(
	17	+ license.html
	18	+ changelog.html
	19	+ DCO.html
25	20	general/welcome.html
26	21	general/requirements.html
27	22	general/credits.html
	23	+ libraries/index.html
	24	+ helpers/index.html
28	25	)
29	26
	27	+ options[:skip_patterns] = [
	28	+ /\Acontributing/,
	29	+ /\Adocumentation/,
	30	+ /\Ainstallation\/upgrade/
	31	+ ]
	32	+
30	33	options[:attribution] = <<-HTML
31		− © British Columbia Institute of Technology<br>
	34	+ © 2014–2016 British Columbia Institute of Technology<br>
32	35	Licensed under the MIT License.
33	36	HTML
	37	+
	38	+ version '3.0' do
	39	+ self.release = '3.0.4'
	40	+ end
34	41	end
35	42	end

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

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.