Ruby implementation of xcproj functionality #203

neonichu · 2014-10-07T20:29:07Z

0xced · 2014-10-07T20:44:38Z

lib/xcodeproj/project/xcproj_helper.rb

-          output = `#{command} 2>&1`
-          success = $?.exitstatus.zero?
-          [success, output]
+        XCODE_PATH = Pathname.new('/Applications/Xcode.app/Contents')


Hardcoding the Xcode path is not good. In my /Applications directory, I have

Xcode4.app

Xcode502.app

Xcode511.app

Xcode6.app

Xcode61.app

but no Xcode.app.

Agreed. I always like using xcode-select -p for this purpose

alloy · 2014-10-08T10:29:37Z

Awesome work!

Be sure to take a look at this comment, though: #199 (comment)

alloy · 2014-10-08T10:30:20Z

lib/xcodeproj/project/xcproj_helper.rb

+          $stderr.reopen orig_stderr
+        end
+        retval
+      end


What type of output is this actually silencing? Can you paste an example?

Lots of load errors for plugins, because we are initialising the IDE without actually being the IDE.

neonichu · 2014-10-08T10:34:48Z

@alloy it doesn't write, though, it just touches, so it felt more appropriate to have it keep the existing API.

alloy · 2014-10-08T10:37:05Z

@alloy it doesn't write, though, it just touches, so it felt more appropriate to have it keep the existing API.

What I gathered from the discussions with @0xced is that that approach is the only way that we are vulnerable to the unicode character crippling bug. i.e. we should skip the XML plist completely where possible and write to ASCII immediately.

alloy · 2014-10-08T10:40:32Z

And regardless of immediately vs touching, there need to be safeguards against not finding the frameworks, not being able to dlopen them, symbols not being found, and runtime errors, so that we can gracefully fallback.

neonichu · 2014-10-08T10:45:05Z

Oh yes, totally - this is just an initial step.

As for directly writing, I don't see how we could do that without completely relying on a PBXProject instance for reading, which would be a much more massive endeavour.

0xced · 2014-10-08T10:53:53Z

There is no need to rely on PBXProject for reading, this work is already done. The RubyHashPropertyListWrite method should just be changed to this (pseudo code):

RubyHashPropertyListWrite(hash, path)
  plist = RubyHashToCFDictionary(hash)
  data = objc_msgSend(plist, sel_registerName("plistDescriptionUTF8Data")) # whatever the syntax is with fiddle
  write `data` (with whatever conversion is needed from NSData) to `path`

neonichu · 2014-10-08T10:55:39Z

@0xced awesome 👍

alloy · 2014-10-08T10:57:01Z

Right, that’s the version I meant. Thanks, @0xced.

Except of course that RubyHashPropertyListWrite shouldn’t be modified, as it should be the version that we fallback to when all else with private APIs fail.

neonichu · 2014-10-08T11:02:54Z

So I'd say we actually put this into PlistHelper as another strategy, as initially proposed in @alloy's comment. Do we get rid off XCProjHelper entirely, or still keep it around for cases where our internal writing fails, but xcproj might succeed?

alloy · 2014-10-08T11:04:19Z

So I'd say we actually put this into PlistHelper as another strategy, as initially proposed in @alloy's comment.

👍

Do we get rid off XCProjHelper entirely, or still keep it around for cases where our internal writing fails, but xcproj might succeed?

I think we can get rid of it completely. The chance of one working but the other failing is slim afaik and only means more code in our codebase.

kylef · 2014-10-13T15:20:38Z

lib/xcodeproj/plist_helper.rb

+        instance,
+        CoreFoundation.NSSelectorFromString(CoreFoundation.RubyStringToCFString('respondsToSelector:')),
+        selector)
+      result == CoreFoundation::TRUE ? true : false


CoreFoundation.CFBooleanToRubyBoolean(result)

That's actually not a CFBoolean, just a BOOL

kylef · 2014-11-07T13:51:06Z

This needs a rebase before it can be merged.

segiddins · 2014-12-27T17:01:47Z

@neonichu @alloy @kylef should this go into 0.36 or no?

segiddins · 2015-01-12T02:03:05Z

@neonichu ping

neonichu · 2015-01-12T09:22:00Z

@segiddins IDK, seems to me that there is little interest in merging this, so probably should just be closed.

kylef · 2015-01-12T15:40:00Z

@neonichu There is certainly interest in getting this into master. We've been waiting for you to rebase this branch before it's even mergable.

Along with addressing the outstanding comments.

segiddins · 2015-01-12T16:55:04Z

Well done @neonichu! Let's review this one more time, and then get this into the final 0.36 release!

neonichu · 2015-01-12T16:58:12Z

@kylef sorry, I thought I had done that already, but turns out I merged master into this instead of doing a rebase. ¯_(ツ)_/¯

kylef · 2015-01-24T17:56:52Z

lib/xcodeproj/plist_helper.rb

@@ -70,6 +76,24 @@ def file_in_conflict?(path)
      ensure
        file.close
      end
+
+      def ruby_hash_write_xcode(hash, path)


@neonichu Could you add some documentation to this stating which type this method expects. I.e, path being a pathname or string etc.

- Moved implementation to `PlistHelper` - Deleted all references to `xcproj` - Added a spec for testing emoji in Xcode projects - Deliberately fall back to XML writing for some specs

…re not present.

Possible cases: - Xcode is not installed at all - User hasn't agreed to the license

Ruby implementation of xcproj functionality

neonichu · 2015-01-31T22:20:03Z

orta · 2015-01-31T22:23:59Z

awesome

coveralls · 2016-04-13T10:10:43Z

Changes Unknown when pulling 5fb3e42 on pbxproject-write-💥 into * on master*.

0xced reviewed Oct 7, 2014
View reviewed changes

alloy mentioned this pull request Oct 8, 2014

RuntimeError - Unable to convert the ... project.pbxproj` plist file to XML: #204

Closed

alloy reviewed Oct 8, 2014
View reviewed changes

neonichu mentioned this pull request Oct 10, 2014

"Check Pods Manifest.lock" fails in 0.34.2 (PODS_ROOT) CocoaPods/CocoaPods#2627

Closed

kylef reviewed Oct 13, 2014
View reviewed changes

alloy mentioned this pull request Oct 18, 2014

Explore the use of fiddle to save ASCII plists using Xcode frameworks #199

Closed

neonichu force-pushed the pbxproject-write-💥 branch 2 times, most recently from 1c58a7f to 1fd9cbb Compare January 12, 2015 16:49

kylef self-assigned this Jan 16, 2015

kylef reviewed Jan 24, 2015
View reviewed changes

neonichu and others added 19 commits January 31, 2015 23:05

Ruby implementation of xcproj functionality.

0cc35ad

Use xcode-select -p to determine path.

0024cb3

Rename function to be more descriptive.

0924057

Fix determining the Xcode path.

421bec0

Added some error handling.

119a1fd

Directly write ASCII plists using DevToolsCore.

18d0fa0

- Moved implementation to `PlistHelper` - Deleted all references to `xcproj` - Added a spec for testing emoji in Xcode projects - Deliberately fall back to XML writing for some specs

Do not write schemes as ASCII.

9ebad88

Test expects XML, so let's give it that.

5453d0c

Bools will not be retained in ASCII plists.

7374259

[PlistHelper] Load private frameworks for both Xcode 5 and 6.

b7ac051

Xcode ¯\_(ツ)_/¯

5cdf21c

Use respondsToSelector: before calling PBXProject methods.

fb91c30

Ensure fallback to XML is used when NSData / NSDictionary selectors a…

f933634

…re not present.

Make RuboCop happy! 🌈

54957a4

Simplify path expansion.

0daab67

[Rubocop] Removed empty lines from specs.

38a088d

Removed no longer valid spec.

11956f8

[Spec] Ensure fallback if Xcode path is unknown.

63104fa

Possible cases: - Xcode is not installed at all - User hasn't agreed to the license

[Documentation] Documented ruby_hash_write_xcode

0525ef1

neonichu force-pushed the pbxproject-write-💥 branch from 5dacc71 to 0525ef1 Compare January 31, 2015 22:08

[Changelog] Usage DVTFoundation.framework

5fb3e42

kylef added a commit that referenced this pull request Jan 31, 2015

Merge pull request #203 from CocoaPods/pbxproject-write-💥

3e1c0c7

Ruby implementation of xcproj functionality

kylef merged commit 3e1c0c7 into master Jan 31, 2015

kylef deleted the pbxproject-write-💥 branch January 31, 2015 22:19

neonichu mentioned this pull request Jan 31, 2015

Reading and saving a project with Xcodeproj breaks emoji characters in the project #196

Closed

coveralls unassigned kylef Apr 13, 2016

devxoul referenced this pull request in CocoaPods/guides.cocoapods.org Jun 16, 2016

[FAQ] CocoaPods now saves ASCII plists

fda8c30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ruby implementation of xcproj functionality #203

Ruby implementation of xcproj functionality #203

neonichu commented Oct 7, 2014

0xced Oct 7, 2014

segiddins Oct 7, 2014

alloy commented Oct 8, 2014

alloy Oct 8, 2014

neonichu Oct 8, 2014

neonichu commented Oct 8, 2014

alloy commented Oct 8, 2014

alloy commented Oct 8, 2014

neonichu commented Oct 8, 2014

0xced commented Oct 8, 2014

neonichu commented Oct 8, 2014

alloy commented Oct 8, 2014

neonichu commented Oct 8, 2014

alloy commented Oct 8, 2014

kylef Oct 13, 2014

neonichu Oct 13, 2014

kylef commented Nov 7, 2014

segiddins commented Dec 27, 2014

segiddins commented Jan 12, 2015

neonichu commented Jan 12, 2015

kylef commented Jan 12, 2015

segiddins commented Jan 12, 2015

neonichu commented Jan 12, 2015

kylef Jan 24, 2015

neonichu commented Jan 31, 2015

orta commented Jan 31, 2015

coveralls commented Apr 13, 2016

Ruby implementation of xcproj functionality #203

Ruby implementation of xcproj functionality #203

Conversation

neonichu commented Oct 7, 2014

0xced Oct 7, 2014

Choose a reason for hiding this comment

segiddins Oct 7, 2014

Choose a reason for hiding this comment

alloy commented Oct 8, 2014

alloy Oct 8, 2014

Choose a reason for hiding this comment

neonichu Oct 8, 2014

Choose a reason for hiding this comment

neonichu commented Oct 8, 2014

alloy commented Oct 8, 2014

alloy commented Oct 8, 2014

neonichu commented Oct 8, 2014

0xced commented Oct 8, 2014

neonichu commented Oct 8, 2014

alloy commented Oct 8, 2014

neonichu commented Oct 8, 2014

alloy commented Oct 8, 2014

kylef Oct 13, 2014

Choose a reason for hiding this comment

neonichu Oct 13, 2014

Choose a reason for hiding this comment

kylef commented Nov 7, 2014

segiddins commented Dec 27, 2014

segiddins commented Jan 12, 2015

neonichu commented Jan 12, 2015

kylef commented Jan 12, 2015

segiddins commented Jan 12, 2015

neonichu commented Jan 12, 2015

kylef Jan 24, 2015

Choose a reason for hiding this comment

neonichu commented Jan 31, 2015

orta commented Jan 31, 2015

coveralls commented Apr 13, 2016