flip_the_switch 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e9b8507bbc66a9479d3fe174c8a42fba3495200
-  data.tar.gz: 01f913063a72ab9a2bd670fe7600f0d4b16fc830
+  metadata.gz: 4e4c3d08117d7df04e9f0b072c46ceaa37677bae
+  data.tar.gz: 129fd88d8381ebc2caac41d0cc28a52640043d2c
 SHA512:
-  metadata.gz: 8077a424aec23a34f08139b7213c8f17d8c650d980a3cea097c1d137609f08d5af256823eacf89b9fd67af9b5fd3255a6d7cf70e9a4a6d0a8e62a34bd7256144
-  data.tar.gz: a5a65e6aa1a43e8e22a4424a76efd73a90c99106c851ff5cfb2880ee4ea71529d7a159c352b57ebcfa02e34456c439661015f0fa86ebe9599f51dd5190489ce1
+  metadata.gz: aeb03d159b4a890318eea4976566d192c15c780558ec15eb2267047fd33f23891126acd287052d58f1a308fbd4414a8a19ec99fdcfb6107b30742f73940c02f0
+  data.tar.gz: 7120397022f1507790cd58763fc28fbb10fcc50d30ccf695eaeb21a7687474bd788c16bdb281b2d68accfc26eb01d375605955f32fb51bc8ac7eb61d42d22bb5

data/.gitignore

@@ -41,7 +41,7 @@ profile
 
 ####
 # Xcode temporary files that should never be committed
-# 
+#
 # NB: NIB/XIB files still exist even on Storyboard projects, so we want this...
 
 *~.nib
@@ -139,6 +139,9 @@ xcuserdata
 
 *.moved-aside
 
+####
+# AppCode
+.idea/
 
 ####
 # UNKNOWN: recommended by others, but I can't discover what these files are

data/.travis.yml

@@ -1,7 +1,9 @@
 language: objective-c
+osx_image: xcode7
 before_install:
     - brew update
-    - brew upgrade xctool
+    - brew uninstall xctool
+    - brew install xctool
     - sudo easy_install cpp-coveralls
     - gem install bundler
     - bundle install

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.0.0 / 2015-10-15
+
+*  [ENHANCEMENT] Using JSON instead of YAML for  features 
+*  [ENHANCEMENT] #37 Add Mac OSX Example Project
+*  [FEATURE] #36 Possibility to reset all features button (according to original plist at once)
+*  [FEATURE] #24 Adding reset to defaults functionality
+*  [FEATURE] #22 Adding support for subfeature
+*  [FEATURE] #21 Notifications on Feature Status
+*  [FEATURE] #20 Possibility to add description for feature flags
+
 # 0.4.0 / 2014-07-16
 
  * [FEATURE] #17 Use environments for feature states

data/Classes/FlipTheSwitch/Shared/FTSFeature.h

@@ -0,0 +1,11 @@
+@import Foundation;
+
+@interface FTSFeature : NSObject
+@property (nonatomic, readonly) NSString *name;
+@property (nonatomic, readonly) NSString *featureDescription;
+@property (nonatomic, readonly) BOOL enabled;
+
+- (id)init NS_UNAVAILABLE;
+- (instancetype)initWithName:(NSString *)name enabled:(BOOL)enabled featureDescription:(NSString *)featureDescription;
+
+@end

data/Classes/FlipTheSwitch/Shared/FTSFeature.m

@@ -0,0 +1,67 @@
+#import "FTSFeature.h"
+
+@implementation FTSFeature
+
+- (instancetype)initWithName:(NSString *)name enabled:(BOOL)enabled featureDescription:(NSString *)featureDescription
+{
+    self = [super init];
+    if (self) {
+        NSParameterAssert(name);
+        _name = name;
+        _featureDescription = featureDescription;
+        _enabled = enabled;
+    }
+    return self;
+}
+
+- (BOOL)isEqual:(id)other
+{
+    if (other == self) {
+        return YES;
+    }
+    if (!other || ![[other class] isEqual:[self class]]) {
+        return NO;
+    }
+
+    return [self isEqualToFeature:other];
+}
+
+- (BOOL)isEqualToFeature:(FTSFeature *)feature
+{
+    if (self == feature) {
+        return YES;
+    }
+    if (feature == nil) {
+        return NO;
+    }
+    if (self.name != feature.name && ![self.name isEqualToString:feature.name]) {
+        return NO;
+    }
+    if (self.featureDescription != feature.featureDescription && ![self.featureDescription isEqualToString:feature.featureDescription]) {
+        return NO;
+    }
+    if (self.enabled != feature.enabled) {
+        return NO;
+    }
+    return YES;
+}
+
+- (NSUInteger)hash
+{
+    NSUInteger hash = [self.name hash];
+    hash = hash * 31u + [self.featureDescription hash];
+    hash = hash * 31u + self.enabled;
+    return hash;
+}
+
+- (NSString *)description
+{
+    NSMutableString *description = [NSMutableString stringWithFormat:@"<%@: ", NSStringFromClass([self class])];
+    [description appendFormat:@"self.name=%@", self.name];
+    [description appendFormat:@", self.featureDescription=%@", self.featureDescription];
+    [description appendFormat:@", self.enabled=%d", self.enabled];
+    [description appendString:@">"];
+    return description;
+}
+
+@end

data/Classes/FlipTheSwitch/Shared/FTSFlipTheSwitch.h

@@ -0,0 +1,21 @@
+@import Foundation;
+
+#import "FTSFeature.h"
+
+extern NSString *const FTSFeatureStatusChangedNotification;
+extern NSString *const FTSFeatureStatusChangedNotificationFeatureKey;
+extern NSString *const FTSFeatureStatusChangedNotificationEnabledKey;
+extern NSString *const FTSFeaturePlistNameKey;
+
+@interface FTSFlipTheSwitch : NSObject
+- (instancetype)init NS_UNAVAILABLE;
++ (instancetype)sharedInstance;
+
+- (NSArray *)features;
+- (BOOL)isFeatureEnabled:(NSString *)feature;
+- (void)enableFeature:(NSString *)feature;
+- (void)disableFeature:(NSString *)feature;
+- (void)setFeature:(NSString *)feature enabled:(BOOL)enabled;
+- (void)resetFeature:(NSString *)feature;
+- (void)resetAllFeatures;
+@end

data/Classes/FlipTheSwitch/Shared/FTSFlipTheSwitch.m

@@ -0,0 +1,144 @@
+#import "FTSFlipTheSwitch.h"
+
+NSString *const FTSFeatureStatusChangedNotification = @"FTSFeatureStatusChangedNotification";
+NSString *const FTSFeatureStatusChangedNotificationFeatureKey = @"FTSFeatureStatusChangedNotificationFeatureKey";
+NSString *const FTSFeatureStatusChangedNotificationEnabledKey = @"FTSFeatureStatusChangedNotificationEnabledKey";
+NSString *const FTSFeaturePlistNameKey = @"FTSFeaturePlistNameKey";
+
+
+@interface FTSFlipTheSwitch ()
+@property (nonatomic, readonly) NSUserDefaults *userDefaults;
+@property (nonatomic, readonly) NSBundle *bundle;
+@property (nonatomic, readonly) NSNotificationCenter *notificationCenter;
+@end
+
+@implementation FTSFlipTheSwitch {
+    NSDictionary *_plistEnabledFeatures;
+}
+
+#pragma mark - Singleton
+
++ (instancetype)sharedInstance
+{
+    static FTSFlipTheSwitch *sharedInstance;
+    static dispatch_once_t once;
+    dispatch_once(&once, ^{
+        sharedInstance = [[self alloc] initWithUserDefaults:[NSUserDefaults standardUserDefaults]
+                                                     bundle:[NSBundle mainBundle]
+                                         notificationCenter:[NSNotificationCenter defaultCenter]];
+    });
+    return sharedInstance;
+}
+
+#pragma mark - Initialization
+
+- (instancetype)initWithUserDefaults:(NSUserDefaults *)userDefaults
+                              bundle:(NSBundle *)bundle
+                  notificationCenter:(NSNotificationCenter *)notificationCenter
+{
+    self = [super init];
+    if (self) {
+        NSParameterAssert(userDefaults);
+        NSParameterAssert(bundle);
+        NSParameterAssert(notificationCenter);
+        _userDefaults = userDefaults;
+        _bundle = bundle;
+        _notificationCenter = notificationCenter;
+    }
+    return self;
+}
+
+#pragma mark - Public
+
+- (NSArray *)features
+{
+    NSMutableArray *featureArray = [NSMutableArray array];
+    for (NSString *featureName in [self plistEnabledFeatures]) {
+        FTSFeature *feature = [[FTSFeature alloc] initWithName:featureName
+                                                       enabled:[self isFeatureEnabled:featureName]
+                                            featureDescription:[self plistEnabledFeatures][featureName][@"description"]];
+        [featureArray addObject:feature];
+    }
+    return [featureArray copy];
+}
+
+- (BOOL)isFeatureEnabled:(NSString *)feature
+{
+    NSNumber *userEnabledFeature = [self.userDefaults objectForKey:[self userKeyForFeature:feature]];
+    if (userEnabledFeature) {
+        return [userEnabledFeature boolValue];
+    } else {
+        return [[self plistEnabledFeatures][feature][@"enabled"] boolValue];
+    }
+}
+
+- (void)enableFeature:(NSString *)feature
+{
+    [self setFeature:feature enabled:YES];
+}
+
+- (void)disableFeature:(NSString *)feature
+{
+    [self setFeature:feature enabled:NO];
+}
+
+- (void)setFeature:(NSString *)feature enabled:(BOOL)enabled
+{
+    if (![self isFeatureEnabled:feature] == enabled) {
+        [self.userDefaults setObject:@(enabled) forKey:[self userKeyForFeature:feature]];
+        [self.userDefaults synchronize];
+        [self.notificationCenter postNotification:[self statusChangeNotificationForFeature:feature
+                                                                                   enabled:enabled]];
+    }
+}
+
+- (void)resetFeature:(NSString *)feature
+{
+    [self.userDefaults removeObjectForKey:[self userKeyForFeature:feature]];
+    [self.userDefaults synchronize];
+    [self.notificationCenter postNotification:[self statusChangeNotificationForFeature:feature
+                                                                               enabled:[self isFeatureEnabled:feature]]];
+}
+
+- (void)resetAllFeatures
+{
+    for (NSString *featureName in [self plistEnabledFeatures]) {
+        [self resetFeature:featureName];
+    }
+}
+
+#pragma mark - Private
+
+- (NSString *)userKeyForFeature:(NSString *)feature
+{
+    return [NSString stringWithFormat:@"FTS_FEATURE_%@", feature];
+}
+
+- (NSDictionary *)plistEnabledFeatures
+{
+    if (!_plistEnabledFeatures) {
+        _plistEnabledFeatures = [[NSDictionary alloc] initWithContentsOfFile:[self featurePlistPath]];
+    }
+    return _plistEnabledFeatures;
+}
+
+- (NSString *)featurePlistPath
+{
+    NSString *plistName = [self.userDefaults objectForKey:FTSFeaturePlistNameKey];
+    if (plistName == nil) {
+      plistName = @"Features";
+    }
+    return [self.bundle pathForResource:plistName ofType:@"plist"];
+}
+
+- (NSNotification *)statusChangeNotificationForFeature:(NSString *)feature enabled:(BOOL)enabled
+{
+    return [NSNotification notificationWithName:FTSFeatureStatusChangedNotification
+                                         object:self
+                                       userInfo:@{
+                                           FTSFeatureStatusChangedNotificationFeatureKey : feature,
+                                           FTSFeatureStatusChangedNotificationEnabledKey : @(enabled)
+                                       }];
+}
+
+@end

data/Classes/FlipTheSwitch/iOS/FTSFeatureCell.h

@@ -0,0 +1,17 @@
+@import Foundation;
+@import UIKit;
+
+@class FTSFeatureCell;
+#import "FTSFeatureDescriptionLabel.h"
+
+@protocol FlipTheSwitchCellDelegate <NSObject>
+- (void)flipTheSwitchCellDidToggleFeature:(FTSFeatureCell *)cell;
+@end
+
+@interface FTSFeatureCell : UITableViewCell
+@property (nonatomic, weak) IBOutlet UILabel *featureNameLabel;
+@property (nonatomic, weak) IBOutlet UISwitch *toggle;
+@property (nonatomic, weak) IBOutlet FTSFeatureDescriptionLabel *featureDescriptionLabel;
+
+@property (nonatomic, weak) id<FlipTheSwitchCellDelegate> delegate;
+@end

data/Classes/FlipTheSwitch/iOS/FTSFeatureCell.m

@@ -0,0 +1,12 @@
+#import "FTSFeatureCell.h"
+
+@implementation FTSFeatureCell
+
+#pragma mark - Action
+
+- (IBAction)featureToggled:(id)sender
+{
+    [self.delegate flipTheSwitchCellDidToggleFeature:self];
+}
+
+@end

data/Classes/FlipTheSwitch/iOS/FTSFeatureConfigurationViewController.h

@@ -0,0 +1,5 @@
+@import Foundation;
+@import UIKit;
+
+@interface FTSFeatureConfigurationViewController : UIViewController
+@end

data/Classes/FlipTheSwitch/iOS/FTSFeatureConfigurationViewController.m

@@ -0,0 +1,142 @@
+#import "FTSFeatureConfigurationViewController.h"
+#import "FTSFlipTheSwitch.h"
+#import "FTSFeatureCell.h"
+
+static NSString * const FTSFeatureCellIdentifier = @"featureCell";
+
+@interface FTSFeatureConfigurationViewController () <UITableViewDelegate, UITableViewDataSource, FlipTheSwitchCellDelegate>
+@property (nonatomic) NSArray *dataSource;
+@property (weak, nonatomic) IBOutlet UITableView *tableView;
+
+@end
+
+@implementation FTSFeatureConfigurationViewController
+
+#pragma mark - UIViewController
+
+- (void)viewDidLoad
+{
+    [super viewDidLoad];
+    
+    self.tableView.delegate = self;
+    self.tableView.dataSource = self;
+    [self setupDataSource];
+}
+
+#pragma mark - Actions
+
+- (IBAction)doneButtonTapped:(id)sender
+{
+    [self dismissViewControllerAnimated:YES completion:nil];
+}
+
+- (IBAction)resetFeatures:(UIButton *)sender {
+    [self resetFeatures];
+}
+
+- (void)resetFeatures{
+    [[FTSFlipTheSwitch sharedInstance] resetAllFeatures];
+    [self reloadData];
+}
+
+#pragma mark - UITableViewDataSource
+
+- (void)reloadData
+{
+    [self loadFeatureData];
+    [self.tableView reloadData];
+}
+
+- (void)setupDataSource
+{
+    [self loadFeatureData];
+}
+
+- (void)loadFeatureData{
+    self.dataSource = [[FTSFlipTheSwitch sharedInstance] features];
+}
+
+- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView
+{
+    return 1;
+}
+
+- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section
+{
+    return [self.dataSource count];
+}
+
+- (CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath
+{
+    return [self heightForBasicCellAtIndexPath:indexPath];
+}
+
+#pragma mark - UITableViewDelegate
+
+- (CGFloat)heightForBasicCellAtIndexPath:(NSIndexPath *)indexPath
+{
+    [self configureFeatureCell:self.sizingCell atIndexPath:indexPath];
+    return [self calculateHeightForConfiguredSizingCell:self.sizingCell];
+}
+
+- (CGFloat)calculateHeightForConfiguredSizingCell:(UITableViewCell *)sizingCell
+{
+    sizingCell.bounds = CGRectMake(0.0f, 0.0f, CGRectGetWidth(self.tableView.frame), CGRectGetHeight(sizingCell.bounds));
+    [sizingCell layoutIfNeeded];
+
+    CGSize size = [sizingCell.contentView systemLayoutSizeFittingSize:UILayoutFittingCompressedSize];
+    return size.height + 1.0f; // seperator
+}
+
+- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
+{
+    return [self featureCellAtIndexPath:indexPath];
+}
+    
+#pragma mark - FlipTheSwitchCellDelegate
+
+- (void)flipTheSwitchCellDidToggleFeature:(FTSFeatureCell *)cell
+{
+    NSUInteger index = (NSUInteger)[self.tableView indexPathForCell:cell].row;
+    FTSFeature *feature = self.dataSource[index];
+    [[FTSFlipTheSwitch sharedInstance] setFeature:feature.name
+                                          enabled:cell.toggle.on];
+}
+
+#pragma mark - Private
+
+- (void)configureFeatureCell:(FTSFeatureCell *)cell atIndexPath:(NSIndexPath *)indexPath{
+    FTSFeature *feature = self.dataSource[(NSUInteger)indexPath.row];
+    [self presentCell:cell withFeature:feature];
+}
+
+- (FTSFeatureCell *)featureCellAtIndexPath:(NSIndexPath *)indexPath
+{
+    FTSFeatureCell *cell = [self.tableView dequeueReusableCellWithIdentifier:FTSFeatureCellIdentifier forIndexPath:indexPath];
+    cell.delegate = self;
+    [self configureFeatureCell:cell atIndexPath:indexPath];
+    
+    return cell;
+}
+
+- (void)presentCell:(FTSFeatureCell *)cell withFeature:(FTSFeature *)feature
+{
+    cell.featureNameLabel.text = feature.name;
+    [cell.toggle setOn:feature.enabled animated:NO];
+    cell.featureDescriptionLabel.text = feature.featureDescription;
+}
+
+- (FTSFeatureCell *)sizingCell
+{
+    static FTSFeatureCell *sizingCell = nil;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        sizingCell = [self.tableView dequeueReusableCellWithIdentifier:FTSFeatureCellIdentifier];
+        // iOS bug fix to avoid breaking a by system added 'UIView-Encapsulated-Layout-Height' constraint
+        sizingCell.frame = CGRectMake(0, 0, 100, 100);
+        sizingCell.contentView.frame = sizingCell.frame;
+    });
+    return sizingCell;
+}
+
+@end