Where group #186

dpDesignz · 2020-04-21T06:18:36Z

Resolves #164

UPDATE: There are no longer breaking changes

Example code from pdo\pdo_mysqlTest.php file:

$db->selecting(
    'unit_test', 
    '*', 
    where(
        eq('active', '1'),
        whereGroup(
           like('test_key', '%1%', _OR),
           like('test_key', '%3%')
        )
    )
);

or another example without the function

$db->selecting(
    'unit_test', 
    '*', 
    where(
        eq('active', '1'),
        like('test_key', '%1%', _OR, '('),
        like('test_key', '%3%', null, ')')
    )
);

The combiner will add itself at the end of the group.

Created the initial function but came across an issue where the $whereClause doesn't work in the $where method when using an OR combiner, so need to fix that first

Methods and functions complete but failed testing in phpunit so needing to fix

PHPUnit tests succeeded.

Cleaned up trailing combiner in tests

codeclimate · 2020-04-21T06:19:16Z

lib/ezFunctions.php

@@ -126,110 +127,110 @@ function createCertificate(
    /**
     * Creates an equality comparison expression with the given arguments.
     */
-    function eq($x, $y, $and = null, ...$args)
+    function eq($x, $y, $and = null, $group = null, ...$args)


Method eq has 5 arguments (exceeds 4 allowed). Consider refactoring.

All these bring in another required field? Whereas ...$args already covers that. You should try adding additional logic in the other methods instead to get the same results you are after.

The logic could be some kind of token/trigger word, to extract to get the desired action.
This is far beyond a breaking change, unnecessary, the logic should include a way for the current code to continue to work. The current tests should still pass.

codeclimate · 2020-04-21T06:19:16Z

lib/ezFunctions.php

        return $expression;
    }

    /**
     * Creates a non equality comparison expression with the given arguments.
     */
-    function neq($x, $y, $and = null, ...$args)
+    function neq($x, $y, $and = null, $group = null, ...$args)


Method neq has 5 arguments (exceeds 4 allowed). Consider refactoring.

codeclimate · 2020-04-21T06:19:16Z

lib/ezFunctions.php

        return $expression;
    }

    /**
     * Creates the other non equality comparison expression with the given arguments.
     */
-    function ne($x, $y, $and = null, ...$args)
+    function ne($x, $y, $and = null, $group = null, ...$args)


Method ne has 5 arguments (exceeds 4 allowed). Consider refactoring.

codeclimate · 2020-04-21T06:19:17Z

lib/ezFunctions.php

        return $expression;
    }

    /**
     * Creates a lower-than comparison expression with the given arguments.
     */
-    function lt($x, $y, $and = null, ...$args)
+    function lt($x, $y, $and = null, $group = null, ...$args)


Method lt has 5 arguments (exceeds 4 allowed). Consider refactoring.

codeclimate · 2020-04-21T06:19:17Z

lib/ezFunctions.php

        return $expression;
    }

    /**
     * Creates a lower-than-equal comparison expression with the given arguments.
     */
-    function lte($x, $y, $and = null, ...$args)
+    function lte($x, $y, $and = null, $group = null, ...$args)


Method lte has 5 arguments (exceeds 4 allowed). Consider refactoring.

TheTechsTech · 2020-04-21T11:42:44Z

you will need to come up with a solution for the bc, to have tests pass as is.

Changed from breaking changes to use the existing extra `$args`. All existing PHPUnit tests run without failing.

codeclimate · 2020-04-22T01:03:35Z

lib/ezFunctions.php

@@ -485,6 +493,19 @@ function replace($table = '', $keyValue)
            : false;
    }

+    function flattenWhereConditions($whereConditions)


Function flattenWhereConditions has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.

This function should be in the class method being used in. It's a private helper function that should not be called directly by user/developer.

Very good point. I have moved this to the ezQuery file as a private method.

codeclimate · 2020-04-22T01:03:35Z

lib/ezQuery.php

+        }
+    }
+
+    public function whereGroup(...$whereConditions)


Function whereGroup has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.

What you think about just calling it group or grouping?
The only place it can be used in is with where already.
Repeating the same word within the same function call trying to stay away from, and keep naming somewhat similar to regular SQL dialect.

Good idea. Have updated the code and tests. I didn't want to call it group as that felt too close to groupBy for me and I thought it might get confused, but I like grouping.

Incorrectly made a modification to the return of the `where` method instead of the `whereGroup` method

dpDesignz · 2020-04-22T01:08:41Z

you will need to come up with a solution for the bc, to have tests pass as is.

Thanks, I didn't even really think of using the existing $args, that makes way more sense. It took me most of the day to work out how it worked in the first place. Definitely learned a lot. 😄

Updated the code to use the existing options to avoid breaking changes.

TheTechsTech · 2020-04-22T17:27:58Z

You will need to re-sync with master branch, the CI travis and appveyor systems and github see a conflicting file, and Travis still has a fail.

Synced with master branch to reduce conflicts

dpDesignz · 2020-04-22T23:57:51Z

You will need to re-sync with master branch, the CI travis and appveyor systems and github see a conflicting file, and Travis still has a fail.

Thanks. Still learning how this all works with open source and larger projects. I've only really used GitHub for small personal projects until recently.

Both CI checks passed :)

Changed the method from `whereGroup` to `grouping` and moved the flatten function to be a private method in the `ezQuery` file as per @techno-express recommendations.

codeclimate · 2020-04-23T22:14:14Z

lib/ezQuery.php

+        }
+    }
+
+    public function grouping(...$whereConditions)


Function grouping has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.

Added a brief example in the readme file underneath the shortcut methods. Will add a detailed example in the wiki once approved.

dpDesignz added 4 commits April 21, 2020 15:37

Initial function creation

a283b6d

Created the initial function but came across an issue where the $whereClause doesn't work in the $where method when using an OR combiner, so need to fix that first

Testing phase

009a75d

Methods and functions complete but failed testing in phpunit so needing to fix

Tests completed

b50ca9d

PHPUnit tests succeeded.

Cleaned up trailing in tests

6ef9eff

Cleaned up trailing combiner in tests

codeclimate bot reviewed Apr 21, 2020

View reviewed changes

Changed from breaking changes to user $args

cc7a8cd

Changed from breaking changes to use the existing extra `$args`. All existing PHPUnit tests run without failing.

codeclimate bot reviewed Apr 22, 2020

View reviewed changes

Fixed incorrect return change

fd67871

Incorrectly made a modification to the return of the `where` method instead of the `whereGroup` method

dpDesignz added 3 commits April 23, 2020 11:49

Merge remote-tracking branch 'upstream/master' into where-group

97b18b3

Synced with master for conflicts

b35291a

Synced with master branch to reduce conflicts

Synced with master for conflicts

1637812

Synced with master branch to reduce conflicts

Changed to grouping

f990c88

Changed the method from `whereGroup` to `grouping` and moved the flatten function to be a private method in the `ezQuery` file as per @techno-express recommendations.

codeclimate bot reviewed Apr 23, 2020

View reviewed changes

Added brief example to the readme

8b83dd7

Added a brief example in the readme file underneath the shortcut methods. Will add a detailed example in the wiki once approved.

TheTechsTech merged commit c843017 into ezSQL:master Apr 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Where group #186

Where group #186

dpDesignz commented Apr 21, 2020 •

edited

Loading

codeclimate bot Apr 21, 2020

TheTechsTech Apr 21, 2020

codeclimate bot Apr 21, 2020

codeclimate bot Apr 21, 2020

codeclimate bot Apr 21, 2020

codeclimate bot Apr 21, 2020

TheTechsTech commented Apr 21, 2020

codeclimate bot Apr 22, 2020

TheTechsTech Apr 23, 2020

dpDesignz Apr 23, 2020

codeclimate bot Apr 22, 2020

TheTechsTech Apr 23, 2020

dpDesignz Apr 23, 2020

dpDesignz commented Apr 22, 2020

TheTechsTech commented Apr 22, 2020

dpDesignz commented Apr 22, 2020

codeclimate bot Apr 23, 2020

Where group #186

Where group #186

Conversation

dpDesignz commented Apr 21, 2020 • edited Loading

codeclimate bot Apr 21, 2020

Choose a reason for hiding this comment

TheTechsTech Apr 21, 2020

Choose a reason for hiding this comment

codeclimate bot Apr 21, 2020

Choose a reason for hiding this comment

codeclimate bot Apr 21, 2020

Choose a reason for hiding this comment

codeclimate bot Apr 21, 2020

Choose a reason for hiding this comment

codeclimate bot Apr 21, 2020

Choose a reason for hiding this comment

TheTechsTech commented Apr 21, 2020

codeclimate bot Apr 22, 2020

Choose a reason for hiding this comment

TheTechsTech Apr 23, 2020

Choose a reason for hiding this comment

dpDesignz Apr 23, 2020

Choose a reason for hiding this comment

codeclimate bot Apr 22, 2020

Choose a reason for hiding this comment

TheTechsTech Apr 23, 2020

Choose a reason for hiding this comment

dpDesignz Apr 23, 2020

Choose a reason for hiding this comment

dpDesignz commented Apr 22, 2020

TheTechsTech commented Apr 22, 2020

dpDesignz commented Apr 22, 2020

codeclimate bot Apr 23, 2020

Choose a reason for hiding this comment

dpDesignz commented Apr 21, 2020 •

edited

Loading