flip_the_switch 0.3.0

data/Tests/FlipTheSwitchSpec.xcodeproj/xcshareddata/xcschemes/FlipTheSwitchSpec-iOS.xcscheme

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "5B87AFE9193A80F20082F7A1"
+               BuildableName = "FlipTheSwitchSpec-iOS.xctest"
+               BlueprintName = "FlipTheSwitchSpec-iOS"
+               ReferencedContainer = "container:FlipTheSwitchSpec.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      buildConfiguration = "Debug">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "5B87AFE9193A80F20082F7A1"
+               BuildableName = "FlipTheSwitchSpec-iOS.xctest"
+               BlueprintName = "FlipTheSwitchSpec-iOS"
+               ReferencedContainer = "container:FlipTheSwitchSpec.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      buildConfiguration = "Debug"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      allowLocationSimulation = "YES">
+      <EnvironmentVariables>
+         <EnvironmentVariable
+            key = "SPECTA_REPORTER_CLASS"
+            value = "GcovTestObserver"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+      </EnvironmentVariables>
+      <AdditionalOptions>
+      </AdditionalOptions>
+   </LaunchAction>
+   <ProfileAction
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      buildConfiguration = "Release"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

data/Tests/Podfile

@@ -0,0 +1,15 @@
+def needed_pods
+  pod 'Specta'
+  pod 'Expecta'
+  pod 'OCMockito'
+end
+
+target 'FlipTheSwitchSpec-iOS' do
+  platform :ios, :deployment_target => 6.0
+  needed_pods
+end
+
+target 'FlipTheSwitchSpec-Mac' do
+  platform :osx, :deployment_target => 10.8
+  needed_pods
+end

data/Tests/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/clean'
+
+def pods; 'Pods'; end
+def podfile_lock; 'Podfile.lock'; end
+def build; 'build'; end
+def workspace; 'FlipTheSwitchSpec'; end
+
+CLOBBER.include(podfile_lock)
+CLOBBER.include(pods)
+
+CLEAN.include(build)
+
+task :default => :test
+
+file podfile_lock do
+  sh 'pod install'
+end
+
+task :test => podfile_lock do
+  sh "xctool test -scheme #{workspace}-Mac -workspace #{workspace}.xcworkspace OBJROOT=#{build} SHARED_PRECOMPS_DIR=#{build}"
+  sh "xctool test -scheme #{workspace}-iOS -workspace #{workspace}.xcworkspace -sdk iphonesimulator OBJROOT=#{build} SHARED_PRECOMPS_DIR=#{build}"
+end

data/Tests/Spec/Classes/FlipTheSwitch/FlipTheSwitchSpec.m

@@ -0,0 +1,88 @@
+#import "FlipTheSwitch.h"
+
+@interface FlipTheSwitch (Spec)
+- (instancetype)initWithUserDefaults:(NSUserDefaults *)userDefaults
+                              bundle:(NSBundle *)bundle;
+@end
+
+SpecBegin(FlipTheSwitch)
+    __block FlipTheSwitch *subject;
+
+    __block NSUserDefaults *userDefaults;
+
+    __block NSString *standardFeature;
+    __block NSString *plistEnabledFeature;
+
+    before(^{
+        userDefaults = [[NSUserDefaults alloc] init];
+
+        standardFeature = @"standard_feature";
+        plistEnabledFeature = @"plist_enabled_feature";
+
+        subject = [[FlipTheSwitch alloc] initWithUserDefaults:userDefaults
+                                                       bundle:[NSBundle bundleForClass:[self class]]];
+    });
+
+    after(^{
+        for (NSString *key in [userDefaults dictionaryRepresentation]) {
+            [userDefaults removeObjectForKey:key];
+        }
+        [userDefaults synchronize];
+    });
+
+    it(@"is a singleton", ^{
+        expect([FlipTheSwitch sharedInstance]).to.beIdenticalTo([FlipTheSwitch sharedInstance]);
+    });
+
+    context(@"when feature is NOT set", ^{
+        context(@"when feature defaults to enabled through plist", ^{
+            it(@"is enabled", ^{
+                expect([subject isFeatureEnabled:plistEnabledFeature]).to.beTruthy();
+            });
+        });
+
+        context(@"when feature does not default to enabled through plist", ^{
+            it(@"is disabled", ^{
+                expect([subject isFeatureEnabled:standardFeature]).to.beFalsy();
+            });
+        });
+    });
+
+    context(@"when feature is manually enabled", ^{
+        before(^{
+            [subject enableFeature:standardFeature];
+            [subject enableFeature:plistEnabledFeature];
+        });
+
+        it(@"is enabled", ^{
+            expect([subject isFeatureEnabled:standardFeature]).to.beTruthy();
+            expect([subject isFeatureEnabled:plistEnabledFeature]).to.beTruthy();
+        });
+    });
+
+    context(@"when feature is manually enabled", ^{
+        before(^{
+            [subject enableFeature:standardFeature];
+            [subject enableFeature:plistEnabledFeature];
+            [subject disableFeature:standardFeature];
+            [subject disableFeature:plistEnabledFeature];
+        });
+
+        it(@"is enabled", ^{
+            expect([subject isFeatureEnabled:standardFeature]).to.beFalsy();
+            expect([subject isFeatureEnabled:plistEnabledFeature]).to.beFalsy();
+        });
+    });
+
+    context(@"when feature is manually set", ^{
+        before(^{
+            [subject setFeature:standardFeature enabled:YES];
+            [subject setFeature:plistEnabledFeature enabled:YES];
+        });
+
+        it(@"is enabled", ^{
+            expect([subject isFeatureEnabled:standardFeature]).to.beTruthy();
+            expect([subject isFeatureEnabled:plistEnabledFeature]).to.beTruthy();
+        });
+    });
+SpecEnd

data/Tests/Spec/Helpers/GcovTestObserver.h

@@ -0,0 +1,4 @@
+#import <Specta/SPTNestedReporter.h>
+
+@interface GcovTestObserver : SPTNestedReporter
+@end

data/Tests/Spec/Helpers/GcovTestObserver.m

@@ -0,0 +1,12 @@
+#import "GcovTestObserver.h"
+
+@implementation GcovTestObserver
+
+- (void)stopObserving
+{
+    [super stopObserving];
+    extern void __gcov_flush(void);
+    __gcov_flush();
+}
+
+@end

data/bin/flip-the-switch

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'flip_the_switch/cli'
+
+FlipTheSwitch::Cli.start

data/flip_the_switch.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = 'flip_the_switch'
+  s.authors = ['Michael England', 'Rob Siwek']
+  s.email = %w(mg.england@gmail.com rob@robsiwek.com)
+  s.summary = 'A simple library to help enabling/disabling features on iOS/Mac applications.'
+  s.homepage = 'https://github.com/michaelengland/FlipTheSwitch'
+  s.version = '0.3.0'
+  s.license = 'MIT'
+
+  s.add_dependency 'activesupport', '~> 3.2'
+  s.add_dependency 'thor', '~> 0.19'
+  s.add_dependency 'plist', '~> 3.1'
+
+  s.files = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+end

data/lib/flip_the_switch/cli.rb

@@ -0,0 +1,61 @@
+require 'thor'
+require 'flip_the_switch'
+
+module FlipTheSwitch
+  class Cli < Thor
+    class_option :input, type: :string, aliases: '-i', default: Dir.pwd, desc: 'Location of the directory containing features.yml file to read'
+    class_option :enabled, type: :array, aliases: '-e', default: [], desc: 'Extra features to be set as enabled'
+    class_option :disabled, type: :array, aliases: '-d', default: [], desc: 'Extra features to be set as disabled'
+
+    desc 'plist', 'Auto-generates a Features.plist file for enabled/disabled features'
+    method_option :output, type: :string, aliases: '-o', default: Dir.pwd, desc: 'Location of the directory in which Features.plist file will be created'
+    def plist
+      plist_generator.generate
+    end
+
+    desc 'category', 'Auto-generates .h & .m files for enabled/disabled features'
+    method_option :output, type: :string, aliases: '-o', default: Dir.pwd, desc: 'Location of the directory in which FlipTheSwitch+Features.{h,m} files will be created'
+    def category
+      category_generator.generate
+    end
+
+    private
+
+    def plist_generator
+      Generator::Plist.new(output, feature_states)
+    end
+
+    def category_generator
+      Generator::Category.new(output, feature_states)
+    end
+
+    def output
+      options.output
+    end
+
+    def feature_states
+      yaml_reader.feature_states.
+          merge(enabled_states).
+          merge(disabled_states)
+    end
+
+    def yaml_reader
+      Reader::Yaml.new(options.input)
+    end
+
+    def enabled_states
+      states_for(options.enabled, true)
+    end
+
+    def disabled_states
+      states_for(options.disabled, false)
+    end
+
+    def states_for(array, default)
+      array.inject({}) do |h, feature|
+        h[feature] = default
+        h
+      end
+    end
+  end
+end

data/lib/flip_the_switch/errors.rb

@@ -0,0 +1,12 @@
+module FlipTheSwitch
+  module Error
+    class Base < StandardError
+    end
+
+    class UnreadableFile < Base
+    end
+
+    class InvalidFile < Base
+    end
+  end
+end

data/lib/flip_the_switch/generator/base.rb

@@ -0,0 +1,13 @@
+module FlipTheSwitch
+  module Generator
+    class Base
+      def initialize(output, feature_states)
+        @output = output
+        @feature_states = feature_states
+      end
+
+      protected
+      attr_reader :output, :feature_states
+    end
+  end
+end

data/lib/flip_the_switch/generator/category.rb

@@ -0,0 +1,71 @@
+require 'active_support/inflector'
+require 'erb'
+
+module FlipTheSwitch
+  module Generator
+    class Category < Base
+      def generate
+        delete_existing
+        write_files
+      end
+
+      private
+
+      def delete_existing
+        delete_file(header_file)
+        delete_file(implementation_file)
+      end
+
+      def write_files
+        write_file(header_file, header)
+        write_file(implementation_file, implementation)
+      end
+
+      def write_file(file, text)
+        File.open(file, 'w') do |f|
+          f.syswrite(text)
+        end
+      end
+
+      def delete_file(file)
+        File.delete(file) if File.exists?(file)
+      end
+
+      def header_file
+        File.join(output, 'FlipTheSwitch+Features.h')
+      end
+
+      def implementation_file
+        File.join(output, 'FlipTheSwitch+Features.m')
+      end
+
+      def header
+        render(header_template)
+      end
+
+      def implementation
+        render(implementation_template)
+      end
+
+      def render(template)
+        ERB.new(template).result(binding)
+      end
+
+      def header_template
+        file_template('header.h')
+      end
+
+      def implementation_template
+        file_template('implementation.m')
+      end
+
+      def file_template(name)
+        File.read(File.expand_path("../#{name}.erb", __FILE__))
+      end
+
+      def feature_names
+        feature_states.keys.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/flip_the_switch/generator/header.h.erb

@@ -0,0 +1,11 @@
+/* AUTO-GENERATED. DO NOT ALTER */
+#import <FlipTheSwitch/FlipTheSwitch.h>
+
+@interface FlipTheSwitch (Features)
+<% for feature in feature_names %>
++ (BOOL)is<%= feature.camelize %>Enabled;
++ (void)enable<%= feature.camelize %>;
++ (void)disable<%= feature.camelize %>;
++ (void)set<%= feature.camelize %>Enabled:(BOOL)enabled;
+<% end %>
+@end

data/lib/flip_the_switch/generator/implementation.m.erb

@@ -0,0 +1,26 @@
+/* AUTO-GENERATED. DO NOT ALTER */
+#import "FlipTheSwitch+Features.h"
+
+@implementation FlipTheSwitch (Features)
+<% for feature in feature_names %>
++ (BOOL)is<%= feature.camelize %>Enabled
+{
+    return [[FlipTheSwitch sharedInstance] isFeatureEnabled:@"<%= feature %>"];
+}
+
++ (void)enable<%= feature.camelize %>
+{
+    [[FlipTheSwitch sharedInstance] enableFeature:@"<%= feature %>"];
+}
+
++ (void)disable<%= feature.camelize %>
+{
+    [[FlipTheSwitch sharedInstance] disableFeature:@"<%= feature %>"];
+}
+
++ (void)set<%= feature.camelize %>Enabled:(BOOL)enabled
+{
+    [[FlipTheSwitch sharedInstance] setFeature:@"<%= feature %>" enabled:enabled];
+}
+<% end %>
+@end

data/lib/flip_the_switch/generator/plist.rb

@@ -0,0 +1,17 @@
+require 'plist'
+
+module FlipTheSwitch
+  module Generator
+    class Plist < Base
+      def generate
+        ::Plist::Emit.save_plist(feature_states, output_file)
+      end
+
+      private
+
+      def output_file
+        File.join(output, 'Features.plist')
+      end
+    end
+  end
+end

data/lib/flip_the_switch/generator.rb

@@ -0,0 +1,3 @@
+require 'flip_the_switch/generator/base'
+require 'flip_the_switch/generator/category'
+require 'flip_the_switch/generator/plist'

data/lib/flip_the_switch/reader/yaml.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+
+module FlipTheSwitch
+  module Reader
+    class Yaml
+      def initialize(input)
+        @input = input
+      end
+
+      def feature_states
+        if valid_file?
+          file_states
+        else
+          raise Error::InvalidFile.new
+        end
+      end
+
+      private
+      attr_reader :input
+
+      def valid_file?
+        file_states.is_a?(Hash) && file_states.all? { |feature, state|
+          feature.is_a?(String) && !!state == state
+        }
+      end
+
+      def file_states
+        @file_states ||= YAML.load_file(input_file)
+      rescue SystemCallError => e
+        raise Error::UnreadableFile.new(e)
+      end
+
+      def input_file
+        File.join(input, 'features.yml')
+      end
+    end
+  end
+end
+

data/lib/flip_the_switch/reader.rb

@@ -0,0 +1 @@
+require 'flip_the_switch/reader/yaml'

data/lib/flip_the_switch.rb

@@ -0,0 +1,3 @@
+require 'flip_the_switch/errors'
+require 'flip_the_switch/reader'
+require 'flip_the_switch/generator'

data/spec/flip_the_switch/cli_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe FlipTheSwitch::Cli do
+  subject(:cli) { described_class }
+  let(:perform) { subject.start([command] + options, debug: true) }
+
+  context 'when invalid command called' do
+    let(:command) { 'invalid' }
+    let(:options) { [] }
+
+    it 'throws an error' do
+      expect {
+        perform
+      }.to raise_error
+    end
+  end
+
+  shared_examples_for 'generator' do
+    let(:yaml_reader) { double(FlipTheSwitch::Reader::Yaml, feature_states: {'something' => true}) }
+    let(:generator) { double(generator_class) }
+
+    context 'when no options given' do
+      let(:options) { [] }
+
+      before do
+        FlipTheSwitch::Reader::Yaml.stub(:new).with(Dir.pwd).and_return(yaml_reader)
+        generator_class.stub(:new).with(Dir.pwd, 'something' => true).and_return(generator)
+      end
+
+      it 'generates using default options' do
+        expect(generator).to receive(:generate)
+        perform
+      end
+    end
+
+    context 'when options given' do
+      before do
+        FlipTheSwitch::Reader::Yaml.stub(:new).with('input').and_return(yaml_reader)
+        generator_class.stub(:new).with('output', {
+            'something' => true,
+            'en' => true,
+            'abled' => true,
+            'dis' => false,
+            'appointing' => false
+        }).and_return(generator)
+      end
+
+      context 'using full name' do
+        let(:options) { %w(--input=input --output=output --enabled=en abled --disabled=dis appointing) }
+
+        it 'generates using the options given' do
+          expect(generator).to receive(:generate)
+          perform
+        end
+      end
+
+      context 'using aliases' do
+        let(:options) { %w(-i=input -o=output -e=en abled -d=dis appointing) }
+
+        it 'generates using the options given' do
+          expect(generator).to receive(:generate)
+          perform
+        end
+      end
+    end
+  end
+
+  context 'when plist command called' do
+    let(:command) { 'plist' }
+    let(:generator_class) { FlipTheSwitch::Generator::Plist }
+
+    it_behaves_like 'generator'
+  end
+
+  context 'when category command called' do
+    let(:command) { 'category' }
+    let(:generator_class) { FlipTheSwitch::Generator::Category }
+
+    it_behaves_like 'generator'
+  end
+end

data/spec/flip_the_switch/generator/category_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe FlipTheSwitch::Generator::Category do
+  subject(:category) { FlipTheSwitch::Generator::Category.new(output, feature_states) }
+  let(:output) { 'spec/resources' }
+  let(:feature_states) { {'first_feature' => true, 'second_feature' => false} }
+  let(:expected_header_file) { File.read('spec/resources/expected_header.h') }
+  let(:expected_implementation_file) { File.read('spec/resources/expected_implementation.m') }
+
+  after do
+    delete_header_if_exists
+    delete_implementation_if_exists
+  end
+
+  it 'writes a FlipTheSwitch+Features.h file with the category header' do
+    subject.generate
+
+    expect(File.read(output_name_with('h'))).to eql(expected_header_file)
+  end
+
+  it 'writes a FlipTheSwitch+Features.m file with the category implementation' do
+    subject.generate
+
+    expect(File.read(output_name_with('m'))).to eql(expected_implementation_file)
+  end
+
+  private
+
+  def delete_header_if_exists
+    delete_output_if_exists_with('h')
+  end
+
+  def delete_implementation_if_exists
+    delete_output_if_exists_with('m')
+  end
+
+  def delete_output_if_exists_with(suffix)
+    File.delete(output_name_with(suffix)) if File.exists?(output_name_with(suffix))
+  end
+
+  def output_name_with(suffix)
+    "#{output}/FlipTheSwitch+Features.#{suffix}"
+  end
+end

data/spec/flip_the_switch/generator/plist_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe FlipTheSwitch::Generator::Plist do
+  subject(:plist) { FlipTheSwitch::Generator::Plist.new(output, feature_states) }
+  let(:output) { 'spec/resources' }
+  let(:feature_states) { {enabled_feature: true, disabled_feature: false} }
+  let(:output_file) { 'spec/resources/Features.plist' }
+  let(:expected_plist_file) { File.read('spec/resources/ExpectedFeatures.plist') }
+
+  after do
+    File.delete(output_file) if File.exists?(output_file)
+  end
+
+  it 'writes a Features.plist file with the enabled features set' do
+    subject.generate
+
+    expect(File.read(output_file)).to eql(expected_plist_file)
+  end
+end