Add build phases comparator

[marciniwanicki]

Partially resolves: #17

Describe your changes
Added a new comparator to compare lists of build phases from two projects. The comparison is slightly more complicated to give clear output for most common cases i.e. missing a single build phase in one of the projects, the same build phases but in different order, or different properties in one of the projects.

Testing performed

• CI / unit and integration tests
• Copy an existing project, modify list of build phases in the copy, run xcdiff -p1 <original> -p2 <copy> -g build_phases -v, make sure all the differences are listed.

[codecov]

Codecov Report

Merging #38 into master will increase coverage by 0.19%.
The diff coverage is 97.58%.

@@            Coverage Diff             @@
##           master      #38      +/-   ##
==========================================
+ Coverage   94.82%   95.01%   +0.19%     
==========================================
  Files          39       40       +1     
  Lines        1663     1787     +124     
==========================================
+ Hits         1577     1698     +121     
- Misses         86       89       +3

Impacted Files	Coverage Δ
Sources/XCDiffCore/Library/TargetsHelper.swift	93.37% <ø> (ø)	⬆️
...es/XCDiffCore/Library/Collections+Extensions.swift	83.33% <0%> (-16.67%)	⬇️
Sources/XCDiffCore/ComparatorType.swift	100% <100%> (ø)	⬆️
.../XCDiffCore/Comparator/BuildPhasesComparator.swift	100% <100%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e000640...21bc496. Read the comment docs.

[kwridan]

👍

As a suggestion, to help identify missing build phases we could still offer displaying "only in first" and "only in second"

via:

return result(context: context,
              first: Set(firstDescriptors.map { $0.description }),
              second: Set(secondDescriptors.map { $0.description }),
              differentValues: differentValues)

This would produce:

$ cd Fixtures
$ xcdiff -g build_phases -v

❌ BUILD_PHASES > "MismatchingLibrary" target

⚠️  Only in first (1):

  • name = CopyFiles, type = copyFiles, runOnlyForDeploymentPostprocessing = false


⚠️  Only in second (2):

  • name = Headers, type = headers, runOnlyForDeploymentPostprocessing = false
  • name = Resources, type = resources, runOnlyForDeploymentPostprocessing = false


⚠️  Value mismatch (4):

  • Build Phase 1
    ◦ name = Sources, type = sources, runOnlyForDeploymentPostprocessing = false
    ◦ name = Headers, type = headers, runOnlyForDeploymentPostprocessing = false

  • Build Phase 2
    ◦ name = Frameworks, type = frameworks, runOnlyForDeploymentPostprocessing = false
    ◦ name = Sources, type = sources, runOnlyForDeploymentPostprocessing = false

  • Build Phase 3
    ◦ name = CopyFiles, type = copyFiles, runOnlyForDeploymentPostprocessing = false
    ◦ name = Frameworks, type = frameworks, runOnlyForDeploymentPostprocessing = false

  • Build Phase 4
    ◦ nil
    ◦ name = Resources, type = resources, runOnlyForDeploymentPostprocessing = false


✅ BUILD_PHASES > "Project" target
✅ BUILD_PHASES > "ProjectFramework" target
✅ BUILD_PHASES > "ProjectTests" target
✅ BUILD_PHASES > "ProjectUITests" target

If we go for the onlyInFirst / onlyInSecond maybe we could summarise the value differences?

⚠️  Value mismatch (1):
   • Build Phase Order
    ◦ Sources, Frameworks, CopyFiles
    ◦ Headers, Sources, Frameworks, Resources

Guess there will always be some duplication, what you have is a good start either way to allow us to test this out further.

[kwridan]

👍 Nice work

[kwridan]

minor: the copyright year is now 2020 :p

[kwridan]

👍

[kwridan]

we can add specific copy phase / script phase comparators as follow ups