Make it compatible with the NPM Scope

Author: francoispluchino

Converter/NpmPackageConverter.php

@@ -27,7 +27,7 @@ protected function getMapKeys()
 
         return array(
             'name' => array('name', function ($value) use ($assetType) {
-                return $assetType->formatComposerName($value);
+                return $assetType->formatComposerName(NpmPackageUtil::convertName($value));
             }),
             'type' => array('type', function () use ($assetType) {
                 return $assetType->getComposerType();
@@ -80,4 +80,14 @@ protected function getMapExtras()
             'publishConfig' => 'npm-asset-publish-config',
         );
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function convertDependency($dependency, $version, array &$vcsRepos, array $composer)
+    {
+        $dependency = NpmPackageUtil::convertName($dependency);
+
+        return parent::convertDependency($dependency, $version, $vcsRepos, $composer);
+    }
 }

Converter/NpmPackageUtil.php

@@ -18,6 +18,22 @@
  */
 abstract class NpmPackageUtil
 {
+    /**
+     * Convert the npm package name.
+     *
+     * @param string $name The npm package name
+     *
+     * @return string
+     */
+    public static function convertName($name)
+    {
+        if (0 === strpos($name, '@') && false !== $pos = strpos($name, '/')) {
+            $name = ltrim(str_replace('/', '--', $name), '@');
+        }
+
+        return $name;
+    }
+
     /**
      * Convert the author section.
      *

Repository/AbstractAssetsRepository.php

@@ -130,7 +130,7 @@ public function whatProvides(Pool $pool, $name, $bypassFilters = false)
         try {
             $repoName = Util::convertAliasName($name);
             $packageName = Util::cleanPackageName($repoName);
-            $packageUrl = str_replace('%package%', $packageName, $this->lazyProvidersUrl);
+            $packageUrl = $this->buildPackageUrl($packageName);
             $cacheName = $packageName.'-'.sha1($packageName).'-package.json';
             $data = $this->fetchFile($packageUrl, $cacheName);
             $repo = $this->createVcsRepositoryConfig($data, Util::cleanPackageName($name));
@@ -155,6 +155,18 @@ public function getMinimalPackages()
         return array();
     }
 
+    /**
+     * Build the package url.
+     *
+     * @param string $packageName The package name
+     *
+     * @return string
+     */
+    protected function buildPackageUrl($packageName)
+    {
+        return str_replace('%package%', $packageName, $this->lazyProvidersUrl);
+    }
+
     /**
      * Finds what provides in cache or return empty array if the
      * name is not a asset package.

Repository/NpmRepository.php

@@ -15,6 +15,7 @@
 use Composer\Package\CompletePackageInterface;
 use Composer\Package\Loader\ArrayLoader;
 use Composer\Repository\ArrayRepository;
+use Fxp\Composer\AssetPlugin\Converter\NpmPackageUtil;
 use Fxp\Composer\AssetPlugin\Exception\InvalidCreateRepositoryException;
 
 /**
@@ -64,6 +65,14 @@ public function search($query, $mode = 0, $type = null)
         return array();
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    protected function buildPackageUrl($packageName)
+    {
+        return parent::buildPackageUrl(NpmPackageUtil::convertName($packageName));
+    }
+
     /**
      * {@inheritdoc}
      */

Tests/Converter/NpmPackageConverterTest.php

@@ -29,7 +29,7 @@ protected function setUp()
         /* @var AssetTypeInterface $type */
         $type = $this->type;
         $this->converter = new NpmPackageConverter($type);
-        $this->asset = (array) json_decode(file_get_contents(__DIR__.'/../Fixtures/package/npm.json'), true);
+        $this->asset = $this->loadPackage();
     }
 
     public function testConvert()
@@ -164,6 +164,26 @@ public function testConvert()
         $this->assertArrayNotHasKey('archive', $composer);
     }
 
+    public function testConvertWithScope()
+    {
+        $this->asset = $this->loadPackage('npm-scope.json');
+        $composer = $this->converter->convert($this->asset);
+
+        $this->assertArrayHasKey('name', $composer);
+        $this->assertSame('ASSET/scope--test', $composer['name']);
+
+        $this->assertArrayHasKey('require', $composer);
+        $this->assertSame(array(
+            'ASSET/scope--library1' => '>= 1.0.0',
+            'ASSET/scope2--library2' => '>= 1.0.0',
+        ), $composer['require']);
+
+        $this->assertArrayHasKey('require-dev', $composer);
+        $this->assertSame(array(
+            'ASSET/scope3--dev-library1' => '>= 1.0.0',
+        ), $composer['require-dev']);
+    }
+
     public function getConvertDistData()
     {
         return array(
@@ -184,4 +204,16 @@ public function testConvertDist($value, $result)
     {
         $this->assertSame($result, NpmPackageUtil::convertDist($value));
     }
+
+    /**
+     * Load the package.
+     *
+     * @param string $package The package file name
+     *
+     * @return array
+     */
+    private function loadPackage($package = 'npm.json')
+    {
+        return (array) json_decode(file_get_contents(__DIR__.'/../Fixtures/package/'.$package), true);
+    }
 }

Tests/Fixtures/package/npm-scope.json

@@ -0,0 +1,13 @@
+{
+    "name": "@scope/test",
+    "description": "Test NPM Scope",
+    "version": "1.0.0-pre",
+    "license": "MIT",
+    "dependencies": {
+        "@scope/library1": ">= 1.0.0",
+        "@scope2/library2": ">= 1.0.0"
+    },
+    "devDependencies": {
+        "@scope3/dev-library1": ">= 1.0.0"
+    }
+}