Rename main namespace

In order to avoid clashes with other plugins, as
asked by the WordPress Plugin Review Team.

Author: lourot

frameright.php

@@ -27,10 +27,10 @@
  * along with Image Display Control WordPress Plugin. If not, see
  * https://www.gnu.org/licenses/gpl-3.0.en.html
  *
- * @package Frameright
+ * @package FramerightImageDisplayControl
  */
 
-namespace Frameright;
+namespace FramerightImageDisplayControl;
 
 require_once __DIR__ . '/src/admin/admin-plugin.php';
 require_once __DIR__ . '/src/render/render-plugin.php';

readme.txt

@@ -47,7 +47,7 @@ about the plugin or submit pull requests.
 == Changelog ==
 
 = 0.0.3 (TODO) =
-* TODO
+* Renamed software components to avoid name clashes with other plugins.
 
 = 0.0.2 (2022-10-31) =
 * Improved algorithm for automatically selecting the best hardcrop.

src/admin/admin-plugin.php

@@ -2,18 +2,18 @@
 /**
  * Implementation of the plugin part firing on administrative hooks.
  *
- * @package Frameright\Admin
+ * @package FramerightImageDisplayControl\Admin
  */
 
-namespace Frameright\Admin;
+namespace FramerightImageDisplayControl\Admin;
 
 require_once __DIR__ . '/filesystem.php';
 require_once __DIR__ . '/xmp.php';
 
 require_once __DIR__ . '/../debug.php';
-use Frameright\Debug;
+use FramerightImageDisplayControl\Debug;
 require_once __DIR__ . '/../global-functions.php';
-use Frameright\GlobalFunctions;
+use FramerightImageDisplayControl\GlobalFunctions;
 
 /**
  * Implementation of the plugin part firing on administrative hooks.

src/admin/filesystem.php

@@ -2,10 +2,10 @@
 /**
  * File-related helper functions.
  *
- * @package Frameright\Admin
+ * @package FramerightImageDisplayControl\Admin
  */
 
-namespace Frameright\Admin;
+namespace FramerightImageDisplayControl\Admin;
 
 /**
  * Collection of file-related helper functions. This class has conceptually no

src/admin/xmp.php

@@ -2,10 +2,10 @@
 /**
  * XMP-related helper functions.
  *
- * @package Frameright\Admin
+ * @package FramerightImageDisplayControl\Admin
  */
 
-namespace Frameright\Admin;
+namespace FramerightImageDisplayControl\Admin;
 
 /**
  * Note: the native iptcparse() and exif_read_data() PHP functions are of no

src/debug.php

@@ -2,10 +2,10 @@
 /**
  * Debugging utils.
  *
- * @package Frameright\Debug
+ * @package FramerightImageDisplayControl\Debug
  */
 
-namespace Frameright\Debug;
+namespace FramerightImageDisplayControl\Debug;
 
 /**
  * Log $text to debug.log if WP_DEBUG is true.

src/global-functions.php

@@ -2,10 +2,10 @@
 /**
  * Mockable wrapper of all global functions.
  *
- * @package Frameright
+ * @package FramerightImageDisplayControl
  */
 
-namespace Frameright;
+namespace FramerightImageDisplayControl;
 
 /**
  * Wrap here any global function (e.g. the ones provided by WordPress) called

src/render/render-plugin.php

@@ -2,15 +2,15 @@
 /**
  * Implementation of the plugin part firing on rendering hooks.
  *
- * @package Frameright\Render
+ * @package FramerightImageDisplayControl\Render
  */
 
-namespace Frameright\Render;
+namespace FramerightImageDisplayControl\Render;
 
 require_once __DIR__ . '/../debug.php';
-use Frameright\Debug;
+use FramerightImageDisplayControl\Debug;
 require_once __DIR__ . '/../global-functions.php';
-use Frameright\GlobalFunctions;
+use FramerightImageDisplayControl\GlobalFunctions;
 
 /**
  * Implementation of the plugin part firing on rendering hooks.

tests/AdminPluginTest.php

@@ -1,8 +1,8 @@
 <?php
 /**
- * Tests for Frameright\Admin 's AdminPlugin class.
+ * Tests for FramerightImageDisplayControl\Admin 's AdminPlugin class.
  *
- * @package Frameright\Tests\Admin
+ * @package FramerightImageDisplayControl\Tests\Admin
  */
 
 require_once __DIR__ . '/../src/admin/admin-plugin.php';
@@ -47,7 +47,7 @@ public function test_constructor() {
             ->method('add_filter')
             ->withConsecutive(['wp_handle_upload'], ['wp_read_image_metadata']);
 
-        new Frameright\Admin\AdminPlugin(
+        new FramerightImageDisplayControl\Admin\AdminPlugin(
             $this->global_functions_mock,
             $this->filesystem_mock,
             $this->xmp_mock
@@ -109,7 +109,7 @@ public function test_populate_image_metadata() {
             ],
         ];
 
-        $actual_meta = (new Frameright\Admin\AdminPlugin(
+        $actual_meta = (new FramerightImageDisplayControl\Admin\AdminPlugin(
             $this->global_functions_mock,
             $this->filesystem_mock,
             $this->xmp_mock
@@ -239,17 +239,17 @@ public function test_create_hardcrops_and_set_attachment_meta() {
             ->willReturn(83);
 
         $create_hardcrops_method = new ReflectionMethod(
-            'Frameright\Admin\AdminPlugin',
+            'FramerightImageDisplayControl\Admin\AdminPlugin',
             'create_hardcrops'
         );
         $create_hardcrops_method->setAccessible(true);
         $set_attachment_meta_method = new ReflectionMethod(
-            'Frameright\Admin\AdminPlugin',
+            'FramerightImageDisplayControl\Admin\AdminPlugin',
             'set_attachment_meta'
         );
         $set_attachment_meta_method->setAccessible(true);
 
-        $plugin_under_test = new Frameright\Admin\AdminPlugin(
+        $plugin_under_test = new FramerightImageDisplayControl\Admin\AdminPlugin(
             $this->global_functions_mock,
             $this->filesystem_mock,
             $this->xmp_mock
@@ -305,12 +305,12 @@ public function test_read_rectangle_cropping_metadata() {
         ];
 
         $method = new ReflectionMethod(
-            'Frameright\Admin\AdminPlugin',
+            'FramerightImageDisplayControl\Admin\AdminPlugin',
             'read_rectangle_cropping_metadata'
         );
         $method->setAccessible(true);
         $actual_result = $method->invoke(
-            new Frameright\Admin\AdminPlugin(
+            new FramerightImageDisplayControl\Admin\AdminPlugin(
                 $this->global_functions_mock,
                 $this->filesystem_mock,
                 $this->xmp_mock
@@ -350,12 +350,12 @@ public function test_absolute() {
         ];
 
         $method = new ReflectionMethod(
-            'Frameright\Admin\AdminPlugin',
+            'FramerightImageDisplayControl\Admin\AdminPlugin',
             'absolute'
         );
         $method->setAccessible(true);
         $actual_result = $method->invoke(
-            new Frameright\Admin\AdminPlugin(
+            new FramerightImageDisplayControl\Admin\AdminPlugin(
                 $this->global_functions_mock,
                 $this->filesystem_mock,
                 $this->xmp_mock

tests/FilesystemTest.php

@@ -1,8 +1,8 @@
 <?php
 /**
- * Tests for Frameright\Admin 's Filesystem class.
+ * Tests for FramerightImageDisplayControl\Admin 's Filesystem class.
  *
- * @package Frameright\Tests\Admin
+ * @package FramerightImageDisplayControl\Tests\Admin
  */
 
 require_once __DIR__ . '/../src/admin/filesystem.php';
@@ -27,7 +27,7 @@ protected function setUp(): void {
      */
     public function test_basename_to_name_and_extension() {
         $method = new ReflectionMethod(
-            'Frameright\Admin\Filesystem',
+            'FramerightImageDisplayControl\Admin\Filesystem',
             'basename_to_name_and_extension'
         );
         $method->setAccessible(true);
@@ -48,7 +48,7 @@ public function test_basename_to_name_and_extension() {
      */
     public function test_name_and_extension_to_basename() {
         $method = new ReflectionMethod(
-            'Frameright\Admin\Filesystem',
+            'FramerightImageDisplayControl\Admin\Filesystem',
             'name_and_extension_to_basename'
         );
         $method->setAccessible(true);
@@ -86,7 +86,7 @@ public function test_unique_target_file() {
             ->with('/absolute/path/to', 'img-frameright.jpg')
             ->willReturn('img-frameright.jpg');
 
-        $actual_result = (new Frameright\Admin\Filesystem(
+        $actual_result = (new FramerightImageDisplayControl\Admin\Filesystem(
             $this->global_functions_mock
         ))->unique_target_file($input_source_path, '-frameright');
 
@@ -109,7 +109,7 @@ public function test_image_title_with_metadata() {
                 'title' => $expected_result,
             ]);
 
-        $actual_result = (new Frameright\Admin\Filesystem(
+        $actual_result = (new FramerightImageDisplayControl\Admin\Filesystem(
             $this->global_functions_mock
         ))->image_title($input_path);
 
@@ -132,7 +132,7 @@ public function test_image_title_without_metadata() {
                 'title' => '',
             ]);
 
-        $actual_result = (new Frameright\Admin\Filesystem(
+        $actual_result = (new FramerightImageDisplayControl\Admin\Filesystem(
             $this->global_functions_mock
         ))->image_title($input_path);
 

tests/RenderPluginTest.php

@@ -1,8 +1,8 @@
 <?php
 /**
- * Tests for Frameright\Render 's RenderPlugin class.
+ * Tests for FramerightImageDisplayControl\Render 's RenderPlugin class.
  *
- * @package Frameright\Tests\Render
+ * @package FramerightImageDisplayControl\Tests\Render
  */
 
 require_once __DIR__ . '/../src/render/render-plugin.php';
@@ -38,7 +38,9 @@ public function test_constructor() {
             ->method('add_filter')
             ->with('wp_calculate_image_srcset');
 
-        new Frameright\Render\RenderPlugin($this->global_functions_mock);
+        new FramerightImageDisplayControl\Render\RenderPlugin(
+            $this->global_functions_mock
+        );
     }
 
     /**
@@ -132,7 +134,7 @@ public function test_replace_srcsets_with_better_hardcrop() {
             ],
         ];
 
-        $actual_srcsets = (new Frameright\Render\RenderPlugin(
+        $actual_srcsets = (new FramerightImageDisplayControl\Render\RenderPlugin(
             $this->global_functions_mock
         ))->replace_srcsets(
             null,
@@ -160,7 +162,7 @@ public function test_replace_srcsets_without_hardcrop() {
 
         $expected_srcsets = null;
 
-        $actual_srcsets = (new Frameright\Render\RenderPlugin(
+        $actual_srcsets = (new FramerightImageDisplayControl\Render\RenderPlugin(
             $this->global_functions_mock
         ))->replace_srcsets(null, null, null, null, $input_attachment_id);