From 2f9608662f842bdade887014031b490faa266cdf Mon Sep 17 00:00:00 2001 From: Jamie Ly Date: Sat, 21 Oct 2017 22:51:20 -0400 Subject: [PATCH 1/2] Adds scala documentation --- assets/stylesheets/application-dark.css.scss | 1 + assets/stylesheets/application.css.scss | 1 + assets/stylesheets/pages/_scala.scss | 4 + lib/docs/filters/scala/clean_html.rb | 99 +++++++++++++++++++ lib/docs/filters/scala/clean_html_210.rb | 32 ++++++ lib/docs/filters/scala/clean_html_212.rb | 36 +++++++ lib/docs/filters/scala/entries.rb | 65 ++++++++++++ lib/docs/scrapers/scala.rb | 80 +++++++++++++++ public/icons/docs/scala/16.png | Bin 0 -> 944 bytes public/icons/docs/scala/16@2x.png | Bin 0 -> 1843 bytes 10 files changed, 318 insertions(+) create mode 100644 assets/stylesheets/pages/_scala.scss create mode 100644 lib/docs/filters/scala/clean_html.rb create mode 100644 lib/docs/filters/scala/clean_html_210.rb create mode 100644 lib/docs/filters/scala/clean_html_212.rb create mode 100644 lib/docs/filters/scala/entries.rb create mode 100644 lib/docs/scrapers/scala.rb create mode 100644 public/icons/docs/scala/16.png create mode 100644 public/icons/docs/scala/16@2x.png diff --git a/assets/stylesheets/application-dark.css.scss b/assets/stylesheets/application-dark.css.scss index d480f720..3c407b58 100644 --- a/assets/stylesheets/application-dark.css.scss +++ b/assets/stylesheets/application-dark.css.scss @@ -85,6 +85,7 @@ 'pages/rfc', 'pages/rubydoc', 'pages/rust', + 'pages/scala', 'pages/sinon', 'pages/socketio', 'pages/sphinx', diff --git a/assets/stylesheets/application.css.scss b/assets/stylesheets/application.css.scss index 4fdc2a14..0b5a71ee 100644 --- a/assets/stylesheets/application.css.scss +++ b/assets/stylesheets/application.css.scss @@ -85,6 +85,7 @@ 'pages/rfc', 'pages/rubydoc', 'pages/rust', + 'pages/scala', 'pages/sinon', 'pages/socketio', 'pages/sphinx', diff --git a/assets/stylesheets/pages/_scala.scss b/assets/stylesheets/pages/_scala.scss new file mode 100644 index 00000000..b2beb118 --- /dev/null +++ b/assets/stylesheets/pages/_scala.scss @@ -0,0 +1,4 @@ +._scala { + @extend %simple; + .deprecated { @extend %label-red; } +} diff --git a/lib/docs/filters/scala/clean_html.rb b/lib/docs/filters/scala/clean_html.rb new file mode 100644 index 00000000..95097c80 --- /dev/null +++ b/lib/docs/filters/scala/clean_html.rb @@ -0,0 +1,99 @@ +module Docs + class Scala + class CleanHtmlFilter < Filter + def call + always + + if slug == 'index' + root + else + other + end + end + + def always + # remove deprecated sections + css('.members').each do |members| + header = members.at_css('h3') + members.remove if header.text.downcase.include? 'deprecate' + end + # Some of this is just for 2.12 + # These are things that provide interactive features, which are not supported yet. + css('#subpackage-spacer, #search, #mbrsel, .diagram-btn').remove + css('#footer').remove + css('.toggleContainer').remove + + signature = at_css('#signature') + signature.replace %Q| +

#{signature.inner_html}

+ | + + css('div.members > h3').each do |node| + change_tag! 'h2', node + end + + css('div.members > ol').each do |list| + list.css('li').each do |li| + h3 = doc.document.create_element 'h3' + li.prepend_child h3 + li.css('.shortcomment').remove + modifier = li.at_css('.modifier_kind') + modifier.parent = h3 if modifier + symbol = li.at_css('.symbol') + symbol.parent = h3 if symbol + li.swap li.children + end + list.swap list.children + end + + pres = css('.fullcomment pre, .fullcommenttop pre') + pres.each do |pre| + pre['data-language'] = 'scala' + end + pres.add_class 'language-scala' + + + + doc + + end + + def root + css('#filter').remove # these are filters to search through the types and packages + css('#library').remove # these are icons at the top + doc + end + + def other + # these are sections of the documentation which do not seem useful + %w(#inheritedMembers #groupedMembers .permalink .hiddenContent .material-icons).each do |selector| + css(selector).remove + end + + # This is the kind of thing we have, class, object, trait + kind = at_css('.modifier_kind .kind').content + # this image replacement doesn't do anything on 2.12 docs + img = at_css('img') + img.replace %Q|#{kind}| unless img.nil? + class_to_add = kind == 'object' ? 'value': 'type' + + # for 2.10, 2.11, the kind class is associated to the body. we have to + # add it somewhere, so we do that with the #definition. + definition = css('#definition') + definition.css('.big_circle').remove + definition.add_class class_to_add + + # this is something that is not shown on the site, such as deprecated members + css('li[visbl=prt]').remove + + doc + end + + private + + def change_tag!(new_tag, node) + node.replace %Q|<#{new_tag}>#{node.inner_html}| + end + end + end +end diff --git a/lib/docs/filters/scala/clean_html_210.rb b/lib/docs/filters/scala/clean_html_210.rb new file mode 100644 index 00000000..3160f103 --- /dev/null +++ b/lib/docs/filters/scala/clean_html_210.rb @@ -0,0 +1,32 @@ +module Docs + class Scala + class CleanHtml210Filter < Filter + def call + definition = at_css('#definition') + begin + type = definition.at_css('.img_kind').text + name = definition.at_css('h1').text.strip + + package = definition.at_css('#owner').text rescue '' + package = package + '.' unless name.empty? || name.start_with?('root') + + other = definition.at_css('.morelinks').dup + other_content = other ? "

#{other.to_html}

" : '' + + definition.replace %Q| +

#{type} #{package}#{name}

+ #{other_content} + | + end if definition + + doc + end + + private + + def change_tag!(new_tag, node) + node.replace %Q|<#{new_tag}>#{node.inner_html}| + end + end + end +end diff --git a/lib/docs/filters/scala/clean_html_212.rb b/lib/docs/filters/scala/clean_html_212.rb new file mode 100644 index 00000000..7b4b1fe2 --- /dev/null +++ b/lib/docs/filters/scala/clean_html_212.rb @@ -0,0 +1,36 @@ +module Docs + class Scala + class CleanHtml212Filter < Filter + def call + css('.permalink').remove + + definition = at_css('#definition') + begin + type_full_name = {c: 'class', t: 'trait', o: 'object', 'p': 'package'} + type = type_full_name[definition.at_css('.big-circle').text.to_sym] + name = definition.at_css('h1').text + + package = definition.at_css('#owner').text rescue '' + package = package + '.' unless name.empty? || package.empty? + + other = definition.at_css('.morelinks').dup + other_content = other ? "

#{other.to_html}

" : '' + + definition.replace %Q| +

#{type} #{package}#{name}

+ #{other_content} + | + + end if definition + + doc + end + + private + + def change_tag!(new_tag, node) + node.replace %Q|<#{new_tag}>#{node.inner_html}| + end + end + end +end diff --git a/lib/docs/filters/scala/entries.rb b/lib/docs/filters/scala/entries.rb new file mode 100644 index 00000000..d328764c --- /dev/null +++ b/lib/docs/filters/scala/entries.rb @@ -0,0 +1,65 @@ +module Docs + class Scala + class EntriesFilter < Docs::EntriesFilter + def get_name + # this first condition is mainly for scala 212 docs, which + # have their package listing as index.html + if is_package? + symbol = at_css('#definition h1') + symbol ? symbol.text.gsub(/\W+/, '') : "package" + else + slug.split('/').last + end + end + + def get_type + # if this entry is for a package, we group the package under the parent package + if is_package? + parent_package + # otherwise, group it under the regular package name + else + package_name + end + end + + def include_default_entry? + true + end + + private + + # For the package name, we use the slug rather than parsing the package + # name from the HTML because companion object classes may be broken out into + # their own entries (by the source documentation). When that happens, + # we want to group these classes (like `scala.reflect.api.Annotations.Annotation`) + # under the package name, and not the fully-qualfied name which would + # include the companion object. + def package_name + name = package_drop_last(slug_parts) + name.empty? ? '_root_' : name + end + + def parent_package + name = package_name + parent = package_drop_last(package_name.split('.')) + parent.empty? ? '_root_' : parent + end + + def package_drop_last(parts) + parts[0...-1].join('.') + end + + def slug_parts + slug.split('/') + end + + def owner + at_css('#owner') + end + + def is_package? + slug.ends_with?('index') || slug.ends_with?('package') + end + end + end +end diff --git a/lib/docs/scrapers/scala.rb b/lib/docs/scrapers/scala.rb new file mode 100644 index 00000000..6b6d6bb2 --- /dev/null +++ b/lib/docs/scrapers/scala.rb @@ -0,0 +1,80 @@ +module Docs + class Scala < FileScraper + include FixInternalUrlsBehavior + + self.name = 'scala' + self.type = 'scala' + self.links = { + home: 'http://www.scala-lang.org/', + code: 'https://github.com/scala/scala' + } + + version '2.12 Library' do + self.release = '2.12.3' + self.dir = '/Users/Thibaut/DevDocs/Docs/Scala212/api/scala-library' # https://downloads.lightbend.com/scala/2.12.3/scala-docs-2.12.3.zip + self.base_url = 'http://www.scala-lang.org/api/2.12.3/' + self.root_path = 'index.html' + options[:attribution] = <<-HTML + Scala programming documentation. Copyright (c) 2003-2017 EPFL, with contributions from Lightbend. + HTML + html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_212' + end + + version '2.12 Reflection' do + self.release = '2.12.3' + self.dir = '/Users/Thibaut/DevDocs/Docs/Scala212/api/scala-reflect' # https://downloads.lightbend.com/scala/2.12.3/scala-docs-2.12.3.zip + self.base_url = 'http://www.scala-lang.org/api/2.12.3/scala-reflect/' + self.root_path = 'index.html' + options[:attribution] = <<-HTML + Scala programming documentation. Copyright (c) 2003-2017 EPFL, with contributions from Lightbend. + HTML + html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_212' + end + + version '2.11 Library' do + self.release = '2.11.8' + self.dir = '/Users/Thibaut/DevDocs/Docs/Scala211/api/scala-library' # https://downloads.lightbend.com/scala/2.11.8/scala-docs-2.11.8.zip + self.base_url = 'http://www.scala-lang.org/api/2.11.8/' + self.root_path = 'package.html' + options[:skip_patterns] = [/^index.html/, /index\/index-/] + options[:attribution] = <<-HTML + Scala programming documentation. Copyright (c) 2003-2016 EPFL, with contributions from Lightbend. + HTML + html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_210' + end + + version '2.11 Reflection' do + self.release = '2.11.8' + self.dir = '/Users/Thibaut/DevDocs/Docs/Scala211/api/scala-reflect' # https://downloads.lightbend.com/scala/2.11.8/scala-docs-2.11.8.zip + self.base_url = 'http://www.scala-lang.org/api/2.11.8/scala-reflect/' + self.root_path = 'package.html' + options[:skip_patterns] = [/^index.html/, /index\/index-/] + options[:attribution] = <<-HTML + Scala programming documentation. Copyright (c) 2003-2016 EPFL, with contributions from Lightbend. + HTML + html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_210' + end + + version '2.10' do + self.release = '2.10.6' + self.dir = '/Users/Thibaut/DevDocs/Docs/Scala210' # https://downloads.lightbend.com/scala/2.10.6/scala-docs-2.10.6.zip + self.base_url = 'http://www.scala-lang.org/api/2.10.6/' + self.root_path = 'package.html' + options[:skip_patterns] = [/^index.html/, /index\/index-/] + options[:attribution] = <<-HTML + Scala programming documentation. Copyright (c) 2003-2013 EPFL, with contributions from Typesafe. + HTML + html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_210' + end + end +end diff --git a/public/icons/docs/scala/16.png b/public/icons/docs/scala/16.png new file mode 100644 index 0000000000000000000000000000000000000000..429ed7df29b85da3cc2d26215945b30014465d38 GIT binary patch literal 944 zcmeAS@N?(olHy`uVBq!ia0vp^AhrMp8<5nmf9C+CSkfJR9T^xl_H+M9WCij$3p^r= z85p>QL70(Y)*J~22FA$Dkcg59UmvUF{9L`nl>DSry^7odplSvNn+hu+GdHy)QK2F? zC$HG5!d3~a!V1U+3F|8Y3;nDA{o-C@9zzrKDK}xwt{K z19`Se86_nJR{Hwo<>h+i#(Mch>H3D2mX`VkM*2oZx=P7{9O-#x!EwNQn0$BtH5O0c3d|4@L;p!@;Rg)2@K@7o-U3d z8lt6>&gKa_@*L0YPcPrh?Hi=HD5&v=)l?;gM~_=rw8D=tDi%IECj7z6!-l0pdTIsZ z5(XwEz1Agfmt~sWoXh|C?A(cN$>)3ie>-oi!O+4W_|N#?o434&E`BlHK0S_MhB^N_ z@#oI_rZUBT@|fOu)^A#A9@};)v7BEu71`folYhQCb#Pn59N|MI=4>6h6~5116Q1oo zCb&05I$&w@x=@ZyS9Dr5d|EgcdiKoxXyYbdBK%dwQH57A)HL_vRPK)nHxFbO$s2Ni z3R?QCv>{o1L5|H7J*Sm*S6#e>CMBBhJukm(`T1kr8eDG$t>Fiv70}iFVrF)MlM6d-aa0bR)*%EcCc}Q&W&oUeJEY zu*JpXVI_y*ghLwcO%99xyjl}&yn61RHCZyUQ}#z%1~|S@v9QP!@p$g@+*5erN2j}U zp62OGfBLGRe5UMyrlgn5}kw9uPQydSn&OE*PAexm#Ztn zv(I$&aA@~z-PpSEs?%+Wj~g%BU({&w$oaj-(4&*_!~~x_-ZdS|Vzig;<505)t~URAL>Zu}39_&@d4U6%s^CENMke(O7EN_Jdl|&KuJV z!BZ->R<$FRv|6dXmw&-Z)I{paTT;M|o!S|9)b zl&}~yUVN&H4Jt1y-qpg0ZQ?^Z(%H)y0Gf*xw@EVMSRoD*kO%;Z2lq_^sAL@i0Eqyq zACXS<@fG>IRtx%RpmY6jgwqjPf16~?CrBA&0kmOK4n z*;X0tvOsRDsju&DY}~5ruM7#5hDE^6B~r1bINajLSEA(P7^RtA;seIA?iLN*B@vNxxy`E7}YA=b3%^#lWMgM(%eiikr)*Q0y-gh=h zPi#IMj!3L%?PlK3dNSeb`o~DfO+AM1iz|$dwz%#a>I>$-ZY!+t!01TKyE6@ARQw`& zv|Lz*&EfvmbHaE{5=S7EvW10;np5X1BXmo2*Xo@dE=7U_jPH-d8ufELl^cTye)@UO z6dSlQwnL;o3J2iV)$z%d-PnSn$45$HmjM#`1T@mHmTP+#d*$R|Rh#sGSU%`yfel=1l<*_iL;T7pd`g=~3$Zb}oV4`r=g+ zDi*Spds5I4Z!h2H`p(55TdQ$4d)pTAC}58yt*)IbGd531C@Wps7E%>r-}81;LYpJ9N?xdA_Ii082q?+C=+D>q|?|YOaSetSrZd)U*Wn z=ytpo7EFQKWMs4%8FIY`{4FirTSA9sCU5gD)ib7|jUA>ejJXA`8m{_Cv8?+sIZpas z5YjJq3eqQ;<4c-D7vFI2&Q*B3oB`?U@Kkv@F?q>OA%^}g`D^n%rS1i*Fn!JL+@SFy z9{1o{=Vj?gpWtK4LDy8uPhHUia|$ah!c00du+n8awvu5TORUzLQqcijwr35th8zFT z{3KH9Y+Z#r>wu>UjUHRZy-NOW@2bL?*`4MLR-Xrl6`b;mhic}o#@3EAwO4|lrMMjw z`7%C;zw59A0D{EC%BfuVg z(U}5hcJ=Y6e7Ry{eYg`}=Z8BhPI2<_6gThJz>=+c4%R4tr!VYSEPQ`tJUv%%An?9A6tI?y>d z;t_hYsHw@UtiTZN;hrDH-d1f$>j=1@W5!3^vJL^$v+A?C@Trw?qZ8CU(8Df= zl;!Mj>!pDEV5WCEgXiN;{M4XQ^vJD`cunnaQN>l^hF7|yY7`JX8JGssz(a4#M95`& zuw-SMpbN!BI!wh=K75(t%M2_|Wi#?=3RreJvN=!|Di_+CsuXft25hle>L}@w=aO5B zH^E44{H*#2v~tU&+W#SqYezS;B{e68X0oe>zfo-gS}KE$k6V;NF}By)0$(`r#&g#`QxP&>N^sIp}sBNEo!Txz1Th zC2|VA`uUns(^oq|<+aL^lsw~1Q*P5=s?Sdgw*(LO9=)EsxxV{5XC>_?KdG^`8=alx z<>lZ(?H17rRKGrF@nX$;L|G5dC#&#OwPOu|aJTjM2coL{{D_WGVQ0l*!Qf!?xx69A Xl>A#sPxsj8_P;T#8xGy*63YBH63Qux literal 0 HcmV?d00001 From 6614375671eeedb7634034a7e36f966b5072610e Mon Sep 17 00:00:00 2001 From: Jasper van Merle Date: Sun, 11 Aug 2019 19:53:12 +0200 Subject: [PATCH 2/2] scala: finish scraper and filters --- lib/docs/filters/scala/clean_html.rb | 114 ++++++++++++----------- lib/docs/filters/scala/clean_html_210.rb | 32 ------- lib/docs/filters/scala/clean_html_212.rb | 36 ------- lib/docs/filters/scala/entries.rb | 48 +++++++++- lib/docs/scrapers/scala.rb | 98 ++++++++----------- 5 files changed, 145 insertions(+), 183 deletions(-) delete mode 100644 lib/docs/filters/scala/clean_html_210.rb delete mode 100644 lib/docs/filters/scala/clean_html_212.rb diff --git a/lib/docs/filters/scala/clean_html.rb b/lib/docs/filters/scala/clean_html.rb index 95097c80..0320932d 100644 --- a/lib/docs/filters/scala/clean_html.rb +++ b/lib/docs/filters/scala/clean_html.rb @@ -2,97 +2,107 @@ module Docs class Scala class CleanHtmlFilter < Filter def call + @doc = at_css('#content') + always + add_title - if slug == 'index' - root - else - other - end + doc end def always - # remove deprecated sections + # Remove deprecated sections css('.members').each do |members| header = members.at_css('h3') members.remove if header.text.downcase.include? 'deprecate' end - # Some of this is just for 2.12 - # These are things that provide interactive features, which are not supported yet. - css('#subpackage-spacer, #search, #mbrsel, .diagram-btn').remove - css('#footer').remove - css('.toggleContainer').remove + + css('#mbrsel, #footer').remove + + css('.diagram-container').remove + css('.toggleContainer > .toggle').each do |node| + title = node.at_css('span') + next if title.nil? + + content = node.at_css('.hiddenContent') + next if content.nil? + + title.name = 'dt' + + content.remove_attribute('class') + content.remove_attribute('style') + content.name = 'dd' + + attributes = at_css('.attributes') + unless attributes.nil? + title.parent = attributes + content.parent = attributes + end + end signature = at_css('#signature') - signature.replace %Q| -

#{signature.inner_html}

- | + signature.replace "

#{signature.inner_html}

" css('div.members > h3').each do |node| - change_tag! 'h2', node + node.name = 'h2' end css('div.members > ol').each do |list| list.css('li').each do |li| h3 = doc.document.create_element 'h3' + h3['id'] = li['name'].rpartition('#').last unless li['name'].nil? + li.prepend_child h3 li.css('.shortcomment').remove + modifier = li.at_css('.modifier_kind') - modifier.parent = h3 if modifier + modifier.parent = h3 unless modifier.nil? + + kind = li.at_css('.modifier_kind .kind') + kind.content = kind.content + ' ' unless kind.nil? + symbol = li.at_css('.symbol') - symbol.parent = h3 if symbol + symbol.parent = h3 unless symbol.nil? + li.swap li.children end + list.swap list.children end - pres = css('.fullcomment pre, .fullcommenttop pre') - pres.each do |pre| + css('.fullcomment pre, .fullcommenttop pre').each do |pre| pre['data-language'] = 'scala' + pre.content = pre.content end - pres.add_class 'language-scala' - - - - doc - - end - - def root - css('#filter').remove # these are filters to search through the types and packages - css('#library').remove # these are icons at the top - doc - end - def other - # these are sections of the documentation which do not seem useful + # Sections of the documentation which do not seem useful %w(#inheritedMembers #groupedMembers .permalink .hiddenContent .material-icons).each do |selector| css(selector).remove end - # This is the kind of thing we have, class, object, trait - kind = at_css('.modifier_kind .kind').content - # this image replacement doesn't do anything on 2.12 docs - img = at_css('img') - img.replace %Q|#{kind}| unless img.nil? - class_to_add = kind == 'object' ? 'value': 'type' + # Things that are not shown on the site, like deprecated members + css('li[visbl=prt]').remove + end + + def add_title + css('.permalink').remove - # for 2.10, 2.11, the kind class is associated to the body. we have to - # add it somewhere, so we do that with the #definition. - definition = css('#definition') - definition.css('.big_circle').remove - definition.add_class class_to_add + definition = at_css('#definition') + return if definition.nil? - # this is something that is not shown on the site, such as deprecated members - css('li[visbl=prt]').remove + type_full_name = {a: 'Annotation', c: 'Class', t: 'Trait', o: 'Object', p: 'Package'} + type = type_full_name[definition.at_css('.big-circle').text.to_sym] + name = CGI.escapeHTML definition.at_css('h1').text - doc - end + package = definition.at_css('#owner').text rescue '' + package = package + '.' unless name.empty? || package.empty? - private + other = definition.at_css('.morelinks').dup + other_content = other ? "

#{other.to_html}

" : '' - def change_tag!(new_tag, node) - node.replace %Q|<#{new_tag}>#{node.inner_html}| + title_content = root_page? ? 'Package root' : "#{type} #{package}#{name}".strip + title = "

#{title_content}

" + definition.replace title + other_content end end end diff --git a/lib/docs/filters/scala/clean_html_210.rb b/lib/docs/filters/scala/clean_html_210.rb deleted file mode 100644 index 3160f103..00000000 --- a/lib/docs/filters/scala/clean_html_210.rb +++ /dev/null @@ -1,32 +0,0 @@ -module Docs - class Scala - class CleanHtml210Filter < Filter - def call - definition = at_css('#definition') - begin - type = definition.at_css('.img_kind').text - name = definition.at_css('h1').text.strip - - package = definition.at_css('#owner').text rescue '' - package = package + '.' unless name.empty? || name.start_with?('root') - - other = definition.at_css('.morelinks').dup - other_content = other ? "

#{other.to_html}

" : '' - - definition.replace %Q| -

#{type} #{package}#{name}

- #{other_content} - | - end if definition - - doc - end - - private - - def change_tag!(new_tag, node) - node.replace %Q|<#{new_tag}>#{node.inner_html}| - end - end - end -end diff --git a/lib/docs/filters/scala/clean_html_212.rb b/lib/docs/filters/scala/clean_html_212.rb deleted file mode 100644 index 7b4b1fe2..00000000 --- a/lib/docs/filters/scala/clean_html_212.rb +++ /dev/null @@ -1,36 +0,0 @@ -module Docs - class Scala - class CleanHtml212Filter < Filter - def call - css('.permalink').remove - - definition = at_css('#definition') - begin - type_full_name = {c: 'class', t: 'trait', o: 'object', 'p': 'package'} - type = type_full_name[definition.at_css('.big-circle').text.to_sym] - name = definition.at_css('h1').text - - package = definition.at_css('#owner').text rescue '' - package = package + '.' unless name.empty? || package.empty? - - other = definition.at_css('.morelinks').dup - other_content = other ? "

#{other.to_html}

" : '' - - definition.replace %Q| -

#{type} #{package}#{name}

- #{other_content} - | - - end if definition - - doc - end - - private - - def change_tag!(new_tag, node) - node.replace %Q|<#{new_tag}>#{node.inner_html}| - end - end - end -end diff --git a/lib/docs/filters/scala/entries.rb b/lib/docs/filters/scala/entries.rb index d328764c..98eb9781 100644 --- a/lib/docs/filters/scala/entries.rb +++ b/lib/docs/filters/scala/entries.rb @@ -1,14 +1,30 @@ module Docs class Scala class EntriesFilter < Docs::EntriesFilter + REPLACEMENTS = { + '$eq' => '=', + '$colon' => ':', + '$less' => '<', + } + def get_name - # this first condition is mainly for scala 212 docs, which - # have their package listing as index.html if is_package? symbol = at_css('#definition h1') symbol ? symbol.text.gsub(/\W+/, '') : "package" else - slug.split('/').last + name = slug.split('/').last + + # Some objects have inner objects, show ParentObject$.ChildObject$ instead of ParentObject$$ChildObject$ + name = name.gsub('$$', '$.') + + # If a dollar sign is used as separator between two characters, replace it with a dot + name = name.gsub(/([^$.])\$([^$.])/, '\1.\2') + + REPLACEMENTS.each do |key, value| + name = name.gsub(key, value) + end + + name end end @@ -26,6 +42,31 @@ module Docs true end + def additional_entries + entries = [] + + full_name = "#{type}.#{name}".remove('$') + css(".members li[name^=\"#{full_name}\"]").each do |node| + # Ignore packages + kind = node.at_css('.modifier_kind > .kind') + next if !kind.nil? && kind.content == 'package' + + # Ignore deprecated members + next unless node.at_css('.symbol > .name.deprecated').nil? + + id = node['name'].rpartition('#').last + member_name = node.at_css('.name') + + # Ignore members only existing of hashtags, we can't link to that + next if member_name.nil? || member_name.content.strip.remove('#').blank? + + member = "#{name}.#{member_name.content}()" + entries << [member, id] + end + + entries + end + private # For the package name, we use the slug rather than parsing the package @@ -40,7 +81,6 @@ module Docs end def parent_package - name = package_name parent = package_drop_last(package_name.split('.')) parent.empty? ? '_root_' : parent end diff --git a/lib/docs/scrapers/scala.rb b/lib/docs/scrapers/scala.rb index 6b6d6bb2..e831fa84 100644 --- a/lib/docs/scrapers/scala.rb +++ b/lib/docs/scrapers/scala.rb @@ -1,80 +1,60 @@ module Docs class Scala < FileScraper - include FixInternalUrlsBehavior - - self.name = 'scala' + self.name = 'Scala' self.type = 'scala' self.links = { home: 'http://www.scala-lang.org/', code: 'https://github.com/scala/scala' } - version '2.12 Library' do - self.release = '2.12.3' - self.dir = '/Users/Thibaut/DevDocs/Docs/Scala212/api/scala-library' # https://downloads.lightbend.com/scala/2.12.3/scala-docs-2.12.3.zip - self.base_url = 'http://www.scala-lang.org/api/2.12.3/' + options[:container] = '#content-container' + options[:attribution] = <<-HTML + © 2002-2019 EPFL, with contributions from Lightbend. + HTML + + # https://downloads.lightbend.com/scala/2.13.0/scala-docs-2.13.0.zip + # Extract api/scala-library into docs/scala~2.13_library + version '2.13 Library' do + self.release = '2.13.0' + self.base_url = 'https://www.scala-lang.org/api/2.13.0/' self.root_path = 'index.html' - options[:attribution] = <<-HTML - Scala programming documentation. Copyright (c) 2003-2017 EPFL, with contributions from Lightbend. - HTML - html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_212' + + html_filters.push 'scala/entries', 'scala/clean_html' end - version '2.12 Reflection' do - self.release = '2.12.3' - self.dir = '/Users/Thibaut/DevDocs/Docs/Scala212/api/scala-reflect' # https://downloads.lightbend.com/scala/2.12.3/scala-docs-2.12.3.zip - self.base_url = 'http://www.scala-lang.org/api/2.12.3/scala-reflect/' + # https://downloads.lightbend.com/scala/2.13.0/scala-docs-2.13.0.zip + # Extract api/scala-reflect into docs/scala~2.13_reflection + version '2.13 Reflection' do + self.release = '2.13.0' + self.base_url = 'https://www.scala-lang.org/api/2.13.0/scala-reflect/' self.root_path = 'index.html' - options[:attribution] = <<-HTML - Scala programming documentation. Copyright (c) 2003-2017 EPFL, with contributions from Lightbend. - HTML - html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_212' + + html_filters.push 'scala/entries', 'scala/clean_html' end - version '2.11 Library' do - self.release = '2.11.8' - self.dir = '/Users/Thibaut/DevDocs/Docs/Scala211/api/scala-library' # https://downloads.lightbend.com/scala/2.11.8/scala-docs-2.11.8.zip - self.base_url = 'http://www.scala-lang.org/api/2.11.8/' - self.root_path = 'package.html' - options[:skip_patterns] = [/^index.html/, /index\/index-/] - options[:attribution] = <<-HTML - Scala programming documentation. Copyright (c) 2003-2016 EPFL, with contributions from Lightbend. - HTML - html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_210' + # https://downloads.lightbend.com/scala/2.12.6/scala-docs-2.12.6.zip + # Extract api/scala-library into docs/scala~2.12_library + version '2.12 Library' do + self.release = '2.12.6' + self.base_url = 'https://www.scala-lang.org/api/2.12.6/' + self.root_path = 'index.html' + + html_filters.push 'scala/entries', 'scala/clean_html' end - version '2.11 Reflection' do - self.release = '2.11.8' - self.dir = '/Users/Thibaut/DevDocs/Docs/Scala211/api/scala-reflect' # https://downloads.lightbend.com/scala/2.11.8/scala-docs-2.11.8.zip - self.base_url = 'http://www.scala-lang.org/api/2.11.8/scala-reflect/' - self.root_path = 'package.html' - options[:skip_patterns] = [/^index.html/, /index\/index-/] - options[:attribution] = <<-HTML - Scala programming documentation. Copyright (c) 2003-2016 EPFL, with contributions from Lightbend. - HTML - html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_210' + # https://downloads.lightbend.com/scala/2.12.6/scala-docs-2.12.6.zip + # Extract api/scala-reflect into docs/scala~2.12_reflection + version '2.12 Reflection' do + self.release = '2.12.6' + self.base_url = 'https://www.scala-lang.org/api/2.12.6/scala-reflect/' + self.root_path = 'index.html' + + html_filters.push 'scala/entries', 'scala/clean_html' end - version '2.10' do - self.release = '2.10.6' - self.dir = '/Users/Thibaut/DevDocs/Docs/Scala210' # https://downloads.lightbend.com/scala/2.10.6/scala-docs-2.10.6.zip - self.base_url = 'http://www.scala-lang.org/api/2.10.6/' - self.root_path = 'package.html' - options[:skip_patterns] = [/^index.html/, /index\/index-/] - options[:attribution] = <<-HTML - Scala programming documentation. Copyright (c) 2003-2013 EPFL, with contributions from Typesafe. - HTML - html_filters.push 'scala/entries', 'scala/clean_html', 'scala/clean_html_210' + def get_latest_version(opts) + doc = fetch_doc('https://www.scala-lang.org/api/current/', opts) + doc.at_css('#doc-version').content end end end