Skip to content

Commit 5b51067

Browse files
bgaillardbgaillard
committed
Prepare version 1.1.0.
1 parent 11d6093 commit 5b51067

File tree

9 files changed

+176
-51
lines changed

9 files changed

+176
-51
lines changed

‎.buildpath

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
<attribute name="composer" value="source"/>
77
</attributes>
88
</buildpathentry>
9+
<buildpathentry kind="src" path="src/test/php/Gomoob">
10+
<attributes>
11+
<attribute name="composer" value="source"/>
12+
</attributes>
13+
</buildpathentry>
914
<buildpathentry kind="src" path="vendor/cilex/cilex/src">
1015
<attributes>
1116
<attribute name="composer" value="vendor"/>

‎CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to
66
[Semantic Versioning](http://semver.org/).
77

8+
## [1.1.0] - 2017-11-28
9+
* Add support for expressions with simple logical operators and without parenthesis. The or operator is writen with `-`,
10+
the and operator is written with `+` ;
11+
* Update minor composer dependency versions.
12+
813
## [1.0.0] - 2017-08-01
914

1015
* Initial release.

‎README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,18 @@ The expression language provides the following operators.
8585
The `!` operator is special, it can be used directly before a value string or in combination with the `=` or `in`
8686
operators.
8787

88-
For exemple `!5` or `!=5` to express "no equals to 5" or `!in('Paris','London')` ro express "no equals to Paris or
88+
For exemple `!5` or `!=5` to express "not equals to 5" or `!in('Paris','London')` to express "not equals to Paris or
8989
London".
9090

91-
### And or operators
91+
### AND and OR operators
9292

93-
The `+` and `-` operator allow to create AND and OR SQL requests.
93+
The `+` and `-` operator allow to create AND and OR SQL requests.
94+
95+
Here are sample expressions with logical operators.
96+
97+
* `property=>5.4+<12` is translated to `property >= ? AND property < ?` with 2 parameters `[5.4,12]` ;
98+
* `property=~'*ball*'-~'*tennis*'` is translated to `property like ? OR property like ?` with 2 parameters
99+
`['%ball%','%tennis%'].
94100

95101
### Like operator
96102

‎composer.lock

+6-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/main/php/Gomoob/Filter/Sql/SqlFilterConverter.php

+33-16
Original file line numberDiff line numberDiff line change
@@ -530,19 +530,31 @@ private function transformComplexFilter(
530530
// Tokenize the filter
531531
$tokens = $tokenizer->tokenize($value);
532532

533-
if (count($tokens) === 3 && ($tokens[1]->getTokenCode() === LogicOperatorToken::AND ||
534-
$tokens[1]->getTokenCode() === LogicOperatorToken::OR)) {
535-
$resultFirstPart = $this->transformSimpleFilter($key, $tokens[0]->getSequence(), $context);
536-
$resultSecondPart = $this->transformSimpleFilter($key, $tokens[2]->getSequence(), $context);
533+
// If a logical expression is expressed
534+
if (count($tokens) === 3 &&
535+
($tokens[1]->getTokenCode() === LogicOperatorToken::AND ||
536+
$tokens[1]->getTokenCode() === LogicOperatorToken::OR)) {
537+
// Transform the first part of the logical expression
538+
$sqlFilter1 = $this->transformSimpleFilter($key, $tokens[0]->getSequence(), $context);
539+
540+
// Transform the second part of the logical expression
541+
$sqlFilter2 = $this->transformSimpleFilter($key, $tokens[2]->getSequence(), $context);
542+
543+
// Creates the resulting SQL logical expression
544+
$result[0] = $sqlFilter1->getExpression();
537545

538546
if ($tokens[1]->getTokenCode() === LogicOperatorToken::AND) {
539-
$result[0] = "$resultFirstPart[0] AND $resultSecondPart[0]";
547+
$result[0] .= ' AND ';
540548
} elseif ($tokens[1]->getTokenCode() === LogicOperatorToken::OR) {
541-
$result[0] = "($resultFirstPart[0] OR $resultSecondPart[0])";
549+
$result[0] .= ' OR ';
542550
}
543-
$result[1] = array_merge($resultFirstPart[1], $resultSecondPart[1]);
551+
552+
$result[0] .= $sqlFilter2->getExpression();
553+
554+
// Creates the SQL parameters array
555+
$result[1] = array_merge($sqlFilter1->getParams(), $sqlFilter2->getParams());
544556
} else {
545-
$result = $this->transformSimpleFilter($key, $value, $context);
557+
return $this->transformSimpleFilter($key, $value, $context);
546558
}
547559
} catch (TokenizerException $tex) {
548560
// If an exception is encountered at tokenization then we consider the value to be a simple string
@@ -568,17 +580,22 @@ private function transformSimpleFilter(
568580
) /* : array */ {
569581
$result = ['', []];
570582

571-
// Creates a tokenizer to tokenize the filter value
572-
$tokenizer = new FilterTokenizer();
583+
try {
584+
// Creates a tokenizer to tokenize the filter value
585+
$tokenizer = new FilterTokenizer();
573586

574-
// Tokenize the filter
575-
$tokens = $tokenizer->tokenize($value);
587+
// Tokenize the filter
588+
$tokens = $tokenizer->tokenize($value);
576589

577-
// Now parse the tokens
578-
if (!empty($tokens)) {
579-
$result = $this->parseFromFirstToken($key, $value, $tokens, false);
590+
// Now parse the tokens
591+
if (!empty($tokens)) {
592+
$result = $this->parseFromFirstToken($key, $value, $tokens, false);
593+
}
594+
} catch (TokenizerException $tex) {
595+
// If an exception is encountered at tokenization then we consider the value to be a simple string
596+
$result = [$key . ' = ?', [$value]];
580597
}
581598

582-
return $result;
599+
return new SqlFilter($result[0], $result[1]);
583600
}
584601
}

‎src/main/php/Gomoob/Filter/Tokenizer/FilterTokenizer.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public function __construct()
6060
$this->addTokenInfo('(<)', FilterToken::LESS_THAN);
6161
$this->addTokenInfo('(~)', FilterToken::LIKE);
6262

63-
// No operator
63+
// Not operator
6464
$this->addTokenInfo('(!)', FilterToken::NOT);
6565

6666
// Function operators

‎src/main/php/Gomoob/Filter/Tokenizer/LogicOperatorTokenizer.php

+8-3
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,13 @@
3434
*/
3535
class LogicOperatorTokenizer extends AbstractTokenizer
3636
{
37-
3837
/**
3938
* Creates a new instance of the logic operator tokenizer.
4039
*
4140
* @return \Gomoob\Filter\Tokenizer\LogicOperatorTokenizer the created instance.
4241
*/
4342
public function __construct()
4443
{
45-
4644
// This allows to clean our matched tokens a little
4745
$this->trim = true;
4846

@@ -52,9 +50,16 @@ public function __construct()
5250
$this->addTokenInfo('(\+)', LogicOperatorToken::AND);
5351
$this->addTokenInfo('(-)', LogicOperatorToken::OR);
5452

55-
// Values
53+
// "Raw" values
5654
$this->addTokenInfo('([0-9.]+)', LogicOperatorToken::NUMBER);
5755
$this->addTokenInfo('(\'[^\']+\')', LogicOperatorToken::STRING);
56+
57+
// Values prefixed with Simple operators
58+
$this->addTokenInfo('(~\'[^\']+\')', LogicOperatorToken::STRING);
59+
60+
// Values prefixed with Not operator
61+
$this->addTokenInfo('(!\'[^\']+\')', LogicOperatorToken::STRING);
62+
5863
$this->addTokenInfo('([^\'\+-]+)', LogicOperatorToken::STRING);
5964
}
6065
}

‎src/test/php/Gomoob/Filter/Sql/SqlFilterConverterTest.php

+81-17
Original file line numberDiff line numberDiff line change
@@ -79,38 +79,66 @@ public function testTransform()
7979
$this->assertCount(1, $sqlFilter->getParams());
8080
$this->assertSame('Sample string', $sqlFilter->getParams()[0]);
8181

82-
// Test with a complex filter and only one property
83-
// Sample complex filters with only one property would be
84-
// "<10+>2" : Lower than 10 and greater than 2
85-
// "'Handball'-'Football'" : Equals to 'Hand ball' or 'Foot ball'
86-
// "'*ball*'+'*tennis*'" : Like 'ball' and like 'tennis'
82+
// Test with a key which has a bad type
83+
try {
84+
$this->filterConverter->transform(0.26, '>10');
85+
$this->fail('Must have thrown a ConverterException !');
86+
} catch (ConverterException $cex) {
87+
$this->assertSame('Invalid filter key type !', $cex->getMessage());
88+
}
89+
}
90+
91+
92+
/**
93+
* Test method for {@link SqlFilterConverter#transform(Object, String)}.
94+
*
95+
* @group SqlFilterConverterTest.testTransformAnd
96+
*/
97+
public function testTransformAnd()
98+
{
99+
// Test with integers
87100
$sqlFilter = $this->filterConverter->transform('property', '<10+>2');
88101
$this->assertSame('property < ? AND property > ?', $sqlFilter->getExpression());
89102
$this->assertCount(2, $sqlFilter->getParams());
90103
$this->assertSame(10, $sqlFilter->getParams()[0]);
91104
$this->assertSame(2, $sqlFilter->getParams()[1]);
92105

93-
$sqlFilter = $this->filterConverter->transform('property', '>10-<2');
94-
$this->assertSame('(property > ? OR property < ?)', $sqlFilter->getExpression());
106+
// Test with floats
107+
$sqlFilter = $this->filterConverter->transform('property', '<5.3+>3.4');
108+
$this->assertSame('property < ? AND property > ?', $sqlFilter->getExpression());
95109
$this->assertCount(2, $sqlFilter->getParams());
96-
$this->assertSame(10, $sqlFilter->getParams()[0]);
97-
$this->assertSame(2, $sqlFilter->getParams()[1]);
110+
$this->assertSame(5.3, $sqlFilter->getParams()[0]);
111+
$this->assertSame(3.4, $sqlFilter->getParams()[1]);
112+
113+
// Test with strings
114+
$sqlFilter = $this->filterConverter->transform('property', "Handball+Football");
115+
$this->assertSame('property = ? AND property = ?', $sqlFilter->getExpression());
116+
$this->assertCount(2, $sqlFilter->getParams());
117+
$this->assertSame('Handball', $sqlFilter->getParams()[0]);
118+
$this->assertSame('Football', $sqlFilter->getParams()[1]);
98119

120+
// Test with strings and the like operator
121+
$sqlFilter = $this->filterConverter->transform('property', "~'*ball*'+~'*tennis*'");
122+
$this->assertSame('property like ? AND property like ?', $sqlFilter->getExpression());
123+
$this->assertCount(2, $sqlFilter->getParams());
124+
$this->assertSame('%ball%', $sqlFilter->getParams()[0]);
125+
$this->assertSame('%tennis%', $sqlFilter->getParams()[1]);
126+
}
127+
128+
/**
129+
* Test method for {@link SqlFilterConverter#transform(Object, String)}.
130+
*
131+
* @group SqlFilterConverterTest.testTransformComplex
132+
*/
133+
public function testTransformComplex()
134+
{
99135
// Test with a complex filter with multiple properties (currently not supported and will fail)
100136
try {
101137
$this->filterConverter->transform(0, 'price:<90-validity:>=3');
102138
$this->fail('Must have thrown a ConverterException !');
103139
} catch (ConverterException $cex) {
104140
$this->assertSame('Complex filters are currently not implemented !', $cex->getMessage());
105141
}
106-
107-
// Test with a key which has a bad type
108-
try {
109-
$this->filterConverter->transform(0.26, '>10');
110-
$this->fail('Must have thrown a ConverterException !');
111-
} catch (ConverterException $cex) {
112-
$this->assertSame('Invalid filter key type !', $cex->getMessage());
113-
}
114142
}
115143

116144
/**
@@ -497,4 +525,40 @@ public function testTransformNotLike()
497525
);
498526
}
499527
}
528+
529+
/**
530+
* Test method for {@link SqlFilterConverter#transform(Object, String)}.
531+
*
532+
* @group SqlFilterConverterTest.testTransformOr
533+
*/
534+
public function testTransformOr()
535+
{
536+
// Test with integers
537+
$sqlFilter = $this->filterConverter->transform('property', '<10->2');
538+
$this->assertSame('property < ? OR property > ?', $sqlFilter->getExpression());
539+
$this->assertCount(2, $sqlFilter->getParams());
540+
$this->assertSame(10, $sqlFilter->getParams()[0]);
541+
$this->assertSame(2, $sqlFilter->getParams()[1]);
542+
543+
// Test with floats
544+
$sqlFilter = $this->filterConverter->transform('property', '<5.3->3.4');
545+
$this->assertSame('property < ? OR property > ?', $sqlFilter->getExpression());
546+
$this->assertCount(2, $sqlFilter->getParams());
547+
$this->assertSame(5.3, $sqlFilter->getParams()[0]);
548+
$this->assertSame(3.4, $sqlFilter->getParams()[1]);
549+
550+
// Test with strings
551+
$sqlFilter = $this->filterConverter->transform('property', "Handball-Football");
552+
$this->assertSame('property = ? OR property = ?', $sqlFilter->getExpression());
553+
$this->assertCount(2, $sqlFilter->getParams());
554+
$this->assertSame('Handball', $sqlFilter->getParams()[0]);
555+
$this->assertSame('Football', $sqlFilter->getParams()[1]);
556+
557+
// Test with strings and the like operator
558+
$sqlFilter = $this->filterConverter->transform('property', "~'*ball*'-~'*tennis*'");
559+
$this->assertSame('property like ? OR property like ?', $sqlFilter->getExpression());
560+
$this->assertCount(2, $sqlFilter->getParams());
561+
$this->assertSame('%ball%', $sqlFilter->getParams()[0]);
562+
$this->assertSame('%tennis%', $sqlFilter->getParams()[1]);
563+
}
500564
}

‎src/test/php/Gomoob/Filter/Tokenizer/LogicOperatorTokenizerTest.php

+28-6
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
*/
3838
class LogicOperatorTokenizerTest extends TestCase
3939
{
40-
4140
/**
4241
* An instance of the logic operator tokenizer to test.
4342
*
@@ -56,27 +55,50 @@ public function setUp()
5655
/**
5756
* Test with a complex '+' and '-' operators.
5857
*
59-
* @group LogicOperatorTokenizerTest.testTokenizeComplexAndOr
58+
* @group LogicOperatorTokenizerTest.testTokenize
6059
*/
61-
public function testTokenizeComplexAndOr()
60+
public function testTokenize()
6261
{
63-
64-
// Test with a simple integer '+'
62+
// Test with 2 integers and '+'
6563
$tokens = $this->tokenizer->tokenize('>=10+<50');
6664

6765
$this->assertCount(3, $tokens);
6866
$this->assertSame('>=10', $tokens[0]->getSequence());
6967
$this->assertSame('+', $tokens[1]->getSequence());
7068
$this->assertSame('<50', $tokens[2]->getSequence());
7169

72-
// Test with a simple float '-'
70+
// Test with 2 floats and '-'
7371
$tokens = $this->tokenizer->tokenize('>=10.1-<50.2');
7472

7573
$this->assertCount(3, $tokens);
7674
$this->assertSame('>=10.1', $tokens[0]->getSequence());
7775
$this->assertSame('-', $tokens[1]->getSequence());
7876
$this->assertSame('<50.2', $tokens[2]->getSequence());
7977

78+
// Test with 2 not quoted strings and '+'
79+
$tokens = $this->tokenizer->tokenize("Hand+Ball");
80+
81+
$this->assertCount(3, $tokens);
82+
$this->assertSame('Hand', $tokens[0]->getSequence());
83+
$this->assertSame('+', $tokens[1]->getSequence());
84+
$this->assertSame('Ball', $tokens[2]->getSequence());
85+
86+
// Test with 2 quoted strings and '+'
87+
$tokens = $this->tokenizer->tokenize("'Hand'+'Ball'");
88+
89+
$this->assertCount(3, $tokens);
90+
$this->assertSame("'Hand'", $tokens[0]->getSequence());
91+
$this->assertSame('+', $tokens[1]->getSequence());
92+
$this->assertSame("'Ball'", $tokens[2]->getSequence());
93+
94+
// Test 2 strings prefixed with the like operator and '+'
95+
$tokens = $this->tokenizer->tokenize("~'*ball*'+~'*tennis*'");
96+
97+
$this->assertCount(3, $tokens);
98+
$this->assertSame("~'*ball*'", $tokens[0]->getSequence());
99+
$this->assertSame('+', $tokens[1]->getSequence());
100+
$this->assertSame("~'*tennis*'", $tokens[2]->getSequence());
101+
80102
// Test with complex '+' '-'
81103
$tokens = $this->tokenizer->tokenize('>=10.1+<50.2-=60.3');
82104

0 commit comments

Comments
 (0)