Skip to content

Commit

Permalink
Initial commit for public release
Browse files Browse the repository at this point in the history
  • Loading branch information
adamkaplan committed Aug 6, 2015
0 parents commit a438d8f
Show file tree
Hide file tree
Showing 47 changed files with 3,632 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 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

Carthage

# We recommend against adding the Pods directory to your .gitignore. However
# you should judge for yourself, the pros and cons are mentioned at:
# http://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/
15 changes: 15 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# references:
# * http://www.objc.io/issue-6/travis-ci.html
# * https://github.com/supermarin/xcpretty#usage

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
install:
- gem install xcpretty --no-rdoc --no-ri --no-document --quiet
script:
- set -o pipefail && xcodebuild test -workspace Example/YMCache.xcworkspace -scheme YMCache-Example -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO | xcpretty -c
- pod lib lint --quick
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HEAD
====

0.0.1 (2015-08-01)
==================

* Initial public release of library (@adamkaplan)
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Contribution Guidelines

## General Guidelines

- **Min iOS SDK**: 7.0
- **Language**: Swift-compatible Objective-C.
- **Tests**: Yes, please

#### Architecture guidelines

- Avoid singletons that don't encapsulate a finite resource
- Never expose mutable state
- Public API designed to be called safely from any thread
- Keep classes/methods sharply focused
- Stay generic

## Style Guide

#### Base style:

Please add new code to this project based on the following style guidelines:

- [Apple's Coding Guidelines for Cocoa](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html)
- [NYTimes Objective C Style Guidelines](https://github.com/NYTimes/objective-c-style-guide)

Among other things, these guidelines call for:

- Open braces on the same line; close braces on their own line
- Always using braces for `if` statements, even with single-liners
- No spaces in method signatures except after the scope (-/+) and between parameter segments
- Use dot-notation, not `setXXX`, for properties (e.g. `self.enabled = YES`)
- Asterisk should touch variable name, not type (e.g. `NSString *myString`)
- Prefer `static const` (or `static Type *const`) over `#define` for compile-time constants
- Prefer private properties to ‘naked’ instance variables wherever possible
- Prefer accessor methods over direct struct access (e.g. CGGeometry methods like `CGRectGetMinX()`)

#### Additions:

- Prefix all class names with `YM`
- Prefix all constants with `kYM`
- Group related methods with `#pragma mark`
- Keep as much of the API private as is practically possible
4 changes: 4 additions & 0 deletions Cartfile.private
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Test Dependencies
github "specta/specta" ~> 1.0

github "specta/expecta" ~> 1.0
2 changes: 2 additions & 0 deletions Cartfile.resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github "specta/expecta" "v1.0.2"
github "specta/specta" "v1.0.3"
1 change: 1 addition & 0 deletions Examples/Mantle/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Pods/
8 changes: 8 additions & 0 deletions Examples/Mantle/Podfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
platform :ios, '8.0'
use_frameworks!

target 'YMCacheMantleExample' do
pod "Mantle", "~> 2.0"
pod "YMCache", :path => "../../"
end

19 changes: 19 additions & 0 deletions Examples/Mantle/Podfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
PODS:
- Mantle (2.0.3):
- Mantle/extobjc (= 2.0.3)
- Mantle/extobjc (2.0.3)
- YMCache (1.0.0)

DEPENDENCIES:
- Mantle (~> 2.0)
- YMCache (from `../../`)

EXTERNAL SOURCES:
YMCache:
:path: "../../"

SPEC CHECKSUMS:
Mantle: 8d6b14979a082a9ed4994463eb7a4ff576c94632
YMCache: 4650659957fd11ab7ab58ced7a2a49b130c24bd2

COCOAPODS: 0.38.2
Loading

0 comments on commit a438d8f

Please sign in to comment.