Is it possible to generate a diagram from Apple APIs? For example, I would like to generate a diagram for HealthKit types. I'm not sure how to proceed.

Hi,

I've had a problem with generating diagram for my app. It was stuck and nothing happened.

After a while I found a culprit, and it was .h file from RNCryptor ( attachment ). So my suggestion is to either try to fix it, or exclude it and put next to diagram a list of excluded files, so user can see what code files were missed.

RNCryptor.zip

I'm looking at a big project and there's no way to actually read what is being generated.
In Chrome and Safari, I try to zoom with +/- keys and it just gets blurry, as in pictures attached.

I poked around the folder and saw that all of it is in diagram.js... Is this any known/standard format or could it be exported into some kind that I can see anything?

I also unable to run the command ruby generateEntityDiagram.rb.

When I run it the browser window opens in safari and simply sits there. There seems to be an error in the browser console

Generic classes derived from other generic classes do not draw their relationship

Example:
protocol ProtocolF {
associatedtype T
var b1: T? { get }
}

class ClassF<Type,TypeB,TypeC> : ProtocolF {
var b1: Type?
var b2: TypeB?
var b3: TypeC?
}

class ClassG<Type,TypeB,TypeC,TypeD>: ClassF<Type,TypeB,TypeC> {
var b5: Type?
var b6: TypeB?
var b7: TypeC?
var b8: TypeD?
}

If you have *.swift.orig files in a directory, I get issue #13 even parsing 4 files only.

I tried running on the whole project and even separate .swift files but I don't get uml diagrams just connection diagrams.

Am I doing something wrong??

Hi,

is there a way to edit and order diagram? I'm not saying that HTML version should have these options, but it would be nice to export diagram to yEd or StarUML or something? Can you recommend a good ( free if possible ) software for editing, if it can be done?

Thanks.

The execution breaks if the project contains nested classes, e.g.:

class MyClass {
    struct MyStruct {
        static let value = 7
    }   
}

The following error is presented:

/Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:64:in `gsub!': wrong argument type nil (expected Regexp) (TypeError)
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:64:in `block (2 levels) in createEntities'
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:60:in `each'
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:60:in `block in createEntities'
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:55:in `each'
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:55:in `createEntities'
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:13:in `block in entitiesFromFiles'
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:5:in `each'
    from /Users/x-three/Documents/Repositories/swift-auto-diagram/rubyResources/helpers.rb:5:in `entitiesFromFiles'
    from generateEntityDiagram.rb:60:in `<main>'

I can see only classes, is swift 4 supported?

All the extensions are drawn with the name undefined.

function networkLabel(entity) {
if (entity == undefined) {
return "Undefined";
}

return (
"" +
entity.name + //<------------------- The problem is here, the "entity.name" is undefined
":" +
entity.typeString +
"" +
"\n ----------------- \n" +
itemsString(entity.properties) +
"\n ----------------- \n" +
itemsString(entity.methods)
);
}

Would it be possible to sort the classes on horizontal levels instead? I imagine the diagrams would be easier to read and would require less reordering afterwards. In this context, multiple selection of the ordered groups of classes could also be helpful to move around the whole (already tidy) groups by context.

Here an example of a quite untidy diagram with many dependencies to UIViewController:

After reordering in horizontal hierarchy levels, sorted descending by dependency count (not very strictly, just as a quick example):

The algorithm could be roughly: find the class with the most inheritances and place it, then place all protocols below them, then place all inherited classes below (maybe also sorted left to right by dependency count), continue until inheritance ends. Then place next unplaced class with the most inheritances randomly somewhere else on the screen (maybe below) with the same algorithm and so on.

Even if this algorithm wouldn't work on some edge cases, it would already help a lot on big projects.

Hi, first of all, thanks for the idea and this tool, really like it.
As I try to generate my class diagram, I noticed, if I have some IBOutlets in code, like:
@IBOutlet weak var tableview: UITableView! \n @IBOutlet weak var imageView: UIImageView!
the result will be like this:

Two instances with nothing will be generated as you can see, can you pls check it, if you have some time? many thanks!

/.../swift-auto-diagram-master/rubyResources/helpers.rb:6:in `read': Is a directory @ io_fread - /...//Pods/R.swift (Errno::EISDIR) from /.../swift-auto-diagram-master/rubyResources/helpers.rb:6:in `block in entitiesFromFiles' from /.../swift-auto-diagram-master/rubyResources/helpers.rb:5:in `each' from /.../swift-auto-diagram-master/rubyResources/helpers.rb:5:in `entitiesFromFiles' from generateEntityDiagram.rb:61:in `<main>'

Hi Team,

I'm unable to run Swift Class Diagram on my swift project. Upon running the command, the web page with UML diagram isn't opening up.

Also, when I'm trying to run this utility on sample swift project (https://github.com/soapyigu/Swift-30-Projects), this tool isn't giving me the UML diagram, instead only Connection diagram is being returned.

Please advice!

Thanks!

Cc: [email protected]

Hi there,
My codebase is about 9000 lines of code. But it has been more than 15mins and I am seeing the grey circle loading and when I scrolled down, I saw this.

The network seems to be receiving and getting data from the server, lots of them. I am not sure if it should run that long. Can you please address? Thanks!

Come here to say Thank you.

Diagram got generated. But each time when I am trying to open the html file in chrome it takes too much time to load.It is more that 10 minutes.

the tool works great except that all the objects are on top of eachother so its really hard to organize them in a way that makes sense.

While this is very good tool for swift developers, when I ran on Swift5 code, Names of the classes/entities are not displayed.

Image attached.

I have created a demo project with a extension of AppDelegate and some other classes and its extensions, and the script don't show the extensions.

extension AppDelegate {

var some : String {
    return "some"
}

}

class ClassA0 {

var a1 : String?
var a2 : String?

func doItInBase() -> Bool {
    return true
}

}

class ClassA1 : ClassA0 {

var ad1 : String?
var ad2 : String?

override func doItInBase() -> Bool {
    return true
}

}

class ClassB1 {

var b1 : String?
var b2 : String?

}

class ClassC1 : ClassA1 {
override func doItInBase() -> Bool {
return super.doItInBase()
}

}

extension ClassA0 {

var ab1 : String? {
    return nil
}
var ab2 : String? {
    return nil
}

func doItInBase2() -> Bool {
    return true
}
func doItInBase3() -> Bool {
    return true
}

}

extension ClassA1 {

var a1ext1 : String? {
    return nil
}
var a1ext2 : String? {
    return nil
}

}

extension ClassA1 {

var a1ext3 : String? {
    return nil
}
var a1ext4 : String? {
    return nil
}
func doIt() -> Bool {
    return true
}

}

extension ClassB1 {

var b1ext1 : String? {
    return nil
}
var b1ext2 : String? {
    return nil
}

}

extension ClassB1 {

var b1ext3 : String? {
    return nil
}
var b1ext4 : String? {
    return nil
}
func doIt() -> Bool {
    return true
}

}

Command used:
ruby generateEntityDiagram.rb -v /swift-auto-diagram_bug/swift-auto-diagram_bug

Output:

I enter my project but this error comes ruby: No such file or directory what is problem

It would be great to be able to get the result in graphml format to open in graph and diagram viewers viewers like yEd

The script generates a complex diagram with thousands of classes because I'm using several libraries like RxSwift. Is there a way to only display the classes of your own project?

A type with a generic type annotation is not handled correctly (the generic type is not recognised).

For example:

struct STError<T: ErrorKind>: Error, CustomStringConvertible {
    // ...
}

produces this:

When I try to run the script on my project it fails with the following error. can some help me here
Thanks.

Users/abc/Desktop/swift-auto-diagram/rubyResources/helpers.rb:6:in read': Is a directory @ io_fread - /Users/abc/Desktop/gojekRepo/project/projectName/Pods/GRDB.swift (Errno::EISDIR) from /Users/abc/Desktop/swift-auto-diagram/rubyResources/helpers.rb:6:in block in entitiesFromFiles'
from /Users/abc/Desktop/swift-auto-diagram/rubyResources/helpers.rb:5:in each' from /Users/abc/Desktop/swift-auto-diagram/rubyResources/helpers.rb:5:in entitiesFromFiles'
from generateEntityDiagram.rb:59:in `

First of all - I love the idea and really need this tool.
Maybe, I could contribute if you want so and I find the necessary time.
Unfortunately the HTML is completely unsharp when trying to get the diagram for my medium-large project.

A class that conforms to a single protocol only and does not inherit is assumed to inherit from the protocol, which is assumed to be a class.

For example:

class Day: Comparable {
    // ...
}

produces this:

Whereas it should say "conforms to" and "protocol Comparable"

try to generate docs for swift 2.3 project

1. git clone https://github.com/yoshimkd/swift-auto-diagram
2. cd "docs folder/swift-auto-diagram/"
3. ruby generateEntityDiagram.rb '/Users/User/Path/To/Root/Project Folder/'

...

result:

The argument '/Users/andrewskrypnik/Concepter\ Apps/Soul/' is not a directory and does not have a '.swift' extension