Attendee - Code Metrics - Inspection of "more efficient guest list" - TheBnl/event-tickets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 324319...e9ec8f )

by Bram

created 2018-02-27 12:23 UTC

Attendee F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	522
Duplicated Lines	4.41 %

Coupling/Cohesion

Components	1
Dependencies	25

Importance

Changes

Metric	Value
wmc	62
lcom	1
cbo	25
dl	23
loc	522
rs	1.3043
c	0
b	0
f	0

28 Methods

Rating	Name	Duplication	Size	Complexity
B	getCMSFields()	0	29	3
B	getBetterButtonsActions()	0	14	5
A	__construct()	0	17	1
D	onBeforeWrite()	0	32	10
A	onAfterWrite()	0	7	4
A	onBeforeDelete()	0	19	4
A	fileFolder()	0	4	1
A	getFirstName()	0	4	1
A	getSurname()	0	4	1
A	getEmail()	0	4	1
A	getName()	0	11	4
A	getUserField()	0	13	3
A	getCacheFactory()	0	4	1
A	getFieldCacheKey()	0	4	1
A	getTableFields()	0	11	2
A	singular_name()	0	5	1
A	generateTicketCode()	0	4	1
B	createQRCode()	0	33	4
B	createTicketFile()	0	36	3
A	sendTicket()	23	23	2
A	getCheckInLink()	0	4	1
A	checkIn()	0	5	1
A	canCheckOut()	0	4	1
A	checkOut()	0	7	2
A	canView()	0	4	1
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	canCreate()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Attendee often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Attendee, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Attendee.php
 *
 * @author Bram de Leeuw
 * Date: 09/03/17
 */

namespace Broarm\EventTickets;

use ArrayList;
use BaconQrCode;
use BetterButtonCustomAction;
use CalendarEvent;
use Config;
use DataObject;
use Director;
use Dompdf\Dompdf;
use Email;
use FieldList;
use File;
use Folder;
use Image;
use ManyManyList;
use Member;
use ReadonlyField;
use SilverStripe\Omnipay\Exception\Exception;
use SSViewer;
use Tab;
use TabSet;
use ViewableData;

/**
 * Class Attendee
 *
 * @package Broarm\EventTickets
 *
 * @property string    Title
 * @property string    TicketCode
 * @property boolean   TicketReceiver
 * @property boolean   CheckedIn
 * @property FieldList SavableFields    Field to be set in AttendeesField
 *
 * @property int       TicketID
 * @property int       TicketQRCodeID
 * @property int       TicketFileID
 * @property int       ReservationID
 * @property int       EventID
 * @property int       MemberID
 *
 * @method Reservation Reservation()
 * @method Ticket Ticket()
 * @method Image TicketQRCode()
 * @method File TicketFile()
 * @method Member Member()
 * @method CalendarEvent|TicketExtension Event()
 * @method ManyManyList Fields()
 */
class Attendee extends DataObject
{
    /**
     * Set this to true when you want to have a QR code that opens the check in page and validates the code.
     * The validation is only done with proper authorisation so guest cannot check themselves in by mistake.
     * By default only the ticket number is translated to an QR code. (for use with USB QR scanners)
     *
     * @var bool
     */
    private static $qr_as_link = false;

    private static $default_fields = array(
        'FirstName' => array(
            'Title' => 'First name',
            'FieldType' => 'UserTextField',
            'Required' => true,
            'Editable' => false
        ),
        'Surname' => array(
            'Title' => 'Surname',
            'FieldType' => 'UserTextField',
            'Required' => true,
            'Editable' => false
        ),
        'Email' => array(
            'Title' => 'Email',
            'FieldType' => 'UserEmailField',
            'Required' => true,
            'Editable' => false
        )
    );

    private static $table_fields = array(
        'Title',
        'Email'
    );

    private static $db = array(
        'Title' => 'Varchar(255)',
        'TicketReceiver' => 'Boolean',
        'TicketCode' => 'Varchar(255)',
        'CheckedIn' => 'Boolean'
    );

    private static $default_sort = 'Created DESC';

    private static $indexes = array(
        'TicketCode' => 'unique("TicketCode")'
    );

    private static $has_one = array(
        'Reservation' => 'Broarm\EventTickets\Reservation',
        'Ticket' => 'Broarm\EventTickets\Ticket',
        'Event' => 'CalendarEvent',
        'Member' => 'Member',
        'TicketQRCode' => 'Image',
        'TicketFile' => 'File'
    );

    private static $many_many = array(
        'Fields' => 'Broarm\EventTickets\UserField'
    );

    private static $many_many_extraFields = array(
        'Fields' => array(
            'Value' => 'Varchar(255)'
        )
    );

    private static $summary_fields = array(
        'Title' => 'Name',
        'Ticket.Title' => 'Ticket',
        'TicketCode' => 'Ticket #',
        'CheckedIn.Nice' => 'Checked in',
    );

    /**
     * Actions usable on the cms detail view
     *
     * @var array
     */
    private static $better_buttons_actions = array(
        'sendTicket',
        'createTicketFile'
    );

    protected static $cachedFields = array();

    public function getCMSFields()

    {
        $fields = new FieldList(new TabSet('Root', $mainTab = new Tab('Main')));

        $fields->addFieldsToTab('Root.Main', array(
            ReadonlyField::create('TicketCode', _t('Attendee.Ticket', 'Ticket')),
            ReadonlyField::create('MyCheckedIn', _t('Attendee.CheckedIn', 'Checked in'), $this->dbObject('CheckedIn')->Nice())
        ));

        foreach ($this->Fields() as $field) {
            $fieldType = $field->getFieldType();
            $fields->addFieldToTab(
                'Root.Main',
                $fieldType::create("{$field->Name}[$field->ID]", $field->Title, $field->getValue())
            );
        }

        if ($this->TicketFile()->exists()) {
            $fields->addFieldToTab('Root.Main', $reservationFileField = ReadonlyField::create(
                'ReservationFile',
                _t('Attendee.Reservation', 'Reservation'),
                "<a class='readonly' href='{$this->TicketFile()->Link()}' target='_blank'>Download reservation PDF</a>"
            ));
            $reservationFileField->dontEscape = true;
        }

        $this->extend('updateCMSFields', $fields);
        return $fields;
    }

    /**
     * Add utility actions to the attendee details view
     *
     * @return FieldList
     */
    public function getBetterButtonsActions()
    {
        /** @var FieldList $fields */
        $fields = parent::getBetterButtonsActions();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        if ($this->TicketFile()->exists() && !empty($this->getEmail())) {
            $fields->push(BetterButtonCustomAction::create('sendTicket', _t('Attendee.SEND', 'Send the ticket')));
        }

        if (!empty($this->getName()) && !empty($this->getEmail())) {
            $fields->push(BetterButtonCustomAction::create('createTicketFile', _t('Attendee.CREATE_TICKET', 'Create the ticket')));
        }

        return $fields;
    }

    /**
     * Attendee constructor
     * If the fields don't exist yet add them
     * If they do populate the record with the set data
     *
     * @param null $record
     * @param bool $isSingleton
     * @param null $model
     */
    public function __construct($record = null, $isSingleton = false, $model = null)
    {
        parent::__construct($record, $isSingleton, $model);
        //if (($event = $this->Event()) && $event->exists() && !$this->Fields()->exists()) {

        //    $this->Fields()->addMany($event->Fields()->column());

        //}
        
        /* todo populate the records with the set UserFields

        if ($this->Fields()->exists()) {
            // Populate the record with the set field names
            foreach ($this->Fields() as $field) {
                if (!isset($this->record[$field->Name])) {
                    $this->record[$field->Name] = $field->Value;
                }
            }
        }*/
    }

    /**
     * Set the title and ticket code before writing
     */
    public function onBeforeWrite()
    {
        // Set the title of the attendee
        $this->Title = $this->getName();

        // Generate the ticket code
        if ($this->exists() && empty($this->TicketCode)) {
            $this->TicketCode = $this->generateTicketCode();
        }

        if (
            $this->getEmail()
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            && $this->getName()
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            && !$this->TicketFile()->exists()
            && !$this->TicketQRCode()->exists()
        ) {
            $this->createQRCode();
            $this->createTicketFile();
        }

        if ($fields = $this->Fields()) {
            foreach ($fields as $field) {
                if ($value = $this->{"$field->Name[$field->ID]"}) {
                    //$cache = self::getCacheFactory();

                    //$cache->save(serialize($value), $this->getFieldCacheKey($field));

                    $fields->add($field->ID, array('Value' => $value));
                }
            }
        }

        parent::onBeforeWrite();
    }

    public function onAfterWrite()
    {
        parent::onAfterWrite();
        if (($event = $this->Event()) && $event->exists() && !$this->Fields()->exists()) {
            $this->Fields()->addMany($event->Fields()->column());
        }
    }

    /**
     * Delete any stray files before deleting the object
     */
    public function onBeforeDelete()
    {
        // If an attendee is deleted from the guest list remove it's qr code
        // after deleting the code it's not validatable anymore, simply here for cleanup
        if ($this->TicketQRCode()->exists()) {
            $this->TicketQRCode()->delete();
        }

        // cleanup the ticket file
        if ($this->TicketFile()->exists()) {
            $this->TicketFile()->delete();
        }

        if ($this->Fields()->exists()) {
            $this->Fields()->removeAll();
        }

        parent::onBeforeDelete();
    }

    /**
     * Create the folder for the qr code and ticket file
     *
     * @return Folder|DataObject|null
     */
    public function fileFolder()
    {
        return Folder::find_or_make("/event-tickets/{$this->Event()->URLSegment}/{$this->TicketCode}/");
    }

    /**
     * Utility method for fetching the default field, FirstName, value
     *
     * @return string|null
     */
    public function getFirstName()
    {
        return self::getUserField('FirstName');
    }

    /**
     * Utility method for fetching the default field, Surname, value
     *
     * @return string|null
     */
    public function getSurname()
    {
        return self::getUserField('Surname');
    }

    /**
     * Utility method for fetching the default field, Email, value
     *
     * @return string|null
     */
    public function getEmail()
    {
        return self::getUserField('Email');
    }

    /**
     * Get the combined first and last nave for display on the ticket and attendee list
     *
     * @return string|null
     */
    public function getName()
    {
        $mainContact = $this->Reservation()->MainContact();
        if ($this->getSurname()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return trim("{$this->getFirstName()} {$this->getSurname()}");
        } elseif ($mainContact->exists() && $mainContact->getSurname()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return _t('Attendee.GUEST_OF', 'Guest of {name}', null, array('name' => $mainContact->getName()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            return null;
        }
    }

    /**
     * Get the user field and store it in a static cache
     * todo: add a cache that saves the field value on save and retrieves the values here, dumb, so empty fields don't trigger queries
     *
     * @param $field
     * @return mixed|null|string
     */
    public function getUserField($field)
    {
        //$cache = self::getCacheFactory();

        //return unserialize($cache->load($this->getFieldCacheKey($field)));


        if (isset(self::$cachedFields[$this->ID][$field])) {
            return self::$cachedFields[$this->ID][$field];
        } elseif ($userField = $this->Fields()->find('Name', $field)) {
            return self::$cachedFields[$this->ID][$field] = (string)$userField->getField('Value');
        }

        return null;
    }

    protected static function getCacheFactory()
    {
        return \SS_Cache::factory('event_tickets_user_field');
    }

    protected function getFieldCacheKey($field)
    {
        return md5(serialize(array($this->ID, $field)));
    }

    /**
     * Get the table fields for this attendee
     *
     * @return ArrayList
     */
    public function getTableFields()
    {
        $fields = new ArrayList();
        foreach (self::config()->get('table_fields') as $field) {
            $data = new ViewableData();
            $data->Header = _t("Attendee.$field", $field);
            $data->Value = $this->{$field};
            $fields->add($data);
        }
        return $fields;
    }

    /**
     * Get the unnamespaced singular name for display in the CMS
     *
     * @return string
     */
    public function singular_name()
    {
        $name = explode('\\', parent::singular_name());
        return trim(end($name));
    }

    /**
     * Generate a unique ticket id
     * Serves as the base for the QR code and ticket file
     *
     * @return string
     */
    public function generateTicketCode()
    {
        return uniqid($this->ID);
    }

    /**
     * Create a QRCode for the attendee based on the Ticket code
     *
     * @return Image
     */
    public function createQRCode()
    {
        $folder = $this->fileFolder();
        $relativeFilePath = "/{$folder->Filename}{$this->TicketCode}.png";
        $absoluteFilePath = Director::baseFolder() . $relativeFilePath;

        if (!$image = Image::get()->find('Filename', $relativeFilePath)) {
            // Generate the QR code
            $renderer = new BaconQrCode\Renderer\Image\Png();
            $renderer->setHeight(256);
            $renderer->setWidth(256);
            $writer = new BaconQrCode\Writer($renderer);
            if (self::config()->get('qr_as_link')) {
                $writer->writeFile($this->getCheckInLink(), $absoluteFilePath);
            } else {
                $writer->writeFile($this->TicketCode, $absoluteFilePath);
            }

            // Store the image in an image object
            $image = Image::create();
            $image->ParentID = $folder->ID;
            $image->OwnerID = (Member::currentUser()) ? Member::currentUser()->ID : 0;
            $image->Title = $this->TicketCode;
            $image->setFilename($relativeFilePath);
            $image->write();

            // Attach the QR code to the Attendee
            $this->TicketQRCodeID = $image->ID;
            $this->write();
        }

        return $image;
    }

    /**
     * Creates a printable ticket for the attendee
     *
     * @return File
     */
    public function createTicketFile()
    {
        // Find or make a folder
        $folder = $this->fileFolder();
        $relativeFilePath = "/{$folder->Filename}{$this->TicketCode}.pdf";
        $absoluteFilePath = Director::baseFolder() . $relativeFilePath;

        if (!$file = File::get()->find('Filename', $relativeFilePath)) {
            $file = File::create();
            $file->ParentID = $folder->ID;
            $file->OwnerID = (Member::currentUser()) ? Member::currentUser()->ID : 0;
            $file->Title = $this->TicketCode;
            $file->setFilename($relativeFilePath);
            $file->write();
        }

        // Set the template and parse the data
        $template = new SSViewer('PrintableTicket');
        $html = $template->process($this->data());// getViewableData());


        // Create a DomPDF instance
        $domPDF = new Dompdf();
        $domPDF->loadHtml($html);
        $domPDF->setPaper('A4');
        $domPDF->getOptions()->setDpi(150);
        $domPDF->render();

        // Save the pdf stream as a file
        file_put_contents($absoluteFilePath, $domPDF->output());

        // Attach the ticket file to the Attendee
        $this->TicketFileID = $file->ID;
        $this->write();

        return $file;
    }

    /**
     * Send the attendee ticket
     */
    public function sendTicket()

    {
        // Get the mail sender or fallback to the admin email
        if (empty($from = Reservation::config()->get('mail_sender'))) {
            $from = Config::inst()->get('Email', 'admin_email');
        }

        $email = new Email();
        $email->setSubject(_t(
            'AttendeeMail.TITLE',
            'Your ticket for {event}',
            null,
            array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'event' => $this->Event()->Title
            )
        ));
        $email->setFrom($from);
        $email->setTo($this->getEmail());
        $email->setTemplate('AttendeeMail');
        $email->populateTemplate($this);
        $this->extend('updateTicketMail', $email);
        $email->send();
    }

    /**
     * Get the checkin link
     *
     * @return string
     */
    public function getCheckInLink()
    {
        return $this->Event()->AbsoluteLink("checkin/{$this->TicketCode}");
    }

    /**
     * Check the attendee out
     */
    public function checkIn()
    {
        $this->CheckedIn = true;
        $this->write();
    }

    public function canCheckOut()

    {
        return CheckInValidator::config()->get('allow_checkout');
    }

    /**
     * Check the attendee in
     */
    public function checkOut()
    {
        if ($this->canCheckOut()) {
            $this->CheckedIn = false;
            $this->write();
        }
    }

    public function canView($member = null)

    {
        return $this->Reservation()->canView($member);
    }

    public function canEdit($member = null)

    {
        return $this->Reservation()->canEdit($member);
    }

    public function canDelete($member = null)

    {
        return $this->Reservation()->canDelete($member);
    }

    public function canCreate($member = null)

    {
        return $this->Reservation()->canCreate($member);
    }
}


TheBnl / event-tickets

Push — master ( 324319...e9ec8f )

Attendee F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

28 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Duplication Side-by-Side

Filter issues like