Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nzrsky/odstringify
Stringify ObjC variables. Safely 🈯️
https://github.com/nzrsky/odstringify
cocoa cocoapods ios macos objc objective-c osx runtime
Last synced: 22 days ago
JSON representation
Stringify ObjC variables. Safely 🈯️
- Host: GitHub
- URL: https://github.com/nzrsky/odstringify
- Owner: nzrsky
- License: mit
- Created: 2016-06-14T21:34:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T16:57:41.000Z (2 months ago)
- Last Synced: 2024-12-01T01:06:51.926Z (22 days ago)
- Topics: cocoa, cocoapods, ios, macos, objc, objective-c, osx, runtime
- Language: Objective-C
- Homepage:
- Size: 512 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ODStringify
[](https://app.travis-ci.com/nzrsky/ODStringify)
[](https://codecov.io/github/nzrsky/ODStringify?branch=master)
[](https://cocoapods.org/pods/ODStringify)
[](https://github.com/Carthage/Carthage)
[](http://cocoadocs.org/docsets/ODStringify)
[](http://twitter.com/nzrsky)
## Usage
With ODStringify, you can create strings from classes, properties, defines, and functions using one function—safely.
And everything is done at compile time.
No more runtime overhead and calls like `NSStringFromClass` (although for this function, it was very small).
First of all, you can create strings from defined values. It's amazing. For example:
```objective-c
#define MAX_NUMBER_OF_SOMETHING 10
#define DEFAULT_HI_STRING @"hello"
NSLog(@"Hi string:%@", ODStringify(DEFAULT_HI_STRING)); // > @"hello" (@"@\"hello\"")
NSLog(@"Max number:%@", ODStringify(MAX_NUMBER_OF_SOMETHING)); // > 10 (@"10")
```
### ODStringifyClass
Class name string with compile-time type checking.
```objective-c
NSLog(@"Valid class:%@", ODStringifyClass(AppDelegate)); // AppDelegate
NSLog(@"Invalid class:%@", ODStringifyClass(App_Delegate)); // Error
```
### ODStringifyProtocol
Protocol name string with compile-time type checking.
```objective-c
NSLog(@"Valid protocol:%@", ODStringifyProtocol(NSCopying)); // NSCopying
NSLog(@"Invalid protocol:%@", ODStringifyProtocol(NSCopiing)); // Error
```
### ODStringifyProperty
Pretty much the same thing for properties.
**Note:** You need to be inside a class implementation (and have access to `self`).
```objective-c
// AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
NSLog(@"Valid property:%@", ODStringifyProperty(window)); // window
NSLog(@"Invalid property:%@", ODStringifyProperty(window_)); // Error
return YES;
}
```
## Installation
ODStringify supports multiple methods for installing the library in a project.
### Installation with CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Objective-C and Swift, which automates and simplifies the process of using third-party libraries like ODStringify in your projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
#### Podfile
To integrate ODStringify into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '12.0'
target 'TargetName' do
pod 'ODStringify'
end
```
Then, run the following command:
```bash
$ pod install
```
### Installation with Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following commands:
```bash
$ brew update
$ brew install carthage
```
To integrate ODStringify into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "nzrsky/ODStringify" ~> 1.1
```
Run `carthage` to build the framework and drag the built `ODStringify.framework` into your Xcode project.
## Author
Alexey Nazarov, [email protected]
## License
ODStringify is available under the MIT license. See the LICENSE file for more info.