Fix test warning, improve naming in tests

amarcu · amarcu · commit 20e1d4dd5ed2 · 2015-10-12T16:41:18.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 /vendor/
+composer.lock
diff --git a/examples/dorm/CodegenDorm.php b/examples/dorm/CodegenDorm.php
@@ -45,6 +45,7 @@ public function generate(): void {
     $path = $rc->getFileName();
     $pos = strrpos($path, '/');
     $dir = substr($path, 0, $pos + 1);
+    $gen_from = 'codegen.php '.$this->getSchemaName().'Schema';
 
     // This generates a file (we pass the file name) that contains the
     // class defined above and saves it.
@@ -54,7 +55,7 @@ public function generate(): void {
     // of the existing file and merging it if it's partially generated.
     codegen_file($dir.$this->getSchemaName().'.php')
       ->addClass($class)
-      ->setGeneratedFrom(codegen_generated_from_script())
+      ->setGeneratedFrom(codegen_generated_from_script($gen_from))
       ->save();
   }
 
diff --git a/examples/dorm/CodegenMutator.php b/examples/dorm/CodegenMutator.php
@@ -51,13 +51,14 @@ public function generate(): void {
     $path = $rc->getFileName();
     $pos = strrpos($path, '/');
     $dir = substr($path, 0, $pos + 1);
+    $gen_from = 'codegen.php '.$rc->getShortName();
 
     // This generates a file (we pass the file name) that contains the
     // class defined above and saves it.
     codegen_file($dir.$name.'.php')
       ->addClass($class)
       ->setIsStrict(true)
-      ->setGeneratedFrom(codegen_generated_from_script())
+      ->setGeneratedFrom(codegen_generated_from_script($gen_from))
       ->save();
   }
 
diff --git a/examples/dorm/demo/DormUser.php b/examples/dorm/demo/DormUser.php
@@ -3,11 +3,10 @@
  * This file is partially generated. Only make modifications between BEGIN
  * MANUAL SECTION and END MANUAL SECTION designators.
  *
- * To re-generate this file run
- * /home/ubuntu/hack-codegen/examples/dorm/codegen.php
+ * To re-generate this file run codegen.php DormUserSchema
  *
  *
- * @partially-generated SignedSource<<f9e8b0c880da41854d491905f3a7314e>>
+ * @partially-generated SignedSource<<609ad77761b889b1c3dd2a45c5aa296a>>
  */
 
 final class DormUser {
diff --git a/examples/dorm/demo/DormUserMutator.php b/examples/dorm/demo/DormUserMutator.php
@@ -3,11 +3,10 @@
  * This file is partially generated. Only make modifications between BEGIN
  * MANUAL SECTION and END MANUAL SECTION designators.
  *
- * To re-generate this file run
- * /home/ubuntu/hack-codegen/examples/dorm/codegen.php
+ * To re-generate this file run codegen.php DormUserSchema
  *
  *
- * @partially-generated SignedSource<<f9c5059806c0ec22c4ba40846c277eb9>>
+ * @partially-generated SignedSource<<aed81933eb3016547905627d230a9d5a>>
  */
 
 final class DormUserMutator {
diff --git a/lib/Filesystem.php b/lib/Filesystem.php
@@ -17,7 +17,7 @@ public static function createTemporaryFile(
   ): string {
     $fname = tempnam(sys_get_temp_dir(), $prefix);
     if ($cleanup) {
-      register_shutdown_function(array('Filesystem', 'remove'), $fname);
+      register_shutdown_function(array(Filesystem::class, 'remove'), $fname);
     }
     return $fname;
   }
diff --git a/src/CodegenClass.php b/src/CodegenClass.php
@@ -51,6 +51,7 @@ public function getExtends(): ?string {
     return $this->extendsClass;
   }
 
+
   public function setConstructor(CodegenConstructor $constructor): this {
     $this->constructor = $constructor;
     return $this;
diff --git a/src/CodegenFile.php b/src/CodegenFile.php
@@ -228,9 +228,13 @@ public function render(): string {
 
     $old_content = $this->loadExistingFiles();
 
-    $doc_block = $this->docBlock;
-    if ($this->generatedFrom !== null) {
-      $doc_block = $doc_block. $this->generatedFrom->render() ."\n";
+    $doc_block = (string)$this->docBlock;
+    $gen_from = $this->generatedFrom;
+    if ($gen_from !== null) {
+      if ($doc_block && !Str::endsWith($doc_block, "\n")) {
+        $doc_block .= "\n";
+      }
+      $doc_block = $doc_block.$gen_from->render()."\n";
     }
 
     if (PartiallyGeneratedCode::containsManualSection($content)) {
diff --git a/src/CodegenFunctionBase.php b/src/CodegenFunctionBase.php
@@ -38,6 +38,11 @@ public function __construct(
     $this->name = $name;
   }
 
+  public function setName(string $name): this {
+    $this->name = $name;
+    return $this;
+  }
+
   public function setIsAsync(bool $value = true): this {
     $this->isAsync = $value;
     return $this;
diff --git a/src/CodegenGeneratedFrom.php b/src/CodegenGeneratedFrom.php
@@ -34,10 +34,6 @@ function codegen_generated_from_class(string $class): CodegenGeneratedFrom {
   return new CodegenGeneratedFrom("Generated from $class");
 }
 
-function codegen_generated_from_string(string $string): CodegenGeneratedFrom {
-  return new CodegenGeneratedFrom("Generated from $string");
-}
-
 function codegen_generated_from_method(
   string $class,
   string $method
diff --git a/src/CodegenMemberVar.php b/src/CodegenMemberVar.php
@@ -77,7 +77,9 @@ public function setType(string $type, ...$args): this {
    * arrays, etc, and it will generate the code to render those values.
    */
   public function setValue(mixed $value): this {
-    return $this->setLiteralValue(strip_hh_prefix(var_export($value, true)));
+    $val_str = var_export($value, true);
+    $val_str = $val_str === 'NULL' ? 'null' : $val_str;
+    return $this->setLiteralValue(strip_hh_prefix($val_str));
   }
 
   /**
diff --git a/src/HackBuilder.php b/src/HackBuilder.php
@@ -74,7 +74,7 @@ public function addMultilineCall(
   /**
    * Add a Map with the specified pairs.
    *
-   * @param ConstMap<Tk, Tv> $map The Map or Map to output. Note that
+   * @param \ConstMap<Tk, Tv> $map The Map or Map to output. Note that
    *    regardless of which type is passed in, a Map will be output. This is
    *    useful for sorting the map for readability, as long as you don't need
    *    the sorting in actual code.
@@ -95,7 +95,7 @@ public function addMap<Tk, Tv>(
   /**
    * Add an ImmMap with the specified pairs.
    *
-   * @param ConstMap<Tk, Tv> $map The Map or Map to output. Note that
+   * @param \ConstMap<Tk, Tv> $map The Map or Map to output. Note that
    *    regardless of which type is passed in, an ImmMap will be output. This is
    *    useful for sorting the map for readability, as long as you don't need
    *    the sorting in actual code.
diff --git a/test/CodegenClassTestCase.codegen b/test/CodegenClassTestCase.codegen
@@ -2,7 +2,7 @@
 !@#$%codegentest:testClassDeclarationWithGenerics
 class ClassWithGenerics
   <
-    Tent as Facebook\HackCodegen\IEnt,
+    Tent as Ixyz,
     T,
     Tstory as EntCreationStory<Tent>
   > {
diff --git a/test/CodegenClassTestCase.php b/test/CodegenClassTestCase.php
@@ -89,7 +89,7 @@ public function testLongClassDeclarationWithInterfaces() {
 
   public function testClassDeclarationWithGenerics() {
     $generics_decl = Map {
-      'Tent' => IEnt::class,
+      'Tent' => 'Ixyz',
       'T' => "",
       'Tstory' => "EntCreationStory<Tent>",
     };
diff --git a/test/CodegenExpectedFile.php b/test/CodegenExpectedFile.php
@@ -37,7 +37,7 @@ public static function getPath(string $class_name): string {
     $ref = new \ReflectionClass($class_name);
     $source_file = $ref->getFileName();
     // Get classname without namespace
-    $class_name = $ref->getShortName(); 
+    $class_name = $ref->getShortName();
     return dirname($source_file).'/'.$class_name.self::EXTENSION;
   }
 
diff --git a/test/CodegenFunctionTestCase.codegen b/test/CodegenFunctionTestCase.codegen
@@ -25,17 +25,17 @@ function getExpensive() {
 }
 
 !@#$%codegentest:testMixedBuiltInAndUserAttributes
-<<__Override, Facebook\HackCodegen\DataProvider('providerFunc'), Facebook\HackCodegen\TestsBypassVisibility>>
+<<__Override, DataProvider('providerFunc'), TestsBypassVisibility>>
 function getOverridedBypassVisibilityAndUseDataProvider() {
 }
 
 !@#$%codegentest:testMixedBuiltInAndUserAttributesAsync
-<<__Override, Facebook\HackCodegen\DataProvider('providerFunc'), Facebook\HackCodegen\TestsBypassVisibility>>
+<<__Override, DataProvider('providerFunc'), TestsBypassVisibility>>
 async function genOverridedBypassVisibilityAndUseDataProvider() {
 }
 
 !@#$%codegentest:testMixedUserAttributes
-<<Facebook\HackCodegen\DataProvider('providerFunc'), Facebook\HackCodegen\TestsBypassVisibility>>
+<<DataProvider('providerFunc'), TestsBypassVisibility>>
 function getBypassVisibilityAndUseDataProvider() {
 }
 
@@ -67,13 +67,13 @@ function getName(): string {
   return $name;
 }
 
-!@#$%codegentest:testSingleUserAttributeWitArgument
-<<Facebook\HackCodegen\DataProvider('providerFunc')>>
+!@#$%codegentest:testSingleUserAttributeWithArgument
+<<DataProvider('providerFunc')>>
 function getUseDataProvider() {
 }
 
 !@#$%codegentest:testSingleUserAttributeWithoutArgument
-<<Facebook\HackCodegen\TestsBypassVisibility>>
+<<TestsBypassVisibility>>
 function getTestsBypassVisibility() {
 }
 
diff --git a/test/CodegenFunctionTestCase.php b/test/CodegenFunctionTestCase.php
@@ -69,40 +69,40 @@ public function testOverrideMemoizedAsync() {
 
   public function testSingleUserAttributeWithoutArgument() {
     $code = codegen_function('getTestsBypassVisibility')
-      ->setUserAttribute(TestsBypassVisibility::class)
+      ->setUserAttribute('TestsBypassVisibility')
       ->render();
     self::assertUnchanged($code);
   }
 
-  public function testSingleUserAttributeWitArgument() {
+  public function testSingleUserAttributeWithArgument() {
     $code = codegen_function('getUseDataProvider')
-      ->setUserAttribute(DataProvider::class, "'providerFunc'")
+      ->setUserAttribute('DataProvider', "'providerFunc'")
       ->render();
     self::assertUnchanged($code);
   }
 
   public function testMixedUserAttributes() {
     $code = codegen_function('getBypassVisibilityAndUseDataProvider')
-      ->setUserAttribute(DataProvider::class, "'providerFunc'")
-      ->setUserAttribute(TestsBypassVisibility::class)
+      ->setUserAttribute('DataProvider', "'providerFunc'")
+      ->setUserAttribute('TestsBypassVisibility')
       ->render();
     self::assertUnchanged($code);
   }
 
   public function testMixedBuiltInAndUserAttributes() {
     $code = codegen_function('getOverridedBypassVisibilityAndUseDataProvider')
       ->setIsOverride(true)
-      ->setUserAttribute(DataProvider::class, "'providerFunc'")
-      ->setUserAttribute(TestsBypassVisibility::class)
+      ->setUserAttribute('DataProvider', "'providerFunc'")
+      ->setUserAttribute('TestsBypassVisibility')
       ->render();
     self::assertUnchanged($code);
   }
 
   public function testMixedBuiltInAndUserAttributesAsync() {
     $code = codegen_function('genOverridedBypassVisibilityAndUseDataProvider')
       ->setIsOverride(true)
-      ->setUserAttribute(DataProvider::class, "'providerFunc'")
-      ->setUserAttribute(TestsBypassVisibility::class)
+      ->setUserAttribute('DataProvider', "'providerFunc'")
+      ->setUserAttribute('TestsBypassVisibility')
       ->setIsAsync()
       ->render();
     self::assertUnchanged($code);
diff --git a/test/CodegenMethodTestCase.codegen b/test/CodegenMethodTestCase.codegen
@@ -22,7 +22,7 @@ public function getName(): string {
 
 !@#$%codegentest:testManualSection
 public function genProprietorName(): string {
-  /* BEGIN MANUAL SECTION Facebook\HackCodegen\EntBlindPig::genProprietorName */
+  /* BEGIN MANUAL SECTION MyClass::genProprietorName */
   // insert your code here
   /* END MANUAL SECTION */
 }
diff --git a/test/CodegenMethodTestCase.php b/test/CodegenMethodTestCase.php
@@ -55,7 +55,7 @@ public function testManualSection() {
       ->setBody('// insert your code here')
       ->setManualBody();
 
-    codegen_class(EntBlindPig::class)->addMethod($method);
+    codegen_class('MyClass')->addMethod($method);
     $code = $method->render();
 
     self::assertUnchanged($code);
diff --git a/test/CodegenTraitTestCase.codegen b/test/CodegenTraitTestCase.codegen
@@ -5,10 +5,10 @@
  */
 trait DemoInternal {
 
-  require extends Facebook\HackCodegen\EntSchema;
-  require implements Facebook\HackCodegen\IEntSchemaBase;
+  require extends RequiredClass;
+  require implements RequiredInterface;
 
-  use EntProvisionalMode;
+  use DemoTrait;
   // Generated from Whatever::Method()
   use WhateverTrait;
   use Useless;
diff --git a/test/CodegenTraitTestCase.php b/test/CodegenTraitTestCase.php
@@ -29,9 +29,9 @@ public function testDocblock() {
 
   public function testDemo() {
     $code = codegen_trait('DemoInternal')
-      ->addRequireClass(EntSchema::class)
-      ->addRequireInterface(IEntSchemaBase::class)
-      ->addTrait(codegen_uses_trait('EntProvisionalMode'))
+      ->addRequireClass('RequiredClass')
+      ->addRequireInterface('RequiredInterface')
+      ->addTrait(codegen_uses_trait('DemoTrait'))
       ->addTrait(
         codegen_uses_trait('WhateverTrait')
         ->setGeneratedFrom(codegen_generated_from_method("Whatever", "Method"))

Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,10 @@`
`3`	`3`	`* This file is partially generated. Only make modifications between BEGIN`
`4`	`4`	`* MANUAL SECTION and END MANUAL SECTION designators.`
`5`	`5`	`*`
`6`		`- * To re-generate this file run`
`7`		`- * /home/ubuntu/hack-codegen/examples/dorm/codegen.php`
	`6`	`+ * To re-generate this file run codegen.php DormUserSchema`
`8`	`7`	`*`
`9`	`8`	`*`
`10`		`- * @partially-generated SignedSource<<f9e8b0c880da41854d491905f3a7314e>>`
	`9`	`+ * @partially-generated SignedSource<<609ad77761b889b1c3dd2a45c5aa296a>>`
`11`	`10`	`*/`
`12`	`11`
`13`	`12`	`final class DormUser {`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public static function createTemporaryFile(`
`17`	`17`	`): string {`
`18`	`18`	`$fname = tempnam(sys_get_temp_dir(), $prefix);`
`19`	`19`	`if ($cleanup) {`
`20`		`- register_shutdown_function(array('Filesystem', 'remove'), $fname);`
	`20`	`+ register_shutdown_function(array(Filesystem::class, 'remove'), $fname);`
`21`	`21`	`}`
`22`	`22`	`return $fname;`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ public function getExtends(): ?string {`
`51`	`51`	`return $this->extendsClass;`
`52`	`52`	`}`
`53`	`53`
	`54`	`+`
`54`	`55`	`public function setConstructor(CodegenConstructor $constructor): this {`
`55`	`56`	`$this->constructor = $constructor;`
`56`	`57`	`return $this;`