Minor fixes related to naming

openzim · Aug 14, 2023 · 3c1020f · 3c1020f
1 parent 2cd3e58
commit 3c1020f
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 16 deletions.
diff --git a/src/Downloader.ts b/src/Downloader.ts
@@ -209,14 +209,14 @@ class Downloader {
   public async setBaseUrls() {
     //* Objects order in array matters!
     this.baseUrl = basicURLDirector.buildDownloaderBaseUrl([
-      { condition: this.mw.hasDesktopRestApi, value: this.mw.desktopRestApiUrl.href },
-      { condition: this.mw.hasVeApi, value: this.mw.veApiUrl.href },
+      { condition: this.mw.hasWikimediaDesktopRestApi, value: this.mw.desktopRestApiUrl.href },
+      { condition: this.mw.hasVisualEditorApi, value: this.mw.visualEditorApiUrl.href },
     ])
 
     //* Objects order in array matters!
     this.baseUrlForMainPage = basicURLDirector.buildDownloaderBaseUrl([
-      { condition: this.mw.hasDesktopRestApi, value: this.mw.desktopRestApiUrl.href },
-      { condition: this.mw.hasVeApi, value: this.mw.veApiUrl.href },
+      { condition: this.mw.hasWikimediaDesktopRestApi, value: this.mw.desktopRestApiUrl.href },
+      { condition: this.mw.hasVisualEditorApi, value: this.mw.visualEditorApiUrl.href },
     ])
 
     logger.log('Base Url: ', this.baseUrl)

diff --git a/src/MediaWiki.ts b/src/MediaWiki.ts
@@ -29,18 +29,18 @@ class MediaWiki {
   private readonly apiPath: string
   private readonly domain: string
   private apiUrlDirector: ApiURLDirector
-  private desktopUrlDirector: DesktopURLDirector
+  private wikimediaDesktopUrlDirector: DesktopURLDirector
   private visualEditorURLDirector: VisualEditorURLDirector
 
-  public veApiUrl: URL
+  public visualEditorApiUrl: URL
   public restApiUrl: URL
   public apiUrl: URL
   public modulePath: string
   public webUrl: URL
   public desktopRestApiUrl: URL
 
-  public hasDesktopRestApi = false
-  public hasVeApi = false
+  public hasWikimediaDesktopRestApi = false
+  public hasVisualEditorApi = false
 
   constructor(config: MWConfig) {
     this.domain = config.domain || ''
@@ -60,15 +60,15 @@ class MediaWiki {
     this.webUrl = baseUrlDirector.buildURL(this.wikiPath)
     this.apiUrl = baseUrlDirector.buildURL(this.apiPath)
     this.apiUrlDirector = new ApiURLDirector(this.apiUrl.href)
-    this.veApiUrl = this.apiUrlDirector.buildVisualEditorURL()
+    this.visualEditorApiUrl = this.apiUrlDirector.buildVisualEditorURL()
 
     this.restApiUrl = baseUrlDirector.buildRestApiURL(this.restApiPath)
     this.desktopRestApiUrl = baseUrlDirector.buildDesktopRestApiURL(this.restApiPath)
 
     this.modulePath = baseUrlDirector.buildModuleURL(this.modulePathConfig)
 
-    this.desktopUrlDirector = new DesktopURLDirector(this.desktopRestApiUrl.href)
-    this.visualEditorURLDirector = new VisualEditorURLDirector(this.veApiUrl.href)
+    this.wikimediaDesktopUrlDirector = new DesktopURLDirector(this.desktopRestApiUrl.href)
+    this.visualEditorURLDirector = new VisualEditorURLDirector(this.visualEditorApiUrl.href)
   }
 
   public async login(downloader: Downloader) {
@@ -312,8 +312,8 @@ class MediaWiki {
 
   // Set capability properties, usied while mw.login
   public async setCapabilities(articleId = 'MediaWiki:Sidebar', loginCookie?: string): Promise<void> {
-    this.hasDesktopRestApi = await checkApiAvailabilty(this.desktopUrlDirector.buildArticleURL(articleId), loginCookie)
-    this.hasVeApi = await checkApiAvailabilty(this.visualEditorURLDirector.buildArticleURL(articleId), loginCookie)
+    this.hasWikimediaDesktopRestApi = await checkApiAvailabilty(this.wikimediaDesktopUrlDirector.buildArticleURL(articleId), loginCookie)
+    this.hasVisualEditorApi = await checkApiAvailabilty(this.visualEditorURLDirector.buildArticleURL(articleId), loginCookie)
   }
 }
 

diff --git a/src/util/builders/url/basic.director.ts b/src/util/builders/url/basic.director.ts
@@ -2,6 +2,9 @@ import urlBuilder from './url.builder.js'
 
 type DownloaderBaseUrlConditions = Array<{ condition: boolean; value: string }>
 
+/**
+ * Build base URL for specific wiki if format like 'https://en.wikipedia.org' or 'https://de.wikivoyage.org
+ */
 class BasicURLDirector {
   buildMediawikiBaseURL(domain: string) {
     return urlBuilder.setDomain(domain).build(true, '/')

diff --git a/src/util/saveArticles.ts b/src/util/saveArticles.ts
@@ -247,7 +247,7 @@ function isMainPage(dump: Dump, articleId: string): boolean {
 }
 
 async function chooseRenderer(articleId, dump, mw: MediaWiki, wikimediaDesktopRenderer, visualEditorRenderer) {
-  if (mw.hasVeApi && !mw.hasDesktopRestApi) {
+  if (mw.hasVisualEditorApi && !mw.hasWikimediaDesktopRestApi) {
     return visualEditorRenderer
   }
   return wikimediaDesktopRenderer

diff --git a/test/unit/builders/url/desktop.director.test.ts b/test/unit/builders/url/desktop.director.test.ts
@@ -1,11 +1,11 @@
 import DesktopURLDirector from '../../../../src/util/builders/url/desktop.director.js'
 
 describe('DesktopURLDirector', () => {
-  const desktopUrlDirector = new DesktopURLDirector('https://en.m.wikipedia.org/api/rest_v1/page/html/')
+  const wikimediaDesktopUrlDirector = new DesktopURLDirector('https://en.m.wikipedia.org/api/rest_v1/page/html/')
 
   describe('buildArticleURL', () => {
     it('should return the URL to retrieve a desktop article', () => {
-      const url = desktopUrlDirector.buildArticleURL('article-1234')
+      const url = wikimediaDesktopUrlDirector.buildArticleURL('article-1234')
 
       expect(url).toBe('https://en.m.wikipedia.org/api/rest_v1/page/html/article-1234')
     })