Add new move functions

Author: danielsaidi

RELEASE_NOTES.md

@@ -6,6 +6,14 @@ Until then, deprecated features may be removed in the next minor version.
 
 
 
+## 0.7.1
+
+### 💡 New features
+
+* `Deck` has new `move` functions.
+
+
+
 ## 0.7
 
 ### 💡 New features

Sources/DeckKit/Animations/DeckShuffleAnimation.swift

@@ -13,9 +13,8 @@ import SwiftUI
 
  To use this animation, first create a `@StateObject` in the
  view that should use the animation, then bind the animation
- to your deck item views using the `withDeckShuffleAnimation`
- view modifier, then call `shuffle` to shuffle the deck with
- a nice shuffle animation.
+ to your item views, using a `withShuffleAnimation` modifier,
+ then call `shuffle` to perform an animated shuffle.
  */
 public class DeckShuffleAnimation: ObservableObject {
 

Sources/DeckKit/Deck.swift

@@ -25,59 +25,58 @@ public struct Deck<Item: DeckItem>: Identifiable, Equatable {
     public init(
         id: UUID = UUID(),
         name: String = "",
-        items: [Item]) {
+        items: [Item]
+    ) {
         self.id = id
         self.name = name
         self.items = items
     }
 
-    /**
-     The unique id of the deck.
-     */
+    /// The unique id of the deck.
     public let id: UUID
 
-    /**
-     The name of the deck.
-     */
+    /// The name of the deck.
     public let name: String
 
-    /**
-     The items that are added to the deck.
-     */
+    /// The items that are added to the deck.
     public var items: [Item]
 }
 
 public extension Deck {
 
-    /**
-     The index of a certain item, if any.
-     */
+    /// The index of a certain item, if any.
     func index(of item: Item) -> Int? {
         items.firstIndex { $0.id == item.id }
     }
 
-    /**
-     Move an item to the back of the deck.
-     */
+    /// Move the first item to the back of the deck.
+    mutating func moveFirstItemToBack() {
+        guard let item = items.first else { return }
+        moveToBack(item)
+    }
+    
+    /// Move the last item to the front of the deck.
+    mutating func moveLastItemToFront() {
+        guard let item = items.last else { return }
+        moveToFront(item)
+    }
+    
+    /// Move an item to the back of the deck.
     mutating func moveToBack(_ item: Item) {
         guard let index = index(of: item) else { return }
         let topItem = items.remove(at: index)
         items.append(topItem)
     }
 
-    /**
-     Move an item to the front of the deck.
-     */
+    /// Move an item to the front of the deck.
     mutating func moveToFront(_ item: Item) {
         guard let index = index(of: item) else { return }
         if items[0].id == item.id { return }
         let topItem = items.remove(at: index)
         items.insert(topItem, at: 0)
     }
 
-    /**
-     Shuffle the deck.
-     */
+    /// Shuffle the deck.
     mutating func shuffle() {
         items.shuffle()
     }

Sources/DeckKit/DeckView.swift

@@ -134,16 +134,10 @@ private extension DeckView {
 
 private extension DeckView {
 
-    /**
-     Move a certain item to the back of the stack.
-     */
     func moveItemToBack(_ item: ItemType) {
         deck.wrappedValue.moveToBack(item)
     }
 
-    /**
-     Move a certain item to the front of the stack.
-     */
     func moveItemToFront(_ item: ItemType) {
         deck.wrappedValue.moveToFront(item)
     }

Sources/DeckKit/Favorites/Favoritable.swift

@@ -7,6 +7,7 @@
 //
 
 /**
- This protocol can be implemented by anything that can be markes as a favorite.
+ This protocol can be implemented by any type that should be
+ able to be marked as a favorite.
  */
 public protocol Favoritable: Identifiable {}

Sources/DeckKit/Favorites/FavoriteService.swift

@@ -6,8 +6,11 @@
 //  Copyright © 2020-2023 Daniel Saidi. All rights reserved.
 //
 
+import Foundation
+
 /**
- This protocol can be implemented by classes that can mark items as favorites.
+ This service protocol can be implemented any types that can
+ toggle the favorite state of ``Favoritable`` items.
  */
 public protocol FavoriteService: AnyObject {
 

Sources/DeckKit/PreviewCard.swift

@@ -10,8 +10,7 @@ import SwiftUI
 import CoreGraphics
 
 /**
- This view can be used to presents a ``PreviewCard/Item``, and
- can be used as is or as a template for other cards.
+ This view can be used as a preview template for other cards.
  */
 struct PreviewCard: View {