Merge pull request #82 from cmanon/feature/61-route-block

Feature/61 route block

readme.txt

@@ -4,7 +4,7 @@ Contributors: cmanon, jrfoell, lancewillett, dlintott, sebastianerb
 Tags: strava, activity, bicycle, cycling, biking, running, run, swimming, swim, paddle, kayak, gps, shortcode, widget, plugin
 Requires at least: 4.6
 Tested up to: 5.6
-Stable tag: 2.5.1
+Stable tag: 2.6.0
 Requires PHP: 5.3
 License: GPLv2 or later
 
@@ -22,10 +22,16 @@ Using WP-Strava 2.0+ requires a working WordPress cron configuration. By default
 
 = Blocks =
 
+*Available in WordPress 5.0 and up.*
+
 Strava Activity  - embed an activity in any page or post. Shows a summary of the activity plus a map if a google maps key has been added.
 
 Paste in the full activity URL from Strava, such as https://www.strava.com/activities/1793155844 and click "Embed." A preview map will be shown in the editor, similar to what will be displayed on the front-end. In the side-panel you can selection options to show the image only (without the details table), display markers at the start & finish points, and override the system of measure from your default selection under Settings -> Strava.
 
+Strava Route - embed a route in any page or post. Shows a summary of the route plus a map if a google maps key has been added.
+
+Paste in the full route URL from Strava, such as hhttps://www.strava.com/routes/2326567 and click "Embed." A preview map will be shown in the editor, similar to what will be displayed on the front-end. In the side-panel you can selection options to show the image only (without the details table), display markers at the start & finish points, and override the system of measure from your default selection under Settings -> Strava.
+
 = Shortcodes =
 
 [activity id=NUMBER] - add to any page or post. Shows a summary of the activity plus a map if a google maps key has been added.
@@ -112,6 +118,9 @@ On the WP-Strava settings page you cannot currently remove and add another athle
 
 == Changelog ==
 
+= 2.6.0 =
+Make reusable components for embed screens and SOMOverride
+Add Route Block
 
 = 2.5.1 =
 

src/WPStrava.php

@@ -62,6 +62,17 @@ public static function get_instance() {
 		return self::$instance;
 	}
 
+	/**
+	 * Check if rest request to skip link rendering in block editor.
+	 *
+	 * @return boolean
+	 * @author Justin Foell <[email protected]>
+	 * @since  2.6.0
+	 */
+	public static function is_rest_request() {
+		return defined( 'REST_REQUEST' ) && REST_REQUEST;
+	}
+
 	/**
 	 * Function to install hooks at WP runtime.
 	 *
@@ -188,7 +199,10 @@ public function register_shortcodes() {
 	 * @see https://wordpress.org/gutenberg/handbook/blocks/writing-your-first-block-type/#enqueuing-block-scripts
 	 */
 	public function register_blocks() {
-		static $blocks = array( 'WPStrava_Blocks_Activity' );
+		static $blocks = array(
+			'WPStrava_Blocks_Activity',
+			'WPStrava_Blocks_Route',
+		);
 
 		// automatically load dependencies and version
 		$asset_file = include WPSTRAVA_PLUGIN_DIR . 'build/index.asset.php';

src/WPStrava/Activity.php

@@ -109,22 +109,11 @@ public function get_activities_longer_than( $activities, $dist ) {
 	 * @since  2.3.2
 	 */
 	public function get_activity_link( $activity_id, $text, $title = '' ) {
-		if ( $this->is_rest_request() || WPStrava::get_instance()->settings->no_link ) {
+		if ( WPStrava::is_rest_request() || WPStrava::get_instance()->settings->no_link ) {
 			return $text;
 		}
 		$url        = esc_url( self::ACTIVITIES_URL . $activity_id );
 		$title_attr = $title ? " title='" . esc_attr( $title ) . "'" : '';
 		return "<a href='{$url}'{$title_attr}>{$text}</a>";
 	}
-
-	/**
-	 * Check if rest request to skip link rendering in block editor.
-	 *
-	 * @return boolean
-	 * @author Justin Foell <[email protected]>
-	 * @since  2.5.1
-	 */
-	private function is_rest_request() {
-		return defined( 'REST_REQUEST' ) && REST_REQUEST;
-	}
 }

src/WPStrava/Blocks/Activity.php

@@ -85,7 +85,7 @@ public function render_block( $attributes, $content ) {
 	}
 
 	/**
-	 * Enqueue style if shortcode is being used.
+	 * Enqueue style if block is being used.
 	 *
 	 * @author Justin Foell <[email protected]>
 	 * @since  2.5.0

src/WPStrava/Blocks/Route.php

@@ -0,0 +1,98 @@
+<?php
+/*
+ * Route block.
+ */
+
+class WPStrava_Blocks_Route implements WPStrava_Blocks_Interface {
+
+	/**
+	 * Whether or not to enqueue styles (if shortcode is present).
+	 *
+	 * @var boolean
+	 * @author Justin Foell <[email protected]>
+	 * @since  2.6.0
+	 */
+	private $add_script = false;
+
+	/**
+	 * Register the wp-strava/route block.
+	 *
+	 * @author Justin Foell <[email protected]>
+	 * @since  2.6.0
+	 */
+	public function register_block() {
+		register_block_type(
+			'wp-strava/route',
+			array(
+				'style'           => 'wp-strava-block',
+				'editor_style'    => 'wp-strava-block-editor',
+				'editor_script'   => 'wp-strava-block',
+				'render_callback' => array( $this, 'render_block' ),
+				'attributes'      => array(
+					'url'            => array(
+						'type'    => 'string',
+						'default' => '',
+					),
+					'imageOnly'      => array(
+						'type'    => 'boolean',
+						'default' => false,
+					),
+					'displayMarkers' => array(
+						'type'    => 'boolean',
+						'default' => false,
+					),
+					'som'            => array(
+						'type'    => 'string',
+						'default' => null,
+					),
+				),
+			)
+		);
+		add_action( 'wp_footer', array( $this, 'print_scripts' ) );
+	}
+
+	/**
+	 * Render for this block.
+	 *
+	 * @param array $attributes JSON attributes saved in the HTML comment for this block.
+	 * @param string $content The content from JS save() for this block.
+	 * @return string HTML for this block.
+	 * @author Justin Foell <[email protected]>
+	 * @since  2.6.0
+	 */
+	public function render_block( $attributes, $content ) {
+		if ( empty( $attributes['url'] ) ) {
+			return $content;
+		}
+
+		$this->add_script = true;
+
+		$matches = [];
+		preg_match( '/\/routes\/([0-9].*)$/', $attributes['url'], $matches );
+		if ( $matches[1] ) {
+			// Transform from block attributes to shortcode standard.
+			$attributes = array(
+				'id'         => $matches[1],
+				'image_only' => isset( $attributes['imageOnly'] ) ? $attributes['imageOnly'] : false,
+				'markers'    => isset( $attributes['displayMarkers'] ) ? $attributes['displayMarkers'] : false,
+				'som'        => ! empty( $attributes['som'] ) ? $attributes['som'] : null,
+			);
+
+			$renderer = new WPStrava_RouteRenderer();
+			return $renderer->get_html( $attributes );
+		}
+		return $content;
+	}
+
+	/**
+	 * Enqueue style if block is being used.
+	 *
+	 * @author Justin Foell <[email protected]>
+	 * @since  2.6.0
+	 */
+	public function print_scripts() {
+		if ( $this->add_script ) {
+			wp_enqueue_style( 'wp-strava-style' );
+		}
+	}
+}

src/WPStrava/RouteRenderer.php

@@ -0,0 +1,117 @@
+<?php
+/*
+ * RouteRenderer has all the markup for the Route Block & Shortcode.
+ */
+class WPStrava_RouteRenderer {
+
+	/**
+	 * Get the HTML for a single route.
+	 *
+	 * @param array $atts
+	 * @return string HTML for an route.
+	 * @author Justin Foell <[email protected]>
+	 * @since  2.6.0
+	 */
+	public function get_html( $atts ) {
+		$defaults = array(
+			'id'         => 0,
+			'som'        => WPStrava::get_instance()->settings->som,
+			'map_width'  => '480',
+			'map_height' => '320',
+			'client_id'  => WPStrava::get_instance()->settings->get_default_id(),
+			'markers'    => false,
+			'image_only' => false,
+		);
+
+		$atts = wp_parse_args( $atts, $defaults );
+
+		/* Make sure boolean values are actually boolean
+		 * @see https://wordpress.stackexchange.com/a/119299
+		 */
+		$atts['markers']    = filter_var( $atts['markers'], FILTER_VALIDATE_BOOLEAN );
+		$atts['image_only'] = filter_var( $atts['image_only'], FILTER_VALIDATE_BOOLEAN );
+
+		$route         = WPStrava::get_instance()->routes;
+		$route_details = null;
+
+		try {
+			$route_details = $route->get_route( $atts['client_id'], $atts['id'] );
+		} catch ( WPStrava_Exception $e ) {
+			return $e->to_html();
+		}
+
+		$route_output = '';
+		if ( $route_details ) {
+			$route_output = '<div id="activity-header-' . $atts['id'] . '" class="wp-strava-activity-container">';
+			if ( ! $atts['image_only'] ) {
+				$route_output .= $this->get_table( $route_details, $atts['som'] );
+			}
+
+			// Sanitize width & height.
+			$map_width  = str_replace( '%', '', $atts['map_width'] );
+			$map_height = str_replace( '%', '', $atts['map_height'] );
+			$map_width  = str_replace( 'px', '', $map_width );
+			$map_height = str_replace( 'px', '', $map_height );
+
+			$route_output .= $route->get_route_link(
+				$route_details->id,
+				WPStrava_StaticMap::get_image_tag( $route_details, $map_height, $map_width, $atts['markers'], $route_details->name ),
+				$route_details->name
+			);
+
+			if ( ! empty( $route_details->description ) ) {
+				$route_output .= '<div class="wp-strava-activity-description">' . esc_html( $route_details->description ) . '</div>';
+			}
+
+			$route_output .= '</div>';
+		} // End if( $route_details ).
+		return $route_output;
+	}
+
+	/**
+	 * The the route details in in HTML table.
+	 *
+	 * @param stdClass $route_details route details from the route class.
+	 * @param string $som System of measure (english/metric).
+	 * @return string HTML Table of route details.
+	 * @author Justin Foell <[email protected]>
+	 * @since  1.7.0
+	 */
+	private function get_table( $route_details, $som ) {
+		$strava_som = WPStrava_SOM::get_som( $som );
+
+		$elevation_title = '<th>' . __( 'Elevation Gain', 'wp-strava' ) . '</th>';
+		$elevation       = '<td>' . $strava_som->elevation( $route_details->elevation_gain ) . '</td>';
+		$elevation_label = '<td>' . $strava_som->get_elevation_label() . '</td>';
+
+		if ( WPStrava::get_instance()->settings->hide_elevation ) {
+			$elevation       = '';
+			$elevation_title = '';
+			$elevation_label = '';
+		}
+
+		return '
+			<table class="activity-details-table">
+				<thead>
+					<tr>
+						<th>' . __( 'Est. Moving Time', 'wp-strava' ) . '</th>
+						<th>' . __( 'Distance', 'wp-strava' ) . '</th>
+						' . $elevation_title . '
+					</tr>
+				</thead>
+				<tbody>
+					<tr class="activity-details-table-info">
+						<td>' . $strava_som->time( $route_details->estimated_moving_time ) . '</td>
+						<td>' . $strava_som->distance( $route_details->distance ) . '</td>
+						' . $elevation . '
+					</tr>
+					<tr class="activity-details-table-units">
+						<td>' . $strava_som->get_time_label() . '</td>
+						<td>' . $strava_som->get_distance_label() . '</td>
+						' . $elevation_label . '
+					</tr>
+				</tbody>
+			</table>
+		';
+	}
+}