drslump / Protobuf-PHP

PHP implementation of Google's Protocol Buffers with a protoc plugin compiler
http://drslump.github.com/Protobuf-PHP/
MIT License
461 stars 163 forks source link

Unexpected namespace naming with nested messages #26

Open DanielPlainview opened 11 years ago

DanielPlainview commented 11 years ago

I try to make PHP classes from this proto: https://developers.google.com/ad-exchange/rtb/downloads/realtime-bidding-proto.txt with following command:

protoc-gen-php -o ~/rtb/ -i ./ -v -Dmultifile -Dpackage="Google.Rtb" realtime-bidding.proto

I expect to see PSR-0 like structure of generated library, but actually protoc-gen-php generates namespace Google\Rtb for BidRequest and BidResponse classes only:

Protobuf-PHP 0.9.4 by Ivan -DrSlump- Montes

NOTICE: Mapping  to Google\Rtb
WARNING: Non tracked package name found "BidRequest.UserList"
WARNING: Non tracked package name found "BidRequest.Vertical"
WARNING: Non tracked package name found "BidRequest.KeyValue"
WARNING: Non tracked package name found "BidRequest.Mobile"
WARNING: Non tracked package name found "BidRequest.Video"
WARNING: Non tracked package name found "BidRequest.MatchingNetwork"
...

Other classes have wrong namespaces, e.g., Ad class has \BidResponse namespace instead \Google\Rtb\BidResponse. Is it a bug or just wrong usage?

DanielPlainview commented 11 years ago

Furthermore, protoc-gen-php saves files (multifile) with following structure:

<...>/BidRequest.php
<...>/BidRequest/UserList.php
<...>/BidResponse.php
<...>

but I'd except

<...>/Google/Rtb/BidRequest.php
<...>/Google/Rtb/BidRequest/UserList.php
<...>/Google/Rtb/BidResponse.php
<...>
DanielPlainview commented 10 years ago

Hi,

I've found out I still use hack in DrSlump\Protobuf\Compiler like

        foreach($req->getProtoFileList() as $proto) {
            $package = $proto->getPackage();
            $namespace = $generator->getNamespace($proto);
            if (isset($this->packages[$package]) && $namespace !== $this->packages[$package]) {
                $this->warning("Package $package was already mapped to {$this->packages[$package]} but has now been overridden to $namespace");
            }
            $this->packages[$package] = $namespace;
            $this->notice("Mapping $package to $namespace");

            PackageMap::map($this, $namespace); // hack
        }
use DrSlump\Protobuf\Compiler;

class PackageMap
{
    private static $packageList = array(
        'BidRequest',
        'BidRequest.AdSlot',
        'BidRequest.AdSlot.MatchingAdData',
        'BidRequest.AdSlot.MatchingAdData.DirectDeal',
        'BidRequest.AdSlot.SlotVisibility',
        'BidRequest.KeyValue',
        'BidRequest.MatchingNetwork',
        'BidRequest.Mobile',
        'BidRequest.Mobile.DeviceOsVersion',
        'BidRequest.Mobile.MobileDeviceType',
        'BidRequest.Mobile.ScreenOrientation',
        'BidRequest.UserList',
        'BidRequest.Vertical',
        'BidRequest.Video',
        'BidRequest.Video.CompanionSlot',
        'BidRequest.Video.CompanionSlot.CreativeFormat',
        'BidRequest.Video.InventoryType',
        'BidRequest.Video.SkippableBidRequestType',
        'BidRequest.Video.VideoFormat',
        'BidResponse',
        'BidResponse.Ad',
        'BidResponse.Ad.AdSlot',
        'BidResponse.Ad.TemplateParameter'
    );

    public static function map(Compiler $compiler, $namespace)
    {
        foreach (self::$packageList as $package) {
            $compiler->setPackage($package, self::normalize($namespace.'.'.$package));
        }
    }

    private static function normalize($ns)
    {
        return strtr($ns, '.', '\\');
    }
}

Any chance to fix it properly?