Skip to content

Commit 28bd4d5

Browse files
barnabywaltersbarnabywalters
committed
Additional fix for #29
* The previous fix (substituting a stdClass for an empty rels array) was causing looping problems, so there is now a “JSON mode” into which the parser can be put either by passing true as the third constructor parameter or by setting jsonMode = true. By default an empty rels key will be an array, but if JSON mode is set it will be an empty stdClass, ensuringcorrect serialisation. * The tests have been updated accordingly * A missing value property from one test has been added
1 parent 27bfa27 commit 28bd4d5

File tree

5 files changed

+77
-64
lines changed

5 files changed

+77
-64
lines changed

‎Mf2/Parser.php

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
use DOMNodeList;
1010
use Exception;
1111
use SplObjectStorage;
12+
use stdClass;
1213

1314
/**
1415
* Parse Microformats2
@@ -163,14 +164,17 @@ class Parser {
163164

164165
/** @var SplObjectStorage */
165166
protected $parsed;
167+
168+
public $jsonMode;
166169

167170
/**
168171
* Constructor
169172
*
170173
* @param DOMDocument|string $input The data to parse. A string of HTML or a DOMDocument
171174
* @param string $url The URL of the parsed document, for relative URL resolution
175+
* @param boolean $jsonMode Whether or not to use a stdClass instance for an empty `rels` dictionary. This breaks PHP looping over rels, but allows the output to be correctly serialized as JSON.
172176
*/
173-
public function __construct($input, $url = null) {
177+
public function __construct($input, $url = null, $jsonMode = false) {
174178
libxml_use_internal_errors(true);
175179
if (is_string($input)) {
176180
$doc = new DOMDocument();
@@ -205,6 +209,7 @@ public function __construct($input, $url = null) {
205209
$this->baseurl = $baseurl;
206210
$this->doc = $doc;
207211
$this->parsed = new SplObjectStorage();
212+
$this->jsonMode = $jsonMode;
208213
}
209214

210215
private function elementPrefixParsed(\DOMElement $e, $prefix) {
@@ -694,6 +699,14 @@ public function parseH(\DOMElement $e) {
694699
return $parsed;
695700
}
696701

702+
/**
703+
* Parse Rels and Alternatives
704+
*
705+
* Returns [$rels, $alternatives]. If the $rels value is to be empty, i.e. there are no links on the page
706+
* with a rel value *not* containing `alternate`, then the type of $rels depends on $this->jsonMode. If set
707+
* to true, it will be a stdClass instance, optimising for JSON serialisation. Otherwise (the default case),
708+
* it will be an empty array.
709+
*/
697710
public function parseRelsAndAlternates() {
698711
$rels = array();
699712
$alternates = array();
@@ -729,6 +742,10 @@ public function parseRelsAndAlternates() {
729742
}
730743
}
731744

745+
if (empty($rels) and $this->jsonMode) {
746+
$rels = new stdClass();
747+
}
748+
732749
return array($rels, $alternates);
733750
}
734751

‎tests/Mf2/ClassicMicroformatsTest.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ public function setUp() {
2525
public function testParsesClassicHcard() {
2626
$input = '<div class="vcard"><span class="fn n">Barnaby Walters</span> is a person.</div>';
2727
$expected = '{"items": [{"type": ["h-card"], "properties": {"name": ["Barnaby Walters"]}}], "rels": {}}';
28-
$parser = new Parser($input);
28+
$parser = new Parser($input, '', true);
2929
$this->assertJsonStringEqualsJsonString(json_encode($parser->parse()), $expected);
3030
}
3131

3232
public function testParsesClassicHEntry() {
3333
$input = '<div class="hentry"><h1 class="entry-title">microformats2 Is Great</h1> <p class="entry-summary">yes yes it is.</p></div>';
3434
$expected = '{"items": [{"type": ["h-entry"], "properties": {"name": ["microformats2 Is Great"], "summary": ["yes yes it is."]}}], "rels": {}}';
35-
$parser = new Parser($input);
35+
$parser = new Parser($input, '', true);
3636
$this->assertJsonStringEqualsJsonString(json_encode($parser->parse()), $expected);
3737
}
3838

@@ -106,8 +106,6 @@ public function testParsesFBerrimanClassicHEntry() {
106106

107107
public function testParsesSnarfedOrgArticleCorrectly() {
108108
$input = file_get_contents(__DIR__ . '/snarfed.org.html');
109-
/*$parser = new Parser($input, 'http://snarfed.org/2013-10-23_oauth-dropins');
110-
$result = $parser->parse();/**/
111109
$result = Mf2\parse($input, 'http://snarfed.org/2013-10-23_oauth-dropins');
112110
print_r($result);
113111
}

‎tests/Mf2/CombinedMicroformatsTest.php

Lines changed: 48 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -24,46 +24,42 @@ public function setUp() {
2424
*/
2525
public function testHEventLocationHCard() {
2626
$input = '<div class="h-event">
27-
<a class="p-name u-url" href="http://indiewebcamp.com/2012">
27+
<a class="p-name u-url" href="http://indiewebcamp.com/2012">
2828
IndieWebCamp 2012
29-
</a>
30-
from <time class="dt-start">2012-06-30</time>
31-
to <time class="dt-end">2012-07-01</time> at
32-
<span class="p-location h-card">
29+
</a>
30+
from <time class="dt-start">2012-06-30</time>
31+
to <time class="dt-end">2012-07-01</time> at
32+
<span class="p-location h-card">
3333
<a class="p-name p-org u-url" href="http://geoloqi.com/">
34-
Geoloqi
35-
</a>,
36-
<span class="p-street-address">920 SW 3rd Ave. Suite 400</span>,
37-
<span class="p-locality">Portland</span>,
38-
<abbr class="p-region" title="Oregon">OR</abbr>
34+
Geoloqi</a>, <span class="p-street-address">920 SW 3rd Ave. Suite 400</span>, <span class="p-locality">Portland</span>, <abbr class="p-region" title="Oregon">OR</abbr>
3935
</span>
4036
</div>';
4137
$expected = '{
4238
"rels": {},
43-
"items": [{
44-
"type": ["h-event"],
45-
"properties": {
46-
"name": ["IndieWebCamp 2012"],
47-
"url": ["http://indiewebcamp.com/2012"],
48-
"start": ["2012-06-30"],
49-
"end": ["2012-07-01"],
50-
"location": [{
51-
"value": "Geoloqi, 920 SW 3rd Ave. Suite 400, Portland, OR",
52-
"type": ["h-card"],
39+
"items": [{
40+
"type": ["h-event"],
5341
"properties": {
54-
"name": ["Geoloqi"],
55-
"org": ["Geoloqi"],
56-
"url": ["http://geoloqi.com/"],
57-
"street-address": ["920 SW 3rd Ave. Suite 400"],
58-
"locality": ["Portland"],
59-
"region": ["Oregon"]
42+
"name": ["IndieWebCamp 2012"],
43+
"url": ["http://indiewebcamp.com/2012"],
44+
"start": ["2012-06-30"],
45+
"end": ["2012-07-01"],
46+
"location": [{
47+
"value": "Geoloqi, 920 SW 3rd Ave. Suite 400, Portland, OR",
48+
"type": ["h-card"],
49+
"properties": {
50+
"name": ["Geoloqi"],
51+
"org": ["Geoloqi"],
52+
"url": ["http://geoloqi.com/"],
53+
"street-address": ["920 SW 3rd Ave. Suite 400"],
54+
"locality": ["Portland"],
55+
"region": ["Oregon"]
56+
}
57+
}]
6058
}
61-
}]
62-
}
63-
}]
59+
}]
6460
}';
6561

66-
$parser = new Parser($input);
62+
$parser = new Parser($input, '', true);
6763
$parser->stringDateTimes = true;
6864
$output = $parser->parse();
6965

@@ -92,7 +88,7 @@ public function testHCardOrgPOrg() {
9288
}]
9389
}';
9490

95-
$parser = new Parser($input);
91+
$parser = new Parser($input, '', true);
9692
$parser->stringDateTimes = true;
9793
$output = $parser->parse();
9894

@@ -130,7 +126,7 @@ public function testHCardOrgHCard() {
130126
}]
131127
}';
132128

133-
$parser = new Parser($input);
129+
$parser = new Parser($input, '', true);
134130
$parser->stringDateTimes = true;
135131
$output = $parser->parse();
136132

@@ -168,7 +164,7 @@ public function testHCardPOrgHCardHOrg() {
168164
}]
169165
}';
170166

171-
$parser = new Parser($input);
167+
$parser = new Parser($input, '', true);
172168
$output = $parser->parse();
173169

174170
print_r($output);
@@ -181,31 +177,32 @@ public function testHCardPOrgHCardHOrg() {
181177
*/
182178
public function testHCardChildHCard() {
183179
$input = '<div class="h-card">
184-
<a class="p-name u-url"
185-
href="http://blog.lizardwrangler.com/">
186-
Mitchell Baker</a>
187-
(<a class="h-card h-org" href="http://mozilla.org/">
188-
Mozilla Foundation</a>)
180+
<a class="p-name u-url"
181+
href="http://blog.lizardwrangler.com/">
182+
Mitchell Baker</a>
183+
(<a class="h-card h-org" href="http://mozilla.org/">
184+
Mozilla Foundation</a>)
189185
</div>';
190186
$expected = '{
191187
"rels": {},
192188
"items": [{
193-
"type": ["h-card"],
194-
"properties": {
195-
"name": ["Mitchell Baker"],
196-
"url": ["http://blog.lizardwrangler.com/"]
197-
},
198-
"children": [{
199-
"type": ["h-card","h-org"],
200-
"properties": {
201-
"name": ["Mozilla Foundation"],
202-
"url": ["http://mozilla.org/"]
203-
}
204-
}]
189+
"type": ["h-card"],
190+
"properties": {
191+
"name": ["Mitchell Baker"],
192+
"url": ["http://blog.lizardwrangler.com/"]
193+
},
194+
"children": [{
195+
"type": ["h-card","h-org"],
196+
"properties": {
197+
"name": ["Mozilla Foundation"],
198+
"url": ["http://mozilla.org/"]
199+
},
200+
"value": "Mozilla Foundation"
201+
}]
205202
}]
206203
}';
207204

208-
$parser = new Parser($input);
205+
$parser = new Parser($input, '', true);
209206
$output = $parser->parse();
210207

211208
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);

‎tests/Mf2/MicroformatsWikiExamplesTest.php

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public function testHandlesEmptyStringsCorrectly() {
3232
"items": []
3333
}';
3434

35-
$parser = new Parser($input);
35+
$parser = new Parser($input, '', true);
3636
$output = $parser->parse();
3737

3838
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);
@@ -45,7 +45,8 @@ public function testHandlesNullCorrectly() {
4545
"items": []
4646
}';
4747

48-
$parser = new Parser($input);
48+
$parser = new Parser($input, '', true);
49+
$parser->jsonMode = true;
4950
$output = $parser->parse();
5051

5152
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);
@@ -65,7 +66,7 @@ public function testSimplePersonReference() {
6566
}
6667
}]
6768
}';
68-
$parser = new Parser($input);
69+
$parser = new Parser($input, '', true);
6970
$output = $parser->parse();
7071

7172
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);
@@ -86,7 +87,7 @@ public function testSimpleHyperlinkedPersonReference() {
8687
}
8788
}]
8889
}';
89-
$parser = new Parser($input);
90+
$parser = new Parser($input, '', true);
9091
$output = $parser->parse();
9192

9293
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);
@@ -107,7 +108,7 @@ public function testSimplePersonImage() {
107108
"photo": ["http://example.org/pic.jpg"]
108109
}
109110
}]}';
110-
$parser = new Parser($input);
111+
$parser = new Parser($input, '', true);
111112
$output = $parser->parse();
112113

113114
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);
@@ -132,7 +133,7 @@ public function testHyperlinkedImageNameAndPhotoProperties() {
132133
"photo": ["https://s3.amazonaws.com/twitter_production/profile_images/53307499/180px-Rohit-sq_bigger.jpg"]
133134
}
134135
}]}';
135-
$parser = new Parser($input);
136+
$parser = new Parser($input, '', true);
136137
$output = $parser->parse();
137138

138139
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);
@@ -179,7 +180,7 @@ public function testMoreDetailedPerson() {
179180
}
180181
}]
181182
}';
182-
$parser = new Parser($input);
183+
$parser = new Parser($input, '', true);
183184
$output = $parser->parse();
184185

185186
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);

‎tests/Mf2/ParseImpliedTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public function testMultipleImpliedHCards() {
160160
}]
161161
}';
162162

163-
$parser = new Parser($input);
163+
$parser = new Parser($input, '', true);
164164
$output = $parser->parse();
165165

166166
$this->assertJsonStringEqualsJsonString(json_encode($output), $expected);

0 commit comments

Comments
 (0)