Skip to content
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

Enhancement/5450 tag placement refactoring #5616

Merged
merged 2 commits into from
Jul 27, 2022
Merged

Enhancement/5450 tag placement refactoring #5616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7ed1b0
Remove redundant set_publication_id method.
eugene-manuilov Jul 27, 2022
4fde6b9
Replace hardcoded placement values.
eugene-manuilov Jul 27, 2022
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
1 change: 0 additions & 1 deletion includes/Modules/Thank_With_Google.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,6 @@ private function register_tag() {
$tag->use_guard( new Tag_Environment_Type_Guard() );

if ( $tag->can_register() ) {
$tag->set_publication_id( $settings['publicationID'] );
$tag->set_button_placement( $settings['buttonPlacement'] );
$tag->set_button_post_types( $settings['buttonPostTypes'] );

Expand Down
12 changes: 6 additions & 6 deletions includes/Modules/Thank_With_Google/Settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,12 @@ private function sanitize_button_placement( $button_placement ) {
if ( in_array(
$button_placement,
array(
'dynamic_low',
'dynamic_high',
'static_auto',
'static_above-content',
'static_below-content',
'static_below-first-paragraph',
Web_Tag::PLACEMENT_DYNAMIC_LOW,
Web_Tag::PLACEMENT_DYNAMIC_HIGH,
Web_Tag::PLACEMENT_STATIC_AUTO,
Web_Tag::PLACEMENT_STATIC_ABOVE_CONTENT,
Web_Tag::PLACEMENT_STATIC_BELOW_CONTENT,
Web_Tag::PLACEMENT_STATIC_AFTER_1ST_P,
),
true
) ) {
Expand Down
26 changes: 11 additions & 15 deletions includes/Modules/Thank_With_Google/Web_Tag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ class Web_Tag extends Module_Web_Tag {

use Method_Proxy_Trait, Tag_With_DNS_Prefetch_Trait;

const PLACEMENT_DYNAMIC_LOW = 'dynamic_low';
const PLACEMENT_DYNAMIC_HIGH = 'dynamic_high';
const PLACEMENT_STATIC_AUTO = 'static_auto';
const PLACEMENT_STATIC_ABOVE_CONTENT = 'static_above-content';
const PLACEMENT_STATIC_BELOW_CONTENT = 'static_below-content';
const PLACEMENT_STATIC_AFTER_1ST_P = 'static_below-first-paragraph';

/**
* Publication ID.
*
Expand All @@ -49,17 +56,6 @@ class Web_Tag extends Module_Web_Tag {
*/
private $button_post_types;

/**
* Sets the current publication ID.
*
* @since n.e.x.t
*
* @param string $publication_id Publication ID.
*/
public function set_publication_id( $publication_id ) {
$this->publication_id = $publication_id;
}

/**
* Sets the current button placement.
*
Expand Down Expand Up @@ -133,7 +129,7 @@ protected function enqueue_twg_script() {
});
});
",
esc_js( $this->publication_id ),
esc_js( $this->tag_id ),
esc_js( $this->has_static_button_placement() ? 'inline' : 'floating' ),
esc_js( $is_singular_button_post_type_entity ? get_permalink() : '' ),
esc_js( GOOGLESITEKIT_VERSION ),
Expand Down Expand Up @@ -179,11 +175,11 @@ protected function update_the_content( $content ) {
return $button_placeholder;
}

if ( in_array( $this->button_placement, array( 'static_auto', 'static_below-content' ), true ) ) {
if ( in_array( $this->button_placement, array( self::PLACEMENT_STATIC_AUTO, self::PLACEMENT_STATIC_BELOW_CONTENT ), true ) ) {
$content = $content . $button_placeholder;
} elseif ( 'static_above-content' === $this->button_placement ) {
} elseif ( self::PLACEMENT_STATIC_ABOVE_CONTENT === $this->button_placement ) {
$content = $button_placeholder . $content;
} elseif ( 'static_below-first-paragraph' === $this->button_placement ) {
} elseif ( self::PLACEMENT_STATIC_AFTER_1ST_P === $this->button_placement ) {
$content = substr_replace( $content, $button_placeholder, strpos( $content, '</p>' ) + 4, 0 ); // strlen( '</p>' ) is 4.
}

Expand Down
14 changes: 6 additions & 8 deletions tests/phpunit/integration/Modules/Thank_With_Google/Web_TagTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,14 @@ public function set_up() {
parent::set_up();

$this->web_tag = new Web_Tag( '12345', Thank_With_Google::MODULE_SLUG );

$this->web_tag->set_publication_id( '12345' );
$this->web_tag->set_button_post_types( array( 'post' ) );

remove_all_filters( 'the_content' );
$this->web_tag->register();
}

public function test_content_placeholder_not_inserted_on_unselected_button_post_types() {
$this->web_tag->set_button_placement( 'static_auto' );
$this->web_tag->set_button_placement( Web_Tag::PLACEMENT_STATIC_AUTO );

$post_ID = $this->factory()->post->create( array( 'post_type' => 'page' ) );
$this->go_to( get_permalink( $post_ID ) );
Expand All @@ -53,7 +51,7 @@ public function test_content_placeholder_not_inserted_on_unselected_button_post_
}

public function test_content_placeholder_inserted_on_button_post_types() {
$this->web_tag->set_button_placement( 'static_auto' );
$this->web_tag->set_button_placement( Web_Tag::PLACEMENT_STATIC_AUTO );

$this->create_post_and_go_to_it();

Expand All @@ -64,7 +62,7 @@ public function test_content_placeholder_inserted_on_button_post_types() {
}

public function test_content_placeholder_not_inserted_on_dynamic_button_placement() {
$this->web_tag->set_button_placement( 'dynamic_low' );
$this->web_tag->set_button_placement( Web_Tag::PLACEMENT_DYNAMIC_LOW );

$this->create_post_and_go_to_it();

Expand All @@ -75,7 +73,7 @@ public function test_content_placeholder_not_inserted_on_dynamic_button_placemen
}

public function test_content_placeholder_inserted_static_below_content() {
$this->web_tag->set_button_placement( 'static_below-content' );
$this->web_tag->set_button_placement( Web_Tag::PLACEMENT_STATIC_BELOW_CONTENT );

$this->create_post_and_go_to_it();

Expand All @@ -87,7 +85,7 @@ public function test_content_placeholder_inserted_static_below_content() {
}

public function test_content_placeholder_inserted_static_above_content() {
$this->web_tag->set_button_placement( 'static_above-content' );
$this->web_tag->set_button_placement( Web_Tag::PLACEMENT_STATIC_ABOVE_CONTENT );

$this->create_post_and_go_to_it();

Expand All @@ -99,7 +97,7 @@ public function test_content_placeholder_inserted_static_above_content() {
}

public function test_content_placeholder_inserted_static_below_first_paragraph() {
$this->web_tag->set_button_placement( 'static_below-first-paragraph' );
$this->web_tag->set_button_placement( Web_Tag::PLACEMENT_STATIC_AFTER_1ST_P );

$this->create_post_and_go_to_it();

Expand Down