Latest 0.1.9
Homepage https://github.com/dmwesterhoff/DWRandom
License MIT
Platforms ios 7.0, requires ARC
Authors

Alt text

Version
[CI Status](https://travis-ci.org/David Westerhoff/DWRandom)
Doc Coverage
License
Platform
Language

Sometimes life calls for a bit of randomness.

Whether or not its grabbing a marble from a bag, a card from a deck or
something else entirely this library will give you a simple yet powerful
addition to Foundation objects functionality, random behavior.

DWRandom is a lightweight framework written in Objective-C that makes working
with randomization in many of the Foundation core objects a breeze. The
interface is extension based and aims to be dead simple to use and
effortless to learn. Use DWRandom if you want to add a deadly one liner for
randomization in your project.

Table of Contents


Features


So why use this library and not write your own randomization utility methods?
While you’re welcome to do so, theres several reasons you might want to use
DWRandom in your project.

  • Dead simple developer inteface, and a lot of nice one-liners
  • 100% documentation coverage
  • Comprehensive testing on all methods
  • Cocoapods integration, get started fast
  • Completely extension based, no need for additional classes
  • Properly implemented, see implementation for more info

Installation


Cocoapods

DWRandom is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod "DWRandom"

Now you can add to your project with

#import <DWRandom/DWRandom.h>
Source

You can clone the repo with git:

git clone https://github.com/dmwesterhoff/DWRandom.git

then simply add the files to your project, and use a local import header

#import "DWRandom.h"

Usage


To make things easy to remember all methods in the DWRandom library are
prefixed with the word ‘random’. For example choosing a random element from
an array.

id randomObject = [array randomObject];

or grabbing a random UIColor…

UIColor *randomColor = [UIColor randomColor];

Easy to remember right? Heres a comprehensive list of all available methods,
for copy-paste snippets showing many examples check out the
Examples

Foundation+DWRandom


NSArray
- (id)randomObject;
+ (NSArray*)randomShuffle:(NSArray*)array;
NSMutableArray
- (id)randomObject;
- (void)randomShuffle;
+ (NSMutableArray*)randomShuffle:(NSMutableArray*)array;
NSDictionary
- (id)randomKey;
- (id)randomValue;
NSMutableDictionary
- (id)randomKey;
- (id)randomValue;
NSSet
- (id)randomObject;
NSMutableSet
- (id)randomObject;
NSOrderedSet
- (id)randomObject;
NSCountedSet
- (id)randomObject;
NSData
+ (NSData*)randomDataOfLength:(NSUInteger)length;
NSNumber
+ (BOOL)randomBool;
+ (unsigned int)randomInteger;
+ (unsigned int)randomIntegerWithMax:(unsigned int)max;
+ (unsigned int)randomIntegerWithMin:(unsigned int)min
                                 max:(unsigned int)max;
+ (NSNumber*)randomNumber;
+ (NSNumber*)randomNumberWithMax:(unsigned int)max;
+ (NSNumber*)randomNumberWithMin:(unsigned int)min
                             max:(unsigned int)max;
NSString
- (NSString*)randomCharacter;
+ (NSString*)randomStringOfLength:(NSUInteger)length;
+ (NSString*)randomStringOfLength:(NSUInteger)length
                           option:(DWRandomStringOption)option;
+ (NSString*)randomStringOfLength:(NSUInteger)length
                     characterSet:(NSString*)characterSet;
+ (NSString*)randomShuffle:(NSString*)string;
NSMutableString
- (void)randomShuffle;
- (NSString*)randomCharacter;

UIKit+DWRandom


UIColor
+ (UIColor*)randomColor;
+ (UIColor*)randomColorWithAlpha:(CGFloat)alpha;
+ (UIColor*)randomColorWithRandomAlpha;

Examples


Coming soon…

Documentation


You can check out the full reference documentation
here.

Implementation


Underlying the library is the arc4random() function, more specifically the
arc4random_uniform() as it avoids a modulo bias as opposed to doing something
like arc4random() % n. arc4random methods also have significantly better
range than other "equivalents".

The arc4random man pages say:

The arc4random() function uses the key stream generator employed by the
arc4 cipher, which uses 8*8 8 bit S-Boxes.  The S-Boxes can be in about
(2**1700) states.  The arc4random() function returns pseudo-random numbers
in the range of 0 to (2**32)-1, and therefore has twice the range of
rand(3) and random(3).

And some information on the modulo bias from the man pages:

arc4random_uniform() will return a uniformly distributed random number
less than upper_bound.  arc4random_uniform() is recommended over construc-
tions like ``arc4random() % upper_bound'' as it avoids "modulo bias" when
the upper bound is not a power of two.

Another benefit of using the arc4random function famility is that none
of the functions need be explicitly seeded as it is done automatically
behind the scenes.

Contributing


Got a great idea and want to contribute? Here’s how you can help…

  1. Fork it
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

History


v0.1.0 – Intial project release (3/6/16)

Roadmap


  • +90% code testing coverage
  • AppKit Classes
  • Randomly add/pop from mutable arrays

References


Good reads for anyone that wants to do their own digging around.

Author


David Westerhoff – [email protected]

License


The MIT License (MIT)

Copyright (c) 2016 David M. Westerhoff

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.

Latest podspec

{
    "name": "DWRandom",
    "version": "0.1.9",
    "summary": "An extension based iOS and OS X randomization library",
    "description": "DWRandom is a lightweight framework written in Objective-C that makesnworking with randomization in many of Foundations core data structures anbreeze(And some UI classes too!). The interface is extension based and aimsnto be dead simple to easily put randomization capabilities in your projectnin a very clean way. If you want a clean one liner solution fornrandomization look no further.",
    "homepage": "https://github.com/dmwesterhoff/DWRandom",
    "license": "MIT",
    "authors": {
        "David Westerhoff": "[email protected]"
    },
    "source": {
        "git": "https://github.com/dmwesterhoff/DWRandom.git",
        "tag": "0.1.9"
    },
    "platforms": {
        "ios": "7.0"
    },
    "requires_arc": true,
    "source_files": "DWRandom/**/*"
}

Pin It on Pinterest

Share This