Reorganized code to use PHP namespaces with Composer integration.

Keith Morgan · Keith Morgan · commit 7f6a4f3d93f4 · 2015-01-06T15:45:22.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -1 +1,6 @@
-*.*~
+vendor
+composer.phar
+phpunit.xml
+composer.lock
+cov
+.DS_Store
diff --git a/.gitmodules b/.gitmodules
diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@ Usage
 -----------------------------
 Sanscript is simple to use:
 
+    use Sanskrit\Sanscript;
+
     $sanscript = new Sanscript();
     $output = $sanscript->t($input, $from, $to);
 
@@ -72,3 +74,11 @@ Adding a new scheme is simple:
     $sanscript->addRomanScheme($schemeName, $schemeData);
 
 For help in creating `$schemeData`, see the comments on the `addBrahmicScheme` and `addRomanScheme` functions.
+
+Running tests
+-----------------------------
+Running tests is facilitated with Composer:
+
+1. composer install
+2. composer --dev update
+3. ./vendor/bin/phpunit
diff --git a/composer.json b/composer.json
@@ -0,0 +1,29 @@
+{
+  "name": "sanskrit/sanscript",
+  "description": "Transliteration library for Sanskrit and other Indian languages",
+  "keywords": ["transliteration", "romanization", "sanskrit", "devanagari", "itrans", "iast"],
+  "type": "library",
+  "homepage": "https://github.com/sanskrit/sanscript.php",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Keith Morgan",
+      "email": "keith@wellebee.com",
+      "homepage": "http://wellebee.com"
+    },
+    {
+      "name": "Arun Prasad",
+      "homepage": "https://github.com/akprasad"
+    }
+  ],
+
+  "require": {
+    "php": ">=5.4.8"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "~4.0"
+  },
+  "autoload": {
+    "psr-4": {"Sanskrit\\": "src/"}
+  }
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="tests/bootstrap.php" colors="true">
+  <testsuites>
+    <testsuite name="Sanscript Test Suite">
+      <file>tests/SanscriptSetup.php</file>
+      <file>tests/SanscriptTransliteration.php</file>
+      <file>tests/SanscriptDravidian.php</file>
+      <file>tests/SanscriptToggle.php</file>
+      <file>tests/SanscriptOptions.php</file>
+      <file>tests/SanscriptITRANS.php</file>
+    </testsuite>
+  </testsuites>
+</phpunit>
diff --git a/src/sanscript.php b/src/sanscript.php
@@ -1,5 +1,7 @@
 <?php
 
+namespace Sanskrit;
+
 /**
  * Sanscript
  *
@@ -726,3 +728,4 @@ public function t($data, $from, $to, $options = NULL) {
         }
     }
 }
+
diff --git a/test/config.xml b/test/config.xml
diff --git a/test/run_tests b/test/run_tests
diff --git a/tests/SanscriptBase.php b/tests/SanscriptBase.php
@@ -1,11 +1,13 @@
 <?php
 
-abstract class SanscriptBase extends PHPUnit_Framework_TestCase {
+namespace Sanskrit\Sanscript\Tests;
+use Sanskrit\Sanscript;
+
+abstract class SanscriptBase extends \PHPUnit_Framework_TestCase {
     protected $sanscript;
     protected $data;
 
     protected function setUp() {
-        include_once '../sanscript/sanscript.php';
         $this->sanscript = new Sanscript();
 
         $this->data = array(
diff --git a/tests/SanscriptDravidian.php b/tests/SanscriptDravidian.php
@@ -1,6 +1,6 @@
 <?php
 
-include_once './SanscriptBase.php';
+use Sanskrit\Sanscript\Tests\SanscriptBase;
 
 class SanscriptDravidian extends SanscriptBase {
 
diff --git a/tests/SanscriptITRANS.php b/tests/SanscriptITRANS.php
@@ -1,6 +1,6 @@
 <?php
 
-include_once './SanscriptBase.php';
+use Sanskrit\Sanscript\Tests\SanscriptBase;
 
 class SanscriptITRANS extends SanscriptBase {
 
diff --git a/tests/SanscriptOptions.php b/tests/SanscriptOptions.php
@@ -1,6 +1,6 @@
 <?php
 
-include_once './SanscriptBase.php';
+use Sanskrit\Sanscript\Tests\SanscriptBase;
 
 class SanscriptOptions extends SanscriptBase {
 
diff --git a/tests/SanscriptSetup.php b/tests/SanscriptSetup.php
@@ -1,6 +1,6 @@
 <?php
 
-include_once './SanscriptBase.php';
+use Sanskrit\Sanscript\Tests\SanscriptBase;
 
 class SanscriptSetup extends SanscriptBase {
 
diff --git a/tests/SanscriptToggle.php b/tests/SanscriptToggle.php
@@ -1,6 +1,6 @@
 <?php
 
-include_once './SanscriptBase.php';
+use Sanskrit\Sanscript\Tests\SanscriptBase;
 
 class SanscriptToggle extends SanscriptBase {
 
diff --git a/tests/SanscriptTransliteration.php b/tests/SanscriptTransliteration.php
@@ -1,6 +1,6 @@
 <?php
 
-include_once './SanscriptBase.php';
+use Sanskrit\Sanscript\Tests\SanscriptBase;
 
 class SanscriptTransliteration extends SanscriptBase {
 
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -0,0 +1,4 @@
+<?php
+
+$loader = require __DIR__ . "/../vendor/autoload.php";
+$loader->addPsr4('Sanskrit\\Sanscript\\Tests\\', __DIR__);

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`<?php`
`2`	`2`
	`3`	`+namespace Sanskrit;`
	`4`	`+`
`3`	`5`	`/**`
`4`	`6`	`* Sanscript`
`5`	`7`	`*`
`@@ -726,3 +728,4 @@ public function t($data, $from, $to, $options = NULL) {`
`726`	`728`	`}`
`727`	`729`	`}`
`728`	`730`	`}`
	`731`	`+`