reallyli / laravel-ab-test

src/Tester.php

<?php

namespace Reallyli\AB;

use Illuminate\Http\Request;
use Reallyli\AB\Models\Goal;
use Reallyli\AB\Models\Experiment;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Config;
use Reallyli\AB\Session\SessionInterface;

class Tester
{
    /**
     * The Session instance.
     *
     * @var SessionInterface
     */
    protected $session;

    /**
     * Constructor.
     *
     * @param SessionInterface $session
     */
    public function __construct(SessionInterface $session)
    {
        $this->session = $session;
    }

    /**
     * Track clicked links and form submissions.
     *
     * @param  Request $request
     * @return void
     */
    public function track(Request $request)
    {
        // Don't track if there is no active experiment.
        if (! $this->session->get('experiment')) {
            return;
        }

        // Since there is an ongoing experiment, increase the pageviews.
        // This will only be incremented once during the whole experiment.
        $this->pageview();

        // Check current and previous urls.
        $root = $request->root();
        $from = ltrim(str_replace($root, '', $request->headers->get('referer')), '/');
        $to = ltrim(str_replace($root, '', $request->getPathInfo()), '/');
        // Don't track refreshes.
        if ($from == $to) {
            return;
        }

        // Because the visitor is viewing a new page, trigger engagement.
        // This will only be incremented once during the whole experiment.
        $this->interact();

        $goals = $this->getGoals();

        // Detect goal completion based on the current url.
        if (in_array($to, $goals) or in_array('/'.$to, $goals)) {
            $this->complete($to);
        }

        // Detect goal completion based on the current route name.
        if ($route = Route::currentRouteName() and in_array($route, $goals)) {
            $this->complete($route);
        }
    }

    /**
     * Get or compare the current experiment for this session.
     *
     * @param  string  $target
     * @return bool|string
     */
    public function experiment($target = null)
    {
        // Get the existing or new experiment.
        try {
            $experiment = $this->session->get('experiment') ?: $this->nextExperiment();

            if (is_null($target)) {
                return $experiment;
            }

            return $experiment == $target;
        } catch (\Exception $e) {
            \Log::error('Experiments on front may be deleted');

            return false;
        }
    }

    /**
     * Increment the pageviews for the current experiment.
     *
     * @return void
     */
    public function pageview()
    {
        // Only interact once per experiment. #reallyli update
        if (config('ab.unique_pageview')) {
            if ($this->session->get('pageview')) {
                return;
            }
        }

        $experiment = Experiment::firstOrNew(['name' => $this->experiment()]);
        $experiment->visitors++;
        $experiment->save();

        // Mark current experiment as interacted.
        $this->session->set('pageview', 1);
    }

    /**
     * Increment the engagement for the current experiment.
     *
     * @return void
     */
    public function interact()
    {
        // Only interact once per experiment.
        if ($this->session->get('interacted')) {
            return;
        }

        $experiment = Experiment::firstOrNew(['name' => $this->experiment()]);
        $experiment->engagement++;
        $experiment->save();

        // Mark current experiment as interacted.
        $this->session->set('interacted', 1);
    }

    /**
     * Mark a goal as completed for the current experiment.
     *
     * @return void
     */
    public function complete($name)
    {
        // Only complete once per experiment.
        if ($this->session->get("completed_$name")) {
            return;
        }

        $goal = Goal::firstOrCreate(['name' => $name, 'experiment' => $this->experiment()]);
        Goal::where('name', $name)->where('experiment', $this->experiment())->update(['count' => ($goal->count + 1)]);

        // Mark current experiment as completed.
        $this->session->set("completed_$name", 1);
    }

    /**
     * Set the current experiment for this session manually.
     *
     * @param string $experiment
     */
    public function setExperiment($experiment)
    {
        if ($this->session->get('experiment') != $experiment) {
            $this->session->set('experiment', $experiment);

            // Increase pageviews for new experiment.
            $this->nextExperiment($experiment);
        }
    }

    /**
     * Get all experiments.
     *
     * @return array
     */
    public function getExperiments()
    {
        return Config::get('ab', [])['experiments'];
    }

    /**
     * Get all goals.
     *
     * @return array
     */
    public function getGoals()
    {
        return Config::get('ab', [])['goals'];
    }

    /**
     * Get the session instance.
     *
     * @return SessionInterface
     */
    public function getSession()
    {
        return $this->session;
    }

    /**
     * Set the session instance.
     *
     * @param $session SessionInterface
     */
    public function setSession(SessionInterface $session)
    {
        $this->session = $session;
    }

    /**
     * If an experiment has initialized get his string.
     *
     * @return string
     */
    public function currentExperiment()
    {
        // Verify that the experiments are in the database.
        $this->checkExperiments();
        if ($this->session->get('experiment') != '') {
            $experiment = $this->session->get('experiment');
        } else {
            $experiment = Experiment::active()->orderBy('updated_at', 'asc')->firstOrFail();

The method active() does not exist on Reallyli\AB\Models\Experiment. Did you maybe mean scopeActive()?

            $experiment = $experiment->name;
        }

        return $experiment;
    }

    /**
     * Prepare an experiment for this session.
     *
     * @return string
     */
    protected function nextExperiment($experiment = null)
    {
        // Verify that the experiments are in the database.
        $this->checkExperiments();

        if ($experiment) {
            $experiment = Experiment::active()->findOrfail($experiment);

The method active() does not exist on Reallyli\AB\Models\Experiment. Did you maybe mean scopeActive()?

        } else {
            $experiment = Experiment::active()->orderBy('visitors', 'asc')->firstOrFail();

The method active() does not exist on Reallyli\AB\Models\Experiment. Did you maybe mean scopeActive()?

        }

        $this->session->set('experiment', $experiment->name);

        // Since there is an ongoing experiment, increase the pageviews.
        // This will only be incremented once during the whole experiment.
        $this->pageview();

        return $experiment->name;
    }

    /**
     * Add experiments to the database.
     *
     * @return void
     */
    protected function checkExperiments()
    {
        // Check if the database contains all experiments.
        if (Experiment::active()->count() != count($this->getExperiments())) {

The method active() does not exist on Reallyli\AB\Models\Experiment. Did you maybe mean scopeActive()?

            // Insert all experiments.
            foreach ($this->getExperiments() as $experiment) {
                Experiment::firstOrCreate(['name' => $experiment]);
            }
        }
    }

    /**
     * Check if there are active experiments.
     *
     * @return string
     */
    public function hasExperiments()
    {
        $count = Experiment::count();

        return $count > 1;
    }
}