Skip to content

Commit

Permalink
Add pod spec and separate sources from examples (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
mats-claassen authored and lognaturel committed May 19, 2017
1 parent beac8a6 commit aaa5657
Show file tree
Hide file tree
Showing 20 changed files with 117 additions and 12 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Change Log
All notable changes to SuggestionRow will be documented in this file.

### [1.0.0](https://github.com/EurekaCommunity/SuggestionRow/releases/tag/1.0.0)

* This is the initial version. It supports Eureka 3.0 and Swift 3

56 changes: 56 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
Contributing Guidelines
--------------------------------------------------

This document provides general guidelines about how to contribute to the project. Keep in mind these important things before you start contributing.

### Reporting issues

* Use [github issues](https://github.com/EurekaCommunity/SuggestionRow/issues) to report a bug.
* Before creating a new issue:
* Make sure you are using the [latest release](https://github.com/EurekaCommunity/SuggestionRow/releases).
* Check if the issue was [already reported or fixed](https://github.com/EurekaCommunity/SuggestionRow/issues?utf8=%E2%9C%93&q=is%3Aissue). Notice that it may not be released yet.
* If you found a match add a brief comment "I have the same problem" or "+1". This helps prioritize the issues addressing the most common and critical first. If possible add additional information to help us reproduce and fix the issue. Please use your best judgement.
* Reporting issues:
* Please include the following information to help maintainers to fix the problem faster:
* Xcode version you are using.
* iOS version you are targeting.
* Full Xcode console output of stack trace or code compilation error.
* Any other additional detail you think it would be useful to understand and solve the problem.


### Pull requests

The easiest way to start contributing is searching open issues by `help wanted` tag. We also add a `difficulty` tag (difficulty: easy, difficulty: moderate, difficulty: hard) in order to give an idea of how complex it can be to implement the feature according maintainers project experience.

* Add test coverage to the feature or fix. We only accept new feature pull requests that have related test coverage. This allows us to keep the library stable as we move forward.
* Remember to document the new feature. We do not accept new feature pull requests without its associated documentation.
* In case of a new feature please update the example project showing the feature.
* Please only one fix or feature per pull request. This will increase the chances your feature will be merged.


###### Suggested git workflow to contribute

1. Fork the SuggestionRow repository.
2. Clone your forked project into your developer machine: `git clone [email protected]:<your-github-username>/SuggestionRow.git`
3. Add the original project repo as upstream repository in your forked project: `git remote add upstream [email protected]:EurekaCommunity/SuggestionRow.git`
4. Before starting a new feature make sure your forked master branch is synchronized upstream master branch. Considering you do not mere your pull request into master you can run: `git checkout master` and then `git pull upstream master`. Optionally `git push origin master`.
5. Create a new branch. Note that the starting point is the upstream master branch HEAD. `git checkout -b my-feature-name`
6. Stage all your changes `git add .` and commit them `git commit -m "Your commit message"`
7. Make sure your branch is up to date with upstream master, `git pull --rebase upstream master`, resolve conflicts if necessary. This will move your commit to the top of git stack.
8. Squash your commits into one commit. `git rebase -i HEAD~6` considering you did 6 commits.
9. Push your branch into your forked remote repository.
10. Create a new pull request adding any useful comment.


###### Code style and conventions

We try to follow our [swift style guide](https://github.com/EurekaCommunity/Swift-Style-Guide). Following it is not strictly necessary to contribute and to have a pull request accepted but project maintainers try to follow it. We would love to hear your ideas to improve our code style and conventions. Feel free to contribute.


### Feature proposal

We would love to hear your ideas and make a discussions about it.

* Use github issues to make feature proposals.
* Before submitting your proposal make sure there is no similar feature request. If you found a match feel free to join the discussion or just add a brief "+1" if you think the feature is worth implementing.
* Be as specific as possible providing a precise explanation of feature request so anyone can understand the problem and the benefits of solving it.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Xmartlabs SRL

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ DEPENDENCIES:
SPEC CHECKSUMS:
Eureka: f36fd440c3ebb7bfea0a4fbe6f16a05f1cb35906

PODFILE CHECKSUM: abdf80b6d02f84824636f9d2253fa1ea8b32db46
PODFILE CHECKSUM: 7f4b13f8845410547d116e4d22ae094abc668c8c

COCOAPODS: 1.2.1
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<img src="https://img.shields.io/badge/platform-iOS-blue.svg?style=flat" alt="Platform iOS" />
<a href="https://developer.apple.com/swift"><img src="https://img.shields.io/badge/swift3-compatible-4BC51D.svg?style=flat" alt="Swift 3 compatible" /></a>
<a href="https://cocoapods.org/pods/SuggestionRow"><img src="https://img.shields.io/cocoapods/v/SuggestionRow.svg" alt="CocoaPods compatible" /></a>
<a href="https://raw.githubusercontent.com/EurekaCommunity/SuggestionRow/master/LICENSE"><img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License: MIT" /></a>
</p>

## Contents
* [Introduction](#introduction)
Expand Down Expand Up @@ -66,8 +69,8 @@ In your form, add a row of type `SuggestionAccessoryRow<Scientist>` or `Suggesti
...
form +++ Section("Table suggestions")
<<< SuggestionTableRow<Scientist>() {
$0.filterFunction = { text in
users.filter({ $0.firstName.lowercaseString.containsString(text.lowercaseString) })
$0.filterFunction = { [unowned self] text in
self.users.filter({ $0.firstName.lowercased().contains(text.lowercased()) })
}
$0.placeholder = "Search for a famous scientist"
}
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions SuggestionRow.podspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Pod::Spec.new do |s|
s.name = "SuggestionRow"
s.version = "1.0.0"
s.summary = "Eureka row that displays completion suggestions either below the row in a table view or in the input accessory view above the keyboard."
s.homepage = "https://github.com/EurekaCommunity/SuggestionRow"
s.license = { type: 'MIT', file: 'LICENSE' }
s.author = { "Xmartlabs SRL" => "[email protected]" }
s.source = { git: "https://github.com/EurekaCommunity/SuggestionRow.git", tag: s.version.to_s }
s.social_media_url = 'https://twitter.com/EurekaCommunity'
s.ios.deployment_target = '8.0'
s.requires_arc = true
s.ios.source_files = 'Sources/**/*.{swift}'
s.dependency 'Eureka', '3.0'
end
22 changes: 13 additions & 9 deletions SuggestionRow.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@
AA81DD391D64F706002F17F9 = {
isa = PBXGroup;
children = (
AA81DD441D64F706002F17F9 /* SuggestionRow */,
AA81DD731D64F801002F17F9 /* SuggestionRow */,
AA81DD441D64F706002F17F9 /* Example */,
AA81DD591D64F707002F17F9 /* SuggestionRowTests */,
AA81DD641D64F707002F17F9 /* SuggestionRowUITests */,
AA81DD431D64F706002F17F9 /* Products */,
Expand All @@ -138,18 +139,17 @@
name = Products;
sourceTree = "<group>";
};
AA81DD441D64F706002F17F9 /* SuggestionRow */ = {
AA81DD441D64F706002F17F9 /* Example */ = {
isa = PBXGroup;
children = (
AA81DD451D64F706002F17F9 /* AppDelegate.swift */,
AA81DD471D64F707002F17F9 /* SuggestionExampleViewController.swift */,
AA81DD731D64F801002F17F9 /* SuggestionRow */,
AA81DD491D64F707002F17F9 /* Main.storyboard */,
AA81DD4C1D64F707002F17F9 /* Assets.xcassets */,
AA81DD4E1D64F707002F17F9 /* LaunchScreen.storyboard */,
AA81DD511D64F707002F17F9 /* Info.plist */,
);
path = SuggestionRow;
path = Example;
sourceTree = "<group>";
};
AA81DD591D64F707002F17F9 /* SuggestionRowTests */ = {
Expand Down Expand Up @@ -182,6 +182,7 @@
8FA74BC81D831E2100571A0C /* String+SuggestionValue.swift */,
);
name = SuggestionRow;
path = Sources;
sourceTree = "<group>";
};
B49C487EB6DD1EF9AA014DDC /* Frameworks */ = {
Expand Down Expand Up @@ -271,6 +272,7 @@
TargetAttributes = {
AA81DD411D64F706002F17F9 = {
CreatedOnToolsVersion = 7.3.1;
DevelopmentTeam = 6F2G55XL63;
LastSwiftMigration = 0800;
};
AA81DD551D64F707002F17F9 = {
Expand Down Expand Up @@ -360,7 +362,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "diff \"${PODS_ROOT}/../Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n";
shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n";
showEnvVarsInLog = 0;
};
4CDE81A143A142D52FC074F6 /* [CP] Copy Pods Resources */ = {
Expand Down Expand Up @@ -390,7 +392,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "diff \"${PODS_ROOT}/../Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n";
shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n";
showEnvVarsInLog = 0;
};
9BAFAEE36ED07189A5DF8E7C /* [CP] Embed Pods Frameworks */ = {
Expand Down Expand Up @@ -435,7 +437,7 @@
);
runOnlyForDeploymentPostprocessing = 0;
shellPath = /bin/sh;
shellScript = "diff \"${PODS_ROOT}/../Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n";
shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n";
showEnvVarsInLog = 0;
};
E857824996F04E4B4EA1D2BE /* [CP] Copy Pods Resources */ = {
Expand Down Expand Up @@ -633,7 +635,8 @@
baseConfigurationReference = A5F8E139F8EF16B60D1F1F4C /* Pods-SuggestionRow.debug.xcconfig */;
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
INFOPLIST_FILE = SuggestionRow/Info.plist;
DEVELOPMENT_TEAM = 6F2G55XL63;
INFOPLIST_FILE = "$(SRCROOT)/Example/Info.plist";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = "Helene-Martin.SuggestionRow";
PRODUCT_NAME = "$(TARGET_NAME)";
Expand All @@ -646,7 +649,8 @@
baseConfigurationReference = 68D0D0DDD51BB31798E20BFD /* Pods-SuggestionRow.release.xcconfig */;
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
INFOPLIST_FILE = SuggestionRow/Info.plist;
DEVELOPMENT_TEAM = 6F2G55XL63;
INFOPLIST_FILE = "$(SRCROOT)/Example/Info.plist";
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = "Helene-Martin.SuggestionRow";
PRODUCT_NAME = "$(TARGET_NAME)";
Expand Down

0 comments on commit aaa5657

Please sign in to comment.