Merge pull request #1 from Samshal/master

Added Foreign Key Support

Author: Samshal

README.md

@@ -1,2 +1,90 @@
-# Scripd [![Build Status](https://travis-ci.org/Samshal/Scripd.svg?branch=master)](https://travis-ci.org/Samshal/Scripd)
-A robust SQL Generator. Parses database structures defined in json based on the jsyn file format and generates corresponding sql queries.
+# Scripd [![Build Status](https://travis-ci.org/Samshal/Scripd.svg?branch=master)](https://travis-ci.org/Samshal/Scripd) [![Latest Stable Version](https://poser.pugx.org/samshal/scripd/v/stable)](https://packagist.org/packages/samshal/scripd) [![Total Downloads](https://poser.pugx.org/samshal/scripd/downloads)](https://packagist.org/packages/samshal/scripd) [![Latest Unstable Version](https://poser.pugx.org/samshal/scripd/v/unstable)](https://packagist.org/packages/samshal/scripd) [![License](https://poser.pugx.org/samshal/scripd/license)](https://packagist.org/packages/samshal/scripd) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Samshal/Scripd/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Samshal/Scripd/?branch=master)
+A robust SQL Generator. Parses database structures defined in json based on a custom jsyn file format and generates corresponding sql queries.
+
+## Class Features
+
+- A json like file format to define database structure
+- Support for multiple sql vendors / dialects
+- Compatible with PHP 5.0+
+- Support for UTF-8 content and 8bit, base64, binary, and quoted-printable encodings
+- Much More!
+
+## Why you might need it
+
+This project was birthed as a result of the need to give users an opportunity to `create` their own custom database structure in a PHP Application.
+I wanted users to be able to modify database structures while there is support for multiple db vendors such as mysql, sqlite and sql server.
+
+This library offers the ability to create database structures in a json-like format and generate sql compatible with several database vendors.
+
+It is also very easy to use and integrate into your php based projects
+
+## License
+
+This software is distributed under the [MIT](https://opensource.org/licenses/MIT) license. Please read LICENSE for information on the
+software availability and distribution.
+
+## Installation & loading
+Scripd is available via [Composer/Packagist](https://packagist.org/packages/samshal/scripd), so just add this line to your `composer.json` file:
+
+```json
+"samshal/scripd": "~1.0"
+```
+
+or
+
+```sh
+composer require samshal/scripd
+```
+
+## A Simple Example
+
+#### JSON DB Structure (structure.json)
+```json
+{
+	":database":{
+		":crud-action":"create",
+		"name":"dbname",
+
+		":table":[
+			{
+				":crud-action":"create",
+				"name":"students",
+				"columns":[
+					{
+						"name":"id",
+						"data-type":"int",
+						"primary-key":true
+					},
+					{
+						"name":"first_name",
+						"data-type":"varchar(20)",
+						"default":"'samuel'"
+					},
+					{
+						"name":"last_name",
+						"data-type":"varchar(20)"
+					},
+					{
+						"name":"class",
+						"data-type":"varchar(10)"
+					}
+				]
+			}
+		]
+	}
+}
+```
+
+#### PHP (index.php)
+```php
+<?php
+    require 'vendor/autoload.php';
+
+    $jsonDBStructure = new Samshal\Scripd\JsonDbStructure('./structure.json', 'mysql');
+
+    $jsonDBStructure->parseStructure();
+
+    $sql = $jsonDBStructure->getGeneratedSql();
+    
+    echo $sql;
+```

index.php

@@ -51,6 +51,7 @@ final class JsonDbStructure
     private $objectDefiners = [
         'columns',
         'add-column',
+        'foreign-key'
     ];
 
     /**
@@ -65,6 +66,8 @@ final class JsonDbStructure
         'right-curly-brace' => '}',
         'left-square-bracket' => '[',
         'right-square-bracket' => ']',
+        'left-bracket' => '(',
+        'right-bracket' => ')',
     ];
 
     /**
@@ -302,14 +305,19 @@ public function generateSqlFromObjectDefiner($jsonStructures, $objectDefiner)
                 $string = $jsyn[$i];
                 $toSetValue = false;
                 $isConstant = false;
+                $replaceWithComma = false;
 
                 if (self::enclosed($this->specialCharacters['left-square-bracket'], $this->specialCharacters['right-square-bracket'], $string)) {
                     $string = str_replace($this->specialCharacters['left-square-bracket'], null, str_replace($this->specialCharacters['right-square-bracket'], null, $string));
                     if (self::enclosed($this->specialCharacters['left-curly-brace'], $this->specialCharacters['right-curly-brace'], $string)) {
                         $string = str_replace($this->specialCharacters['left-curly-brace'], null, str_replace($this->specialCharacters['right-curly-brace'], null, $string));
                         $toSetValue = true;
+                    } else if (self::enclosed($this->specialCharacters['left-bracket'], $this->specialCharacters['right-bracket'], $string)) {
+                        $string = str_replace($this->specialCharacters['left-bracket'], null, str_replace($this->specialCharacters['right-bracket'], null, $string));
+                        $toSetValue = false;
+                        $replaceWithComma = true;
                     }
-                } elseif (self::enclosed($this->specialCharacters['left-curly-brace'], $this->specialCharacters['right-curly-brace'], $string)) {
+                } else if (self::enclosed($this->specialCharacters['left-curly-brace'], $this->specialCharacters['right-curly-brace'], $string)) {
                     $string = str_replace($this->specialCharacters['left-curly-brace'], null, str_replace($this->specialCharacters['right-curly-brace'], null, $string));
                     $toSetValue = true;
                 } else {
@@ -321,7 +329,11 @@ public function generateSqlFromObjectDefiner($jsonStructures, $objectDefiner)
                     if ($toSetValue && !is_bool($jsonStructure[$topLevelObject][$_string])) {
                         $jsyn[$i] = $jsonStructure[$topLevelObject][$_string];
                     } else {
+                        if ($replaceWithComma){
+                            $string = ", $string";
+                        }
                         $jsyn[$i] = (isset($jsonStructure[$topLevelObject][$_string]) && $jsonStructure[$topLevelObject][$_string] == true) ? strtoupper($string) : null;
+                       
                     }
                 } else {
                     if (!$isConstant) {
@@ -333,7 +345,7 @@ public function generateSqlFromObjectDefiner($jsonStructures, $objectDefiner)
                 }
             }
         }
-
+        
         return implode(' ', $jsyn);
     }
 

src/JsonDbStructure.php

@@ -15,6 +15,8 @@
 		"[{{COLUMN FORMAT}}]",
 		"[STORAGE]",
 		"[{{STORAGE}}]",
+		"[(FOREIGN KEY)]",
+		"[{{FOREIGN KEY}}]",
 		"[REFERENCES]",
 		"[{{REFERENCES}}]",
 		"[MATCH FULL]",

src/bin/columns.jsyn

@@ -34,7 +34,7 @@ public function dataProvider()
                  'USE another_unify_schools;'.
                  "CREATE TABLE students (id int PRIMARY KEY, first_name varchar(20) DEFAULT 'samuel', last_name varchar(20), class varchar(10));".
                  'CREATE TABLE faculty (fac_id int AUTO_INCREMENT PRIMARY KEY, first_name varchar(20), last_name varchar(20));'.
-                 'CREATE TABLE subjects (subject_id int AUTO_INCREMENT PRIMARY KEY, subject_name varchar(30), subject_faculty int REFERENCES faculty('.'fac_id) ON UPDATE cascade ON DELETE set null)', __DIR__.'/json/1.json'
+                 'CREATE TABLE subjects (subject_id int AUTO_INCREMENT PRIMARY KEY, subject_name varchar(30), subject_faculty int , FOREIGN KEY (subject_faculty) REFERENCES faculty(fac_id) ON UPDATE cascade ON DELETE set null)', __DIR__.'/json/1.json'
             ],
             'Alter Table'=>[
                 "ALTER TABLE facultys ADD COLUMN (full_name varchar(30) NOT NULL DEFAULT 'john doe')", __DIR__.'/json/2.json'

tests/JsonDbStructureTest.php

@@ -65,6 +65,7 @@
 					{
 						"name":"subject_faculty",
 						"data-type":"int",
+						"foreign-key":"(subject_faculty)",
 						"references":"faculty(fac_id)",
 						"on-update":"cascade",
 						"on-delete":"set null"