vibrancy

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: iSapozhnik
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Mojave]
+- Version [e.g. 1.0.7]
+ - ...
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: iSapozhnik
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, 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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sapozhnik.ivan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

Package.swift

@@ -6,7 +6,7 @@ import PackageDescription
 let package = Package(
     name: "Popover",
     platforms: [
-        .macOS(.v10_11)
+        .macOS(.v10_14)
     ],
     products: [
         // Products define the executables and libraries produced by a package, and make them visible to other packages.

Sources/Popover/EventMonitor.swift

@@ -1,6 +1,6 @@
 //
-//  File.swift
-//  
+//  EventMonitor.swift
+//  Popover
 //
 //  Created by Ivan Sapozhnik on 03.04.20.
 //

Sources/Popover/Popover.swift

@@ -3,15 +3,14 @@
 //  Popover
 //
 //  Created by Ivan Sapozhnik on 29.03.20.
-//  Copyright © 2020 heavylightapps. All rights reserved.
 //
 
 import Cocoa
 
 public class Popover: NSObject {
-    public var item: NSStatusItem!
+    var item: NSStatusItem!
 
-    private let windowConfiguration: PopoverConfiguration
+    private let wConfig: PopoverConfiguration
     private var popoverWindowController: PopoverWindowController?
     private var statusItemContainer: StatusItemContainerView?
     private var eventMonitor: EventMonitor?
@@ -20,33 +19,46 @@ public class Popover: NSObject {
         return (popoverWindowController != nil) ? popoverWindowController!.windowIsOpen : false
     }
 
-    public init(with configuration: PopoverConfiguration) {
-        windowConfiguration = configuration
+    /// Creates a Popover with given PopoverConfiguration. Popover configuration can be either `DefaultConfiguration` or you can sublclass this class and override some of the properties.
+    /// By default Popover is using Event Monitor and by doing left or right click ouside of the Popover's frame, the Popover will be automatically dismissed.
+    public init(with windowConfiguration: PopoverConfiguration) {
+        wConfig = windowConfiguration
 
         super.init()
 
         eventMonitor = EventMonitor(mask: [.rightMouseDown, .leftMouseDown], handler: { [weak self] event in
             guard let self = self else { return }
-            self.dismissPopoverWindow()
+            self.dismiss()
         })
     }
 
-    public func presentPopover(with image: NSImage, contentViewController viewController: NSViewController) {
+    /// Convenience initializer which is using default configuration
+    public convenience override init() {
+        self.init(with: DefaultConfiguration())
+    }
+
+    /// Creates a Popover with given image and contentViewController
+    /// By default it won't present any Popover until the user clicks on status bar item
+    public func createPopover(with image: NSImage, contentViewController viewController: NSViewController) {
         configureStatusBarButton(with: image)
-        popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: windowConfiguration)
+        popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: wConfig)
     }
 
-    public func presentPopover(with view: NSView, contentViewController viewController: NSViewController) {
+    /// Creates a Popover with given view and contentViewController. The view's height will be scaled down to 18pt and also will be vertically aligned. The wdith can be any.
+    /// By default it won't present any Popover until the user clicks on status bar item
+    public func createPopover(with view: NSView, contentViewController viewController: NSViewController) {
         configureStatusBarButton(with: view)
-        popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: windowConfiguration)
+        popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: wConfig)
     }
 
-    public func showPopoverWindow() {
+    /// Shows the Popover with no animation
+    public func show() {
         popoverWindowController?.show()
         eventMonitor?.start()
     }
 
-    public func dismissPopoverWindow() {
+    /// Dismisses the Popover with default animation. Animation behaviour is `AnimationBehavior.utilityWindow`
+    public func dismiss() {
         popoverWindowController?.dismiss()
         eventMonitor?.stop()
     }
@@ -78,10 +90,6 @@ public class Popover: NSObject {
     }
 
     @objc private func handleStatusItemButtonAction(_ sender: Any?) {
-        if isPopoverWindowVisible {
-            dismissPopoverWindow()
-        } else {
-            showPopoverWindow()
-        }
+        isPopoverWindowVisible ? dismiss() : show()
     }
 }

Sources/Popover/PopoverConfiguration.swift

@@ -3,20 +3,45 @@
 //  Popover
 //
 //  Created by Ivan Sapozhnik on 29.03.20.
-//  Copyright © 2020 heavylightapps. All rights reserved.
 //
 
 import Cocoa
 
 public protocol PopoverConfiguration {
-    var popoverToStatusItemMargin: CGFloat { get }
-    var backgroundColor: NSColor { get }
-    var borderColor: NSColor? { get }
-    var borderWidth: CGFloat { get }
-    var arrowHeight: CGFloat { get }
-    var arrowWidth: CGFloat { get }
-    var cornerRadius: CGFloat { get }
-    var contentInset: NSEdgeInsets { get }
+    /// The distance from Popover's arrow to a status item.
+    var popoverToStatusItemMargin:  CGFloat { get }
+
+    /// Popover's background color.
+    var backgroundColor:            NSColor { get }
+
+    /// Popover's border color.
+    /// - Important:
+    ///     If `borderColor` returns `nil`, settings `borderWidth` won't make any affect. See also: `borderWidth`.
+    var borderColor:                NSColor? { get }
+
+    /// Popover's border width.
+    /// - Important:
+    ///      If Popover's border color is set to `nil`, setting `borderWidth` won't make any affect.
+    var borderWidth:                CGFloat { get }
+
+    /// Defines Popover arrow height.
+    var arrowHeight:                CGFloat { get }
+
+    /// Defines Popover arrow width.
+    var arrowWidth:                 CGFloat { get }
+
+    /// Defines Popover corner radius.
+    /// - Warning:
+    ///     If this value is too big and if the Popover's status item (menu bar view) is too close to the right edge, the appearence of the Popover might be odd.
+    var cornerRadius:               CGFloat { get }
+
+    /// Defines Popover content edge insets.
+    var contentEdgeInsets:          NSEdgeInsets { get }
+
+    /// The distance from the right side of the Popover to the screen's edge.
+    /// - Warning:
+    ///     If this value is too big and if the Popover's status item (menu bar view) is too close to the right edge, the appearence of the Popover might be odd.
+    var rightEdgeMargin:            CGFloat { get }
 }
 
 open class DefaultConfiguration: PopoverConfiguration {
@@ -47,10 +72,14 @@ open class DefaultConfiguration: PopoverConfiguration {
     }
 
     open var cornerRadius: CGFloat {
-        return 12
+        return 5
     }
 
-    open var contentInset: NSEdgeInsets {
+    open var contentEdgeInsets: NSEdgeInsets {
         return NSEdgeInsetsZero
     }
+
+    open var rightEdgeMargin: CGFloat {
+        return 12.0
+    }
 }

Sources/Popover/PopoverWindow.swift

@@ -3,17 +3,34 @@
 //  Popover
 //
 //  Created by Ivan Sapozhnik on 29.03.20.
-//  Copyright © 2020 heavylightapps. All rights reserved.
 //
 
 import Cocoa
 
-public class PopoverWindow: NSPanel {
+class PopoverWindow: NSPanel {
+    var arrowXLocation: CGFloat = 0.0 {
+        didSet {
+            updateArrowPosition()
+        }
+    }
     private let wConfig: PopoverConfiguration
     private var childContentView: NSView?
     private var backgroundView: PopoverWindowBackgroundView?
 
-    public static func window(with configuration: PopoverConfiguration) -> PopoverWindow {
+    private init(contentRect: NSRect, styleMask style: NSWindow.StyleMask, backing backingStoreType: NSWindow.BackingStoreType, defer flag: Bool, configuration: PopoverConfiguration) {
+        wConfig = configuration
+        super.init(contentRect: contentRect, styleMask: style, backing: backingStoreType, defer: flag)
+
+        isOpaque = false
+        hasShadow = true
+        level = .statusBar
+        animationBehavior = .utilityWindow
+        backgroundColor = .clear
+        collectionBehavior = [.canJoinAllSpaces, .ignoresCycle]
+        appearance = NSAppearance.current
+    }
+
+    static func window(with configuration: PopoverConfiguration) -> PopoverWindow {
         let window = PopoverWindow.init(
             contentRect: .zero,
             styleMask: .nonactivatingPanel,
@@ -25,11 +42,11 @@ public class PopoverWindow: NSPanel {
         return window
     }
 
-    public override var canBecomeKey: Bool {
+    override var canBecomeKey: Bool {
         return true
     }
 
-    public override var contentView: NSView? {
+    override var contentView: NSView? {
         set {
             guard childContentView != newValue, let bounds = newValue?.bounds else { return }
 
@@ -57,10 +74,10 @@ public class PopoverWindow: NSPanel {
             backgroundView.addSubview(userContentView)
 
             let borderWidth = wConfig.borderColor != nil ? wConfig.borderWidth : 0
-            let left = borderWidth + wConfig.contentInset.left
-            let right = borderWidth + wConfig.contentInset.right
-            let top = wConfig.arrowHeight + borderWidth + wConfig.contentInset.top
-            let bottom = borderWidth + wConfig.contentInset.bottom
+            let left = borderWidth + wConfig.contentEdgeInsets.left
+            let right = borderWidth + wConfig.contentEdgeInsets.right
+            let top = wConfig.arrowHeight + borderWidth + wConfig.contentEdgeInsets.top
+            let bottom = borderWidth + wConfig.contentEdgeInsets.bottom
 
             NSLayoutConstraint.activate([
                 userContentView.leadingAnchor.constraint(equalTo: backgroundView.leadingAnchor, constant: left),
@@ -75,20 +92,12 @@ public class PopoverWindow: NSPanel {
         }
     }
 
-    public override func frameRect(forContentRect contentRect: NSRect) -> NSRect {
+    override func frameRect(forContentRect contentRect: NSRect) -> NSRect {
         NSMakeRect(NSMinX(contentRect), NSMinY(contentRect), NSWidth(contentRect), NSHeight(contentRect) + wConfig.arrowHeight)
     }
 
-    private init(contentRect: NSRect, styleMask style: NSWindow.StyleMask, backing backingStoreType: NSWindow.BackingStoreType, defer flag: Bool, configuration: PopoverConfiguration) {
-        wConfig = configuration
-        super.init(contentRect: contentRect, styleMask: style, backing: backingStoreType, defer: flag)
-
-        isOpaque = false
-        hasShadow = true
-        level = .statusBar
-        animationBehavior = .utilityWindow
-        backgroundColor = .clear
-        collectionBehavior = [.canJoinAllSpaces, .ignoresCycle]
-        appearance = NSAppearance.current
+    private func updateArrowPosition() {
+        guard let backgroundView = self.backgroundView as? PopoverWindowBackgroundView else { return }
+        backgroundView.arrowXLocation = arrowXLocation
     }
 }

Sources/Popover/PopoverWindowBackgroundView.swift

@@ -3,7 +3,6 @@
 //  Popover
 //
 //  Created by Ivan Sapozhnik on 29.03.20.
-//  Copyright © 2020 heavylightapps. All rights reserved.
 //
 
 import Cocoa
@@ -11,9 +10,47 @@ import Cocoa
 class PopoverWindowBackgroundView: NSView {
     private let wConfig: PopoverConfiguration
 
+    private var visualEffect: NSVisualEffectView?
+    
+    var arrowXLocation: CGFloat = 0.0 {
+        didSet {
+            needsDisplay = true
+        }
+    }
+
     init(frame frameRect: NSRect, windowConfiguration: PopoverConfiguration) {
         self.wConfig = windowConfiguration
         super.init(frame: frameRect)
+
+//        setupVisualEffect()
+    }
+
+    private func setupVisualEffect() {
+        let visualEffect = NSVisualEffectView()
+        visualEffect.translatesAutoresizingMaskIntoConstraints = false
+        visualEffect.blendingMode = .behindWindow
+        visualEffect.state = .active
+        visualEffect.appearance = NSAppearance.current
+        guard let appearence = NSAppearance.current else { return }
+        switch appearence.name {
+        case .aqua:
+            visualEffect.material = .dark
+        case .darkAqua:
+            visualEffect.material = .dark
+        default:
+            break
+        }
+
+        self.visualEffect = visualEffect
+
+        addSubview(visualEffect)
+
+        NSLayoutConstraint.activate([
+            visualEffect.leadingAnchor.constraint(equalTo: self.leadingAnchor),
+            visualEffect.trailingAnchor.constraint(equalTo: self.trailingAnchor),
+            visualEffect.topAnchor.constraint(equalTo: self.topAnchor),
+            visualEffect.bottomAnchor.constraint(equalTo: self.bottomAnchor)
+        ])
     }
 
     required init?(coder: NSCoder) {
@@ -36,13 +73,14 @@ class PopoverWindowBackgroundView: NSView {
         let arrowPath = NSBezierPath()
         let backgroundPath = NSBezierPath(roundedRect: backgroundRect, xRadius: wConfig.cornerRadius, yRadius: wConfig.cornerRadius)
 
-        let leftPoint = NSPoint(x: NSWidth(backgroundRect) / 2 - wConfig.arrowWidth / 2, y: NSMaxY(backgroundRect))
-        let toPoint = NSPoint(x: NSWidth(backgroundRect) / 2, y: NSMaxY(backgroundRect) + wConfig.arrowHeight)
-        let rightPoint = NSPoint(x: NSWidth(backgroundRect) / 2 + wConfig.arrowWidth / 2, y: NSMaxY(backgroundRect))
-        let cp11 = NSPoint(x: NSWidth(backgroundRect) / 2 - wConfig.arrowWidth / 6, y: NSMaxY(backgroundRect))
-        let cp12 = NSPoint(x: NSWidth(backgroundRect) / 2 - wConfig.arrowWidth / 9, y: NSMaxY(backgroundRect) + wConfig.arrowHeight)
-        let cp21 = NSPoint(x: NSWidth(backgroundRect) / 2 + wConfig.arrowWidth / 9, y: NSMaxY(backgroundRect) + wConfig.arrowHeight)
-        let cp22 = NSPoint(x: NSWidth(backgroundRect) / 2 + wConfig.arrowWidth / 6, y: NSMaxY(backgroundRect))
+        let x = arrowXLocation
+        let leftPoint = NSPoint(x: x - wConfig.arrowWidth / 2, y: NSMaxY(backgroundRect))
+        let toPoint = NSPoint(x: x, y: NSMaxY(backgroundRect) + wConfig.arrowHeight)
+        let rightPoint = NSPoint(x: x + wConfig.arrowWidth / 2, y: NSMaxY(backgroundRect))
+        let cp11 = NSPoint(x: x - wConfig.arrowWidth / 6, y: NSMaxY(backgroundRect))
+        let cp12 = NSPoint(x: x - wConfig.arrowWidth / 9, y: NSMaxY(backgroundRect) + wConfig.arrowHeight)
+        let cp21 = NSPoint(x: x + wConfig.arrowWidth / 9, y: NSMaxY(backgroundRect) + wConfig.arrowHeight)
+        let cp22 = NSPoint(x: x + wConfig.arrowWidth / 6, y: NSMaxY(backgroundRect))
 
         controlPoints.append(NSBezierPath(ovalIn: NSMakeRect(leftPoint.x - 2, leftPoint.y - 2, 4, 4)))
         controlPoints.append(NSBezierPath(ovalIn: NSMakeRect(toPoint.x - 2, toPoint.y - 2, 4, 4)))
@@ -67,12 +105,18 @@ class PopoverWindowBackgroundView: NSView {
             windowPath.stroke()
         }
 
-
         wConfig.backgroundColor.setFill()
         windowPath.fill()
 
-//        controlPoints.fill()
+        let antialiasingMask: CAEdgeAntialiasingMask = [.layerLeftEdge, .layerRightEdge, .layerBottomEdge, .layerTopEdge]
+        let mask = CAShapeLayer()
+        mask.edgeAntialiasingMask = antialiasingMask
+        mask.path = windowPath.cgPath
+        visualEffect?.layer?.mask = mask
 
+
+//        NSColor.red.setFill()
+//        controlPoints.fill()
     }
     
     override var frame: NSRect {
@@ -81,3 +125,27 @@ class PopoverWindowBackgroundView: NSView {
         }
     }
 }
+
+extension NSBezierPath {
+    var cgPath: CGPath {
+        let path = CGMutablePath()
+        var points = [CGPoint](repeating: .zero, count: 3)
+        for i in 0 ..< self.elementCount {
+            let type = self.element(at: i, associatedPoints: &points)
+
+            switch type {
+            case .moveTo:
+                path.move(to: points[0])
+            case .lineTo:
+                path.addLine(to: points[0])
+            case .curveTo:
+                path.addCurve(to: points[2], control1: points[0], control2: points[1])
+            case .closePath:
+                path.closeSubpath()
+            @unknown default:
+                break
+            }
+        }
+        return path
+    }
+}

Sources/Popover/PopoverWindowController.swift

@@ -3,7 +3,6 @@
 //  Popover
 //
 //  Created by Ivan Sapozhnik on 29.03.20.
-//  Copyright © 2020 heavylightapps. All rights reserved.
 //
 
 import Cocoa
@@ -27,7 +26,7 @@ class PopoverWindowController: NSWindowController {
         fatalError("init(coder:) has not been implemented")
     }
 
-    public func show() {
+    func show() {
         guard !isAnimating else { return }
 
         updateWindowFrame()
@@ -38,7 +37,7 @@ class PopoverWindowController: NSWindowController {
         // TODO: animation
     }
 
-    public func dismiss() {
+    func dismiss() {
         guard !isAnimating else { return }
 
         window?.orderOut(self)
@@ -47,27 +46,28 @@ class PopoverWindowController: NSWindowController {
     }
 
     private func updateWindowFrame() {
+        guard let window = self.window as? PopoverWindow else { return }
         let windowFrame = visibleStatusItemWindowFrame()
-        window?.setFrame(windowFrame, display: true)
-        window?.appearance = NSAppearance.current
+        window.arrowXLocation = windowFrame.arrowXLocation
+        window.setFrame(windowFrame.frame, display: true)
+        window.appearance = NSAppearance.current
     }
 
-    private func visibleStatusItemWindowFrame() -> NSRect {
+    private func visibleStatusItemWindowFrame() -> (frame: NSRect, arrowXLocation: CGFloat) {
         let screenFrame = currentMouseScreen().frame
-        let popoverRect = popover.item.button?.window?.frame ?? .zero
+        let statusItemRect = popover.item.button?.window?.frame ?? .zero
 
-        guard let window = self.window else { return .zero }
+        guard let window = self.window else { return (.zero, 0.0) }
 
         let borderWidth = wConfig.borderColor != nil ? wConfig.borderWidth : 0
-        let x = NSMinX(popoverRect) - NSWidth(window.frame) / 2 + NSWidth(popoverRect) / 2 + borderWidth
-        let y = min(NSMinY(popoverRect), NSMaxY(screenFrame)) - NSHeight(window.frame) - wConfig.popoverToStatusItemMargin + borderWidth / 2
+        let x = min(NSMinX(statusItemRect) - NSWidth(window.frame) / 2 + NSWidth(statusItemRect) / 2 + borderWidth, NSMaxX(screenFrame) - NSWidth(window.frame) - wConfig.rightEdgeMargin)
+        let y = min(NSMinY(statusItemRect), NSMaxY(screenFrame)) - NSHeight(window.frame) - wConfig.popoverToStatusItemMargin + borderWidth / 2
 
-        return NSMakeRect(
-            x,
-            y,
-            NSWidth(window.frame),
-            NSHeight(window.frame)
-        )
+        let windowFrame = NSMakeRect(x, y, NSWidth(window.frame), NSHeight(window.frame))
+
+        let arrowXLocation = NSMinX(statusItemRect) + NSWidth(statusItemRect) / 2 - NSMinX(windowFrame)
+
+        return (windowFrame, arrowXLocation)
     }
 
     private func currentMouseScreen() -> NSScreen {

Sources/Popover/StatusItemContainerView.swift

@@ -1,6 +1,6 @@
 //
-//  File.swift
-//  
+//  StatusItemContainerView.swift
+//  Popover
 //
 //  Created by Ivan Sapozhnik on 03.04.20.
 //