JSON dump (#302), add format option

* #219 dump JSON as a step to WebPack support

* #219 dump JSON as a step to WebPack support

* Switch to PHP 5.3 array declaration

* #219 dump JSON as a step to WebPack support

* #219 Adding test (based on existing) for use of --format=json

Author: Matatiro Solutions

Command/DumpCommand.php

@@ -24,21 +24,6 @@
  */
 class DumpCommand extends ContainerAwareCommand
 {
-    /**
-     * @var string
-     */
-    private $targetPath;
-
-    /**
-     * @var \FOS\JsRoutingBundle\Extractor\ExposedRoutesExtractorInterface
-     */
-    private $extractor;
-
-    /**
-     * @var \Symfony\Component\Serializer\SerializerInterface
-     */
-    private $serializer;
-
     protected function configure()
     {
         $this
@@ -51,6 +36,13 @@ protected function configure()
                 'Callback function to pass the routes as an argument.',
                 'fos.Router.setData'
             )
+            ->addOption(
+                'format',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Format to output routes in. js to wrap the response in a callback, json for raw json output. Callback is ignored when format is json',
+                'js'
+            )
             ->addOption(
                 'target',
                 null,
@@ -73,23 +65,24 @@ protected function configure()
         ;
     }
 
-    protected function initialize(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)
     {
-        parent::initialize($input, $output);
-
-        $this->targetPath = $input->getOption('target') ?:
-            sprintf('%s/../web/js/fos_js_routes.js', $this->getContainer()->getParameter('kernel.root_dir'));
+        if(!in_array($input->getOption('format'), array('js', 'json'))) {
+            $output->writeln('<error>Invalid format specified. Use js or json.</error>');
+            return 1;
+        }
 
-        $this->extractor = $this->getContainer()->get('fos_js_routing.extractor');
-        $this->serializer = $this->getContainer()->get('fos_js_routing.serializer');
-    }
+        $callback = $input->getOption('callback');
+        if(empty($callback)) {
+            $output->writeln('<error>If you include --callback it must not be empty. Do you perhaps want --format=json</error>');
+            return 1;
+        }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
         $output->writeln('Dumping exposed routes.');
         $output->writeln('');
 
         $this->doDump($input, $output);
+        return 0;
     }
 
     /**
@@ -100,18 +93,27 @@ protected function execute(InputInterface $input, OutputInterface $output)
      */
     private function doDump(InputInterface $input, OutputInterface $output)
     {
-        if (!is_dir($dir = dirname($this->targetPath))) {
+        $extractor = $this->getContainer()->get('fos_js_routing.extractor');
+        $serializer = $this->getContainer()->get('fos_js_routing.serializer');
+        $targetPath = $input->getOption('target') ?:
+            sprintf(
+                '%s/../web/js/fos_js_routes.%s',
+                $this->getContainer()->getParameter('kernel.root_dir'),
+                $input->getOption('format')
+            );
+        
+        if (!is_dir($dir = dirname($targetPath))) {
             $output->writeln('<info>[dir+]</info>  ' . $dir);
             if (false === @mkdir($dir, 0777, true)) {
                 throw new \RuntimeException('Unable to create directory ' . $dir);
             }
         }
 
-        $output->writeln('<info>[file+]</info> ' . $this->targetPath);
+        $output->writeln('<info>[file+]</info> ' . $targetPath);
 
         $baseUrl = $this->getContainer()->hasParameter('fos_js_routing.request_context_base_url') ?
             $this->getContainer()->getParameter('fos_js_routing.request_context_base_url') :
-            $this->extractor->getBaseUrl()
+            $extractor->getBaseUrl()
         ;
 
         if ($input->getOption('pretty-print')) {
@@ -120,22 +122,24 @@ private function doDump(InputInterface $input, OutputInterface $output)
             $params = array();
         }
 
-        $content = $this->serializer->serialize(
+        $content = $serializer->serialize(
             new RoutesResponse(
                 $baseUrl,
-                $this->extractor->getRoutes(),
-                $this->extractor->getPrefix($input->getOption('locale')),
-                $this->extractor->getHost(),
-                $this->extractor->getScheme()
+                $extractor->getRoutes(),
+                $extractor->getPrefix($input->getOption('locale')),
+                $extractor->getHost(),
+                $extractor->getScheme()
             ),
             'json',
             $params
         );
 
-        $content = sprintf("%s(%s);", $input->getOption('callback'), $content);
+        if('js' == $input->getOption('format')) {
+            $content = sprintf("%s(%s);", $input->getOption('callback'), $content);
+        }
 
-        if (false === @file_put_contents($this->targetPath, $content)) {
-            throw new \RuntimeException('Unable to write file ' . $this->targetPath);
+        if (false === @file_put_contents($targetPath, $content)) {
+            throw new \RuntimeException('Unable to write file ' . $targetPath);
         }
     }
 }

Tests/Command/DumpCommandTest.php

@@ -97,6 +97,39 @@ public function testExecuteCallbackOption()
         $this->assertEquals('test({"base_url":"","routes":{"literal":{"tokens":[["text","\/homepage"]],"defaults":[],"requirements":[],"hosttokens":[]},"blog":{"tokens":[["variable","\/","[^\/]++","slug"],["text","\/blog-post"]],"defaults":[],"requirements":[],"hosttokens":[["text","localhost"]]}},"prefix":"","host":"","scheme":""});', file_get_contents('/tmp/dump-command-test'));
     }
 
+    public function testExecuteFormatOption()
+    {
+        $json = '{"base_url":"","routes":{"literal":{"tokens":[["text","\/homepage"]],"defaults":[],"requirements":[],"hosttokens":[]},"blog":{"tokens":[["variable","\/","[^\/]++","slug"],["text","\/blog-post"]],"defaults":[],"requirements":[],"hosttokens":[["text","localhost"]]}},"prefix":"","host":"","scheme":""}';
+
+        $this->container->expects($this->at(0))
+            ->method('get')
+            ->with('fos_js_routing.extractor')
+            ->will($this->returnValue($this->extractor));
+
+        $this->serializer->expects($this->once())
+            ->method('serialize')
+            ->will($this->returnValue($json));
+
+        $this->container->expects($this->at(1))
+            ->method('get')
+            ->with('fos_js_routing.serializer')
+            ->will($this->returnValue($this->serializer));
+
+        $command = new DumpCommand();
+        $command->setContainer($this->container);
+
+        $tester = new CommandTester($command);
+        $tester->execute(array(
+            '--target' => '/tmp/dump-command-test',
+            '--format' => 'json',
+        ));
+
+        $this->assertContains('Dumping exposed routes.', $tester->getDisplay());
+        $this->assertContains('[file+] /tmp/dump-command-test', $tester->getDisplay());
+
+        $this->assertEquals($json, file_get_contents('/tmp/dump-command-test'));
+    }
+
     /**
      * @expectedException \RuntimeException
      * @expectedExceptionMessage Unable to create directory /../web/js