Skip to content

Add protocol-level @available annotation inheritance to generated mocks #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Keitaro0226 wants to merge 8 commits into
base: master
Choose a base branch
from
+99 −6
Open

Add protocol-level @available annotation inheritance to generated mocks #315

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0261032
Add protocol-level @available annotation inheritance to generated mocks
Keitaro0226 Jul 10, 2025
b5cf99e
Merge remote-tracking branch 'upstream/master' into fix-available-ann…
Keitaro0226 Mar 26, 2026
1ff56ed
Fix unintended formatting changes introduced during conflict resolution
Keitaro0226 Mar 26, 2026
d4a41e0
Add tests for protocol-level @available inheritance on Sendable mocks
Keitaro0226 Mar 26, 2026
2fa6c3d
Add availability-gated Sendable fixture coverage
Keitaro0226 Apr 5, 2026
3e51751
Remove redundant ParsedEntity attribute comment
Keitaro0226 Apr 5, 2026
7f3a38b
Fix availability attribute extraction for mock generation
Keitaro0226 Apr 18, 2026
32dffb1
Add availability test for inherited protocols
Keitaro0226 Apr 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Sources/MockoloFramework/Models/ParsedEntity.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,17 @@ struct ResolvedEntity {

func model() -> Model {
let metadata = entity.metadata
// Combine protocol-level attributes with member-level attributes
Copy link
Copy Markdown
Collaborator

@sidepelican sidepelican Apr 2, 2026

Choose a reason for hiding this comment

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

Suggested change
// Combine protocol-level attributes with member-level attributes

The meaning feels a bit off and it’s redundant, so let's remove it.

Copy link
Copy Markdown
Author

@Keitaro0226 Keitaro0226 Apr 18, 2026

Choose a reason for hiding this comment

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

Fixed in 3e51751.
Removed the redundant comment.

let protocolLevelAttributes =
entity.entityNode.attributesDescription.isEmpty
? [] : [entity.entityNode.attributesDescription]
let combinedAttributes = protocolLevelAttributes + attributes
return NominalModel(selfType: .init(name: metadata?.nameOverride ?? (key + "Mock")),
namespaces: entity.entityNode.namespaces,
acl: entity.entityNode.accessLevel,
declKindOfMockAnnotatedBaseType: entity.entityNode.declKind,
declKind: inheritsActorProtocol ? .actor : .class,
attributes: attributes,
attributes: combinedAttributes,
offset: entity.entityNode.offset,
inheritedTypeName: (entity.metadata?.module?.withDot ?? "") + key,
genericWhereConstraints: entity.entityNode.genericWhereConstraints,
Expand Down
3 changes: 3 additions & 0 deletions Tests/TestActor/FixtureActor.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@
init() { }
}

@MainActor
/// @mockable
Copy link
Copy Markdown
Collaborator

@sidepelican sidepelican Apr 2, 2026

Choose a reason for hiding this comment

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

It's strange for @mockable to come along too.
How about just inheriting available?
You can change EntityNode.attributesDescription requirement to var attributes: [String] { get }.

Copy link
Copy Markdown
Author

@Keitaro0226 Keitaro0226 Apr 18, 2026

Choose a reason for hiding this comment

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

Fixed in 7f3a38b.
I changed declaration attribute handling to keep syntax attributes as separate entries, so @mockable trivia no longer gets carried along with @available.

@available(iOS 18.0, *)
class P1Mock: P1 {
init() { }
}
Expand Down
36 changes: 36 additions & 0 deletions Tests/TestSendable/FixtureSendable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,4 +208,40 @@
}
}
}

@Fixture enum availableSendableProtocol {
/// @mockable
@available(iOS 18.0, *)
public protocol Foo: Sendable {
func bar() -> String
}
Comment on lines +216 to +220
Copy link
Copy Markdown
Collaborator

@sidepelican sidepelican Apr 2, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

I want to enforce a compilation error when @available isn't applied to a mock.

Suggested change
/// @mockable
@available(iOS 18.0, *)
public protocol Foo: Sendable {
func bar() -> String
}
@available(macOS 99.0, *)
struct Bar {}
/// @mockable
@available(macOS 99.0, *)
protocol Foo: Sendable {
func bar() -> Bar
}

Copy link
Copy Markdown
Author

@Keitaro0226 Keitaro0226 Apr 18, 2026

Choose a reason for hiding this comment

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

Fixed in 2fa6c3d.
I updated the fixture to use an availability-gated return type (Bar) so the generated mock must inherit @available to compile.


@Fixture(includesConcurrencyHelpers: true)
enum expected {
@available(iOS 18.0, *)
public final class FooMock: Foo, @unchecked Sendable {
public init() { }


private let barState = MockoloMutex(MockoloHandlerState<Never, @Sendable () -> String>())
public var barCallCount: Int {
return barState.withLock(\.callCount)
}
public var barHandler: (@Sendable () -> String)? {
get { barState.withLock(\.handler) }
set { barState.withLock { $0.handler = newValue } }
}
public func bar() -> String {
let barHandler = barState.withLock { state in
state.callCount += 1
return state.handler
}
if let barHandler = barHandler {
return barHandler()
}
return ""
}
}
}
Copy link
Copy Markdown
Collaborator

@sidepelican sidepelican Apr 2, 2026

Choose a reason for hiding this comment

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

I need a test case for protocol inheritance scenarios:

@available(macOS 100.0, *)
struct Bar {}

@available(macOS 90.0, *)
protocol Foo {
}

/// @mockable
@available(macOS 100.0, *)
protocol Foo2: Foo {
  var bar: Bar { get set }
}

Copy link
Copy Markdown
Author

@Keitaro0226 Keitaro0226 Apr 18, 2026

Choose a reason for hiding this comment

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

Fixed in 32dffb1.

}
#endif
5 changes: 5 additions & 0 deletions Tests/TestSendable/SendableTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,10 @@ class SendableTests: MockoloTestCase {
verify(srcContent: confirmedSendableProtocol._source,
dstContent: confirmedSendableProtocol.expected._source)
}

func testAvailableSendableProtocol() {
verify(srcContent: availableSendableProtocol._source,
dstContent: availableSendableProtocol.expected._source)
}
}
#endif