Merge pull request #225 from sagittaracc/develop

Develop

Author: sagittaracc

CHANGELOG.md

@@ -5,6 +5,7 @@
 **New features:**
 - Add filter modifier
 - Remove commands (no need anymore since we use orm approach)
+- Add examples of extending SuQL syntax
 
 ---
 

README.md

@@ -32,7 +32,7 @@ SuQL is syntactic sugar for SQL.
 3. Expand SuQL syntax on your own. SQL isn't the limit. There's no limit really.
 
 ### Examples
-There are couple examples in the ```tests``` directory
+There are couple examples in the ```tests``` directory and an example of extending SuQL syntax in the ```syntax``` directory.
 
 ## Conclusion
 SuQL is all about modifiers and commands. Modifiers already replace standart SQL clauses such as `WHERE`, `GROUP`, `JOIN`, `ORDER` and SQL functions etc. Meanwhile commands can do everything that SuQL or SQL can\'t.

composer.json

@@ -15,7 +15,6 @@
       ]
     },
     "require": {
-      "sagittaracc/config": "@dev",
       "sagittaracc/regexp": "@dev",
       "sagittaracc/strings": "@dev",
       "sagittaracc/arrays": "@dev",

composer.lock

@@ -2,14 +2,26 @@
 namespace core;
 
 use builder\SQLAdapter;
-use sagittaracc\Config;
 
 class SuQLObject {
   private $queries = [];
   private $scheme  = ['rel' => [], 'temp_rel' => []];
   protected $adapter = null;
   private $log = [];
-  private $configFile = __DIR__ . '/../../config/main.php';
+
+  protected function modifierList()
+  {
+    return [
+      'SQLBaseModifier',
+      'SQLWhereModifier',
+      'SQLFilterModifier',
+      'SQLOrderModifier',
+      'SQLGroupModifier',
+      'SQLFunctionModifier',
+      'SQLCaseModifier',
+      'SQLConditionModifier',
+    ];
+  }
 
   public function clear() {
     $this->queries = [];
@@ -141,11 +153,6 @@ public function addUnionTable($name, $unionType, $table) {
       $this->queries[$name]->addUnionTable($unionType, $table);
   }
 
-  // PHP command as a store procedure
-  public function addCommand($name, $instruction, $args) {
-    $this->queries[$name] = new SuQLCommand($this, $instruction, $args);
-  }
-
   public function getQuery($name) {
     return $this->queries[$name];
   }
@@ -155,17 +162,11 @@ public function hasQuery($name) {
   }
 
   public function getModifierClass($modifierHandler) {
-    $modifierClassList = Config::load($this->configFile)->get('modifier.handler');
-
-    foreach ($modifierClassList as $modifierClass) {
+    foreach ($this->modifierList() as $modifierClass) {
       if (method_exists($modifierClass, $modifierHandler))
         return $modifierClass;
     }
 
     return null;
   }
-
-  public function getCommandClass() {
-    return class_exists('SuQLExtCommand') ? 'SuQLExtCommand' : 'SuQLBaseCommand';
-  }
 }

config/main.php

@@ -6,8 +6,7 @@ class SuQLRegexp extends Regexp {
   function __construct($regex, $flags = '') {
     parent::registerSequence('v', [SuQLSpecialSymbols::$prefix_declare_variable]);
     parent::registerSequence('f', [SuQLSpecialSymbols::$prefix_declare_field_alias]);
-    parent::registerSequence('c', [SuQLSpecialSymbols::$prefix_declare_command]);
-    parent::registerSequence('p', [SuQLSpecialSymbols::$prefix_declare_command, SuQLSpecialSymbols::$prefix_declare_variable]);
+    parent::registerSequence('p', [SuQLSpecialSymbols::$prefix_declare_variable]);
     parent::__construct($regex, $flags);
   }
 }

src/core/SuQLObject.php

@@ -4,7 +4,6 @@
 class SuQLSpecialSymbols {
   public static $prefix_declare_variable = '@';
   public static $prefix_declare_field_alias = ':';
-  public static $prefix_declare_command = '%';
 
   public static function nestedQueryPlaceholder($query) {
     return self::$prefix_declare_variable . $query;

src/core/SuQLRegexp.php

@@ -3,9 +3,9 @@
 namespace sagittaracc\model;
 
 use \SuQL;
-use \SuQLExt;
+use \SuQLExtensionExample;
 
-class User extends SuQLExt
+class User extends SuQLExtensionExample
 {
 	public function query()
 	{

src/core/SuQLSpecialSymbols.php

@@ -1,9 +1,19 @@
 <?php
 
-// Example: max function
+// Example: extend SuQL functionality on your own
 
-class SuQLExt extends SuQL
+class SuQLExtensionExample extends SuQL
 {
+  protected function modifierList()
+  {
+    return array_merge(
+      parent::modifierList(),
+      [
+        'SQLArithmeticModifier',
+      ]
+    );
+  }
+
   public function max($field)
   {
     $this->field($field, [

src/model/User.php

@@ -133,7 +133,7 @@ public function testFunction(): void
     );
   }
 
-  public function testSuQLExt(): void
+  public function testSuQLExtension(): void
   {
     $this->assertEquals(
       User::find()->max('id')->getRawSql(),
@@ -150,4 +150,14 @@ public function testSuQLExt(): void
       'select users.name from users'
     );
   }
+
+  public function testSuQLExtensionArithmeticModifier(): void
+  {
+    $this->assertEquals(
+      User::find()->field('id', [
+        'div' => [2]
+      ])->getRawSql(),
+      'select users.id / 2 from users'
+    );
+  }
 }