chore: preference generator test & namespace fixes

Author: raideer

src/generator/preference/PreferenceClassGenerator.ts

@@ -13,7 +13,8 @@ export default class PreferenceClassGenerator extends FileGenerator {
 
   public async generate(workspaceUri: Uri): Promise<GeneratedFile> {
     const [vendor, module] = this.data.module.split('_');
-    const namespaceParts = [vendor, module, this.data.directory];
+    const directoryParts = this.data.directory.split('/');
+    const namespaceParts = [vendor, module, ...directoryParts];
     const moduleDirectory = Magento.getModuleDirectory(vendor, module, workspaceUri);
 
     const header = FileHeader.getHeader(this.data.module);

src/generator/preference/PreferenceDiGenerator.ts

@@ -14,14 +14,18 @@ export default class PreferenceDiGenerator extends FileGenerator {
 
   public async generate(workspaceUri: Uri): Promise<GeneratedFile> {
     const [vendor, module] = this.data.module.split('_');
+    const directoryParts = this.data.directory.split('/');
+    const namespaceParts = [vendor, module, ...directoryParts, this.data.className];
+    const typeNamespace = namespaceParts.join('\\');
+
     const etcDirectory = Magento.getModuleDirectory(vendor, module, workspaceUri, 'etc');
     const diFile = Magento.getUriWithArea(etcDirectory, 'di.xml', this.data.area);
     const diXml = await FindOrCreateDiXml.execute(workspaceUri, vendor, module, this.data.area);
     const insertPosition = this.getInsertPosition(diXml);
 
     const pluginXml = await GenerateFromTemplate.generate('xml/preference', {
       forClass: this.data.parentClass,
-      typeClass: this.data.className,
+      typeClass: typeNamespace,
     });
 
     const newDiXml =

src/test/generator/preference/PreferenceClassGenerator.test.ts

@@ -0,0 +1,94 @@
+import { PreferenceWizardData } from 'wizard/PreferenceWizard';
+import * as assert from 'assert';
+import { Uri } from 'vscode';
+import PreferenceClassGenerator from 'generator/preference/PreferenceClassGenerator';
+import { describe, it, before, afterEach } from 'mocha';
+import { setup } from 'test/setup';
+import { getReferenceFile, getTestWorkspaceUri } from 'test/util';
+import FileHeader from 'common/php/FileHeader';
+import sinon from 'sinon';
+import { MagentoScope } from 'types';
+
+describe('PreferenceClassGenerator Tests', () => {
+  const preferenceWizardData: PreferenceWizardData = {
+    module: 'Foo_Bar',
+    className: 'TestPreference',
+    directory: 'Model',
+    parentClass: 'Magento\\Catalog\\Model\\Product',
+    inheritClass: true,
+    area: MagentoScope.Global,
+  };
+
+  before(async () => {
+    await setup();
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('should generate preference class file', async () => {
+    // Mock the FileHeader.getHeader method to return a consistent header
+    sinon.stub(FileHeader, 'getHeader').returns('Foo_Bar');
+
+    // Create the generator with test data
+    const generator = new PreferenceClassGenerator(preferenceWizardData);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Get the reference file content
+    const referenceContent = getReferenceFile('generator/preference/TestPreference.php');
+
+    // Compare the generated content with reference
+    assert.strictEqual(generatedFile.content, referenceContent);
+  });
+
+  it('should generate file in correct location', async () => {
+    // Create the generator with test data
+    const generator = new PreferenceClassGenerator(preferenceWizardData);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Expected path
+    const expectedPath = Uri.joinPath(
+      workspaceUri,
+      'app/code/Foo/Bar/Model/TestPreference.php'
+    ).fsPath;
+
+    assert.strictEqual(generatedFile.uri.fsPath, expectedPath);
+  });
+
+  it('should generate preference without inheritance', async () => {
+    // Create test data without inheritance
+    const noInheritanceData: PreferenceWizardData = {
+      ...preferenceWizardData,
+      inheritClass: false,
+    };
+
+    // Mock the FileHeader.getHeader method to return a consistent header
+    sinon.stub(FileHeader, 'getHeader').returns('Foo_Bar');
+
+    // Create the generator with modified data
+    const generator = new PreferenceClassGenerator(noInheritanceData);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Get the reference file content
+    const referenceContent = getReferenceFile('generator/preference/TestPreferenceNoInherit.php');
+
+    // Compare the generated content with reference
+    assert.strictEqual(generatedFile.content, referenceContent);
+  });
+});

src/test/generator/preference/PreferenceDiGenerator.test.ts

@@ -0,0 +1,105 @@
+import { PreferenceWizardData } from 'wizard/PreferenceWizard';
+import * as assert from 'assert';
+import { Uri } from 'vscode';
+import PreferenceDiGenerator from 'generator/preference/PreferenceDiGenerator';
+import { describe, it, before, afterEach } from 'mocha';
+import { setup } from 'test/setup';
+import { getReferenceFile, getTestWorkspaceUri } from 'test/util';
+import sinon from 'sinon';
+import { MagentoScope } from 'types';
+
+describe('PreferenceDiGenerator Tests', () => {
+  const preferenceWizardData: PreferenceWizardData = {
+    module: 'Foo_Bar',
+    className: 'TestPreference',
+    directory: 'Model',
+    parentClass: 'Magento\\Catalog\\Model\\Product',
+    inheritClass: true,
+    area: MagentoScope.Global,
+  };
+
+  before(async () => {
+    await setup();
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('should generate di.xml file', async () => {
+    // Create the generator with test data
+    const generator = new PreferenceDiGenerator(preferenceWizardData);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Get the reference file content
+    const referenceContent = getReferenceFile('generator/preference/di.xml');
+
+    // Compare the generated content with reference
+    assert.strictEqual(generatedFile.content, referenceContent);
+  });
+
+  it('should generate file in correct location for global scope', async () => {
+    // Create the generator with test data
+    const generator = new PreferenceDiGenerator(preferenceWizardData);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Expected path for global scope
+    const expectedPath = Uri.joinPath(workspaceUri, 'app/code/Foo/Bar/etc/di.xml').fsPath;
+
+    assert.strictEqual(generatedFile.uri.fsPath, expectedPath);
+  });
+
+  it('should generate file in correct location for frontend scope', async () => {
+    // Create test data with frontend scope
+    const frontendData: PreferenceWizardData = {
+      ...preferenceWizardData,
+      area: MagentoScope.Frontend,
+    };
+
+    // Create the generator with frontend data
+    const generator = new PreferenceDiGenerator(frontendData);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Expected path for frontend scope
+    const expectedPath = Uri.joinPath(workspaceUri, 'app/code/Foo/Bar/etc/frontend/di.xml').fsPath;
+
+    assert.strictEqual(generatedFile.uri.fsPath, expectedPath);
+  });
+
+  it('should generate file in correct location for adminhtml scope', async () => {
+    // Create test data with adminhtml scope
+    const adminhtmlData: PreferenceWizardData = {
+      ...preferenceWizardData,
+      area: MagentoScope.Adminhtml,
+    };
+
+    // Create the generator with adminhtml data
+    const generator = new PreferenceDiGenerator(adminhtmlData);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Expected path for adminhtml scope
+    const expectedPath = Uri.joinPath(workspaceUri, 'app/code/Foo/Bar/etc/adminhtml/di.xml').fsPath;
+
+    assert.strictEqual(generatedFile.uri.fsPath, expectedPath);
+  });
+});

test-resources/reference/generator/preference/TestPreference.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * Foo_Bar
+ */
+
+declare(strict_types=1);
+
+namespace Foo\Bar\Model;
+
+class TestPreference extends \Magento\Catalog\Model\Product
+{
+}

test-resources/reference/generator/preference/TestPreferenceNoInherit.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * Foo_Bar
+ */
+
+declare(strict_types=1);
+
+namespace Foo\Bar\Model;
+
+class TestPreference
+{
+}

test-resources/reference/generator/preference/di.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+
+    <preference for="Magento\Catalog\Model\Product" type="Foo\Bar\Model\TestPreference" />
+</config>