Skip to content

Commit

Permalink
Ignore internal properties in components (#459)
Browse files Browse the repository at this point in the history 
* Ignore internal properties in components

- Fixes #458 (see bug for details)

* Fix tests
  • Loading branch information
@rudro
rudro authored Aug 16, 2023
1 parent 2f2856d commit 008c094
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 21 deletions.
8 changes: 6 additions & 2 deletions ...Sources/NeedleFramework/Parsing/Pluginized/Tasks/PluginizedASTDeclarationParserTask.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,24 +106,28 @@ private final class PluginizedVisitor: BaseVisitor {
override func visitPost(_ node: ClassDeclSyntax) {
let componentName = node.typeName
if componentName == currentPluginizedComponentName {
// Internal properties cannot be seen by the needle generated code, so leave them out
let filteredProperties = propertiesDict[componentName, default: []].filter { property in !property.isInternal }
let component = ASTComponent(name: componentName,
dependencyProtocolName: currentPluginExtensionGenerics.dependencyProtocolName,
isRoot: node.isRoot,
sourceHash: sourceHash,
filePath: filePath,
properties: propertiesDict[componentName, default: []],
properties: filteredProperties,
expressionCallTypeNames: Array(componentToCallExprs[componentName, default: []]).sorted())
let pluginizedComponent = PluginizedASTComponent(data: component,
pluginExtensionType: currentPluginExtensionGenerics.pluginExtensionName,
nonCoreComponentType: currentPluginExtensionGenerics.nonCoreComponentName)
pluginizedComponents.append(pluginizedComponent)
} else if componentName == currentNonCoreComponentName {
// Internal properties cannot be seen by the needle generated code, so leave them out
let filteredProperties = propertiesDict[componentName, default: []].filter { property in !property.isInternal }
let component = ASTComponent(name: componentName,
dependencyProtocolName: currentDependencyProtocol ?? "",
isRoot: false,
sourceHash: sourceHash,
filePath: filePath,
properties: propertiesDict[componentName, default: []],
properties: filteredProperties,
expressionCallTypeNames: Array(componentToCallExprs[componentName, default: []]).sorted())
nonCoreComponents.append(component)
}
Expand Down
5 changes: 3 additions & 2 deletions Generator/Sources/NeedleFramework/Parsing/Tasks/DeclarationsParserTask.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,14 @@ private final class Visitor: BaseVisitor {
let componentName = node.typeName
if componentName == currentEntityNode?.typeName {
let dependencyProtocolName = node.isRoot ? emptyDependency.name : (currentDependencyProtocol ?? "")

// Internal properties cannot be seen by the needle generated code, so leave them out
let filteredProperties = propertiesDict[componentName, default: []].filter { property in !property.isInternal }
let component = ASTComponent(name: componentName,
dependencyProtocolName: dependencyProtocolName,
isRoot: node.isRoot,
sourceHash: sourceHash,
filePath: filePath,
properties: propertiesDict[componentName, default: []],
properties: filteredProperties,
expressionCallTypeNames: Array(componentToCallExprs[componentName, default: []]).sorted())
components.append(component)
}
Expand Down
22 changes: 11 additions & 11 deletions Generator/Tests/NeedleFrameworkTests/Fixtures/ComponentSample.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ class MyComponent: NeedleFoundation.Component<
MyDependency
> {

let stream: Stream = Stream()
public let stream: Stream = Stream()

var donut: Donut {
public var donut: Donut {
return Donut()
}

var sweetsBasket: Basket {
public var sweetsBasket: Basket {
return shared {
Basket(dependency.candy, self.donut)
}
}

var myChildComponent: MyChildComponent {
public var myChildComponent: MyChildComponent {
return MyChildComponent(parent: self)
}

Expand All @@ -44,36 +44,36 @@ protocol SomeNonCoreDependency: Dependency {
}

class SomeNonCoreComponent: NeedleFoundation.NonCoreComponent< SomeNonCoreDependency > {
var newNonCoreObject: NonCoreObject? {
public var newNonCoreObject: NonCoreObject? {
return NonCoreObject()
}
var sharedNonCoreObject: SharedObject {
public var sharedNonCoreObject: SharedObject {
return shared {
return SharedObject()
}
}
}

class MyRComp: BootstrapComponent {
var rootObj: Obj {
public var rootObj: Obj {
return shared {
Obj()
}
}
}

class My2Component: Component<My2Dependency> {
var book: Book {
public var book: Book {
return shared {
Book()
}
}

var maybeWallet: Wallet? {
public var maybeWallet: Wallet? {
return Wallet()
}

var myStore: MyStorage<MyStorageKey> {
public var myStore: MyStorage<MyStorageKey> {
return MyStorage()
}

Expand All @@ -98,7 +98,7 @@ class SomePluginizedComp: PluginizedComponent<
ADependency,
BExtension, SomeNonCoreComponent
>, Stuff {
var tv: Tv {
public var tv: Tv {
return LGOLEDTv()
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...s/NeedleFrameworkTests/Generating/Pluginized/PluginizedDependencyGraphExporterTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class PluginizedDependencyGraphExporterTests: AbstractPluginizedGeneratorTests {
XCTAssertTrue(generated.contains("import UIKit"))
XCTAssertTrue(generated.contains("import ScoreSheet"))
XCTAssertTrue(generated.contains("import TicTacToeIntegrations"))
XCTAssertTrue(generated.contains("private let needleDependenciesHash : String? = \"4b585865bab35437b0cbc60e9d74b1b1\""))
XCTAssertTrue(generated.contains("private let needleDependenciesHash : String? = \"86deb40d0ec1c9fc9fd5e5e8fc17a167\""))
XCTAssertTrue(generated.contains("// MARK: - Registration"))
XCTAssertTrue(generated.contains("""
registerProviderFactory(\"^->RootComponent->LoggedOutComponent\", factory1434ff4463106e5c4f1bb3a8f24c1d289f2c0f2e)
Expand Down
2 changes: 1 addition & 1 deletion Sample/MVC/TicTacToe/Sources/LoggedIn/LoggedInComponent.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import UIKit

class LoggedInComponent: Component<EmptyDependency>, LoggedInBuilder {

var scoreStream: ScoreStream {
public var scoreStream: ScoreStream {
return mutableScoreStream
}

Expand Down
4 changes: 2 additions & 2 deletions Sample/MVC/TicTacToe/Sources/Root/RootComponent.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ import UIKit

class RootComponent: BootstrapComponent {

var playersStream: PlayersStream {
public var playersStream: PlayersStream {
return mutablePlayersStream
}

var mutablePlayersStream: MutablePlayersStream {
public var mutablePlayersStream: MutablePlayersStream {
return shared { PlayersStreamImpl() }
}

Expand Down
4 changes: 2 additions & 2 deletions Sample/Pluginized/TicTacToe/TicTacToeCore/Root/RootComponent.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ import UIKit

class RootComponent: BootstrapComponent {

var playersStream: PlayersStream {
public var playersStream: PlayersStream {
return mutablePlayersStream
}

var mutablePlayersStream: MutablePlayersStream {
public var mutablePlayersStream: MutablePlayersStream {
return shared { PlayersStreamImpl() }
}

Expand Down

1 comment on commit 008c094

@xezero
Copy link

@xezero xezero commented on 008c094 Mar 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This specific commit broke our entire Needle usage as we only use our dependencies within our main app target. To make every dependency public would be a monstrous refactoring as we don't make any of the types that the dependencies use public. This seems related #464

Please sign in to comment.