Skip to content

Support i18n in story budget date picker #569

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
cojennin merged 3 commits into from
Mar 30, 2020
Merged

Support i18n in story budget date picker #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44313c8
Support i18n in story budget date picker
cojennin Dec 14, 2019
ca8c69a
Merge branch 'master' into fix/story-budget-date-i18n
cojennin Mar 17, 2020
a4d811f
Merge branch 'master' into fix/story-budget-date-i18n
cojennin Mar 30, 2020
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
48 changes: 28 additions & 20 deletions common/js/ef_date.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
jQuery(document).ready(function($) {
var dateTimePicks = jQuery(".date-time-pick");
/* global document, jQuery, ef_week_first_day */

dateTimePicks.each(function() {
var $dTP = jQuery(this);
jQuery( document ).ready( function() {
const dateTimePicks = jQuery( '.date-time-pick' );

$dTP.datetimepicker({
dateFormat: "M dd yy",
firstDay: ef_week_first_day,
alwaysSetTime: false,
controlType: "select",
altField: '#' + $dTP.prop("id") + "_hidden",
altFieldTimeOnly: false,
altFormat: "yy-mm-dd",
altTimeFormat: "HH:mm"
});
});
dateTimePicks.each( function() {
const $dTP = jQuery( this );

jQuery(".date-pick").datepicker({
dateFormat: "M dd yy",
firstDay: ef_week_first_day
});
});
$dTP.datetimepicker( {
dateFormat: 'M dd yy',
firstDay: ef_week_first_day,
alwaysSetTime: false,
controlType: 'select',
altField: '#' + $dTP.prop( 'id' ) + '_hidden',
altFieldTimeOnly: false,
altFormat: 'yy-mm-dd',
altTimeFormat: 'HH:mm',
} );
} );

const datePicks = jQuery( '.date-pick' );
datePicks.each( function() {
const $datePicker = jQuery( this );

$datePicker.datepicker( {
firstDay: ef_week_first_day,
altField: '#' + $datePicker.prop( 'id' ) + '_hidden',
altFormat: 'yy-mm-dd',
} );
} );
} );
89 changes: 57 additions & 32 deletions modules/story-budget/story-budget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,23 +188,56 @@ function register_term_columns() {
*/
function handle_form_date_range_change() {

if ( !isset( $_POST['ef-story-budget-range-submit'], $_POST['ef-story-budget-number-days'], $_POST['ef-story-budget-start-date'] ) )
if ( ! isset( $_POST['ef-story-budget-range-submit'], $_POST['ef-story-budget-number-days'], $_POST['ef-story-budget-start-date_hidden'] ) ) {
return;
}

if ( !wp_verify_nonce( $_POST['nonce'], 'change-date' ) )
wp_die( $this->module->messages['nonce-failed'] );

$current_user = wp_get_current_user();
$user_filters = $this->get_user_meta( $current_user->ID, self::usermeta_key_prefix . 'filters', true );
$user_filters['start_date'] = date( 'Y-m-d', strtotime( $_POST['ef-story-budget-start-date'] ) );
$user_filters['number_days'] = (int)$_POST['ef-story-budget-number-days'];
if ( $user_filters['number_days'] <= 1 )
$user_filters['number_days'] = 1;
$new_filters = array (
'start_date' => $_POST['ef-story-budget-start-date_hidden'],
'number_days' => (int) $_POST['ef-story-budget-number-days'],
);
$user_filters = $this->update_user_filters_from_form_date_range_change( $current_user, $new_filters );

$this->update_user_meta( $current_user->ID, self::usermeta_key_prefix . 'filters', $user_filters );
wp_redirect( menu_page_url( $this->module->slug, false ) );
exit;
}

/**
* Handles updating the users
*/
public function update_user_filters_from_form_date_range_change( $current_user, $new_filters ) {
$existing_filters = $this->get_user_meta( $current_user->ID, self::usermeta_key_prefix . 'filters', true );

// Default start date value
if ( isset( $new_filters['start_date'] ) ) {
// Validate that it's a legitimate date
$valid_date = DateTime::createFromFormat( 'Y-m-d', $new_filters['start_date'] );

if ( false === $valid_date ) {
$start_date = date_i18n( 'Y-m-d' );
} else {
$start_date = $valid_date->format( 'Y-m-d' );
}

// Set the start_date filter (to new value or default)
$existing_filters['start_date'] = $start_date;
}

if ( isset( $new_filters['number_days'] ) ) {
if ( $new_filters['number_days'] <= 1 ) {
$existing_filters['number_days'] = 1;
} else {
$existing_filters['number_days'] = $new_filters['number_days'];
}
}

return $existing_filters;
}

/**
* Get the number of columns to show on the story budget
Expand Down Expand Up @@ -320,32 +353,24 @@ function story_budget() {
* @since 0.7
*/
function story_budget_time_range() {

$output = '<form method="POST" action="' . menu_page_url( $this->module->slug, false ) . '">';

$start_date_value = '<input type="text" id="ef-story-budget-start-date" name="ef-story-budget-start-date"'
. ' size="10" class="date-pick" value="'
. esc_attr( date_i18n( get_option( 'date_format' ), strtotime( $this->user_filters['start_date'] ) ) ) . '" /><span class="form-value">';

$start_date_value .= esc_html( date_i18n( get_option( 'date_format' ), strtotime( $this->user_filters['start_date'] ) ) );
$start_date_value .= '</span>';

$number_days_value = '<input type="text" id="ef-story-budget-number-days" name="ef-story-budget-number-days"'
. ' size="3" maxlength="3" value="'
. esc_attr( $this->user_filters['number_days'] ) . '" /><span class="form-value">' . esc_html( $this->user_filters['number_days'] )
. '</span>';

$output .= sprintf( _x( 'starting %1$s showing %2$s %3$s', '%1$s = start date, %2$s = number of days, %3$s = translation of \'Days\'', 'edit-flow' ), $start_date_value, $number_days_value, _n( 'day', 'days', $this->user_filters['number_days'], 'edit-flow' ) );
$output .= '&nbsp;&nbsp;<span class="change-date-buttons">';
$output .= '<input id="ef-story-budget-range-submit" name="ef-story-budget-range-submit" type="submit"';
$output .= ' class="button-primary" value="' . __( 'Change', 'edit-flow' ) . '" />';
$output .= '&nbsp;';
$output .= '<a class="change-date-cancel hidden" href="#">' . __( 'Cancel', 'edit-flow' ) . '</a>';
$output .= '<a class="change-date" href="#">' . __( 'Change', 'edit-flow' ) . '</a>';
$output .= wp_nonce_field( 'change-date', 'nonce', 'change-date-nonce', false );
$output .= '</span></form>';

echo $output;
?>
<form method="POST" action="<?php echo esc_attr( menu_page_url( $this->module->slug, false ) ); ?>">
<?php _e( 'starting', 'edit-flow' ); ?>
<span class="form-value"><?php echo esc_html( date_i18n( get_option( 'date_format' ), strtotime( $this->user_filters['start_date'] ) ) ); ?></span>
<input type="text" id="ef-story-budget-start-date" name="ef-story-budget-start-date" size="20" autocomplete="off" class="date-pick" value="<?php echo esc_attr( date_i18n( get_option( 'date_format' ), strtotime( $this->user_filters['start_date'] ) ) ); ?>" />
<input type="hidden" id="ef-story-budget-start-date_hidden" name="ef-story-budget-start-date_hidden" />
<?php _e( 'showing', 'edit-flow' ); ?>
<input type="text" id="ef-story-budget-number-days" name="ef-story-budget-number-days" size="3" maxlength="3" value="<?php echo esc_attr( $this->user_filters['number_days'] ); ?>" />
<span class="form-value"><?php echo esc_html( $this->user_filters['number_days'] ); ?></span>
<?php echo esc_html( _n( 'day', 'days', $this->user_filters['number_days'], 'edit-flow' ) ); ?>
<span class="change-date-buttons">
<input id="ef-story-budget-range-submit" name="ef-story-budget-range-submit" type="submit" class="button-primary" value="<?php echo esc_attr( __( 'Change', 'edit-flow' ) ); ?>" />
<a class="change-date-cancel hidden" href="#"><?php echo esc_html( __( 'Cancel', 'edit-flow' ) ); ?></a>
<a class="change-date" href="#"><?php echo esc_html( __( 'Change', 'edit-flow' ) ); ?></a>
</span>
<?php wp_nonce_field( 'change-date', 'nonce', 'change-date-nonce', true ); ?>
</form>
<?php
}

/**
Expand Down
116 changes: 116 additions & 0 deletions tests/test-edit-flow-story-budget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<?php

class WP_Test_Edit_Flow_Story_Budget extends WP_UnitTestCase {

protected static $admin_user_id;

public static function wpSetUpBeforeClass( $factory ) {
self::$admin_user_id = $factory->user->create( array( 'role' => 'administrator' ) );
}

public static function wpTearDownAfterClass() {
self::delete_user( self::$admin_user_id );
}

/**
* Test that the story budget date filter handles valid date
*/
public function test_story_budget_set_start_date_filter() {
global $edit_flow;

$user = get_user_by( 'id', self::$admin_user_id );

wp_set_current_user( self::$admin_user_id );

// Users filters need to be set (they're set by default)
$edit_flow->story_budget->update_user_filters();

$new_filters['start_date'] = '2019-12-01';

$users_filters = $edit_flow->story_budget->update_user_filters_from_form_date_range_change( $user, $new_filters );

$this->assertEquals( '2019-12-01', $users_filters['start_date'] );
}

/**
* Test that the story budget date filter handles invalid date
*/
public function test_story_budget_set_start_date_filter_invalid() {
global $edit_flow;

$user = get_user_by( 'id', self::$admin_user_id );

wp_set_current_user( self::$admin_user_id );

// Users filters need to be set (they're set by default)
$edit_flow->story_budget->update_user_filters();

$new_filters['start_date'] = 'not a date';

$users_filters = $edit_flow->story_budget->update_user_filters_from_form_date_range_change( $user, $new_filters );

$this->assertEquals( date( 'Y-m-d' ), $users_filters['start_date'] );
}

/**
* Test that the story budget number of days filter handles valid number of days
*/
public function test_story_budget_set_number_days_filter() {
global $edit_flow;

$user = get_user_by( 'id', self::$admin_user_id );

wp_set_current_user( self::$admin_user_id );

// Users filters need to be set (they're set by default)
$edit_flow->story_budget->update_user_filters();

$new_filters['number_days'] = 10;

$users_filters = $edit_flow->story_budget->update_user_filters_from_form_date_range_change( $user, $new_filters );

$this->assertEquals( 10, $users_filters['number_days'] );
}

/**
* Test that the story budget number of days filter handles invalid number of days
*/
public function test_story_budget_set_number_days_filter_invalid() {
global $edit_flow;

$user = get_user_by( 'id', self::$admin_user_id );

wp_set_current_user( self::$admin_user_id );

// Users filters need to be set (they're set by default)
$edit_flow->story_budget->update_user_filters();

$new_filters['number_days'] = 'not days';

$users_filters = $edit_flow->story_budget->update_user_filters_from_form_date_range_change( $user, $new_filters );

$this->assertEquals( 1, $users_filters['number_days'] );
}

/**
* Test that the story budget handles both valid date and number of days filters
*/
public function test_story_budget_set_date_and_number_days_filters() {
global $edit_flow;

$user = get_user_by( 'id', self::$admin_user_id );

wp_set_current_user( self::$admin_user_id );

// Users filters need to be set (they're set by default)
$edit_flow->story_budget->update_user_filters();

$new_filters['start_date'] = '2019-12-01';
$new_filters['number_days'] = 10;

$users_filters = $edit_flow->story_budget->update_user_filters_from_form_date_range_change( $user, $new_filters );

$this->assertEquals( 10, $users_filters['number_days'] );
$this->assertEquals( '2019-12-01', $users_filters['start_date'] );
}
}