Skip to content

rel=tag hentry/hreview backcompat #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaronpk merged 6 commits into from
Mar 26, 2018
Merged

rel=tag hentry/hreview backcompat #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
38b2f2b
Add failing test and fix for #157 (hentry)
gRegorLove Mar 24, 2018
40455f3
Add failing test and fix for #157 (hreview)
gRegorLove Mar 24, 2018
c5f4e91
Add rel-tag tests
gRegorLove Mar 24, 2018
4c61222
add failing test for excluding the generated data element in rel tag …
aaronpk Mar 25, 2018
b086f75
Merge pull request #2 from aaronpk/issue157
gRegorLove Mar 25, 2018
c3db4cb
Update upgradeRelTagToCategory() to avoid adding elements to parsed e-*
gRegorLove Mar 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions Mf2/Parser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1319,6 +1319,32 @@ public function parseRelsAndAlternates() {
return array($rels, $rel_urls, $alternates);
}

/**
* Find rel=tag elements that don't have class=category and have an href.
* For each element, get the last non-empty URL segment. Append a <data>
* element with that value as the category. Uses the mf1 class 'category'
* which will then be upgraded to p-category during backcompat.
* @param DOMElement $el
*/
public function upgradeRelTagToCategory(DOMElement $el) {
$rel_tag = $this->xpath->query('.//a[contains(concat(" ",normalize-space(@rel)," ")," tag ") and not(contains(concat(" ", normalize-space(@class), " "), " category ")) and @href]', $el);

if ( $rel_tag->length ) {
foreach ( $rel_tag as $tempEl ) {
$path = trim(parse_url($tempEl->getAttribute('href'), PHP_URL_PATH), ' /');
$segments = explode('/', $path);
$value = array_pop($segments);

# build the <data> element
$dataEl = $tempEl->ownerDocument->createElement('data');
$dataEl->setAttribute('class', 'category');
$dataEl->setAttribute('value', $value);

# append as child of input element. this should ensure added element does get parsed inside e-*
$el->appendChild($dataEl);
}
}
}

/**
* Kicks off the parsing routine
Expand Down Expand Up @@ -1502,6 +1528,8 @@ public function backcompat(DOMElement $el, $context = '', $isParentMf2 = false)
switch ( $classname )
{
case 'hentry':
$this->upgradeRelTagToCategory($el);

$rel_bookmark = $this->xpath->query('.//a[contains(concat(" ",normalize-space(@rel)," ")," bookmark ") and @href]', $el);

if ( $rel_bookmark->length ) {
Expand Down Expand Up @@ -1548,6 +1576,8 @@ public function backcompat(DOMElement $el, $context = '', $isParentMf2 = false)
}
}
}

$this->upgradeRelTagToCategory($el);
break;

case 'vevent':
Expand Down Expand Up @@ -1968,6 +1998,9 @@ public function query($expression, $context = null) {
'description' => array(
'replace' => 'e-content'
),
'category' => array(
'replace' => 'p-category'
),
),
'hproduct' => array(
'fn' => array(
Expand Down
136 changes: 135 additions & 1 deletion tests/Mf2/ClassicMicroformatsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@ public function testParsesFBerrimanClassicHEntry() {
$result = $parser->parse();
$e = $result['items'][0];
$this->assertContains('h-entry', $e['type']);
$this->assertArrayHasKey('category', $e['properties']);
$this->assertCount(7, $e['properties']['category']);
$this->assertContains('speaking', $e['properties']['category']);
$this->assertContains('web-dev', $e['properties']['category']);
$this->assertContains('conferences', $e['properties']['category']);
$this->assertContains('front-trends', $e['properties']['category']);
$this->assertContains('fronttrends', $e['properties']['category']);
$this->assertContains('speaking', $e['properties']['category']);
$this->assertContains('txjs', $e['properties']['category']);
}

public function testParsesSnarfedOrgArticleCorrectly() {
Expand Down Expand Up @@ -566,8 +575,8 @@ public function testMixedMf2andMf1Case1() {

$this->assertCount(1, $result['items'][0]['properties']['author']);
$this->assertCount(1, $result['items'][0]['properties']['author'][0]['type']);

$this->assertEquals('h-card', $result['items'][0]['properties']['author'][0]['type'][0]);
$this->assertArrayNotHasKey('category', $result['items'][0]['properties']);
}


Expand Down Expand Up @@ -837,5 +846,130 @@ public function testParsesHfeed() {
$this->assertArrayHasKey('value', $output['items'][0]['children'][0]['properties']['author'][0]);
}

/**
* @see https://github.com/indieweb/php-mf2/issues/157
* @see source: http://www.manton.org/2018/03/indieweb-generation-4-and-hosted-domains.html
*/
public function testHEntryRelTag() {
$input = '<article id="post-6586" class="post-6586 post type-post status-publish format-standard hentry category-technology tag-domains tag-indiewebcamp tag-microblog tag-wordpress">
<header class="entry-header">

<h1 class="entry-title">IndieWeb generation 4 and hosted domains</h1>
</header><!-- .entry-header -->

<div class="entry-content">
<p>Naturally because of the goals of Micro.blog, I see a lot of discussion about “owning your content”. It’s an important part of the mission for Micro.blog to take control back from closed, ad-supported social networks and instead embrace posting on our own blogs again.</p>
<p>But what does it mean to own our content? Do we have to install WordPress or some home-grown blogging system for it to be considered true content ownership, where we have the source code and direct SFTP access to the server? No. If that’s our definition, then content ownership will be permanently reserved for programmers and technical folks who have hours to spend on server configuration.</p>
<p><a href="https://indieweb.org/generations">IndieWebCamp has a generations chart</a> to illustrate the path from early adopters to mainstream users. Eli Mellen highlighted it <a href="https://eli.li/entry.php?id=20180318015703">in a recent post</a> about the need to bridge the gap between the technical aspects of IndieWeb tools and more approachable platforms. With Micro.blog specifically, the goal is “generation 4”, and I think we’re on track to get there.</p>
<p>I want blogging to be as easy as tweeting. Anything short of that isn’t good enough for Micro.blog. You’ll notice when you use Twitter that they never ask you to SFTP into twitter.com to configure your account. They don’t ask you to install anything.</p>
<p>More powerful software that you can endlessly customize will always have its place. It’s good to have a range of options, including open source to tinker with. That’s often where some of the best ideas start. But too often I see people get lost in the weeds of plugins and themes, lured in by the myth that you have to self-host with WordPress to be part of the IndieWeb.</p>
<p>Owning your content isn’t about portable software. It’s about portable URLs and data. It’s about domain names.</p>
<p>When you write and post photos at your own domain name, your content can outlive any one blogging platform. This month marked the 16th anniversary of blogging at manton.org, and in that time I’ve switched blogging platforms and hosting providers a few times. The posts and URLs can all be preserved through those changes because it’s my own domain name.</p>
<p>I was disappointed when Medium announced they were <a href="http://web.archive.org/web/20180301231401/https://help.medium.com/hc/en-us/articles/115005579728-Get-started-with-custom-domains">discontinuing support for custom domain names</a>. I’m linking to the Internet Archive copy because Medium’s help page about this is no longer available. If “no custom domains” is still their policy, it’s a setback for the open web, and dooms Medium to the same dead-end as twitter.com/username URLs.</p>
<p>If you can’t use your own domain name, you can’t own it. Your content will be forever stuck at those silo URLs, beholden to the whims of the algorithmic timeline and shifting priorities of the executive team.</p>
<p>For hosted blogs on Micro.blog, we encourage everyone to map a custom domain to their content, and we throw in free SSL and preserve redirects for old posts on imported WordPress content. There’s more we can do.</p>
<p>I’m working on the next version of the macOS app for Micro.blog now, which features multiple accounts and even multiple blogs under the same account. Here’s a screenshot of the settings screen:</p>
<p><img src="https://manton.org/images/2018/prefs_accounts.png" width="512" height="415" alt="Mac screenshot" scale="0"></p>
<p>The goal with Micro.blog is not to be a stop-gap hosting provider, with truly “serious” users eventually moving on to something else (although we make that easy). We want Micro.blog hosting to be the best platform for owning your content and participating in the Micro.blog and IndieWeb communities.</p>
</div><!-- .entry-content -->

<footer class="entry-meta">
This entry was posted in <a href="http://www.manton.org/category/technology" rel="category tag">Technology</a> and tagged <a href="http://www.manton.org/tag/domains" rel="tag">domains</a>, <a href="http://www.manton.org/tag/indiewebcamp" rel="tag">indiewebcamp</a>, <a href="http://www.manton.org/tag/microblog" rel="tag">microblog</a>, <a href="http://www.manton.org/tag/wordpress" rel="tag">wordpress</a> on <a href="http://www.manton.org/2018/03/indieweb-generation-4-and-hosted-domains.html" title="9:24 am" rel="bookmark"><time class="entry-date" datetime="2018-03-23T09:24:36+00:00">2018/03/23</time></a><span class="by-author"> by <span class="author vcard"><a class="url fn n" href="http://www.manton.org/author/manton" title="View all posts by manton" rel="author">manton</a></span></span>. </footer><!-- .entry-meta -->
</article>';
$parser = new Parser($input);
$output = $parser->parse();

$this->assertArrayHasKey('category', $output['items'][0]['properties']);
$this->assertCount(5, $output['items'][0]['properties']['category']);
$this->assertContains('technology', $output['items'][0]['properties']['category']);
$this->assertContains('domains', $output['items'][0]['properties']['category']);
$this->assertContains('indiewebcamp', $output['items'][0]['properties']['category']);
$this->assertContains('microblog', $output['items'][0]['properties']['category']);
$this->assertContains('wordpress', $output['items'][0]['properties']['category']);
}

public function testHEntryRelTagInContent() {
$input = <<< END
<article class="hentry">
<div class="entry-content">
Entry content should not include the generated <code>data</code> element for rel tag backcompat <a href="/tag/test" rel="tag">test</a>
</div>
</article>
END;

$parser = new Parser($input);
$output = $parser->parse();
$item = $output['items'][0];

$this->assertEquals(['test'], $item['properties']['category']);
$this->assertEquals('Entry content should not include the generated data element for rel tag backcompat test', $item['properties']['content'][0]['value']);
$this->assertEquals('Entry content should not include the generated <code>data</code> element for rel tag backcompat <a href="/tag/test" rel="tag">test</a>', $item['properties']['content'][0]['html']);
}

/**
* @see https://github.com/indieweb/php-mf2/issues/157
* @see source: http://jg.typepad.com/ciel/2006/02/daniel_bouluds_.html
*/
public function testHReviewRelTag() {
$input = '<div class="hreview">
<span class="version" style="display:none">0.2</span>
<h2 class="summary">
Divine Brunch!
</h2>
<abbr class="dtreviewed" title="20060219T1919-0800">
Feb 19, 2006
</abbr>
by <span class="reviewer fn"><a href="http://jg.typepad.com/ciel">Joan Gelfand</a></span>
<span class="type" style="display:none">business</span>
<div class="item vcard">
<a href="http://www.garconsf.com" class="url fn">
Garçon
</a>
<div class="adr">
<div class="street-address">1101 Valencia Street</div>
<span class="locality">San Francisco</span>,
<span class="region">CA</span>
</div>
</div>
<blockquote class="description"><p>
<abbr class="rating" title="3">★★★ </abbr>
Best Benedicts!
Two perfectly poached eggs and a thin slice of tasty, French ham rest on a circle of warm brioche. Drizzled on top is a light, slightly tangy sauce. Seamless! The sophisticated room and great wine list added to the whole experience - Super!</p></blockquote>
<p style="text-align:right;font-size:10px;">Technorati Tags: <a href="http://www.technorati.com/tag/Garcon" rel="tag">Garcon</a>, <a href="http://www.technorati.com/tag/Garçon" rel="tag">Garçon</a></p>
</div>';
$parser = new Parser($input);
$output = $parser->parse();

$this->assertArrayHasKey('category', $output['items'][0]['properties']);
$this->assertCount(2, $output['items'][0]['properties']['category']);
$this->assertContains('Garcon', $output['items'][0]['properties']['category']);
$this->assertContains('Garçon', $output['items'][0]['properties']['category']);
}

/**
* Should return the last non-empty URL segment
* @see https://github.com/indieweb/php-mf2/issues/157
*/
public function testRelTagTrailingSlash() {
$input = '<div class="hentry">
<a rel="tag" href="/tags/testing/">Testing</a>,
<a rel="tag" href="/tags/microformats">Microformats</a>
</div>

<div class="hreview">
<a rel="tag" href="/tags/phpmf2/">php-mf2</a>,
<a rel="tag" href="/tags/mf2py">mf2py</a>
</div>
';
$parser = new Parser($input);
$output = $parser->parse();

$this->assertArrayHasKey('category', $output['items'][0]['properties']);
$this->assertContains('testing', $output['items'][0]['properties']['category']);
$this->assertContains('microformats', $output['items'][0]['properties']['category']);
$this->assertArrayHasKey('category', $output['items'][1]['properties']);
$this->assertContains('phpmf2', $output['items'][1]['properties']['category']);
$this->assertContains('mf2py', $output['items'][1]['properties']['category']);
}
}

20 changes: 20 additions & 0 deletions tests/Mf2/CombinedMicroformatsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,5 +397,25 @@ public function testNestedValueDTProperty() {
$this->assertEquals('1997-12-12', $output['items'][0]['properties']['acme'][0]['value']);
}

/**
* rel=tag should not be upgraded within microformats2
* @see https://github.com/indieweb/php-mf2/issues/157
*/
public function testMf2DoesNotParseRelTag() {
$input = '<div class="h-entry">
<a rel="tag" href="/tags/tests">Tests</a>
</div>

<div class="h-review">
<a rel="tag" href="/tags/reviews">Reviews</a>
</div>
';
$parser = new Parser($input);
$output = $parser->parse();

$this->assertArrayNotHasKey('category', $output['items'][0]['properties']);
$this->assertArrayNotHasKey('category', $output['items'][1]['properties']);
}

}