History

Merge pull request #170 from TrangPham/master

Adding Official Url for url scrapped documentations

Thibaut Courouble committed 11 years ago

Commit 4b9256a2 parents 05e18b2 ab85da36 files · +57 −3Browse files

Showing the changes to lib/docs (4 of 6 files). Show all

Unified · Split

4 files
  1. lib/docs/core/doc.rb +1 −1
  2. lib/docs/core/filter.rb +4 −0
  3. lib/docs/core/scraper.rb +6 −2
  4. lib/docs/filters/core/home_url.rb +16 −0
lib/docs/core/doc.rb+1−1
@@ -4,7 +4,7 @@ module Docs · 3 unmodified lines
4 DB_FILENAME = 'db.json'4 DB_FILENAME = 'db.json'
5 5
6 class << self6 class << self
7 attr_accessor :name, :slug, :type, :version, :abstract7 attr_accessor :name, :slug, :type, :version, :abstract, :home_url
8 8
9 def inherited(subclass)9 def inherited(subclass)
10 subclass.type = type10 subclass.type = type
lib/docs/core/filter.rb+4−0
@@ -20,6 +20,10 @@ module Docs · 19 unmodified lines
20 context[:base_url]20 context[:base_url]
21 end21 end
22 22
23 def home_url
24 context[:home_url]
25 end
26
23 def current_url27 def current_url
24 context[:url]28 context[:url]
25 end29 end
lib/docs/core/scraper.rb+6−2
@@ -34,7 +34,7 @@ module Docs · 33 unmodified lines
34 self.text_filters = FilterStack.new34 self.text_filters = FilterStack.new
35 35
36 html_filters.push 'container', 'clean_html', 'normalize_urls', 'internal_urls', 'normalize_paths'36 html_filters.push 'container', 'clean_html', 'normalize_urls', 'internal_urls', 'normalize_paths'
37 text_filters.push 'inner_html', 'clean_text', 'attribution'37 text_filters.push 'inner_html', 'clean_text', 'home_url', 'attribution'
38 38
39 def build_page(path)39 def build_page(path)
40 response = request_one url_for(path)40 response = request_one url_for(path)
@@ -65,6 +65,10 @@ module Docs · 24 unmodified lines
65 @root_url ||= root_path? ? URL.parse(File.join(base_url.to_s, root_path)) : base_url.normalize65 @root_url ||= root_path? ? URL.parse(File.join(base_url.to_s, root_path)) : base_url.normalize
66 end66 end
67 67
68 def home_url
69 @home_url ||= self.class.home_url
70 end
71
68 def root_path72 def root_path
69 self.class.root_path73 self.class.root_path
70 end74 end
@@ -89,7 +93,7 @@ module Docs · 18 unmodified lines
89 93
90 def options94 def options
91 @options ||= self.class.options.deep_dup.tap do |options|95 @options ||= self.class.options.deep_dup.tap do |options|
92 options.merge! base_url: base_url, root_url: root_url,96 options.merge! base_url: base_url, root_url: root_url, home_url: home_url,
93 root_path: root_path, initial_paths: initial_paths97 root_path: root_path, initial_paths: initial_paths
94 98
95 if root_path?99 if root_path?
lib/docs/filters/core/home_url.rb+16−0
@@ -0,0 +1,16 @@
1module Docs
2 class HomeUrlFilter < Filter
3 def call
4 html.prepend(home_url_html) if home_url
5 html
6 end
7
8 def home_url_html
9 <<-HTML.strip_heredoc
10 <div class="_official">
11 Official Documentation: <a href="#{home_url}" class="_official-link">#{home_url}</a>
12 </div>
13 HTML
14 end
15 end
16end