abbadon1334 / phpdoc-to-rst

src/Extension/GithubLocationExtension.php

<?php
/**
 * @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
 * @author    Julius Härtl <jus@bitgrid.net>
 * @license   GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace JuliusHaertl\PHPDocToRst\Extension;

use Exception;
use JuliusHaertl\PHPDocToRst\Builder\FileBuilder;
use JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder;
use phpDocumentor\Reflection\Element;
use phpDocumentor\Reflection\Php\File;

/**
 * This extension adds a link to the source at github to all elements.
 *
 * Arguments
 * 0 => Url to the github repo (required)
 * 1 => Path to the git repository (required)
 * 2 => Branch to link to (default=master)
 */
class GithubLocationExtension extends Extension
{
    protected $basePath;
    protected $githubRepo;
    protected $branch = 'master';

    public function prepare()
    {
        if (count($this->arguments) < 2) {
            throw new Exception('GithubLocationExtension requires the following arguments githubUrl, basePath.');
        }
        $this->basePath = $this->arguments[0];
        $this->githubRepo = $this->arguments[1];
        if (count($this->arguments) > 2) {
            $this->branch = $this->arguments[2];
        }
    }

    /**
     * @param string      $type
     * @param FileBuilder $builder
     * @param Element     $element
     */
    public function render($type, &$builder, $element)
    {
        if (!$builder instanceof FileBuilder) {

$builder is always a sub-type of JuliusHaertl\PHPDocToRst\Builder\FileBuilder.

            return;
        }
        if ($type === PhpDomainBuilder::SECTION_AFTER_DESCRIPTION) {
            if (!$builder->getFile() instanceof File) {

$builder->getFile() is always a sub-type of phpDocumentor\Reflection\Php\File.

                return;
            }
            $filePath = $builder->getFile()->getPath();
            $filePath = preg_replace('/^'.preg_quote($this->basePath, '/').'/', '', $filePath);
            $lineNumber = $element->getLocation()->getLineNumber();

The method getLocation() does not exist on phpDocumentor\Reflection\Element. It seems like you code against a sub-type of said class. However, the method does not exist in phpDocumentor\Reflection\Php\Namespace_. Are you sure you never get one of those?

            $url = $this->getGithubLink($filePath, $lineNumber, $this->branch);
            $builder->addFieldList('Source', '`'.$filePath.'#'.$lineNumber.' <'.$url.'>`_');
        }
    }

    private function getGithubLink($file, $line = 1, $branch = 'master')
    {
        return $this->githubRepo.'/blob/'.$branch.'/'.$file.'#L'.$line;
    }
}