xcunique 0.0.1

data/spec/fixtures/TestProject/TestProjectUITests/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>

data/spec/fixtures/TestProject/TestProjectUITests/TestProjectUITests.swift

@@ -0,0 +1,36 @@
+//
+//  TestProjectUITests.swift
+//  TestProjectUITests
+//
+//  Created by Paul Samuels on 18/12/2015.
+//  Copyright © 2015 Paul Samuels. All rights reserved.
+//
+
+import XCTest
+
+class TestProjectUITests: XCTestCase {
+        
+    override func setUp() {
+        super.setUp()
+        
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+        
+        // In UI tests it is usually best to stop immediately when a failure occurs.
+        continueAfterFailure = false
+        // UI tests must launch the application that they test. Doing this in setup will make sure it happens for each test method.
+        XCUIApplication().launch()
+
+        // In UI tests it’s important to set the initial state - such as interface orientation - required for your tests before they run. The setUp method is a good place to do this.
+    }
+    
+    override func tearDown() {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+        super.tearDown()
+    }
+    
+    func testExample() {
+        // Use recording to get started writing UI tests.
+        // Use XCTAssert and related functions to verify your tests produce the correct results.
+    }
+    
+}

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'xcunique'
+
+require 'minitest/spec'
+require 'minitest/autorun'

data/spec/xcunique/hash_ext_spec.rb

@@ -0,0 +1,36 @@
+require_relative '../spec_helper'
+
+describe Hash do
+  
+  it 'performs a deep duplicate of simple types' do
+    input = {
+      "array"  => [ 1, 2, 3 ],
+      "string" => 'value'
+    }
+    
+    result = input.deep_dup
+    
+    assert_equal input, result
+    refute_equal input.object_id, result.object_id
+    refute_equal input['array'].object_id, result['array'].object_id
+  end
+  
+  it 'substitutes objects that match in the substitutes hash' do
+    input = {
+      'aaaa'  => [ 1, 2, 3 ],
+      'bbbb' => 'cccc',
+      'dddd' => 'eeee'
+    }
+    
+    expected = {
+      'AAAA'  => [ 1, 2, 3 ],
+      'BBBB' => 'CCCC',
+      'dddd' => 'eeee'
+    }
+    
+    result = input.deep_dup(substitutions: { 'aaaa' => 'AAAA', 'bbbb' => 'BBBB', 'cccc' => 'CCCC' })
+    
+    assert_equal expected, result
+  end
+  
+end

data/spec/xcunique/helpers_spec.rb

@@ -0,0 +1,58 @@
+require_relative '../spec_helper'
+
+describe Xcunique::Helpers do
+  
+  it "returns an empty string if no name, path or fileRef are found" do
+    objects = {
+      'aaaa' => {}
+    }
+    
+    assert_equal '', Xcunique::Helpers.resolve_attributes('aaaa', objects)
+  end
+  
+  it 'returns the name if found on the object' do
+    objects = {
+      'aaaa' => {
+        'name' => 'Test'
+      }
+    }
+    
+    assert_equal "(name: 'Test')", Xcunique::Helpers.resolve_attributes('aaaa', objects)
+  end
+  
+  it 'returns the path if found on the object' do
+    objects = {
+      'aaaa' => {
+        'path' => 'Test'
+      }
+    }
+    
+    assert_equal "(path: 'Test')", Xcunique::Helpers.resolve_attributes('aaaa', objects)
+  end
+  
+  it 'returns the name and path if found on the object' do
+    objects = {
+      'aaaa' => {
+        'name' => 'Test',
+        'path' => 'Test'
+      }
+    }
+    
+    assert_equal "(name: 'Test', path: 'Test')", Xcunique::Helpers.resolve_attributes('aaaa', objects)
+  end
+  
+  it 'resolves the fileRef if there is one' do
+    objects = {
+      'aaaa' => {
+        'fileRef' => 'bbbb'
+      },
+      'bbbb' => {
+        'name' => 'Test',
+        'path' => 'Test'
+      }
+    }
+    
+    assert_equal "(name: 'Test', path: 'Test')", Xcunique::Helpers.resolve_attributes('aaaa', objects)
+  end
+  
+end

data/spec/xcunique/parser_spec.rb

@@ -0,0 +1,214 @@
+require_relative '../spec_helper'
+
+describe Xcunique::Parser do
+  
+  before do
+    @project = JSON.load(File.open(File.expand_path('../fixtures/TestProject.json', __dir__)))
+    @parser  = Xcunique::Parser.new(@project)
+  end
+  
+  let(:root_uuid)  { @project['rootObject']                      }
+  let(:main_group) { @project['objects'][root_uuid]['mainGroup'] }
+  
+  it 'correctly parses files and groups' do
+    
+    @parser.parse object: main_group
+    
+    result = @parser.visited
+    
+    expectations = {
+      
+      # ├── Project
+      "/PBXGroup" => 'DACE56891C24A14C00E6ABB0',
+      
+      # ├── TestProject
+      #    ├── Products
+      #    ├── TestProject
+      #    ├── TestProjectTests
+      #    ├── TestProjectUITests
+      "/PBXGroup/PBXGroup(name: 'Products')"           => 'DACE56931C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')"        => 'DACE56941C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProjectTests')"   => 'DACE56A91C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProjectUITests')" => 'DACE56B41C24A14D00E6ABB0',
+      
+      # ├── TestProject
+      # │   ├── AppDelegate.swift
+      # │   ├── Assets.xcassets
+      # │   ├── Base.lproj
+      # │   │   ├── LaunchScreen.storyboard
+      # │   │   └── Main.storyboard
+      # │   ├── Info.plist
+      # │   └── ViewController.swift
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXFileReference(path: 'AppDelegate.swift')"                                                                                 => 'DACE56951C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXFileReference(path: 'Assets.xcassets')"                                                                                   => 'DACE569C1C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXVariantGroup(name: 'LaunchScreen.storyboard')"                                                                            => 'DACE569E1C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXVariantGroup(name: 'LaunchScreen.storyboard')/PBXFileReference(name: 'Base', path: 'Base.lproj/LaunchScreen.storyboard')" => 'DACE569F1C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXVariantGroup(name: 'Main.storyboard')"                                                                                    => 'DACE56991C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXVariantGroup(name: 'Main.storyboard')/PBXFileReference(name: 'Base', path: 'Base.lproj/Main.storyboard')"                 => 'DACE569A1C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXFileReference(path: 'Info.plist')"                                                                                        => 'DACE56A11C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProject')/PBXFileReference(path: 'ViewController.swift')"                                                                              => 'DACE56971C24A14D00E6ABB0',
+      
+      # ├── TestProject
+      #    ├── TestProjectTests
+      #    │   ├── Info.plist
+      #    │   └── TestProjectTests.swift
+      "/PBXGroup/PBXGroup(path: 'TestProjectTests')/PBXFileReference(path: 'Info.plist')"             => 'DACE56AC1C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProjectTests')/PBXFileReference(path: 'TestProjectTests.swift')" => 'DACE56AA1C24A14D00E6ABB0',
+      
+      # ├── TestProject
+      #    └── TestProjectUITests
+      #       ├── Info.plist
+      #       └── TestProjectUITests.swift
+      "/PBXGroup/PBXGroup(path: 'TestProjectUITests')/PBXFileReference(path: 'Info.plist')"               => 'DACE56B71C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(path: 'TestProjectUITests')/PBXFileReference(path: 'TestProjectUITests.swift')" => 'DACE56B51C24A14D00E6ABB0',
+      
+      # ├── TestProject
+      #    └── Products
+      #       ├── TestProject.app
+      "/PBXGroup/PBXGroup(name: 'Products')/PBXFileReference(path: 'TestProject.app')"           => 'DACE56921C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(name: 'Products')/PBXFileReference(path: 'TestProjectTests.xctest')"   => 'DACE56A61C24A14D00E6ABB0',
+      "/PBXGroup/PBXGroup(name: 'Products')/PBXFileReference(path: 'TestProjectUITests.xctest')" => 'DACE56B11C24A14D00E6ABB0',
+    }
+    
+    expectations.each do |path, uuid|
+      assert_equal path, result[uuid]
+    end
+    
+    assert_equal [], result.keys - expectations.values
+    
+  end
+  
+  it 'correctly parses the remaining project objects' do
+    
+    @parser.parse(object: main_group)
+    files_and_groups = @parser.visited.keys
+    
+    @parser.parse(object: root_uuid)
+    result = @parser.visited.reject { |key, _| files_and_groups.include?(key) }
+    
+    expectations = {
+      
+      # ├── mainGroup
+      "/PBXProject" => "DACE568A1C24A14C00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── ProjectConfigurations
+      #       ├── Debug
+      #       ├── Release
+      "/PBXProject/XCConfigurationList"                                       => "DACE568D1C24A14C00E6ABB0",
+      "/PBXProject/XCConfigurationList/XCBuildConfiguration(name: 'Debug')"   => "DACE56B81C24A14D00E6ABB0",
+      "/PBXProject/XCConfigurationList/XCBuildConfiguration(name: 'Release')" => "DACE56B91C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProject
+      #       └── Configurations
+      #          ├── Debug
+      #          ├── Release
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')"                                                           => "DACE56911C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/XCConfigurationList"                                       => "DACE56BA1C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/XCConfigurationList/XCBuildConfiguration(name: 'Debug')"   => "DACE56BB1C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/XCConfigurationList/XCBuildConfiguration(name: 'Release')" => "DACE56BC1C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProject
+      #       └── Build Sources
+      #          ├── ViewController.swift
+      #          ├── AppDelegate.swift
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXSourcesBuildPhase"                                            => "DACE568E1C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXSourcesBuildPhase/PBXBuildFile(path: 'ViewController.swift')" => "DACE56981C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXSourcesBuildPhase/PBXBuildFile(path: 'AppDelegate.swift')"    => "DACE56961C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProject
+      #       └── Copy Frameworks
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXFrameworksBuildPhase" => "DACE568F1C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProject
+      #       └── Copy Resources
+      #          ├── LaunchScreen.storyboard
+      #          ├── Assets.xcassets
+      #          ├── Main.storyboard
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXResourcesBuildPhase"                                               => "DACE56901C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXResourcesBuildPhase/PBXBuildFile(name: 'LaunchScreen.storyboard')" => "DACE56A01C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXResourcesBuildPhase/PBXBuildFile(path: 'Assets.xcassets')"         => "DACE569D1C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProject')/PBXResourcesBuildPhase/PBXBuildFile(name: 'Main.storyboard')"         => "DACE569B1C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectTests
+      #       └── Configurations
+      #          ├── Debug
+      #          ├── Release
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')"                                                           => "DACE56A51C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/XCConfigurationList"                                       => "DACE56BD1C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/XCConfigurationList/XCBuildConfiguration(name: 'Debug')"   => "DACE56BE1C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/XCConfigurationList/XCBuildConfiguration(name: 'Release')" => "DACE56BF1C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectTests
+      #       └── Build Sources
+      #          ├── TestProjectTests.swift
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/PBXSourcesBuildPhase"                                              => "DACE56A21C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/PBXSourcesBuildPhase/PBXBuildFile(path: 'TestProjectTests.swift')" => "DACE56AB1C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectTests
+      #       └── Copy Frameworks
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/PBXFrameworksBuildPhase" => "DACE56A31C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectTests
+      #       └── Copy Resources
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/PBXResourcesBuildPhase" => "DACE56A41C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectTests
+      #       └── Dependencies
+      #          ├── TestProject
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/PBXTargetDependency"                       => "DACE56A81C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectTests')/PBXTargetDependency/PBXContainerItemProxy" => "DACE56A71C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectUITests
+      #       └── Configurations
+      #          ├── Debug
+      #          ├── Release
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')"                                                           => "DACE56B01C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/XCConfigurationList"                                       => "DACE56C01C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/XCConfigurationList/XCBuildConfiguration(name: 'Debug')"   => "DACE56C11C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/XCConfigurationList/XCBuildConfiguration(name: 'Release')" => "DACE56C21C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectUITests
+      #       └── Build Sources
+      #          ├── TestProjectUITests.swift
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/PBXSourcesBuildPhase"                                                => "DACE56AD1C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/PBXSourcesBuildPhase/PBXBuildFile(path: 'TestProjectUITests.swift')" => "DACE56B61C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectUITests
+      #       └── Copy Frameworks
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/PBXFrameworksBuildPhase" => "DACE56AE1C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectUITests
+      #       └── Copy Resources
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/PBXResourcesBuildPhase" => "DACE56AF1C24A14D00E6ABB0",
+      
+      # ├── mainGroup
+      #    └── Target = TestProjectUITests
+      #       └── Dependencies
+      #          ├── TestProject
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/PBXTargetDependency" => "DACE56B31C24A14D00E6ABB0",
+      "/PBXProject/PBXNativeTarget(name: 'TestProjectUITests')/PBXTargetDependency/PBXContainerItemProxy" => "DACE56B21C24A14D00E6ABB0"
+    }
+    
+    expectations.each do |path, uuid|
+      assert_equal path, result[uuid]
+    end
+    
+    assert_equal [], result.keys - expectations.values
+    
+  end
+  
+end

data/spec/xcunique/sorter_spec.rb

@@ -0,0 +1,116 @@
+require_relative '../spec_helper'
+
+describe Xcunique::Sorter do
+  
+  describe "when sorting groups" do
+    it "sorts alphabetically by their name" do
+      project = {
+        'objects' => {
+          'PARENT' => { 'children' => [ 'groupB', 'groupA' ] },
+          'groupA' => { 'name' => 'A'  },
+          'groupB' => { 'name' => 'B'  } 
+        }
+      }
+    
+      result = Xcunique::Sorter.new(project).sort
+    
+      assert_equal [ 'groupA', 'groupB' ], result['objects']['PARENT']['children']
+    end
+  
+    it "sorts alphabetically by their path" do
+      project = {
+        'objects' => {
+          'PARENT' => { 'children' => [ 'groupB', 'groupA' ] },
+          'groupA' => { 'path' => 'A'  },
+          'groupB' => { 'path' => 'B'  } 
+        }
+      }
+    
+      result = Xcunique::Sorter.new(project).sort
+    
+      assert_equal [ 'groupA', 'groupB' ], result['objects']['PARENT']['children']
+    end
+    
+    it "sorts alphabetically by their name then path" do
+      project = {
+        'objects' => {
+          'PARENT' => { 'children' => [ 'groupB', 'groupA' ] },
+          'groupA' => { 'name' => 'A', 'path' => 'B'  },
+          'groupB' => { 'name' => 'B', 'path' => 'A'  } 
+        }
+      }
+    
+      result = Xcunique::Sorter.new(project).sort
+    
+      assert_equal [ 'groupA', 'groupB' ], result['objects']['PARENT']['children']
+    end
+  end
+
+  describe "when sorting files" do
+    it "sorts alphabetically by their name" do
+      project = {
+        'objects' => {
+          'PARENT'     => { 'files' => [ 'buildFileB', 'buildFileA' ] },
+          'buildFileA' => { 'isa' => 'PBXBuildFile', 'fileRef' => 'fileA' },
+          'buildFileB' => { 'isa' => 'PBXBuildFile', 'fileRef' => 'fileB' },
+          'fileA'      => { 'name' => 'a.swift'  },
+          'fileB'      => { 'name' => 'b.swift'  }
+        }
+      }
+
+      result = Xcunique::Sorter.new(project).sort
+
+      assert_equal [ 'buildFileA', 'buildFileB' ], result['objects']['PARENT']['files']
+    end
+    
+    it "sorts alphabetically by their path" do
+      project = {
+        'objects' => {
+          'PARENT'     => { 'files' => [ 'buildFileB', 'buildFileA' ] },
+          'buildFileA' => { 'isa' => 'PBXBuildFile', 'fileRef' => 'fileA' },
+          'buildFileB' => { 'isa' => 'PBXBuildFile', 'fileRef' => 'fileB' },
+          'fileA'      => { 'path' => 'a.swift'  },
+          'fileB'      => { 'path' => 'b.swift'  }
+        }
+      }
+
+      result = Xcunique::Sorter.new(project).sort
+
+      assert_equal [ 'buildFileA', 'buildFileB' ], result['objects']['PARENT']['files']
+    end
+    
+    it "sorts alphabetically by their name then path" do
+      project = {
+        'objects' => {
+          'PARENT'     => { 'files' => [ 'buildFileB', 'buildFileA' ] },
+          'buildFileA' => { 'isa' => 'PBXBuildFile', 'fileRef' => 'fileA' },
+          'buildFileB' => { 'isa' => 'PBXBuildFile', 'fileRef' => 'fileB' },
+          'fileA'      => { 'name' => 'a.swift', 'path' => 'b/a.swift'  },
+          'fileB'      => { 'name' => 'b.swift', 'path' => 'a/b.swift'  }
+        }
+      }
+
+      result = Xcunique::Sorter.new(project).sort
+
+      assert_equal [ 'buildFileA', 'buildFileB' ], result['objects']['PARENT']['files']
+    end
+  end
+  
+  describe "when sorting groups and files" do
+    it "sorts groups before files" do
+      project = {
+        'objects' => {
+          'PARENT'     => { 'children' => [ 'buildFileA', 'groupA' ] },
+          'buildFileA' => { 'isa' => 'PBXBuildFile', 'fileRef' => 'fileA' },
+          'groupA'     => { 'isa' => 'PBXGroup', 'name' => 'a' },
+          'fileA'      => { 'name' => 'a' },
+        }
+      }
+      
+      result = Xcunique::Sorter.new(project).sort
+
+      assert_equal [ 'groupA', 'buildFileA' ], result['objects']['PARENT']['children']
+    end
+  end
+
+end