diff --git a/CHANGELOG.md b/CHANGELOG.md index e52ec76eefa..7529f667c29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,28 @@ +# 121.0.1 + +In this patch release we made some internal improvements to our imports and refined our deprecation policy. + +## Component changes + +### BottomNavigation + +* [Fix imports for MDCBottomNavigationItemView.](https://github.com/material-components/material-components-ios/commit/afe4105debedd8c7b3376b5a37e9beeafb9b368e) (Alyssa Weiss) +* [Remove unused 'kOfAnnouncement' and fix imports.](https://github.com/material-components/material-components-ios/commit/3a4270e82053fec7c215a7a766fdfe6c7f153bae) (Alyssa Weiss) + +### Ripple + +* [Declare parameter type NSArray in the Ripple implementation.](https://github.com/material-components/material-components-ios/commit/73fb0330a6e1b0d6f70a0e50037b255cac1cafba) (Yarden Eitan) + +### TextControls + +* [Fix imports for clang tidy](https://github.com/material-components/material-components-ios/commit/ee7f2fce52de27f59a209cca2f43f7609e6e0172) (Andrew Overton) + +### Typography + +* [UIFont MDC simple equality: updated class docs.](https://github.com/material-components/material-components-ios/commit/274ba189abfb3d8065585b64a67f4d4179996e38) (Randall Li) + +--- + # 121.0.0 In this major release, we added a `scrollViewBounce` property and a `adjustHeightForSafeAreaInsets` property to BottomSheets, added a `shouldAutorotateOverride` property, a `preferredInterfaceOrientationForPresentationOverride` property, a `supportedInterfaceOrientationsOverride` property, and a `modalTransitionStyleOverride` property to MDCAlertController, and converted `progressTintColors` property on MDCProgressView to use light weight generics. diff --git a/MaterialComponents.podspec b/MaterialComponents.podspec index 4c25cae0fbc..c6116117867 100644 --- a/MaterialComponents.podspec +++ b/MaterialComponents.podspec @@ -2,7 +2,7 @@ load 'scripts/generated/icons.rb' Pod::Spec.new do |mdc| mdc.name = "MaterialComponents" - mdc.version = "121.0.0" + mdc.version = "121.0.1" mdc.authors = "The Material Components authors." mdc.summary = "A collection of stand-alone production-ready UI libraries focused on design details." mdc.homepage = "https://github.com/material-components/material-components-ios" diff --git a/MaterialComponentsEarlGreyTests.podspec b/MaterialComponentsEarlGreyTests.podspec index 228d209f678..7b6796d7e72 100644 --- a/MaterialComponentsEarlGreyTests.podspec +++ b/MaterialComponentsEarlGreyTests.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = "MaterialComponentsEarlGreyTests" - s.version = "121.0.0" + s.version = "121.0.1" s.authors = "The Material Components authors." s.summary = "This spec is an aggregate of all the Material Components EarlGrey tests." s.description = "This spec is made for use in the MDC Catalog." diff --git a/MaterialComponentsExamples.podspec b/MaterialComponentsExamples.podspec index 1b4f4dcfe5d..20cfe8c6e17 100644 --- a/MaterialComponentsExamples.podspec +++ b/MaterialComponentsExamples.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = "MaterialComponentsExamples" - s.version = "121.0.0" + s.version = "121.0.1" s.authors = "The Material Components authors." s.summary = "This spec is an aggregate of all the Material Components examples." s.description = "This spec is made for use in the MDC Catalog. Used in conjunction with CatalogByConvention we create our Material Catalog." diff --git a/MaterialComponentsSnapshotTests.podspec b/MaterialComponentsSnapshotTests.podspec index 298de0b76b1..a8824d74fec 100644 --- a/MaterialComponentsSnapshotTests.podspec +++ b/MaterialComponentsSnapshotTests.podspec @@ -53,7 +53,7 @@ end Pod::Spec.new do |s| s.name = "MaterialComponentsSnapshotTests" - s.version = "121.0.0" + s.version = "121.0.1" s.authors = "The Material Components authors." s.summary = "This spec is an aggregate of all the Material Components snapshot tests." s.homepage = "https://github.com/material-components/material-components-ios" diff --git a/VERSION b/VERSION index 58326d9a847..6529f0010e2 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -121.0.0 +121.0.1 diff --git a/catalog/MDCCatalog/Info.plist b/catalog/MDCCatalog/Info.plist index 9b267e8fa46..dca3de28c52 100644 --- a/catalog/MDCCatalog/Info.plist +++ b/catalog/MDCCatalog/Info.plist @@ -15,11 +15,11 @@ CFBundlePackageType APPL CFBundleShortVersionString - 121.0.0 + 121.0.1 CFBundleSignature ???? CFBundleVersion - 121.0.0 + 121.0.1 LSRequiresIPhoneOS UIAppFonts diff --git a/catalog/MDCDragons/Info.plist b/catalog/MDCDragons/Info.plist index 602c55f4cf7..edba32531e1 100644 --- a/catalog/MDCDragons/Info.plist +++ b/catalog/MDCDragons/Info.plist @@ -15,9 +15,9 @@ CFBundlePackageType APPL CFBundleShortVersionString - 121.0.0 + 121.0.1 CFBundleVersion - 121.0.0 + 121.0.1 LSRequiresIPhoneOS UILaunchStoryboardName diff --git a/catalog/MaterialCatalog/MaterialCatalog.podspec b/catalog/MaterialCatalog/MaterialCatalog.podspec index 44de03e3058..f660776b56b 100644 --- a/catalog/MaterialCatalog/MaterialCatalog.podspec +++ b/catalog/MaterialCatalog/MaterialCatalog.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = "MaterialCatalog" - s.version = "121.0.0" + s.version = "121.0.1" s.summary = "Helper Objective-C classes for the MDC catalog." s.description = "This spec is made for use in the MDC Catalog." s.homepage = "https://github.com/material-components/material-components-ios" diff --git a/components/BottomNavigation/src/MDCBottomNavigationBar.m b/components/BottomNavigation/src/MDCBottomNavigationBar.m index cae1b68ee90..0a8548c31f5 100644 --- a/components/BottomNavigation/src/MDCBottomNavigationBar.m +++ b/components/BottomNavigation/src/MDCBottomNavigationBar.m @@ -16,6 +16,8 @@ #import "MDCBottomNavigationBar.h" +#import "MaterialElevation.h" +#import "MaterialInk.h" #import #import "private/MDCBottomNavigationBar+Private.h" @@ -41,8 +43,6 @@ static const CGFloat kBarHeightAdjacentTitle = 40; static const CGFloat kItemsHorizontalMargin = 12; -static NSString *const kOfAnnouncement = @"of"; - @interface MDCBottomNavigationBar () diff --git a/components/BottomNavigation/src/private/MDCBottomNavigationItemView.m b/components/BottomNavigation/src/private/MDCBottomNavigationItemView.m index 77208bd1c35..091e937a3ac 100644 --- a/components/BottomNavigation/src/private/MDCBottomNavigationItemView.m +++ b/components/BottomNavigation/src/private/MDCBottomNavigationItemView.m @@ -15,9 +15,10 @@ #import "MDCBottomNavigationItemView.h" +#import "MaterialInk.h" +#import "MaterialRipple.h" #import -#import "MaterialAvailability.h" #import "MDCBottomNavigationBar.h" #import "MDCBottomNavigationItemBadge.h" diff --git a/components/LibraryInfo/src/MDCLibraryInfo.m b/components/LibraryInfo/src/MDCLibraryInfo.m index a47df200e8c..4a8c4dacc7a 100644 --- a/components/LibraryInfo/src/MDCLibraryInfo.m +++ b/components/LibraryInfo/src/MDCLibraryInfo.m @@ -19,7 +19,7 @@ // This string is updated automatically as a part of the release process and should not be edited // manually. Do not rename this constant or change the formatting without updating the release // scripts. -static NSString* const kMDCLibraryInfoVersionString = @"121.0.0"; +static NSString* const kMDCLibraryInfoVersionString = @"121.0.1"; @implementation MDCLibraryInfo diff --git a/components/LibraryInfo/tests/unit/LibraryInfoTests.m b/components/LibraryInfo/tests/unit/LibraryInfoTests.m index fbddfa4e75b..db03008f064 100644 --- a/components/LibraryInfo/tests/unit/LibraryInfoTests.m +++ b/components/LibraryInfo/tests/unit/LibraryInfoTests.m @@ -26,7 +26,7 @@ - (void)testVersionFormat { // Given // This regex pattern does the following: - // Accept: "121.0.0", etc. + // Accept: "121.0.1", etc. // Reject: "0.0.0", "1.2", "1", "-1.2.3", "Hi, I'm a version 1.2.3", "1.2.3 is my version", etc. // // Note the major version must be >= 1 since "0.0.0" is used as the version when something goes diff --git a/components/Ripple/src/MDCRippleView.m b/components/Ripple/src/MDCRippleView.m index c815f4e9ceb..32124af81dc 100644 --- a/components/Ripple/src/MDCRippleView.m +++ b/components/Ripple/src/MDCRippleView.m @@ -88,7 +88,7 @@ - (void)traitCollectionDidChange:(UITraitCollection *)previousTraitCollection { - (void)layoutSublayersOfLayer:(CALayer *)layer { [super layoutSublayersOfLayer:layer]; - NSArray *sublayers = self.layer.sublayers; + NSArray *sublayers = self.layer.sublayers; if (sublayers.count > 0) { [self updateRippleStyle]; } diff --git a/components/TextControls/src/BaseTextFields/MDCBaseTextField.m b/components/TextControls/src/BaseTextFields/MDCBaseTextField.m index 6a65654bb3d..4d279a152b2 100644 --- a/components/TextControls/src/BaseTextFields/MDCBaseTextField.m +++ b/components/TextControls/src/BaseTextFields/MDCBaseTextField.m @@ -16,6 +16,8 @@ #import +#import "MaterialTextControls+Enums.h" +#import "MDCTextControlAssistiveLabelDrawPriority.h" #import #import "MDCBaseTextFieldDelegate.h" diff --git a/components/TextControls/tests/snapshot/MDCBaseTextFieldSnapshotTests.m b/components/TextControls/tests/snapshot/MDCBaseTextFieldSnapshotTests.m index 705e8987302..c415460b214 100644 --- a/components/TextControls/tests/snapshot/MDCBaseTextFieldSnapshotTests.m +++ b/components/TextControls/tests/snapshot/MDCBaseTextFieldSnapshotTests.m @@ -16,8 +16,6 @@ #import -#import "MaterialTextControls+FilledTextFieldsTheming.h" -#import "MaterialTextControls+OutlinedTextFieldsTheming.h" #import "supplemental/MDCBaseTextFieldTestsSnapshotTestHelpers.h" #import "supplemental/MDCTextControlSnapshotTestHelpers.h" diff --git a/components/TextControls/tests/snapshot/MDCFilledTextFieldSnapshotTests.m b/components/TextControls/tests/snapshot/MDCFilledTextFieldSnapshotTests.m index 5a7f3a0e680..17a44e55d61 100644 --- a/components/TextControls/tests/snapshot/MDCFilledTextFieldSnapshotTests.m +++ b/components/TextControls/tests/snapshot/MDCFilledTextFieldSnapshotTests.m @@ -19,8 +19,6 @@ #import "supplemental/MDCBaseTextFieldTestsSnapshotTestHelpers.h" #import "supplemental/MDCTextControlSnapshotTestHelpers.h" #import "MaterialTextControls+FilledTextFields.h" -#import "MaterialTextControls+FilledTextFieldsTheming.h" -#import "MaterialTextControls+OutlinedTextFieldsTheming.h" @interface MDCFilledTextFieldTestsSnapshotTests : MDCSnapshotTestCase @property(strong, nonatomic) MDCFilledTextField *textField; diff --git a/components/TextControls/tests/snapshot/MDCOutlinedTextFieldSnapshotTests.m b/components/TextControls/tests/snapshot/MDCOutlinedTextFieldSnapshotTests.m index 3e45ac71b6a..3ed7a13a73f 100644 --- a/components/TextControls/tests/snapshot/MDCOutlinedTextFieldSnapshotTests.m +++ b/components/TextControls/tests/snapshot/MDCOutlinedTextFieldSnapshotTests.m @@ -18,9 +18,7 @@ #import "supplemental/MDCBaseTextFieldTestsSnapshotTestHelpers.h" #import "supplemental/MDCTextControlSnapshotTestHelpers.h" -#import "MaterialTextControls+FilledTextFieldsTheming.h" #import "MaterialTextControls+OutlinedTextFields.h" -#import "MaterialTextControls+OutlinedTextFieldsTheming.h" @interface MDCOutlinedTextFieldTestsSnapshotTests : MDCSnapshotTestCase @property(strong, nonatomic) MDCOutlinedTextField *textField; diff --git a/components/TextControls/tests/snapshot/supplemental/MDCBaseTextFieldTestsSnapshotTestHelpers.m b/components/TextControls/tests/snapshot/supplemental/MDCBaseTextFieldTestsSnapshotTestHelpers.m index 7de9ab11dd8..282626ec766 100644 --- a/components/TextControls/tests/snapshot/supplemental/MDCBaseTextFieldTestsSnapshotTestHelpers.m +++ b/components/TextControls/tests/snapshot/supplemental/MDCBaseTextFieldTestsSnapshotTestHelpers.m @@ -17,8 +17,11 @@ #import #import "MaterialTextControls+BaseTextFields.h" +#import "MaterialTextControls+Enums.h" +#import "MaterialTextControls+FilledTextFields.h" +#import "MaterialTextControls+OutlinedTextFields.h" +#import "MaterialTextControls+UnderlinedTextFields.h" #import "MDCTextControlSnapshotTestHelpers.h" -#import "MaterialSnapshot.h" @interface MDCBaseTextField (AnimationDuration) @property(nonatomic, assign) NSTimeInterval animationDuration; diff --git a/components/Typography/src/UIFont+MaterialSimpleEquality.h b/components/Typography/src/UIFont+MaterialSimpleEquality.h index a6dbb281de2..1d4364df15b 100644 --- a/components/Typography/src/UIFont+MaterialSimpleEquality.h +++ b/components/Typography/src/UIFont+MaterialSimpleEquality.h @@ -12,17 +12,11 @@ // See the License for the specific language governing permissions and // limitations under the License. -/** - The Typography component provides methods for getting sized fonts and opacities following Material - style guidelines. - - This header is the umbrella header for the component and should be imported by consumers of the - Typography component. Please do not directly import other headers. This will allow the componet to - expand or contract the header file space without consumer modifications. - */ - #import +/** + This UIFont category provides a shallow equality check. http://www.openradar.appspot.com/28406766 + */ @interface UIFont (MaterialSimpleEquality) /* diff --git a/contributing/deprecation_policy.md b/contributing/deprecation_policy.md index 4bfa20c31c9..a7203942b35 100644 --- a/contributing/deprecation_policy.md +++ b/contributing/deprecation_policy.md @@ -25,14 +25,13 @@ the deprecation process below. ## Our deprecation process (Googlers) 1. Measure internal usage of the API. -2. Create a GitHub issue. -3. Write a migration guide. -4. Add a comment to the API indicating that it will be deprecated. -5. Determine a schedule for the API deletion. -6. Announce that the API will be deprecated -7. After the deprecation date, annotate the API as deprecated. -8. After the deletion date, re-evaluate usage of the API. -9. Delete the API and migration guide. +2. Write a migration guide. +3. Determine a schedule for the API deprecation and deletion. +4. Mark the API as To Be Deprecated. +5. Announce that the API will be deprecated. +6. After the deprecation date, annotate the API as deprecated. +7. After the deletion date, re-evaluate usage of the API. +8. Delete the API and migration guide. ### Step 1: Measure internal usage of the API @@ -40,25 +39,8 @@ Read [go/mdc-ios-measuring-api-usage](http://go/mdc-ios-measuring-api-usage) to API usage internally. If there is zero API usage beyond our own library: skip to step 7 (Deprecate the API). -Otherwise, proceed to step 2. -### Step 2: Create a GitHub issue - -Create a GitHub issue with the following template: - -``` -- [x] Measure internal usage of the API. -- [x] Create a GitHub issue. -- [ ] Write a migration guide. -- [ ] Add a comment to the API indicating that it will be deprecated. -- [ ] Determine a schedule for the API deletion. -- [ ] Announce that the API will be deprecated -- [ ] After the deprecation date, annotate the API as deprecated. -- [ ] After the deletion date, re-evaluate usage of the API. -- [ ] Delete the API and migration guide. -``` - -### Step 3: Write a migration guide +### Step 2: Write a migration guide This guide should be placed in the component's docs/ folder and have a prefix `migration-guide-`. @@ -67,41 +49,7 @@ MDCAppBarViewController. Send this migration guide out for review as a standalone pull request. -### Step 4: Add a comment to the API indicating that it will be deprecated. - -Add a `@warning` annotation to the API's public documentation indicating the intent for this API to -eventually be deprecated. This warning should also provide a short suggested alternative, if one -exists, and a link to the migration guide. - -For example: - -```objc -@warning This method will soon be deprecated. Consider using -@c +applySemanticColorScheme:toFlexibleHeaderView: instead. Learn more at -components/schemes/Color/docs/migration-guide-semantic-color-scheme.md -``` - -If the API to be deprecated is a method or property of a class, also move the API to a category -named `ToBeDeprecated`. This will cause the API to show up in our release notes automatically as -a to-be-deprecated API. - -For example: - -```objc -@interface MDCAppBarContainerViewController (ToBeDeprecated) - -/** - The App Bar views that will be presented in front of the contentViewController's view. - - @warning This API will eventually be deprecated. Use appBarViewController instead. Learn more at - components/AppBar/docs/migration-guide-appbar-appbarviewcontroller.md - */ -@property(nonatomic, strong, nonnull, readonly) MDCAppBar *appBar; - -@end -``` - -### Step 5: Determine a schedule for the API deletion +### Step 3: Determine a schedule for the API deprecation and deletion Generally speaking deprecations take a long time unless you take an active part in migrating clients. Calculate your estimates with this in mind. A rough guideline: @@ -135,7 +83,41 @@ Map this schedule onto reality: **Once you have determined a schedule, add the schedule to the migration guide**. -### Step 6: Announce that the API will be deprecated +### Step 4: Mark the API as To Be Deprecated + +Add a `@warning` annotation to the API's public documentation indicating the intent for this API to +eventually be deprecated. This warning should also provide a short suggested alternative, if one +exists, and a link to the migration guide. + +For example: + +```objc +@warning This method will soon be deprecated. Consider using +@c +applySemanticColorScheme:toFlexibleHeaderView: instead. Learn more at +components/schemes/Color/docs/migration-guide-semantic-color-scheme.md +``` + +If the API to be deprecated is a method or property of a class, also move the API to a category +named `ToBeDeprecated`. This will cause the API to show up in our release notes automatically as +a to-be-deprecated API. + +For example: + +```objc +@interface MDCAppBarContainerViewController (ToBeDeprecated) + +/** + The App Bar views that will be presented in front of the contentViewController's view. + + @warning This API will eventually be deprecated. Use appBarViewController instead. Learn more at + components/AppBar/docs/migration-guide-appbar-appbarviewcontroller.md + */ +@property(nonatomic, strong, nonnull, readonly) MDCAppBar *appBar; + +@end +``` + +### Step 5: Announce that the API will be deprecated Inform internal clients of the impending deprecation by sending an email with the following format: @@ -152,12 +134,12 @@ The timeline for this deprecation is as follows: - : The API will be deleted. ``` -### Step 7: After the deprecation date, annotate the API as deprecated +### Step 6: After the deprecation date, annotate the API as deprecated Send a pull request annotating the API as deprecated. Use `__deprecated_msg("")` and provide a concise message with a recommendation for an alternative API, if any is available. -### Step 8: After the deletion date, re-evaluate usage of the API +### Step 7: After the deletion date, re-evaluate usage of the API Once the deletion date has passed and at least one release has been cut since the API was marked as deprecated, you can now consider deleting the API. But first: you must evaluate whether the API is @@ -170,7 +152,7 @@ If the API is still being used by clients, you have a few options: Proceed to step 9 once you've confirmed that there are zero internal usages of the API. -### Step 9: Delete the API and migration guide +### Step 8: Delete the API and migration guide Once you have confirmed that there is no internal usage of the API, you can safely delete it and the migration guide. diff --git a/demos/supplemental/RemoteImageServiceForMDCDemos.podspec b/demos/supplemental/RemoteImageServiceForMDCDemos.podspec index 6269424ce18..15128313ccb 100644 --- a/demos/supplemental/RemoteImageServiceForMDCDemos.podspec +++ b/demos/supplemental/RemoteImageServiceForMDCDemos.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = "RemoteImageServiceForMDCDemos" - s.version = "121.0.0" + s.version = "121.0.1" s.summary = "A helper image class for the MDC demos." s.description = "This spec is made for use in the MDC demos. It gets images via url." s.homepage = "https://github.com/material-components/material-components-ios"