Skip to content
This repository was archived by the owner on Aug 18, 2023. It is now read-only.

Adds WhatsNew to Settings, displaying content from a Markdown file in project #172

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Adds WhatsNew to Settings, displaying content from a Markdown file in project #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions brain-marks.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@

/* Begin PBXBuildFile section */
20636BDDDBEF4EAE9CCE9D9E /* amplifyconfiguration.json in Resources */ = {isa = PBXBuildFile; fileRef = ECA1CF04DB754255822691F2 /* amplifyconfiguration.json */; };
2A2128092909CAA300E280E6 /* WhatsNewView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2A2128082909CAA300E280E6 /* WhatsNewView.swift */; };
2A7C408128EFCC3600F73DF5 /* WidgetKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2A7C408028EFCC3600F73DF5 /* WidgetKit.framework */; };
2A7C408328EFCC3600F73DF5 /* SwiftUI.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2A7C408228EFCC3600F73DF5 /* SwiftUI.framework */; };
2A7C408628EFCC3600F73DF5 /* BrainMarksWidgets.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2A7C408528EFCC3600F73DF5 /* BrainMarksWidgets.swift */; };
2A7C408828EFCC3700F73DF5 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 2A7C408728EFCC3700F73DF5 /* Assets.xcassets */; };
2A7C408C28EFCC3700F73DF5 /* BrainMarksWidgetsExtension.appex in Embed Foundation Extensions */ = {isa = PBXBuildFile; fileRef = 2A7C407E28EFCC3600F73DF5 /* BrainMarksWidgetsExtension.appex */; settings = {ATTRIBUTES = (RemoveHeadersOnCopy, ); }; };
2AD712632908BD9400D3E744 /* whatsnew.md in Resources */ = {isa = PBXBuildFile; fileRef = 2AD712622908BD9400D3E744 /* whatsnew.md */; };
45B4425428EF5AC800FB0B27 /* AppIconSettings.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45B4425328EF5AC800FB0B27 /* AppIconSettings.swift */; };
45B4426628EF5EA300FB0B27 /* 8 Rainbow.png in Resources */ = {isa = PBXBuildFile; fileRef = 45B4425628EF5EA300FB0B27 /* 8 Rainbow.png */; };
45B4426828EF5EA300FB0B27 /* 4 Beach.png in Resources */ = {isa = PBXBuildFile; fileRef = 45B4425828EF5EA300FB0B27 /* 4 Beach.png */; };
Expand Down Expand Up @@ -125,12 +127,14 @@
0AA54EDF3B34443CA9D530E5 /* AWSTweet.swift */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = 4; includeInIndex = 0; lastKnownFileType = sourcecode.swift; name = AWSTweet.swift; path = amplify/generated/models/AWSTweet.swift; sourceTree = "<group>"; };
14F5BDE61EAA4A2DB9030734 /* AmplifyModels.swift */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = 4; includeInIndex = 0; lastKnownFileType = sourcecode.swift; name = AmplifyModels.swift; path = amplify/generated/models/AmplifyModels.swift; sourceTree = "<group>"; };
1E886624D4EE4F64B9160A75 /* amplifytools.xcconfig */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = 4; includeInIndex = 0; lastKnownFileType = text.xcconfig; path = amplifytools.xcconfig; sourceTree = "<group>"; };
2A2128082909CAA300E280E6 /* WhatsNewView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WhatsNewView.swift; sourceTree = "<group>"; };
2A7C407E28EFCC3600F73DF5 /* BrainMarksWidgetsExtension.appex */ = {isa = PBXFileReference; explicitFileType = "wrapper.app-extension"; includeInIndex = 0; path = BrainMarksWidgetsExtension.appex; sourceTree = BUILT_PRODUCTS_DIR; };
2A7C408028EFCC3600F73DF5 /* WidgetKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WidgetKit.framework; path = System/Library/Frameworks/WidgetKit.framework; sourceTree = SDKROOT; };
2A7C408228EFCC3600F73DF5 /* SwiftUI.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SwiftUI.framework; path = System/Library/Frameworks/SwiftUI.framework; sourceTree = SDKROOT; };
2A7C408528EFCC3600F73DF5 /* BrainMarksWidgets.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BrainMarksWidgets.swift; sourceTree = "<group>"; };
2A7C408728EFCC3700F73DF5 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
2A7C408928EFCC3700F73DF5 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
2AD712622908BD9400D3E744 /* whatsnew.md */ = {isa = PBXFileReference; explicitFileType = net.daringfireball.markdown; fileEncoding = 4; path = whatsnew.md; sourceTree = "<group>"; };
45B4425328EF5AC800FB0B27 /* AppIconSettings.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppIconSettings.swift; sourceTree = "<group>"; };
45B4425628EF5EA300FB0B27 /* 8 Rainbow.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "8 Rainbow.png"; sourceTree = "<group>"; };
45B4425828EF5EA300FB0B27 /* 4 Beach.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "4 Beach.png"; sourceTree = "<group>"; };
Expand Down Expand Up @@ -372,6 +376,8 @@
DBF50B58272467F0000D8B25 /* Views */ = {
isa = PBXGroup;
children = (
2A2128082909CAA300E280E6 /* WhatsNewView.swift */,
2AD712622908BD9400D3E744 /* whatsnew.md */,
DBF50B52272467CF000D8B25 /* SettingsView.swift */,
DBF50B51272467CF000D8B25 /* ContributorsListView.swift */,
DB64F8A627270A9B00361E86 /* ContributorProfileView.swift */,
Expand Down Expand Up @@ -690,6 +696,7 @@
45B4426A28EF5EA300FB0B27 /* 2 Halloween.png in Resources */,
20636BDDDBEF4EAE9CCE9D9E /* amplifyconfiguration.json in Resources */,
45B4426928EF5EA300FB0B27 /* 5 Instagram.png in Resources */,
2AD712632908BD9400D3E744 /* whatsnew.md in Resources */,
45B4426628EF5EA300FB0B27 /* 8 Rainbow.png in Resources */,
45B4427428EF5EA300FB0B27 /* 15 Xcode.png in Resources */,
45B4426828EF5EA300FB0B27 /* 4 Beach.png in Resources */,
Expand Down Expand Up @@ -778,6 +785,7 @@
FFEBBB3A26223F75000F475F /* brain_marksApp.swift in Sources */,
CA80832580B84CB3A2D5F629 /* AmplifyModels.swift in Sources */,
DBF50B56272467CF000D8B25 /* SettingsViewModel.swift in Sources */,
2A2128092909CAA300E280E6 /* WhatsNewView.swift in Sources */,
75C999F627518708000B0FF8 /* Media.swift in Sources */,
C0DAFC52B24C456EAE5AEF21 /* AWSCategory.swift in Sources */,
684E2F2D3FCC4D36AC68E57D /* AWSCategory+Schema.swift in Sources */,
Expand Down Expand Up @@ -1047,7 +1055,7 @@
DEVELOPMENT_TEAM = Y535846H6P;
ENABLE_PREVIEWS = YES;
INFOPLIST_FILE = "brain-marks/Info.plist";
IPHONEOS_DEPLOYMENT_TARGET = 14.0;
IPHONEOS_DEPLOYMENT_TARGET = 15.0;
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the deployment target changed to iOS 15.0?

LD_RUNPATH_SEARCH_PATHS = (
"$(inherited)",
"@executable_path/Frameworks",
Expand All @@ -1071,7 +1079,7 @@
DEVELOPMENT_TEAM = Y535846H6P;
ENABLE_PREVIEWS = YES;
INFOPLIST_FILE = "brain-marks/Info.plist";
IPHONEOS_DEPLOYMENT_TARGET = 14.0;
IPHONEOS_DEPLOYMENT_TARGET = 15.0;
LD_RUNPATH_SEARCH_PATHS = (
"$(inherited)",
"@executable_path/Frameworks",
Expand Down
1 change: 0 additions & 1 deletion brain-marks/AmplifyModelExtensions/AWSTweet+Extension.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,3 @@ extension AWSTweet {
userVerified: false)
]
}

24 changes: 24 additions & 0 deletions brain-marks/Settings/SettingsViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,28 @@ class SettingsViewModel: ObservableObject {
}
.resume()
}

func getStringFromBundle() -> String {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rename this to be more specific that this is only for getting the whatsnew file, maybe something like getWhatsNewFromBundle()??

if let filepath = Bundle.main.path(forResource: "whatsnew", ofType: "md") {
do {
let string = try String(contentsOfFile: filepath)
return string
} catch {
print("string could not be loaded")
}
} else {
print("whatsnew.md not found in app bundle")
}
return ""
}

func createAttributedString(plainString: String) -> AttributedString {
do {
let newString = try AttributedString(markdown: plainString, options: AttributedString.MarkdownParsingOptions(interpretedSyntax: .inlineOnlyPreservingWhitespace))
return newString
} catch {
print("Error creating AttributedString: \(error)")
}
return ""
}
}
10 changes: 9 additions & 1 deletion brain-marks/Settings/Views/SettingsView.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,15 @@ struct SettingsView<ViewModel: InfoViewModel>: View {
}
}
}

Section(header: Text("Updates")) {
NavigationLink {
WhatsNewView(viewModel: viewModel)
} label: {
HStack {
Text("What's New")
}
}
}
Comment on lines +40 to +48
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you fix the indentation here?
The NavigationLink shouldn't be indented this far

Also the HStack isn't needed

Section(header: Text("Appearance")) {
NavigationLink {
AppIconListView(appIconSettings: appIconSettings)
Expand Down
20 changes: 20 additions & 0 deletions brain-marks/Settings/Views/WhatsNewView.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
//
// WhatsNewView.swift
// brain-marks
//
// Created by Susannah Skyer Gupta on 10/26/22.
//

import SwiftUI

struct WhatsNewView: View {
@StateObject var viewModel: SettingsViewModel
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be an ObservedObject rather than a StateObject


var body: some View {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add a navigation title to this screen, just "What's New" is fine!

let plainString = viewModel.getStringFromBundle()
let attributedString = viewModel.createAttributedString(plainString: plainString)
Text(attributedString)
.padding()
Spacer()
}
Comment on lines +13 to +19
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put this into a ScrollView? That will help accommodate as the file gets bigger and with dynamic type. Here's an interesting article!

A better way to this would be to have a function called createWhatsNewAttributedString that uses the function getStringFromBundle rather than needing 2 variables in the View

This also makes it so you can make getStringFromBundle a private function

Lastly instead of returning a blank string, you could return an error message saying like "Problem with file" idk haha something useful, otherwise an empty string is weird

}
5 changes: 5 additions & 0 deletions brain-marks/Settings/Views/whatsnew.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
**v1.2**
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine, if you don't want to change it, but I'd prefer for the version numbers to be like this # v1.2, which would show them as a heading rather than just bold

* Delightful updates arriving soon!

**v1.1**
* Fix add folder and add tweet button not working in iOS 15