alexlevshenkov / lifocontainers

Library containing various flavours of Last-In-First-Out (LIFO) data structures

LifoContainers

Library containing various flavours of Last-In-First-Out (LIFO) data structures.

Contents

• Requirements
• Installation Guide
• Demo application
• Versioning
• Contributing
• License

Requirements

• iOS 12.0+ / macOS 10.13+
• Xcode 15.2+
• Swift 5.9+

Installation Guide

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. LifoContainers supports SPM from 0.2.0 version.

Add dependency to the project

You can add LifoContainers to an Xcode project by adding it as a package dependency:

1. In Xcode, select "File" → "Add Package Dependencies...";
2. Enter "https://github.com/AlexLevshenkov/LifoContainers" into the "Search or Enter Package URL" search bar;

Add dependency to the Swift package

Once you have your own Swift package set up, adding LifoContainers as a dependency is as easy as adding it to the dependencies value of your Package.swift:

dependencies: [
    .package(url: "https://github.com/AlexLevshenkov/LifoContainers", from: "<version>")
]

XCFramework

Each release includes *.xcframework framework binary.

1. Download *.xcframework.zip from assets and unpack it;
2. Open the Xcode project or workspace;
3. Go to the target’s General configuration page;
4. Add the framework target to the Frameworks, Libraries, and Embedded Content section by clicking the Add(+) button;
5. Since LifoContainers.xcframework contains static libraries only we recommend choosing the "Do Not Embed" embed option;

Build .xcframework by yourself

You may want to build the binary .xcframework file yourself from the source code. To do so you need to run the build-xcframework.sh script in a scripts folder which places the result .xcframework file into the build folder. Or you may follow the instructions provided by Apple.

Demo application

We have created a simple macOS application called ParenthesesValidator to demonstrate how to connect LifoContainers to your project and show an example of problems that could be solved using the LifoContainers API.

ParenthesesValidator checks if parentheses in the given string are paired. If you find it similar to leetcode problem "20. Valid Parentheses" you are right! One of the ways to solve this problem relies on stack what exactly LifoContainers provides to you.

Versioning

LifoContainers follows semantic versioning 2.0.0. We release patch versions for bug fixes, minor versions for new features (and rarely, clear and easy to fix breaking changes), and major versions for any major breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.

Contributing

We welcome any contributions. See the CONTRIBUTING.md file for how to get involved.

License

This project is licensed under the MIT License.

lifocontainers's Issues

Initialise Xcode project

Description

Create and set up Xcode project considering the programming assignment:

Create a new iOS/macOS static framework as an Xcode project, move all the code related to the implemented stacks into them. Users should be able to use the framework within their projects.

The framework is static which means MACH_O_TYPE build parameter should be set to staticlib.

Increase the framework version

Description

SPM support has been added in #27.
To release a new version of the framework version has to be bumped to 0.2.0.

Add configuration file for `SwiftFormat`

Description

Configuration file with the team settings for SwiftFormat should be added as part of the initial repository setup.

Add `.gitignore` file

Description

A .gitignore file should be added as part of the initial repository setup.

Add installation guide to `README.md` file

Description

As far as the SPM support has been added to the LifoContainers, the framework documentation is missing an installation guide.
Need to describe the process of installation via SPM or by downloading *.xcframework binary file

Add script for running code linters

Description

Script for running SwiftLint and SwiftFormat should be added as part of the initial repository setup.
Documentation for contributors should be updated accordingly.

Add configuration file for `SwiftLint`

Description

Configuration file with the team settings for SwiftLint should be added as part of the initial repository setup.

Supplement the repository documentation

Description

Create documentation:

• for environmental requirements
• how to install the framework
• how the framework release version is formed
• how to contribute to the project

Add license file

Description

A license file should be added as part of the initial repository setup.

Copy `Stack` and `StackStatistics` implementation

Description

Copy Stack and StackStatistics implementation code from the ios-engineering-school-hws repository.

[HW-8] Update linters script

Description

The script running code linters needs to be updated:

• on CI linters should not autocorrect violations to show more warnings to the developer;
• on the local machine the developer should have a choice: autocorrect violations whenever possible or not;

[HW-8] Create Github workflow for necessary checks

Description

Additional checks, such as code a style check and tests passing, should be added to each pull request.
This is going to be added via GitHub Actions.

Set up process of creating `.xcframework`

Description

• LifoContainers should be configured for distribution, so need to be done the adjustments from the documentation.

• I assume LifoContainers will be released not once. Also, the users of the framework may want to create a binary file from the source code by themselves. To make this process unified and easy we need to create a script. We also need to update documentation for the users.

Create simple feature with `LifoContainers` usage

Description

To demonstrate the users of LifoContainers how to connect the framework to their projects and how to use framework API, need to create a simple feature using LifoContainers API in the demo application for macOS.

Copy `Stack` and `StackStatistics` tests

Description

Copy Stack and StackStatistics tests code from the ios-engineering-school-hws repository.

Add Swift Package Manager support

Description

• add package description file to the repository
• platform and its version requirements should be the same as current .xcframework has

Update SwiftFormat and Swiftlint configuration files

Description

• The new version(0.54) of SwiftFormat has been released;
  New rules have been added, bugs have been fixed.
• The team has already updated the SwiftLint configuration file.

Set up test target for the project

Description

To add tests for each type of LIFO container need to set up a test target for the project.

[HW-8] Fix linters warnings across whole repository

Description

The updated code linters script has to be run and all warnings have to be fixed. Otherwise executing the script on CI will fail.

Create demo application showing the usage of `LifoContainers`

Description

To show the users of LifoContainers how to connect the framework to their projects and how to use it, what problems can be solved, need to create a small demo application for macOS.

Integrate the framework via SPM to the demo application

Description

• need to remove Frameworks folder with LifoContainers.xcframework;
• remove LifoContainers.xcframework from target dependencies;
• add the framework to ParenthesesValidator via SPM;