MediaWiki  1.33.1
ResourceLoaderImageModuleTest.php
Go to the documentation of this file.
1 <?php
2 
3 use Wikimedia\TestingAccessWrapper;
4 
9 
10  public static $commonImageData = [
11  'abc' => 'abc.gif',
12  'def' => [
13  'file' => 'def.svg',
14  'variants' => [ 'destructive' ],
15  ],
16  'ghi' => [
17  'file' => [
18  'ltr' => 'ghi.svg',
19  'rtl' => 'jkl.svg'
20  ],
21  ],
22  'mno' => [
23  'file' => [
24  'ltr' => 'mno-ltr.svg',
25  'rtl' => 'mno-rtl.svg',
26  'lang' => [
27  'he' => 'mno-ltr.svg',
28  ]
29  ],
30  ],
31  'pqr' => [
32  'file' => [
33  'default' => 'pqr-a.svg',
34  'lang' => [
35  'en' => 'pqr-b.svg',
36  'ar,de' => 'pqr-f.svg',
37  ]
38  ],
39  ]
40  ];
41 
42  public static $commonImageVariants = [
43  'invert' => [
44  'color' => '#FFFFFF',
45  'global' => true,
46  ],
47  'primary' => [
48  'color' => '#598AD1',
49  ],
50  'constructive' => [
51  'color' => '#00C697',
52  ],
53  'destructive' => [
54  'color' => '#E81915',
55  ],
56  ];
57 
58  public static function providerGetModules() {
59  return [
60  [
61  [
63  'prefix' => 'oo-ui-icon',
64  'variants' => self::$commonImageVariants,
65  'images' => self::$commonImageData,
66  ],
67  '.oo-ui-icon-abc {
68  ...
69 }
70 .oo-ui-icon-abc-invert {
71  ...
72 }
73 .oo-ui-icon-def {
74  ...
75 }
76 .oo-ui-icon-def-invert {
77  ...
78 }
79 .oo-ui-icon-def-destructive {
80  ...
81 }
82 .oo-ui-icon-ghi {
83  ...
84 }
85 .oo-ui-icon-ghi-invert {
86  ...
87 }
88 .oo-ui-icon-mno {
89  ...
90 }
91 .oo-ui-icon-mno-invert {
92  ...
93 }
94 .oo-ui-icon-pqr {
95  ...
96 }
97 .oo-ui-icon-pqr-invert {
98  ...
99 }',
100  ],
101  [
102  [
104  'selectorWithoutVariant' => '.mw-ui-icon-{name}:after, .mw-ui-icon-{name}:before',
105  'selectorWithVariant' =>
106  '.mw-ui-icon-{name}-{variant}:after, .mw-ui-icon-{name}-{variant}:before',
107  'variants' => self::$commonImageVariants,
108  'images' => self::$commonImageData,
109  ],
110  '.mw-ui-icon-abc:after, .mw-ui-icon-abc:before {
111  ...
112 }
113 .mw-ui-icon-abc-invert:after, .mw-ui-icon-abc-invert:before {
114  ...
115 }
116 .mw-ui-icon-def:after, .mw-ui-icon-def:before {
117  ...
118 }
119 .mw-ui-icon-def-invert:after, .mw-ui-icon-def-invert:before {
120  ...
121 }
122 .mw-ui-icon-def-destructive:after, .mw-ui-icon-def-destructive:before {
123  ...
124 }
125 .mw-ui-icon-ghi:after, .mw-ui-icon-ghi:before {
126  ...
127 }
128 .mw-ui-icon-ghi-invert:after, .mw-ui-icon-ghi-invert:before {
129  ...
130 }
131 .mw-ui-icon-mno:after, .mw-ui-icon-mno:before {
132  ...
133 }
134 .mw-ui-icon-mno-invert:after, .mw-ui-icon-mno-invert:before {
135  ...
136 }
137 .mw-ui-icon-pqr:after, .mw-ui-icon-pqr:before {
138  ...
139 }
140 .mw-ui-icon-pqr-invert:after, .mw-ui-icon-pqr-invert:before {
141  ...
142 }',
143  ],
144  ];
145  }
146 
151  public function testGetStyles( $module, $expected ) {
152  $module = new ResourceLoaderImageModuleTestable(
153  $module,
154  __DIR__ . '/../../data/resourceloader'
155  );
156  $styles = $module->getStyles( $this->getResourceLoaderContext() );
157  $this->assertEquals( $expected, $styles['all'] );
158  }
159 
163  public function testContext() {
165  $this->assertFalse( $context->getImageObj(), 'Missing image parameter' );
166 
168  'image' => 'example',
169  ] ) );
170  $this->assertFalse( $context->getImageObj(), 'Missing module parameter' );
171 
173  'modules' => 'unknown',
174  'image' => 'example',
175  ] ) );
176  $this->assertFalse( $context->getImageObj(), 'Not an image module' );
177 
178  $rl = new EmptyResourceLoader();
179  $rl->register( 'test', [
181  'prefix' => 'test',
182  'images' => [ 'example' => 'example.png' ],
183  ] );
184  $context = new ResourceLoaderContext( $rl, new FauxRequest( [
185  'modules' => 'test',
186  'image' => 'unknown',
187  ] ) );
188  $this->assertFalse( $context->getImageObj(), 'Unknown image' );
189 
190  $rl = new EmptyResourceLoader();
191  $rl->register( 'test', [
193  'prefix' => 'test',
194  'images' => [ 'example' => 'example.png' ],
195  ] );
196  $context = new ResourceLoaderContext( $rl, new FauxRequest( [
197  'modules' => 'test',
198  'image' => 'example',
199  ] ) );
200  $this->assertInstanceOf( ResourceLoaderImage::class, $context->getImageObj() );
201  }
202 
203  public static function providerGetStyleDeclarations() {
204  return [
205  [
206  false,
207 <<<TEXT
208 background-image: url(rasterized.png);
209  background-image: linear-gradient(transparent, transparent), url(original.svg);
210 TEXT
211  ],
212  [
213  'data:image/svg+xml',
214 <<<TEXT
215 background-image: url(rasterized.png);
216  background-image: linear-gradient(transparent, transparent), url(data:image/svg+xml);
217 TEXT
218  ],
219 
220  ];
221  }
222 
227  public function testGetStyleDeclarations( $dataUriReturnValue, $expected ) {
228  $module = TestingAccessWrapper::newFromObject( new ResourceLoaderImageModule() );
230  $image = $this->getImageMock( $context, $dataUriReturnValue );
231 
232  $styles = $module->getStyleDeclarations(
233  $context,
234  $image,
235  'load.php'
236  );
237 
238  $this->assertEquals( $expected, $styles );
239  }
240 
241  private function getImageMock( ResourceLoaderContext $context, $dataUriReturnValue ) {
242  $image = $this->getMockBuilder( ResourceLoaderImage::class )
243  ->disableOriginalConstructor()
244  ->getMock();
245  $image->method( 'getDataUri' )
246  ->will( $this->returnValue( $dataUriReturnValue ) );
247  $image->expects( $this->any() )
248  ->method( 'getUrl' )
249  ->will( $this->returnValueMap( [
250  [ $context, 'load.php', null, 'original', 'original.svg' ],
251  [ $context, 'load.php', null, 'rasterized', 'rasterized.png' ],
252  ] ) );
253 
254  return $image;
255  }
256 }
257 
262  protected function getCssDeclarations( $primary, $fallback ) {
263  return [ '...' ];
264  }
265 }
ResourceLoaderImageModuleTest\getImageMock
getImageMock(ResourceLoaderContext $context, $dataUriReturnValue)
Definition: ResourceLoaderImageModuleTest.php:241
ResourceLoaderContext
Object passed around to modules which contains information about the state of a specific loader reque...
Definition: ResourceLoaderContext.php:32
ResourceLoaderImageModuleTest\testGetStyles
testGetStyles( $module, $expected)
providerGetModules ResourceLoaderImageModule::getStyles
Definition: ResourceLoaderImageModuleTest.php:151
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2644
ResourceLoaderImageModuleTest
ResourceLoader.
Definition: ResourceLoaderImageModuleTest.php:8
$fallback
$fallback
Definition: MessagesAb.php:11
ResourceLoaderImageModuleTestable\getCssDeclarations
getCssDeclarations( $primary, $fallback)
Replace with a stub to make test cases easier to write.
Definition: ResourceLoaderImageModuleTest.php:256
original
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two distribute and or modify the software for each author s protection and we want to make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed we want its recipients to know that what they have is not the original
Definition: COPYING.txt:43
data
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
ResourceLoaderImageModuleTest\$commonImageVariants
static $commonImageVariants
Definition: ResourceLoaderImageModuleTest.php:42
ResourceLoaderImageModuleTest\testGetStyleDeclarations
testGetStyleDeclarations( $dataUriReturnValue, $expected)
providerGetStyleDeclarations ResourceLoaderImageModule::getStyleDeclarations
Definition: ResourceLoaderImageModuleTest.php:227
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ResourceLoaderImageModuleTestable
Definition: ResourceLoaderImageModuleTest.php:252
$image
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition: hooks.txt:780
any
they could even be mouse clicks or menu items whatever suits your program You should also get your if any
Definition: COPYING.txt:326
ResourceLoaderImageModuleTest\$commonImageData
static $commonImageData
Definition: ResourceLoaderImageModuleTest.php:10
ResourceLoaderImageModuleTest\testContext
testContext()
ResourceLoaderContext::getImageObj.
Definition: ResourceLoaderImageModuleTest.php:163
EmptyResourceLoader
Definition: ResourceLoaderTestCase.php:172
ResourceLoaderTestCase\getResourceLoaderContext
getResourceLoaderContext( $options=[], ResourceLoader $rl=null)
Definition: ResourceLoaderTestCase.php:23
ResourceLoaderImageModuleTest\providerGetStyleDeclarations
static providerGetStyleDeclarations()
Definition: ResourceLoaderImageModuleTest.php:203
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
ResourceLoaderImageModule
ResourceLoader module for generated and embedded images.
Definition: ResourceLoaderImageModule.php:29
ResourceLoaderImageModuleTest\providerGetModules
static providerGetModules()
Definition: ResourceLoaderImageModuleTest.php:58
ResourceLoaderTestCase
Definition: ResourceLoaderTestCase.php:7