2020-01-09 22:11:00 +00:00
import mustache from 'mustache' ;
import { htmluserlangattributes } from './utils' ;
import skinTemplate from '!!raw-loader!../includes/templates/index.mustache' ;
2020-03-31 17:51:48 +00:00
import legacySkinTemplate from '!!raw-loader!../includes/templates/legacy.mustache' ;
2020-01-09 22:11:00 +00:00
import { placeholder } from './utils' ;
2020-03-10 21:01:09 +00:00
import '../resources/skins.vector.styles/index.less' ;
2020-03-25 20:57:46 +00:00
import { PERSONAL _MENU _TEMPLATE _DATA , personalMenuTemplate } from './PersonalMenu.stories.data' ;
import { pageActionsData , namespaceTabsData , vectorTabsTemplate } from './VectorTabs.stories.data' ;
import { vectorMenuTemplate , moreData , variantsData } from './VectorMenu.stories.data' ;
import { searchBoxData , searchBoxTemplate } from './SearchBox.stories.data' ;
import { SIDEBAR _DATA , SIDEBAR _TEMPLATE _PARTIALS , sidebarTemplate } from './Sidebar.stories.data' ;
2020-02-28 22:17:31 +00:00
import { FOOTER _TEMPLATE _DATA , footerTemplate } from './Footer.stories.data' ;
2020-02-17 19:49:43 +00:00
2020-03-25 20:57:46 +00:00
const NAVIGATION _TEMPLATE _DATA = {
loggedInWithVariantsAndOptOut : {
'data-personal-menu' : PERSONAL _MENU _TEMPLATE _DATA . loggedInWithEcho ,
'data-namespace-tabs' : namespaceTabsData ,
'data-page-actions' : pageActionsData ,
'data-variants' : variantsData ,
'data-search-box' : searchBoxData ,
'data-sidebar' : SIDEBAR _DATA . withPortalsAndOptOut ,
'html-navigation-heading' : 'Navigation menu' ,
'html-logo-attributes' : ` class="mw-wiki-logo" href="/wiki/Main_Page" title="Visit the main page" `
} ,
loggedOutWithVariants : {
'data-personal-menu' : PERSONAL _MENU _TEMPLATE _DATA . loggedOut ,
'data-namespace-tabs' : namespaceTabsData ,
'data-page-actions' : pageActionsData ,
'data-variants' : variantsData ,
'data-search-box' : searchBoxData ,
'data-sidebar' : SIDEBAR _DATA . withPortals ,
'html-navigation-heading' : 'Navigation menu' ,
'html-logo-attributes' : ` class="mw-wiki-logo" href="/wiki/Main_Page" title="Visit the main page" `
} ,
loggedInWithMoreActions : {
'data-personal-menu' : PERSONAL _MENU _TEMPLATE _DATA . loggedInWithEcho ,
'data-namespace-tabs' : namespaceTabsData ,
'data-page-actions' : pageActionsData ,
'data-page-actions-more' : moreData ,
'data-search-box' : searchBoxData ,
'data-sidebar' : SIDEBAR _DATA . withPortals ,
'html-navigation-heading' : 'Navigation menu' ,
'html-logo-attributes' : ` class="mw-wiki-logo" href="/wiki/Main_Page" title="Visit the main page" `
}
} ;
const TEMPLATE _PARTIALS = Object . assign ( { } , SIDEBAR _TEMPLATE _PARTIALS , {
SearchBox : searchBoxTemplate ,
Sidebar : sidebarTemplate ,
VectorTabs : vectorTabsTemplate ,
VectorMenu : vectorMenuTemplate ,
PersonalMenu : personalMenuTemplate ,
2020-02-17 19:49:43 +00:00
Footer : footerTemplate
} ) ;
2020-01-09 22:11:00 +00:00
export default {
title : 'Skin'
} ;
const HTML _INDICATORS = ` <div class="mw-indicators mw-body-content">
< div id = "mw-indicator-good-star" class = "mw-indicator" >
< a href = "/wiki/Wikipedia:Good_articles"
title = "This is a good article. Follow the link for more information." >
< img alt = "This is a good article. Follow the link for more information."
src = "//upload.wikimedia.org/wikipedia/en/thumb/9/94/Symbol_support_vote.svg/19px-Symbol_support_vote.svg.png" decoding = "async" width = "19" height = "20"
srcset = "//upload.wikimedia.org/wikipedia/en/thumb/9/94/Symbol_support_vote.svg/29px-Symbol_support_vote.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/9/94/Symbol_support_vote.svg/39px-Symbol_support_vote.svg.png 2x" data - file - width = "180" data - file - height = "185" / >
< / a >
< / d i v >
< div id = "mw-indicator-pp-autoreview" class = "mw-indicator" >
< a href = "/wiki/Wikipedia:Protection_policy#pending"
title = "All edits by unregistered and new users are subject to review prior to becoming visible to unregistered users" >
< img alt = "Page protected with pending changes" src = "//upload.wikimedia.org/wikipedia/en/thumb/b/b7/Pending-protection-shackle.svg/20px-Pending-protection-shackle.svg.png"
decoding = "async" width = "20" height = "20" srcset = "//upload.wikimedia.org/wikipedia/en/thumb/b/b7/Pending-protection-shackle.svg/30px-Pending-protection-shackle.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/b/b7/Pending-protection-shackle.svg/40px-Pending-protection-shackle.svg.png 2x" data - file - width = "512" data - file - height = "512" / >
< / a >
< / d i v >
< / d i v >
` ;
2020-03-31 17:51:48 +00:00
export const vectorLegacyLoggedOut = ( ) => mustache . render ( legacySkinTemplate , Object . assign ( {
2020-01-09 22:11:00 +00:00
'html-title' : 'Vector 2019' ,
'page-isarticle' : true ,
'msg-tagline' : 'From Wikipedia, the free encyclopedia' ,
'html-userlangattributes' : htmluserlangattributes ,
'msg-jumptonavigation' : 'Jump to navigation' ,
'msg-jumptosearch' : 'Jump to search' ,
// site specific
2020-02-17 19:49:43 +00:00
'data-footer' : FOOTER _TEMPLATE _DATA ,
2020-01-09 22:11:00 +00:00
'html-sitenotice' : placeholder ( 'a site notice or central notice banner may go here' , 70 ) ,
// article dependent
'html-bodycontent' : placeholder ( 'Article content goes here' ) ,
'html-printfooter' : ` Retrieved from ‘ ’ ` ,
'html-catlinks' : placeholder ( 'Category links component from mediawiki core' , 50 ) ,
// extension dependent..
'html-hook-vector-before-footer' : placeholder ( 'VectorBeforeFooter hook output' , 100 ) ,
'html-dataAfterContent' : placeholder ( 'Extensions can add here e.g. Related Articles.' , 100 ) ,
'html-indicators' : HTML _INDICATORS ,
'html-subtitle' : placeholder ( 'Extensions can configure subtitle' , 20 )
2020-03-25 20:57:46 +00:00
} , NAVIGATION _TEMPLATE _DATA . loggedOutWithVariants ) , TEMPLATE _PARTIALS ) ;
2020-01-09 22:11:00 +00:00
2020-03-31 17:51:48 +00:00
export const vectorLegacyLoggedIn = ( ) => mustache . render ( legacySkinTemplate , Object . assign ( {
2020-01-09 22:11:00 +00:00
'html-title' : 'Vector 2019' ,
'page-isarticle' : true ,
'msg-tagline' : 'From Wikipedia, the free encyclopedia' ,
'html-userlangattributes' : htmluserlangattributes ,
'msg-jumptonavigation' : 'Jump to navigation' ,
'msg-jumptosearch' : 'Jump to search' ,
// site specific
2020-02-17 19:49:43 +00:00
'data-footer' : FOOTER _TEMPLATE _DATA ,
2020-01-09 22:11:00 +00:00
'html-sitenotice' : placeholder ( 'a site notice or central notice banner may go here' , 70 ) ,
// article dependent
'html-bodycontent' : placeholder ( 'Article content goes here' ) ,
'html-printfooter' : ` Retrieved from ‘ ’ ` ,
'html-catlinks' : placeholder ( 'Category links component from mediawiki core' , 50 )
2020-03-25 20:57:46 +00:00
} , NAVIGATION _TEMPLATE _DATA . loggedInWithMoreActions ) , TEMPLATE _PARTIALS ) ;
Add opt-out link to Sidebar for Vector/Logged-in Users Without Abstractions
This commit is singularly focused on adding a link to the sidebar for
Vector, logged-in users. It does the bare minimum to fulfill the
requirements of T243281.
Additionally, it will help to answer the question "Do we need to use
abstractions (other than maybe different templates) to separate Legacy
Vector from Vector" by intentionally leaving out any abstractions in
order to make it easier to compare with a follow-up patch
(Ib2ef15180df73360cc1de25b893e49d415d23e1a) which does use abstractions.
It is a good thing to question whether or not we need addtional
abstractions in VectorTemplate and if they will help us as unnecessary
abstractions can have the opposite effect and just lead to further
frustrations down the road.
Therefore, I urge you, the reviewer, to let me know your thoughts! If
abstractions are viewed as not making our lives any easier, the
follow-up patches may be completely discarded and that's totally okay
with me. :) I think it's a good think to talk about now though.
Important changes:
* The VectorTemplate constructor was changed to allow injecting the
config, templateParser, and isLegacy boolean (only the config was
allowed before this commit). According to MediaWiki's Stable Interface
Policy, "Constructor signatures are generally considered unstable unless
explicitly declared stable for calling" [3]. Given that VecorTemplate's
constructor is not marked as stable, it is justified to do this without
warning according to the policy.
* Due to the above, the 'setTemplate' method is no longer needed and was
marked as deprecated.
* VectorTemplateTest was made to adapt to the new VectorTemplate
constructor. Additionally, it now extends from
MediaWikiIntegrationTestCase which my intelliphense server can pick up.
I *think* MediaWikiTestCase is just an alias to
MediaWikiIntegrationTestCase [1] and MediaWikiTestCase file was renamed
to MediaWikiIntegrationTestCase in [2], but I'm willing to change it
back if there is pushback to this.
Open questions:
* What are VectorTemplate's responsibilities? To me, it acts right now
as a controller (because it echos the full HTML string from the
template), a model (because SkinTemplate::prepareQuickTemplate sets data
on it which it later retrieves through `$this->get()`), a presenter
(because it adds data tailored for a web-centric view), and a view
(because it renders HTML strings instead of letting the view/template be
solely responsible for that). Arguably, some business logic might be
mixed in there as well (because it checks to see if a User is logged
in/has necessary permissions to show x which my changes here add to).
This might not be a problem if we keep VectorTemplate relatively small,
but will it remain this way as we progress further in Desktop
Improvements?
* How do we write tests for VectorTemplate without exposing unnecessary
public methods? For example, if I want to test the `getSkinData()`
method to see what state will be sent to the template, how should I do
this? One option might be to use `TestingAccessWrapper` to expose these
private methods which is what
`VectorTemplateTest::testbuildViewsProps()` does. Another option is to
accept this method as public. Is there a better way? Keep in mind that
even with access to this method, there might be many things to mock.
[1] https://github.com/wikimedia/mediawiki/blob/0030cb525be6cabc1d63de80586b2017d4bbe354/tests/common/TestsAutoLoader.php#L64
[2] Ie717b0ecf4fcfd089d46248f14853c80b7ef4a76
[3] https://www.mediawiki.org/wiki/Stable_interface_policy
Bug: T243281
Change-Id: I0571b041bcd7f19bec9f103fa7bccdd093f6394d
2020-03-17 20:21:33 +00:00
2020-03-25 20:57:46 +00:00
export const vectorLoggedIn = ( ) => mustache . render ( skinTemplate , Object . assign ( {
Add opt-out link to Sidebar for Vector/Logged-in Users Without Abstractions
This commit is singularly focused on adding a link to the sidebar for
Vector, logged-in users. It does the bare minimum to fulfill the
requirements of T243281.
Additionally, it will help to answer the question "Do we need to use
abstractions (other than maybe different templates) to separate Legacy
Vector from Vector" by intentionally leaving out any abstractions in
order to make it easier to compare with a follow-up patch
(Ib2ef15180df73360cc1de25b893e49d415d23e1a) which does use abstractions.
It is a good thing to question whether or not we need addtional
abstractions in VectorTemplate and if they will help us as unnecessary
abstractions can have the opposite effect and just lead to further
frustrations down the road.
Therefore, I urge you, the reviewer, to let me know your thoughts! If
abstractions are viewed as not making our lives any easier, the
follow-up patches may be completely discarded and that's totally okay
with me. :) I think it's a good think to talk about now though.
Important changes:
* The VectorTemplate constructor was changed to allow injecting the
config, templateParser, and isLegacy boolean (only the config was
allowed before this commit). According to MediaWiki's Stable Interface
Policy, "Constructor signatures are generally considered unstable unless
explicitly declared stable for calling" [3]. Given that VecorTemplate's
constructor is not marked as stable, it is justified to do this without
warning according to the policy.
* Due to the above, the 'setTemplate' method is no longer needed and was
marked as deprecated.
* VectorTemplateTest was made to adapt to the new VectorTemplate
constructor. Additionally, it now extends from
MediaWikiIntegrationTestCase which my intelliphense server can pick up.
I *think* MediaWikiTestCase is just an alias to
MediaWikiIntegrationTestCase [1] and MediaWikiTestCase file was renamed
to MediaWikiIntegrationTestCase in [2], but I'm willing to change it
back if there is pushback to this.
Open questions:
* What are VectorTemplate's responsibilities? To me, it acts right now
as a controller (because it echos the full HTML string from the
template), a model (because SkinTemplate::prepareQuickTemplate sets data
on it which it later retrieves through `$this->get()`), a presenter
(because it adds data tailored for a web-centric view), and a view
(because it renders HTML strings instead of letting the view/template be
solely responsible for that). Arguably, some business logic might be
mixed in there as well (because it checks to see if a User is logged
in/has necessary permissions to show x which my changes here add to).
This might not be a problem if we keep VectorTemplate relatively small,
but will it remain this way as we progress further in Desktop
Improvements?
* How do we write tests for VectorTemplate without exposing unnecessary
public methods? For example, if I want to test the `getSkinData()`
method to see what state will be sent to the template, how should I do
this? One option might be to use `TestingAccessWrapper` to expose these
private methods which is what
`VectorTemplateTest::testbuildViewsProps()` does. Another option is to
accept this method as public. Is there a better way? Keep in mind that
even with access to this method, there might be many things to mock.
[1] https://github.com/wikimedia/mediawiki/blob/0030cb525be6cabc1d63de80586b2017d4bbe354/tests/common/TestsAutoLoader.php#L64
[2] Ie717b0ecf4fcfd089d46248f14853c80b7ef4a76
[3] https://www.mediawiki.org/wiki/Stable_interface_policy
Bug: T243281
Change-Id: I0571b041bcd7f19bec9f103fa7bccdd093f6394d
2020-03-17 20:21:33 +00:00
'html-title' : 'Vector 2020' ,
'page-isarticle' : true ,
'msg-tagline' : 'From Wikipedia, the free encyclopedia' ,
'html-userlangattributes' : htmluserlangattributes ,
'msg-jumptonavigation' : 'Jump to navigation' ,
'msg-jumptosearch' : 'Jump to search' ,
// site specific
'data-footer' : FOOTER _TEMPLATE _DATA ,
'html-sitenotice' : placeholder ( 'a site notice or central notice banner may go here' , 70 ) ,
// article dependent
'html-bodycontent' : placeholder ( 'Article content goes here' ) ,
'html-printfooter' : ` Retrieved from ‘ ’ ` ,
'html-catlinks' : placeholder ( 'Category links component from mediawiki core' , 50 )
2020-03-25 20:57:46 +00:00
} , NAVIGATION _TEMPLATE _DATA . loggedInWithVariantsAndOptOut ) , TEMPLATE _PARTIALS ) ;
