Merge pull request #63 from archaeopterasa/localization_fix

Fixes handling of localized project files
venmo · Jan 1, 2015 · 938eca4 · 938eca4
2 parents cb6a66b + e9dfa3c
commit 938eca4
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 82 deletions.
diff --git a/lib/synx/xcodeproj_ext.rb b/lib/synx/xcodeproj_ext.rb
@@ -4,4 +4,3 @@
 require "synx/xcodeproj_ext/project/object/pbx_group"
 require "synx/xcodeproj_ext/project/object/abstract_object"
 require "synx/xcodeproj_ext/project/object/abstract_target"
-require "synx/xcodeproj_ext/project/object/pbx_variant_group"
diff --git a/lib/synx/xcodeproj_ext/project/object/abstract_object.rb b/lib/synx/xcodeproj_ext/project/object/abstract_object.rb
@@ -8,27 +8,36 @@ def basename
         end
 
         def referring_groups
-          referrers.select { |ref| ref.instance_of?(Xcodeproj::Project::Object::PBXGroup) }
+          referrers.select { |ref| ref.is_a?(Xcodeproj::Project::Object::PBXGroup) }
         end
 
         def work_pathname
-          # hierarchy path has a leading '/' that will break path concatenation
-          @work_pathname ||= project.work_root_pathname + hierarchy_path[1..-1]
+          # Intuitively, we want the work pathname to correspond 1-1 with the
+          # view in the project hierarchy. Xcode's collapsed display of
+          # identically-named localized files causes some complications, leading
+          # to the special cases here.
+          if self.equal?(project.main_group)
+            @work_pathname ||= project.work_root_pathname
+          elsif parent.is_a?(Xcodeproj::Project::Object::PBXVariantGroup)
+            # Localized object, naming is handled differently.
+            @work_pathname ||= parent.work_pathname + "#{display_name}.lproj" + parent.display_name
+          elsif is_a?(Xcodeproj::Project::Object::PBXVariantGroup)
+            # Localized container, has no path of its own.
+            @work_pathname ||= parent.work_pathname
+          else
+            @work_pathname ||= parent.work_pathname + display_name
+          end
         end
 
         def ensure_internal_consistency(group)
           @removed_from_groups = []
-          if referring_groups.count > 1
-            # Files should only have one referring group -- this is an internal consistency issue if there is more than 1.
-            # Just remove all referring groups but the one we're syncing with
-
-            referring_groups.each do |rg|
-              unless rg == group
-                rg.remove_reference(self) unless rg == group
-                @removed_from_groups << rg.hierarchy_path
-              end
+          # Objects should only have one referring group -- this is an internal consistency issue if there is more than 1.
+          # Just remove all referring groups but the one we're passed
+          referring_groups.each do |rg|
+            unless rg == group
+              rg.remove_reference(self)
+              @removed_from_groups << rg.hierarchy_path
             end
-
           end
         end
 

diff --git a/lib/synx/xcodeproj_ext/project/object/pbx_file_reference.rb b/lib/synx/xcodeproj_ext/project/object/pbx_file_reference.rb
@@ -6,10 +6,10 @@ class PBXFileReference
         def sync(group)
           if should_sync?
             if should_move?
-              FileUtils.mv(real_path.to_s, group.work_pathname.to_s)
+              FileUtils.mv(real_path.to_s, work_pathname.to_s)
               # TODO: move out to abstract_object
               self.source_tree = "<group>"
-              self.path = real_path.basename.to_s
+              self.path = work_pathname.relative_path_from(parent.work_pathname).to_s
             else
               # Don't move this file around -- it's not even inside the structure. Just fix the relative reference
               self.path = real_path.relative_path_from((project.work_pathname_to_pathname(group.work_pathname))).to_s

diff --git a/lib/synx/xcodeproj_ext/project/object/pbx_group.rb b/lib/synx/xcodeproj_ext/project/object/pbx_group.rb
@@ -4,17 +4,25 @@ module Object
       class PBXGroup
 
         def sync(group)
-          ensure_internal_consistency(group)
+          ensure_internal_consistency(group) # Make sure we don't belong to any other groups
           if excluded_from_sync?
             Synx::Tabber.puts "#{basename}/ (excluded)".yellow
           else
             Synx::Tabber.puts "#{basename}/".green
             Synx::Tabber.increase
 
             squash_duplicate_file_references
-            work_pathname.mkpath
-            files.each { |pbx_file| pbx_file.sync(self) }
-            all_groups.each { |group| group.sync(self) }
+            # Child directories may not exist yet (and may be different for
+            # each file) if this is a localized group, so we do the mkpath call
+            # inside the loops.
+            files.each do |pbx_file|
+              pbx_file.work_pathname.dirname.mkpath
+              pbx_file.sync(self)
+            end
+            all_groups.each do |group|
+              group.work_pathname.dirname.mkpath
+              group.sync(self)
+            end
             sync_path
 
             Synx::Tabber.decrease
@@ -28,11 +36,10 @@ def excluded_from_sync?
         def move_entries_not_in_xcodeproj
           if excluded_from_sync?
             Synx::Tabber.puts "#{basename}/ (excluded)".yellow
-          else
+          elsif real_path.exist?
             Synx::Tabber.puts "#{basename}/".green
             Synx::Tabber.increase
-            Dir[real_path.to_s + "/{*,.*}"].reject { |e| %W(. ..).include?(Pathname(e).basename.to_s) }.each do |entry|
-              entry_pathname = real_path + entry
+            real_path.children.each do |entry_pathname|
               unless project.has_object_for_pathname?(entry_pathname)
                 handle_unused_entry(entry_pathname)
               end
@@ -43,32 +50,24 @@ def move_entries_not_in_xcodeproj
         end
 
         def sync_path
-          self.path = basename
+          self.path = work_pathname.relative_path_from(parent.work_pathname).to_s
           self.source_tree = "<group>"
         end
         private :sync_path
 
         def all_groups
-          groups | version_groups | variant_groups
-        end
-
-        def variant_groups
-          children.select { |child| child.instance_of?(Xcodeproj::Project::Object::PBXVariantGroup) }
+          children.select { |child| child.is_a?(Xcodeproj::Project::Object::PBXGroup)}
         end
-        private :variant_groups
 
         def handle_unused_entry(entry_pathname)
           entries_to_ignore = %W(.DS_Store)
           unless entries_to_ignore.include?(entry_pathname.basename.to_s)
             if entry_pathname.directory?
-              work_entry_pathname = project.pathname_to_work_pathname(entry_pathname)
-              # The directory may have already been created for one of two reasons
-              # 1. It was created as a piece of another path, ie, /this/middle/directory.mkdir got called.
-              # 2. OS X has case insensitive folder names, so has_object_for_pathname? may have failed to notice it had the folder.
-              work_entry_pathname.mkdir unless work_entry_pathname.exist?
               # recurse
               Synx::Tabber.puts entry_pathname.basename.to_s.green
               Synx::Tabber.increase
+              # Don't create the directory manually: if it has children, it will
+              # be created then, and if it doesn't, we don't want it.
               entry_pathname.children.each { |child| handle_unused_entry(child) }
               Synx::Tabber.decrease
             elsif entry_pathname.file?
@@ -86,7 +85,9 @@ def handle_unused_file(file_pathname)
             Synx::Tabber.puts "#{file_pathname.basename} (removed source/image file that is not referenced by the Xcode project)".red
             return
           elsif !project.prune || !is_file_to_prune
-            FileUtils.mv(file_pathname.realpath, project.pathname_to_work_pathname(file_pathname.parent).realpath)
+            destination = project.pathname_to_work_pathname(file_pathname.parent.realpath)
+            destination.mkpath
+            FileUtils.mv(file_pathname.realpath, destination)
             if is_file_to_prune
               Synx::Tabber.puts "#{file_pathname.basename} (source/image file that is not referenced by the Xcode project)".yellow
             else

diff --git a/lib/synx/xcodeproj_ext/project/object/pbx_variant_group.rb b/lib/synx/xcodeproj_ext/project/object/pbx_variant_group.rb
diff --git a/spec/dummy/dummy.xcodeproj/project.pbxproj b/spec/dummy/dummy.xcodeproj/project.pbxproj
@@ -62,6 +62,7 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		637E22771A5235CE00A08D6A /* de */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = de; path = de.lproj/Localizable.strings; sourceTree = "<group>"; };
 		8C2DEB7D191D3F5C003A1F44 /* ManyFiles.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ManyFiles.h; sourceTree = "<group>"; };
 		8C2DEB7E191D3F5C003A1F44 /* ManyFiles.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ManyFiles.m; sourceTree = "<group>"; };
 		8C2DEB80191D3F68003A1F44 /* Wow.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Wow.h; sourceTree = "<group>"; };
@@ -207,7 +208,7 @@
 		8C848C4E190DB9B300E9727B /* Supporting Files */ = {
 			isa = PBXGroup;
 			children = (
-				8CD2ABF019558D4100341C58 /* en.lproj */,
+				8CD2ABF119558D7800341C58 /* Localizable.strings */,
 				8C848C4F190DB9B300E9727B /* dummy-Prefix.pch */,
 			);
 			name = "Supporting Files";
@@ -227,7 +228,6 @@
 			isa = PBXGroup;
 			children = (
 				8C848C63190DB9B300E9727B /* dummyTests-Info.plist */,
-				8C848C64190DB9B300E9727B /* InfoPlist.strings */,
 				8CE2DA1D19220F7B00D06F5E /* dummyTests-prefix.pch */,
 			);
 			name = "Supporting Files";
@@ -249,14 +249,6 @@
 			name = Resources;
 			sourceTree = "<group>";
 		};
-		8CD2ABF019558D4100341C58 /* en.lproj */ = {
-			isa = PBXGroup;
-			children = (
-				8CD2ABF119558D7800341C58 /* Localizable.strings */,
-			);
-			path = en.lproj;
-			sourceTree = "<group>";
-		};
 		8CDA046219374F15004435A1 /* FolderWithGroupNotLinked */ = {
 			isa = PBXGroup;
 			children = (
@@ -318,6 +310,7 @@
 			hasScannedForEncodings = 0;
 			knownRegions = (
 				en,
+				de,
 			);
 			mainGroup = 8C848C3F190DB9B300E9727B;
 			productRefGroup = 8C848C49190DB9B300E9727B /* Products */;
@@ -389,8 +382,10 @@
 			isa = PBXVariantGroup;
 			children = (
 				8CD2ABF219558D7800341C58 /* en */,
+				637E22771A5235CE00A08D6A /* de */,
 			);
 			name = Localizable.strings;
+			path = en.lproj;
 			sourceTree = "<group>";
 		};
 /* End PBXVariantGroup section */

diff --git a/spec/dummy/dummy/en.lproj/Localizable.strings b/spec/dummy/dummy/en.lproj/Localizable.strings
@@ -5,3 +5,5 @@
   Created by Mark Larsen on 6/21/14.
   Copyright (c) 2014 marklarr. All rights reserved.
 */
+
+"Greeting" = "Hello";
diff --git a/spec/dummy/dummy/en.lproj/de.lproj/Localizable.strings b/spec/dummy/dummy/en.lproj/de.lproj/Localizable.strings
@@ -0,0 +1,9 @@
+/* 
+  Localizable.strings
+  dummy
+
+  Created by Mark Larsen on 6/21/14.
+  Copyright (c) 2014 marklarr. All rights reserved.
+*/
+
+"Greeting" = "Guten Tag";
diff --git a/spec/synx/expected_file_structure.yml b/spec/synx/expected_file_structure.yml
@@ -30,6 +30,8 @@ dummy:
     dummy-Prefix.pch:
     en.lproj:
       Localizable.strings:
+    de.lproj:
+      Localizable.strings:
   dummy.h:
   dummy.m:
   FileNotInXcodeProj.h:

diff --git a/spec/synx/project_spec.rb b/spec/synx/project_spec.rb
@@ -131,7 +131,7 @@ def expected_group_structure
         expected_file_structure_with_removals = expected_file_structure
         expected_file_structure_with_removals["dummy"].except!("image-not-in-xcodeproj.png")
         expected_file_structure_with_removals["dummy"].except!("FileNotInXcodeProj.h")
-        expected_file_structure_with_removals["dummy"]["AlreadySynced"]["FolderNotInXcodeProj"].except!("AnotherFileNotInXcodeProj.h")
+        expected_file_structure_with_removals["dummy"]["AlreadySynced"].except!("FolderNotInXcodeProj")
         verify_file_structure(Pathname(DUMMY_SYNX_TEST_PROJECT_PATH).parent, expected_file_structure_with_removals)
       end