Initial commit

.github/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing to SheetyColors
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+- Tell your friends about it or leave a star
+
+## We develop with GitHub
+We use Github to host code, to track issues and feature requests, as well as accept pull requests.
+
+## Add code changes
+Pull requests are the best way to propose changes to the codebase (we use [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `develop`.
+2. If you've added code that should be tested, add unit tests (we use [Quick](https://github.com/Quick/Quick) and [Nimble](https://github.com/Quick/Nimble)).
+3. If you've changed APIs, update the code documentation and run the `Scripts/release.sh` from the project's root to re-generate the jazzy-docs.
+4. Ensure the test suite passes.
+5. Extend the example projects for all platforms to showcase your feature.
+6. Make sure your code lints. Please run the `Scripts/setup.sh` from the project's root to install the required tools.
+7. Issue that pull request!
+
+## Report bugs
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/chrs1885/SheetyColors/issues/new?template=BUG_REPORT.md) and fill out the provided template. It's that easy!
+
+## Submit feature requests
+You can [open a new issue](https://github.com/chrs1885/SheetyColors/issues/new?template=FEATURE_REQUEST.md) to file feature requests. Again, please stick with the provided template.
+
+## License
+By contributing, you agree that your contributions will be licensed under its MIT License.
+
+## References
+This document was adapted from [briandk](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,18 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+> Please fill out all lines starting with a 📝 when filing a bug to give us an idea of what exactly went wrong.
+
+## What did you do?
+📝
+
+## What did you expect to happen?
+📝
+
+## What happened instead?
+📝
+
+## Setup
+📝

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: Describe a feature that you would like to see as part of the framework
+---
+
+> Please fill out all lines starting with a 📝 when filing a feature request to give us an idea of what exactly went wrong.
+
+## What kind of feature would you like to see?
+📝
+
+## How does it work in detail?
+📝
+
+## What does the API look like?
+📝
+
+## Any existing projects that do something similiar?
+📝

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+> Please fill out all lines starting with a 📝 when filing a pull request to give us an idea of what you did. 
+
+## Issue information
+📝
+
+## Goal
+📝
+
+## Implementation
+📝
+
+## Testing
+📝

.gitignore

@@ -0,0 +1,42 @@
+# OS X
+.DS_Store
+
+# Xcode
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata/
+*.xccheckout
+profile
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+
+# Bundler
+.bundle
+
+# Add this line if you want to avoid checking in source code from Carthage dependencies.
+# Carthage/Checkouts
+Carthage/Build
+
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-ignore-the-pods-directory-in-source-control
+# 
+# Note: if you ignore the Pods directory, make sure to uncomment
+# `pod install` in .travis.yml
+#
+Pods/
+
+# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
+# Packages/
+# Package.pins
+# Package.resolved
+.build/

.swift-version

@@ -0,0 +1 @@
+5.0

.swiftformat

@@ -0,0 +1 @@
+--exclude Example/Pods

.swiftlint.yml

@@ -0,0 +1,17 @@
+disabled_rules: # rule identifiers to exclude from running
+  - file_length
+  - function_body_length
+  - function_parameter_count
+  - line_length
+  - nesting
+  - type_body_length
+  - identifier_name
+opt_in_rules: # some rules are only opt-in
+  - colon
+  - comma
+  - control_statement
+  - empty_count
+  - trailing_newline
+included: # paths to include during linting. `--path` is ignored if present.
+  - SheetyColors/Classes
+excluded: # paths to ignore during linting. Takes precedence over `included`.

.travis.yml

@@ -0,0 +1,14 @@
+# references:
+# * https://www.objc.io/issues/6-build-tools/travis-ci/
+# * https://github.com/supermarin/xcpretty#usage
+
+osx_image: xcode7.3
+language: objective-c
+# cache: cocoapods
+# podfile: Example/Podfile
+# before_install:
+# - gem install cocoapods # Since Travis is not always on latest version
+# - pod install --project-directory=Example
+script:
+- set -o pipefail && xcodebuild test -enableCodeCoverage YES -workspace Example/SheetyColors.xcworkspace -scheme SheetyColors-Example -sdk iphonesimulator9.3 ONLY_ACTIVE_ARCH=NO | xcpretty
+- pod lib lint

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 christoph.wendt@me.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

Documentation/Reference/README.md

@@ -0,0 +1,26 @@
+# Reference Documentation
+This Reference Documentation has been generated with
+[SourceDocs](https://github.com/eneko/SourceDocs).
+
+## Protocols
+
+-   [SheetyColorProtocol](protocols/SheetyColorProtocol.md)
+-   [SheetyColorsConfigProtocol](protocols/SheetyColorsConfigProtocol.md)
+
+## Structs
+
+-   [SheetyColorsConfig](structs/SheetyColorsConfig.md)
+
+## Classes
+
+-   [RGBAColor](classes/RGBAColor.md)
+
+## Enums
+
+-   [SheetyColorsType](enums/SheetyColorsType.md)
+
+## Extensions
+
+-   [RGBAColor](extensions/RGBAColor.md)
+-   [SheetyColorsController](extensions/SheetyColorsController.md)
+-   [UIColor](extensions/UIColor.md)

Documentation/Reference/classes/RGBAColor.md

@@ -0,0 +1,52 @@
+**CLASS**
+
+# `RGBAColor`
+
+```swift
+public class RGBAColor: NSObject, NSCopying, Codable
+```
+
+> A model class representing RGBA colors. The red, green, and blue component can hold values between 0.0 and 255.0 while the alpha value has a maximum value of 100.0.
+
+## Methods
+### `init(red:green:blue:alpha:)`
+
+```swift
+public init(red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat)
+```
+
+> Creates a RGBAColor instance.
+>
+> - Parameter:
+>     - red: The red component.
+>     - green: The green component.
+>     - blue: The blue component.
+>     - alpha: The opacity component.
+
+### `copy(with:)`
+
+```swift
+public func copy(with _: NSZone? = nil) -> Any
+```
+
+> Creates a copy of the RGBAColor instance.
+>
+> - Returns: A copy of the RGBAColor instance.
+
+### `isEqual(_:)`
+
+```swift
+public override func isEqual(_ object: Any?) -> Bool
+```
+
+> Compares two RGBAColor instances with each other.
+>
+> - Parameter object: The RGBAColor to compare with.
+>
+> - Returns: 'true' if the instance is equal to the other RGBAColor instance, otherwise 'false''.
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| object | The RGBAColor to compare with. |

Documentation/Reference/enums/SheetyColorsType.md

@@ -0,0 +1,18 @@
+**ENUM**
+
+# `SheetyColorsType`
+
+```swift
+public enum SheetyColorsType: Equatable, CaseIterable
+```
+
+> An enum used for specifying the color model of the SheetyColors view.
+
+## Cases
+### `rgb`
+
+```swift
+case rgb
+```
+
+> The RGB color model.

Documentation/Reference/extensions/RGBAColor.md

@@ -0,0 +1,12 @@
+**EXTENSION**
+
+# `RGBAColor`
+
+## Properties
+### `uiColor`
+
+```swift
+public var uiColor: UIColor
+```
+
+> The UIColor representation of the RGBAColor.

Documentation/Reference/extensions/SheetyColorsController.md

@@ -0,0 +1,24 @@
+**EXTENSION**
+
+# `SheetyColorsController`
+
+## Properties
+### `color`
+
+```swift
+var color: UIColor
+```
+
+> The current color managed by the SheetyColorsController instance.
+
+## Methods
+### `init(withConfig:)`
+
+```swift
+convenience init(withConfig config: SheetyColorsConfigProtocol)
+```
+
+> Creates a SheetyColorsController instance.
+>
+> - Parameter:
+>     - config: A config object containing options for specifying the look and feel of a SheetyColors view.