Survey Your Application

1. Talk to users of the application
2. Study the codebase
3. Examine the new feature requests

Survey Your Application

1. Talk to users of the application
2. Study the codebase
3. Examine the new feature requests

Composer Require

{
    "name": "itecs/scholarships",
    "description": "Scholarships application for the College of Engineering.",
    "require": {
        "php": ">=5.3.3",
        "robmorgan/phinx": "*",
        "pimple/pimple": "~3.0",
        "ncsu/auth": "dev-master"
    },
    "require-dev": {
        "codeception/codeception": "2.0.*"
    }
    ...
}

Database Migrations: Phinx

• Allows you to change DB across environments
• Gives you power to undo the change if there is a problem

$ vendor/bin/phinx create CreateUserLoginsTable

<?php
    use Phinx\Migration\AbstractMigration;

    class CreateUserLoginsTable extends AbstractMigration
    {
        public function up()
        {
            $table = $this->table('users');
            $table->renameColumn('bio', 'biography');
        }

        public function down()
        {
            $table = $this->table('users');
            $table->renameColumn('biography', 'bio');
        }
    }

$ vendor/bin/phinx migrate

$ vendor/bin/phinx rollback

<?php
use Phinx\Migration\AbstractMigration;

class CreateUserLoginsTable extends AbstractMigration
{
    public function change()
    {
        // create the table
        $table = $this->table('user_logins');
        $table->addColumn('user_id', 'integer')
        ->addColumn('created', 'datetime')
        ->create();
    }
}

$ vendor/bin/phinx migrate

$ vendor/bin/phinx rollback

The Good Stuff

Dependency Injection

Base Controller

<?php

namespace ITECS\Scholarships;

use \ReflectionClass;
use \Log;

/**
* Base Application Controller Class
*
*/
class BaseController extends \Controller {

    const BAD_REQUEST=400;
    const FORBIDDEN=403;
    const NOT_FOUND=404;
    const METHOD_NOT_ALLOWED=405;
    const SERVER_ERROR=500;

    protected $serverResponseCodes;
    protected $authenticationService;

    /**
    * @var Pimple\Container
    */
    protected $container = null;

    /**
    * Constructor
    */
    public function BaseController()
    {
        parent::Controller();

        // In Ameyrika, BaseController Contains Container
        global $container;
        $this->container = $container;

        $this->authenticationService = $this->container['ITECS\Scholarships\IdentityAccess\AuthenticationService'];

        session_start();

        $this->setExceptionHandler();

        log_message('debug', "Base Controller Class Initialized");
    }
}

Configuration file

'/app/config.php'

<?php
    return array(
        /* base url for path in the site */
        'app' => array(
            'base_url' => sprintf('http://localhost:%s/', isset($_SERVER['SERVER_PORT'])
            ? $_SERVER['SERVER_PORT'] : ''),
            'index_page' => 'index.php/',
            'debug' => FALSE
        ),

        /* DB configuration */
        'db' => array(
            'default' => array(
                'hostname' => "local__server",
                'port' => "3306",
                'username' => "uname",
                'password' => "pword",
                'database' => "db_name_"
            )
        ),

        'twig' => array(
            'template_path' => array(
                __DIR__ . '/templates',
                __DIR__ . '/templates/dashboard',
            )
        ),

        'authorization' => array(
            'funding' => array('elstamey', 'person2'),
            'developers' => array('elstamey'),
            'coordinators' => array('person3')
        ),

        'notice' => array(
            'enabled' => false,
            'type' => 'info',
            'headline' => null,
            'message' => null,
            'syslink' => null
        ),

        'errorHandling' => array(
            'emailExceptions' => false
        ),

        'awardLetters' => array(
            'letterhead' => '_itecs/notification-samples/ncsu_coe_aa_letterhead.pdf',
            'academicYears' => '2015-2016',
            'respondByDate' => 'May 11, 2015',
            'templates' => array(
                'awardLetter' => 'layouts/letters/award-letter.twig',
                'awardEmail' => 'layouts/letters/award-email-body.twig'
            ),
            'fixedAttachments' => array(
                '_itecs/notification-samples/thank_you_template.pdf'
            ),
            'signatureImagePath' => '_uploads/tmp/deans_signature.png',
            'outputPath' => '_uploads/awardLetters/'
        ),

        'emailService' => array(
            'sendLimit' => 5,
            'retries' => 3,
            'throttleTime' => 2, // seconds
            'fromAddress' => 'Scholarships Application <engr-webmaster@ncsu.edu>',
            'replyToAddress'=>'College of Engineering <engineering@ncsu.edu>'
        )
    );

?>

We passed this array into a $container['config'] variable

Controllers

<?php

class Selectionnext extends BaseController
{
    public function Selectionnext()
    {
        parent::BaseController();

        $this->scholarshipRepository = $this->container['Scholarships\Selection\Scholarship\ScholarshipRepository'];
        $this->collaborationsService = $this->container['Scholarships\Selection\CollaborationsService'];
        $this->committeeService = $this->container['Scholarships\Selection\CommitteeService'];
        $this->authService = $this->container['Scholarships\IdentityAccess\AuthenticationService'];
        $this->awardsService = $this->container['Scholarships\Selection\Scholarship\AwardsService'];
        $this->events = $this->container['Scholarships\Support\Events\EventStore'];
    }

    private function getScholarshipDashboard($scholarshipId,$keepItLight=false)
    {
        $committeeMember = $this->getCommitteeMember();

        $presenter = new ScholarshipDashboardPresenter(
            $committeeMember,
            ScholarshipId::fromString($scholarshipId),
            $this->events,
            $this->scholarshipRepository,
            $this->container['Scholarships\Selection\ApplicantQueryService'],
            $keepItLight
        );

        $scholDetails = $presenter->asArrayForJson();
        $scholDetails['json_string'] = json_encode($scholDetails);

        return $scholDetails;
    }
?>

Summary: Scholarship Wins!

• Implemented multiple majors successfully
• Eliminated unqualified candidates
  • made the scoring easier to read
  • reduced the manual review of candidates
• Selection process was entirely inside the application

Summary: Scholarship Wins!

• Restored confidence in selection process!
• Fewer awards were rejected!
• More Scholarship Money was awarded in the application than ever before!

By May 2015: Approximately $1,074,394 Awarded

Summary: Lessons Learned

Tight deadlines with un-scoped work, we created technical debt that we would have to address in the next academic year

Summary: Lessons Learned

• Bootstrapping Legacy Apps
• Event Sourcing
• Domain-Driven Design
• Command Query Response Segregation
• Project Management
• A LOT!

Summary: Accomplishments

• Replaced the full Student Application
• Replaced the Selection Process with improved functionality
• Built Event-sourced distribution of scholarship money

Old Selection Interface

New Selection Interface