Merge pull request #146 from dshanske/commentclass

Comment Class Improvements

Author: pfefferle

README.md

@@ -68,6 +68,12 @@ The Webmention and Pingback logos are made by [Aaron Parecki](http://aaronpareck
 
 Project actively developed on Github at [pfefferle/wordpress-semantic-linkbacks](https://github.com/pfefferle/wordpress-semantic-linkbacks). Please file support issues there.
 
+### 3.7.3 ###
+* Remove `h-as` properties
+* Remove hard-coded microformats2 properties from facepile and move them to being generated from comment_class
+* Remove unused properties
+* Introduce type argument in list_linkbacks to generate unique ideas for each list of linkbacks without having to specify them using style and li-class
+
 ### 3.7.2 ###
 
 * Bugfix: "Normal comments" hidden in comment-section (https://github.com/pfefferle/wordpress-semantic-linkbacks/issues/140)

includes/class-linkbacks-handler.php

@@ -559,33 +559,31 @@ public static function get_comment_author_url( $url, $id, $comment ) {
 	public static function comment_class( $classes, $class, $comment_id, $post_id ) {
 		// get comment
 		$comment = get_comment( $comment_id );
-
 		// "comment type to class" mapper
 		$class_mapping = array(
-			'mention'       => array( 'h-as-mention' ),
-
-			'reply'         => array( 'h-as-reply' ),
-			'repost'        => array( 'h-as-repost', 'p-repost' ),
-			'like'          => array( 'h-as-like', 'p-like' ),
-			'favorite'      => array( 'h-as-favorite', 'p-favorite' ),
-			'tag'           => array( 'h-as-tag', 'p-tag' ),
-			'bookmark'      => array( 'h-as-bookmark', 'p-bookmark' ),
-			'rsvp:yes'      => array( 'h-as-rsvp' ),
-			'rsvp:no'       => array( 'h-as-rsvp' ),
-			'rsvp:maybe'    => array( 'h-as-rsvp' ),
-			'rsvp:invited'  => array( 'h-as-rsvp' ),
-			'rsvp:tracking' => array( 'h-as-rsvp' ),
+			'mention'       => array( 'u-mention' ),
+
+			'reply'         => array( 'u-comment' ),
+			'repost'        => array( 'u-repost' ),
+			'like'          => array( 'u-like' ),
+			'favorite'      => array( 'u-favorite' ),
+			'tag'           => array( 'u-tag' ),
+			'bookmark'      => array( 'u-bookmark' ),
+			'rsvp:yes'      => array( 'u-rsvp' ),
+			'rsvp:no'       => array( 'u-rsvp' ),
+			'rsvp:maybe'    => array( 'u-rsvp' ),
+			'rsvp:invited'  => array( 'u-rsvp' ),
+			'rsvp:tracking' => array( 'u-rsvp' ),
 		);
 
 		$semantic_linkbacks_type = self::get_type( $comment );
 
 		// check the comment type
 		if ( $semantic_linkbacks_type && isset( $class_mapping[ $semantic_linkbacks_type ] ) ) {
 			$classes = array_merge( $classes, $class_mapping[ $semantic_linkbacks_type ] );
-
 			$classes = array_unique( $classes );
 		}
-
+		$classes[] = 'h-cite';
 		return $classes;
 	}
 

includes/functions.php

@@ -150,8 +150,9 @@ function list_linkbacks( $args, $comments ) {
 		'avatar_size' => 64,
 		'style'       => 'ul', // What HTML type to wrap it in. Accepts 'ul', 'ol'.
 		'style-class' => 'mention-list', // What class to assign to the wrapper
-		'li-class'    => 'single-mention', // What class to assign to the list elements
+		'li-class'    => null, // What class to assign to the list elements
 		'echo'        => true, // Whether to echo the output or return
+		'type'        => 'mention', // Type is the semantic linkbacks type and is here only to automatically add to the classes if present
 	);
 
 	$r = wp_parse_args( $args, $defaults );
@@ -170,21 +171,19 @@ function list_linkbacks( $args, $comments ) {
 	} else {
 		$classes = $r['li-class'];
 	}
-	// All of the list_linkbacks() calls right now are in linkbacks.php, and
-	// they pass the mf2 class as the last li-class element, which is unique,
-	// so use that.
-	$id_class    = $classes[ count( $classes ) - 1 ];
-	$ellipsis_id = 'mention-ellipsis-' . $id_class;
-	$fold_id     = 'mentions-below-fold-' . $id_class;
-
-	$classes[] = 'h-cite';
-	$classes   = join( ' ', $classes );
-	$return    = sprintf( '<%1$s class="%2$s">', $r['style'], $r['style-class'] );
-	$fold_at   = get_option( 'semantic_linkbacks_facepiles_fold_limit', 8 );
+	if ( is_string( $r['style-class'] ) ) {
+		$r['style-class'] = explode( ' ', $r['style-class'] );
+	}
+
+	$classes[]          = 'linkback-' . $r['type'] . '-single';
+	$r['style-class'][] = 'linkback-' . $r['type'];
+
+	$return  = sprintf( '<%1$s class="%2$s">', $r['style'], join( ' ', $r['style-class'] ) );
+	$fold_at = (int) get_option( 'semantic_linkbacks_facepiles_fold_limit', 8 );
 
 	foreach ( $comments as $i => $comment ) {
 		if ( $fold_at && $i === $fold_at ) {
-			$classes .= ' additional-facepile';
+			$classes[] = 'additional-facepile';
 		}
 
 		// If it's an emoji reaction, overlay the emoji.
@@ -201,6 +200,8 @@ function list_linkbacks( $args, $comments ) {
 				preg_replace( '/^www\./', '', $url )
 			);
 		}
+		$class = get_comment_class( $classes, $comment );
+		$class = join( ' ', $class );
 
 		$return .= sprintf(
 			'<li class="%1$s" id="%5$s">
@@ -210,7 +211,7 @@ function list_linkbacks( $args, $comments ) {
 				</span>
 				<a class="u-url" href="%7$s"></a>
 			</li>',
-			$classes,
+			$class,
 			get_avatar( $comment, $r['avatar_size'] ),
 			get_comment_author_url( $comment ),
 			get_comment_author( $comment ),

readme.txt

@@ -68,6 +68,12 @@ The Webmention and Pingback logos are made by [Aaron Parecki](http://aaronpareck
 
 Project actively developed on Github at [pfefferle/wordpress-semantic-linkbacks](https://github.com/pfefferle/wordpress-semantic-linkbacks). Please file support issues there.
 
+= 3.7.3 =
+* Remove `h-as` properties
+* Remove hard-coded microformats2 properties from facepile and move them to being generated from comment_class
+* Remove unused properties
+* Introduce type argument in list_linkbacks to generate unique ideas for each list of linkbacks without having to specify them using style and li-class
+
 = 3.7.2 =
 
 * Bugfix: "Normal comments" hidden in comment-section (https://github.com/pfefferle/wordpress-semantic-linkbacks/issues/140)

templates/linkbacks.php

@@ -4,7 +4,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array( 'single-mention', 'p-reply', 'emoji-reaction' ),
+			'type' => 'reacji',
 		),
 		Semantic_Linkbacks_Walker_Comment::$reactions
 	);
@@ -18,7 +18,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array( 'single-mention', 'p-like' ),
+			'type' => 'like',
 		),
 		get_linkbacks( 'like' )
 	);
@@ -32,7 +32,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array( 'single-mention', 'p-favorite' ),
+			'type' => 'favorite',
 		),
 		get_linkbacks( 'favorite' )
 	);
@@ -46,7 +46,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array( 'single-mention', 'p-bookmark' ),
+			'type' => 'bookmark',
 		),
 		get_linkbacks( 'bookmark' )
 	);
@@ -60,7 +60,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array( 'single-mention', 'p-repost' ),
+			'type' => 'repost',
 		),
 		get_linkbacks( 'repost' )
 	);
@@ -74,7 +74,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array( 'single-mention', 'p-tag' ),
+			'type' => 'tag',
 		),
 		get_linkbacks( 'tag' )
 	);
@@ -91,10 +91,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array(
-				'single-mention',
-				'p-rsvp',
-			)
+			'type' => 'rsvp-yes',
 		),
 		get_linkbacks( 'rsvp:yes' )
 	);
@@ -106,10 +103,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array(
-				'single-mention',
-				'p-rsvp',
-			)
+			'type' => 'invited',
 		),
 		get_linkbacks( 'rsvp:invited' )
 	);
@@ -121,10 +115,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array(
-				'single-mention',
-				'p-rsvp',
-			)
+			'type' => 'rsvp-maybe',
 		),
 		get_linkbacks( 'rsvp:maybe' )
 	);
@@ -136,10 +127,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array(
-				'single-mention',
-				'p-rsvp',
-			)
+			'type' => 'rsvp-no',
 		),
 		get_linkbacks( 'rsvp:no' )
 	);
@@ -151,10 +139,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array(
-				'single-mention',
-				'p-rsvp',
-			)
+			'type' => 'rsvp-tracking',
 		),
 		get_linkbacks( 'rsvp:tracking' )
 	);
@@ -169,7 +154,7 @@
 	<?php
 	list_linkbacks(
 		array(
-			'li-class' => array( 'single-mention', 'p-mention' ),
+			'type' => 'mention',
 		),
 		get_linkbacks( 'mention' )
 	);

tests/test-rendering.php

@@ -30,7 +30,7 @@ public function make_comments( $num, $semantic_linkbacks_type = 'like' ) {
 	public function test_facepile_markup() {
 		$comments = $this->make_comments( 1 );
 		$this->assertStringMatchesFormat(
-			'<ul class="mention-list"><li class="single-mention h-cite" id="comment-2">
+			'<ul class="mention-list linkback-mention"><li class="webmention even thread-even depth-1 linkback-mention-single u-like h-cite" id="comment-2">
 				<span class="p-author h-card">
 					<a class="u-url" title="Person 0 liked this Article on example.com." href="http://example.com/person0"><img alt=\'\' src=\'http://example.com/photo\' srcset=\'http://example.com/photo 2x\' class=\'avatar avatar-64 photo avatar-default u-photo avatar-semantic-linkbacks\' height=\'64\' width=\'64\' /> </a>
 					<span class="hide-name p-name">Person 0</span>
@@ -105,7 +105,7 @@ public function test_reactions() {
 		$this->assertStringMatchesFormat(
 			'<div class="reactions">
 	<h3>Reacjis</h3>
-	<ul class="mention-list"><li class="single-mention p-reply emoji-reaction h-cite" id="comment-%d">
+	<ul class="mention-list linkback-reacji"><li class="comment even thread-even depth-1 linkback-reacji-single h-cite" id="comment-%d">
 				<span class="p-author h-card">
 					<a class="u-url" title="Person 😢 on example.com." href="http://example.com/person"><img alt=\'\' src=\'http://example.com/photo\' srcset=\'http://example.com/photo 2x\' class=\'avatar avatar-64 photo avatar-default u-photo avatar-semantic-linkbacks\' height=\'64\' width=\'64\' /> <span class="emoji-overlay">😢</span></a>
 					<span class="hide-name p-name">Person</span>