Added Subspec for Diffing #368

Sherlouk · 2016-12-24T10:49:33Z

Changes in this pull request

So the main Podspec file now has two Subspecs, Diffing and for lack of better name Default. Diffing is purely the files within the common directories (used for Diffing, if in the future we support MacOS NSCollectionView then this may need changing). Default depends on Diffing but also adds all the non-common files.

To use it via CocoaPods, nothing changes. You import IGListKit and you will only have access to the files in the pod you use. (So if you use IGListKit/Diffing in your Podfile, then you will only get access to the diffing files). If you do a manual installation, or I assume via Carthage, then you will need to import the correct header file (either IGListDiffKit.h or IGListKit.h depending on what you want).

Turns out CocoaPods creates it's own umbrella header (unless you tell it otherwise) meaning our ones are unused by it.

Just to confirm IGListKit in your Podfile will give you everything, only if you add /Diffing will you "opt-out" of the extra functionality. MacOS users can use which ever one they choose, and will get the same functionality (at this point in time)

Do I need to update changelog for this?
Leaving myself a few TODOs once we've discussed this

Create new guide in Guides/ explaining this usage
Run pod install in the Examples/ dir
Closes Add pod subspec for 'IGListKit/Diffing' #365 (Hopefully)
Closes Make diff code available as a separate component #53

Pull request checklist

All tests pass. Demo project builds and runs.
I added tests, an experiment, or detailed why my change isn't tested.
I added an entry to the CHANGELOG.md for any breaking changes, enhancements, or bug fixes.
I have reviewed the contributing guide

coveralls · 2016-12-24T11:00:15Z

Coverage remained the same at 97.978% when pulling db8f9f4 on Sherlouk:podspec into c6b65cf on Instagram:master.

facebook-github-bot · 2016-12-24T11:02:59Z

@Sherlouk updated the pull request - view changes

coveralls · 2016-12-24T11:13:51Z

Coverage remained the same at 97.978% when pulling 8ceff68 on Sherlouk:podspec into c6b65cf on Instagram:master.

facebook-github-bot · 2016-12-24T11:29:00Z

@Sherlouk updated the pull request - view changes

coveralls · 2016-12-24T11:43:49Z

Coverage remained the same at 97.978% when pulling 2f90281 on Sherlouk:podspec into c6b65cf on Instagram:master.

coveralls · 2016-12-24T11:43:49Z

Coverage remained the same at 97.978% when pulling 2f90281 on Sherlouk:podspec into c6b65cf on Instagram:master.

jessesquires · 2016-12-24T17:03:51Z

@Sherlouk

jessesquires

A few follow-ups here:

We'll need to merge Added compatibility header #369 first and rebase this.
Definitely need to note this in the changelog
Let's add Guides/Installation.md to explain and let's link to it at the end of the "Installation" section in the README. ("For advanced usage, see our Installation Guide.")

jessesquires · 2016-12-24T17:09:44Z

Oh, one last thing:

We'll probably need to strip the last commit here (2f90281).

Our importing system chokes on .lock and .xcconfig files. That might break travis, but we'll fixup and run pod install internally before merging.

jessesquires · 2016-12-24T17:11:49Z

One more 😊

I noticed you needed to move IGListKit.h -- we'll need to do that internally too.

I'll do that when I merge #369, so your rebase here is easier.

Sherlouk · 2016-12-24T17:12:41Z

@jessesquires Superb!

I'll revert the last commit and then update documentation, merge 369 whenever and I'll rebase!

Obviously not aware how all your internal stuff works, so apologies for that

This reverts commit 2f90281.

jessesquires · 2016-12-24T17:19:24Z

Obviously not aware how all your internal stuff works

Me either 🤷‍♂️ 😆 I just know it breaks all the time. 😊

facebook-github-bot · 2016-12-24T17:45:00Z

@Sherlouk updated the pull request - view changes

facebook-github-bot · 2016-12-24T17:45:05Z

@Sherlouk updated the pull request - view changes

Sherlouk · 2016-12-24T17:45:40Z

Build will continue to fail now until it has been fully merged as:
1 - I have links to pages that don't yet exist (Advanced Installation guide via the HTML page on Jazzy)
2 - I have reverted the pod install

# Conflicts: # CHANGELOG.md # IGListKit.xcodeproj/project.pbxproj

facebook-github-bot · 2016-12-24T18:54:03Z

@Sherlouk updated the pull request - view changes

Sherlouk · 2016-12-24T18:55:12Z

@jessesquires

All rebased & conflict free!
Changelog updated, Guide added
Tests are working fine locally
Haven't run pod install as requested

Do you want me to update docs, or would you rather do that internally?

coveralls · 2016-12-24T19:07:07Z

Coverage remained the same at 97.978% when pulling 00d2852 on Sherlouk:podspec into 19d4f9d on Instagram:master.

facebook-github-bot · 2016-12-24T19:20:37Z

@Sherlouk updated the pull request - view changes

Sherlouk · 2016-12-24T19:31:46Z

@jessesquires All good!

Interesting bug with the facebook bot though, thinks all the changes were made by me!

jessesquires · 2016-12-24T19:31:49Z

We'll do the pod install and docs internally.

jessesquires · 2016-12-24T19:33:02Z

Source/Common/IGListDiffKit.h

+#import <UIKit/UIKit.h>
+#else
+#import <Cocoa/Cocoa.h>
+#endif


import the new compatibility header?

Sherlouk · 2016-12-24T19:33:46Z

Will update to use compatibility header, also README references wrong file name since rename

jessesquires · 2016-12-24T19:33:58Z

One minor inline comment to fix.

I'll leave your move of IGListKit.h and resolve stuff on our side internally after importing.

facebook-github-bot · 2016-12-24T19:35:37Z

@Sherlouk updated the pull request - view changes

coveralls · 2016-12-24T19:37:58Z

Coverage remained the same at 97.978% when pulling 138c1e7 on Sherlouk:podspec into 19d4f9d on Instagram:master.

Sherlouk · 2016-12-24T19:42:47Z

@jessesquires This also closes #53?

coveralls · 2016-12-24T19:50:43Z

Coverage remained the same at 97.978% when pulling 138c1e7 on Sherlouk:podspec into 19d4f9d on Instagram:master.

coveralls · 2016-12-24T19:57:59Z

Coverage remained the same at 97.978% when pulling 138c1e7 on Sherlouk:podspec into 19d4f9d on Instagram:master.

coveralls · 2016-12-24T20:06:36Z

Coverage remained the same at 97.978% when pulling 138c1e7 on Sherlouk:podspec into 19d4f9d on Instagram:master.

rnystrom · 2016-12-24T20:06:51Z

IGListKit.podspec

-    'Source/Common/Internal/*.h'
-  ]
+  s.subspec 'Default' do |cs|
+    cs.dependency 'IGListKit/Diffing'


rnystrom · 2016-12-24T20:07:49Z

Guides/Installation.md

+
+```ogdl
+github "Instagram/IGListKit" ~> 2.0.0
+```


We can followup w/ manual install steps too

I did have that, but @jessesquires removed it -- not sure reasoning behind that?

Ha, sorry.

Removed because manual installation doesn't really work -- it's not just "drag and drop" because our test target depends on OCMock via CocoaPods.

Probably worth just leaving it out then, I'm sure if you really want to manually install it then you'll be able to work it out -- or ask in the issues

rnystrom · 2016-12-24T20:08:01Z

README.md


 ```ogdl
 github "Instagram/IGListKit" ~> 2.0.0
 ```

+> **For advanced usage, see our [Installation Guide](https://instagram.github.io/IGListKit/installation.html)**.


Could we nix the bold?

rnystrom · 2016-12-24T20:08:26Z

Source/Common/IGListDiffKit.h

+ */
+FOUNDATION_EXPORT const unsigned char IGListKitVersionString[];
+
+// Common (iOS, tvOS, macOS compatible):


nit: can we remove this?

rnystrom · 2016-12-24T20:09:01Z

CHANGELOG.md

@@ -17,6 +17,8 @@ This release closes the [2.1.0 milestone](https://github.com/Instagram/IGListKit

 - Working ranges now work with `IGListStackedSectionController`. [Ryan Nystrom](https://github.com/rnystrom) [(#356)](https://github.com/Instagram/IGListKit/pull/356)

+- Added CocoaPods subspec for diffing, `IGListKit/Diffing` and an [installation guide](https://instagram.github.io/IGListKit/installation.html). [Sherlouk](https://github.com/Sherlouk) [(#368)](https://github.com/Instagram/IGListKit/pull/368)


🔥🔥🔥

facebook-github-bot · 2016-12-24T20:12:01Z

@Sherlouk updated the pull request - view changes

facebook-github-bot · 2016-12-24T20:12:02Z

@Sherlouk updated the pull request - view changes

facebook-github-bot · 2016-12-24T20:12:30Z

@Sherlouk updated the pull request - view changes

coveralls · 2016-12-24T20:21:43Z

Coverage remained the same at 97.978% when pulling 2836ebd on Sherlouk:podspec into 19d4f9d on Instagram:master.

coveralls · 2016-12-24T20:29:55Z

Coverage remained the same at 97.978% when pulling 2836ebd on Sherlouk:podspec into 19d4f9d on Instagram:master.

facebook-github-bot · 2016-12-27T13:59:50Z

@jessesquires has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

facebook-github-bot · 2016-12-27T18:40:21Z

@jessesquires has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

Updated Podspec to include Subspec for Diffing

db8f9f4

facebook-github-bot added the CLA Signed label Dec 24, 2016

Add target membership on new file

8ceff68

Ran pod install to fix build issues

2f90281

jessesquires suggested changes Dec 24, 2016

View reviewed changes

jessesquires modified the milestone: 2.1.0 Dec 24, 2016

Revert "Ran pod install to fix build issues"

c352ba5

This reverts commit 2f90281.

Updated documentation

d2f47d9

Merge remote-tracking branch 'upstream/master' into podspec

00d2852

# Conflicts: # CHANGELOG.md # IGListKit.xcodeproj/project.pbxproj

Update README.md

05970d6

Update Advanced Installation.md

bb614d9

jessesquires reviewed Dec 24, 2016

View reviewed changes

Update to use compatibility header

138c1e7

rnystrom reviewed Dec 24, 2016

View reviewed changes

Sherlouk added 2 commits December 24, 2016 20:11

Update IGListDiffKit.h

5b4dfd0

Update README.md

2836ebd

jessesquires mentioned this pull request Dec 27, 2016

Fix build docs script #373

Closed

jessesquires mentioned this pull request Dec 27, 2016

Add incremental move reporting #342

Closed

3 tasks

facebook-github-bot closed this in 5cd771b Dec 27, 2016

Sherlouk deleted the podspec branch December 27, 2016 20:46

This was referenced Dec 27, 2016

Make diff code available as a separate component #53

Closed

Add pod subspec for 'IGListKit/Diffing' #365

Closed

Sherlouk mentioned this pull request Dec 28, 2016

Changed minimum macOS deployment target to 10.10 #374

Closed

Sherlouk mentioned this pull request Jan 7, 2017

Automate PR checking with Danger #394

Open

12 tasks

		@@ -17,6 +17,8 @@ This release closes the [2.1.0 milestone](https://github.com/Instagram/IGListKit

		- Working ranges now work with `IGListStackedSectionController`. [Ryan Nystrom](https://github.com/rnystrom) [(#356)](https://github.com/Instagram/IGListKit/pull/356)

		- Added CocoaPods subspec for diffing, `IGListKit/Diffing` and an [installation guide](https://instagram.github.io/IGListKit/installation.html). [Sherlouk](https://github.com/Sherlouk) [(#368)](https://github.com/Instagram/IGListKit/pull/368)

Added Subspec for Diffing #368

Added Subspec for Diffing #368

Conversation

Sherlouk commented Dec 24, 2016 • edited by jessesquires Loading

Changes in this pull request

Pull request checklist

coveralls commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

coveralls commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

coveralls commented Dec 24, 2016 • edited Loading

coveralls commented Dec 24, 2016

jessesquires commented Dec 24, 2016

jessesquires left a comment

Choose a reason for hiding this comment

jessesquires commented Dec 24, 2016

jessesquires commented Dec 24, 2016

Sherlouk commented Dec 24, 2016

jessesquires commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

Sherlouk commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

Sherlouk commented Dec 24, 2016

coveralls commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

Sherlouk commented Dec 24, 2016

jessesquires commented Dec 24, 2016

Choose a reason for hiding this comment

Sherlouk commented Dec 24, 2016

jessesquires commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

coveralls commented Dec 24, 2016

Sherlouk commented Dec 24, 2016

coveralls commented Dec 24, 2016

coveralls commented Dec 24, 2016

coveralls commented Dec 24, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

facebook-github-bot commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

facebook-github-bot commented Dec 24, 2016

coveralls commented Dec 24, 2016

coveralls commented Dec 24, 2016

facebook-github-bot commented Dec 27, 2016

facebook-github-bot commented Dec 27, 2016

Sherlouk commented Dec 24, 2016 •

edited by jessesquires

Loading

coveralls commented Dec 24, 2016 •

edited

Loading