Skip to content
This repository has been archived by the owner on Jan 23, 2023. It is now read-only.

Commit

Permalink
Refactor view layout and add snapshot tests
Browse files Browse the repository at this point in the history
  • Loading branch information
gonzalezreal committed Jan 3, 2021
1 parent 6f889a3 commit 3e51554
Show file tree
Hide file tree
Showing 20 changed files with 353 additions and 101 deletions.
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
17 changes: 17 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: CI
on:
push:
branches:
- main
pull_request:
branches:
- '*'
jobs:
tests:
runs-on: macos-11.0
steps:
- uses: actions/checkout@v2
- name: Select Xcode 12.3
run: sudo xcode-select -s /Applications/Xcode_12.3.app
- name: Run tests
run: make test
21 changes: 21 additions & 0 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: SwiftFormat
on:
push:
branches:
- main
jobs:
format:
name: SwiftFormat
runs-on: macos-11.0
steps:
- uses: actions/checkout@v2
- name: Install
run: brew install swiftformat
- name: Format
run: make format
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Run swiftformat
branch: 'main'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
DESTINATION_MAC = platform=macOS
DESTINATION_IOS = generic/platform=ios
DESTINATION_TVOS = generic/platform=tvos
DESTINATION_IOS = platform=iOS Simulator,name=iPhone 8
DESTINATION_TVOS = platform=tvOS Simulator,name=Apple TV
DESTINATION_WATCHOS = generic/platform=watchOS

default: build
default: test

build:
test:
xcodebuild \
-scheme AttributedText \
-destination '$(DESTINATION_MAC)'
xcodebuild \
xcodebuild test \
-scheme AttributedText \
-destination '$(DESTINATION_IOS)'
xcodebuild \
xcodebuild test \
-scheme AttributedText \
-destination '$(DESTINATION_TVOS)'
xcodebuild \
Expand Down
16 changes: 16 additions & 0 deletions Package.resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"object": {
"pins": [
{
"package": "SnapshotTesting",
"repositoryURL": "https://github.com/pointfreeco/swift-snapshot-testing",
"state": {
"branch": null,
"revision": "c466812aa2e22898f27557e2e780d3aad7a27203",
"version": "1.8.2"
}
}
]
},
"version": 1
}
11 changes: 9 additions & 2 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,22 @@ let package = Package(
targets: ["AttributedText"]
),
],
dependencies: [],
dependencies: [
.package(
name: "SnapshotTesting",
url: "https://github.com/pointfreeco/swift-snapshot-testing",
from: "1.8.2"
),
],
targets: [
.target(
name: "AttributedText",
dependencies: []
),
.testTarget(
name: "AttributedTextTests",
dependencies: ["AttributedText"]
dependencies: ["AttributedText", "SnapshotTesting"],
exclude: ["__Snapshots__"]
),
]
)
23 changes: 16 additions & 7 deletions Sources/AttributedText/AttributedText.swift
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

@available(macOS 11.0, iOS 14.0, tvOS 14.0, *)
public struct AttributedText: View {
@State private var height: CGFloat?
@StateObject private var store = AttributedTextStore()

private let attributedText: NSAttributedString

Expand All @@ -14,13 +14,22 @@

public var body: some View {
GeometryReader { proxy in
AttributedTextViewWrapper(
attributedText: attributedText,
preferredMaxLayoutWidth: proxy.size.width,
height: $height
)
AttributedTextViewWrapper(attributedText: attributedText, store: store)
.preference(key: ContainerSizePreference.self, value: proxy.size)
}
.frame(height: height)
.onPreferenceChange(ContainerSizePreference.self) { value in
store.onContainerSizeChange(value)
}
.frame(height: store.height)
}
}

@available(macOS 11.0, iOS 14.0, tvOS 14.0, *)
private struct ContainerSizePreference: PreferenceKey {
static var defaultValue: CGSize?

static func reduce(value: inout CGSize?, nextValue: () -> CGSize?) {
value = value ?? nextValue()
}
}

Expand Down
27 changes: 27 additions & 0 deletions Sources/AttributedText/AttributedTextStore.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#if !os(watchOS)

import CoreGraphics
import Foundation

@available(macOS 11.0, iOS 14.0, tvOS 14.0, *)
final class AttributedTextStore: ObservableObject {
@Published var height: CGFloat?

var attributedTextView: AttributedTextView?

func onContainerSizeChange(_ containerSize: CGSize?) {
guard let containerSize = containerSize, containerSize != .zero,
let attributedTextView = self.attributedTextView else { return }

attributedTextView.preferredMaxLayoutWidth = containerSize.width
height = attributedTextView.intrinsicContentSize.height
}

func onUpdateView() {
guard let attributedTextView = self.attributedTextView,
attributedTextView.preferredMaxLayoutWidth > 0 else { return }
height = attributedTextView.intrinsicContentSize.height
}
}

#endif
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,6 @@

import SwiftUI

@available(macOS 11.0, *)
struct AttributedTextViewWrapper: NSViewRepresentable {
let attributedText: NSAttributedString
let preferredMaxLayoutWidth: CGFloat
@Binding var height: CGFloat?

func makeNSView(context _: Context) -> AttributedTextView {
AttributedTextView()
}

func updateNSView(_ nsView: AttributedTextView, context: Context) {
nsView.attributedText = attributedText
nsView.preferredMaxLayoutWidth = preferredMaxLayoutWidth
nsView.numberOfLines = context.environment.lineLimit ?? 0
nsView.lineBreakMode = NSLineBreakMode(truncationMode: context.environment.truncationMode)
nsView.openURL = context.environment.openURL

DispatchQueue.main.async {
// Update the height within the current transaction
$height
.transaction(context.transaction)
.wrappedValue = nsView.intrinsicContentSize.height
}
}
}

@available(macOS 11.0, *)
class AttributedTextView: NSView, NSTextViewDelegate {
var preferredMaxLayoutWidth: CGFloat = 0 {
Expand Down Expand Up @@ -98,9 +72,7 @@

override func layout() {
super.layout()

textView.frame = bounds
textView.attributedString().updateImageTextAttachments(maxWidth: bounds.width)
}

override func invalidateIntrinsicContentSize() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,33 +1,7 @@
#if canImport(SwiftUI) && canImport(UIKit) && !os(watchOS)
#if canImport(UIKit) && !os(watchOS)

import SwiftUI

@available(iOS 14.0, tvOS 14.0, *)
struct AttributedTextViewWrapper: UIViewRepresentable {
let attributedText: NSAttributedString
let preferredMaxLayoutWidth: CGFloat
@Binding var height: CGFloat?

func makeUIView(context _: Context) -> AttributedTextView {
AttributedTextView()
}

func updateUIView(_ uiView: AttributedTextView, context: Context) {
uiView.attributedText = attributedText
uiView.preferredMaxLayoutWidth = preferredMaxLayoutWidth
uiView.numberOfLines = context.environment.lineLimit ?? 0
uiView.lineBreakMode = NSLineBreakMode(truncationMode: context.environment.truncationMode)
uiView.openURL = context.environment.openURL

DispatchQueue.main.async {
// Update the height within the current transaction
$height
.transaction(context.transaction)
.wrappedValue = uiView.intrinsicContentSize.height
}
}
}

@available(iOS 14.0, tvOS 14.0, *)
class AttributedTextView: UIView, UITextViewDelegate {
var preferredMaxLayoutWidth: CGFloat = 0 {
Expand Down Expand Up @@ -90,9 +64,7 @@

override func layoutSubviews() {
super.layoutSubviews()

textView.frame = bounds
textView.attributedText.updateImageTextAttachments(maxWidth: bounds.width)
}

override func invalidateIntrinsicContentSize() {
Expand Down
Loading

0 comments on commit 3e51554

Please sign in to comment.