Extract default values from Podspec

[jpsim]

Currently, many values have to be passed in to jazzy manually that could be automated. For example:

• author_name
• module_name
• github_url
• github_file_prefix
• author_url

[jpsim]

Parsing priority: .git->*.xcodeproj->*.podspec->.jazzy.yml->ci arguments

[orta]

If you presume that CocoaPods exists on the computer you can use pod ipc spec ARAnalytics.podspec to get a JSON version of the podspec and you can just pick out variables from that. Those commands are not going away as we use them for AppCode / Trunk integration.

[jpsim]

Is the podspec guaranteed to be in ruby? Because if so, wouldn't it be simpler to just parse it straight from jazzy?

[orta]

Not guaranteed but very likely, we do support JSON podspecs. Unless it's coming from the public server/trunk, then its always JSON. You would need to require "cocoapods-core" to do it otherwise, as it needs be be eval'd into an existing object. CocoaDocs does this via the CP API.

Both ways work, depends on if you'd prefer CP as an explicit dependency in code, or as a binary you pipe the podspec through.

[jpsim]

Yeah, I'd probably use cocoapods-core for podspec parsing, and likely Xcodeproj for xcode project/workspace parsing.

[orta]

Then do as cocoadocs does 👍

[jpsim]

Renamed this to just parse podspec. Other features won't be nearly as useful for the majority of projects.

[segiddins]

This will be done in a separate plugin once plugin support is added

[jpsim]

Can you make an issue for that listing the required steps?

[segiddins]

(Plugin support will come very soon. As in, maybe tonight or tomorrow.)

[segiddins]

This will happen over at https://github.com/segiddins/cocoapods-documentation

[jpsim]

Podspec parsing should really be in jazzy itself and not just in a cocoapods plugin (though a cp plugin might be useful too). My goal is that running jazzy in the root of any Swift repo should generate docs for it.

[segiddins]

@jpsim the issue is that to properly parse a podspec requires using the cocoapods gem, which is a huge dependency for jazzy. I think a compromise might be to have jazzy dependent upon the plugin, and, if it is able to require 'cocoapods', then load the builder from the plugin as another command.

[jpsim]

Podspec parsing should just require cocoapods-core, not all of cocoapods

[segiddins]

@jpsim it requires all of CocoaPods to do the downloading and figuring out what the source files are.

[orta]

I think you two are talking about different ideas:
@jpsim is talking about already having a local copy and basing it off an existing podspec file
@segiddins is talking about a true equivalent of pod try xxx for Jazzy I think

[jpsim]

@orta's right about what I'm thinking.

[segiddins]

@jpsim I was going at this from a 'make something that cocoadocs can use' perspective

[orta]

yeah, @jpsim's is the minimum for Jazzy. The DL + setup can be done by CocoaDocs, as it's already being done for stuff anyway.