Added 'pre' and 'post' setup blocks

[colinta]

• easier for gems to add files, because @files is just an empty array at this point
• no default setup is done, so sdk_version and so on can still be set by the user
• pre_setup / setup / post_setup are a good trifecta for a compiler 😃

# in your gem
Motion::Project::App.pre_setup do |app|
  Dir.glob(File.join(File.dirname(__FILE__), 'lib/**/*.rb')).each do |file|
    app.files << file
  end

  # other settings as well, it's still a "good ol' setup block"
  app.libs += ['/usr/lib/libicucore.dylib', '/usr/lib/libc++.dylib']
  app.frameworks += ['CFNetwork', 'Security', 'SystemConfiguration']
  app.weak_frameworks += ['Accounts', 'Social']
end

[colinta]

Also, since post_setup is available, gems could detect system configuration and add/remove files and settings as necessary. For instance, it might be a good place to add cocoapods?

[alloy]

I’m unclear as to why not to check it, especially since you do it after all :)

[colinta]

Oh shoot, I just realized I refactored this in /Library/RubyMotion, and didn't copy that in. I'm gonna push that up (with comments to hopefully answer some of these questions)

[alloy]

Also, since post_setup is available, gems could detect system configuration and add/remove files and settings as necessary. For instance, it might be a good place to add cocoa pods?

Can you elaborate on this? Why should motion-cocoapods use that hook instead? E.g. what config access should it be using?

[colinta]

I didn't mean motion-cocoapots would use that hook. I was imagining something like this:

Motion::Project::App.pre_setup do |app|
  # add my gem files to app.files
end
Motion::Project::App.post_setup do |app|
  installed_pods = app.pods
  # I just went looking for a method that could return true/false for "did they include this cocoapod", but
  # couldn't find one... but if it DID exist, this is what I was imagining:
  unless installed_pods.include?('AFNetworking')
    raise StandardError, 'The AFNetworking library is required for this gem, please add it to your cocoapods'
  end
end

Also, code analyzing tools like dbt are ideal for using the post_setup hook:

Motion::Project::App.post_setup do |app|
  DBT.analyze(app)
end

[colinta]

calling config here is what causes some troubles, because config ends up determining sdk and api versions. For instance, on android, I need to set app.api_version = '19', otherwise I get an error about the "L" SDK not being installed.

Which is fine until I include a gem, which calls setup, which calls config, and goes looking for the api_version. My Rakefile's setup hasn't been called, so it detects the wrong one, and errors out.

[colinta]

Ok, ignore the "controversial" stuff above, this restores the previous behavior, where app.files is set before the Rakefile setup block is called.

[colinta]

Now that I think more on it, the most important features of pre_setup are:

• app.files has not been set to the app/ files, so appending them to the end is safe
• config.setup is not called, and so validate is not called, which prevents the gems from inadvertently causing errors

[colinta]

Btw, @alloy, when I was looking through cocoapods code, I noticed this line: https://github.com/HipByte/motion-cocoapods/blob/master/lib/motion/project/cocoapods.rb#L74

This assumes App.template will be something sane, like :ios or :osx, but with extensions this template can also be :ios_extension and other values. Just a heads up on that.

[alloy]

@colinta Do you have an example gem that has been updated to use this so we can easily test and verify it?

[colinta]

Yes, the android branch of sugarcube. It also has a "support" file that adds pre/post setup methods if they're not defined.

On Oct 31, 2014, at 7:21 AM, Eloy Durán [email protected] wrote:

@colinta Do you have an example gem that has been updated to use this so we can easily test and verify it?

—
Reply to this email directly or view it on GitHub.

[jamonholmgren]

I would love to have these methods. 👍