bumper

A/B Testing debug helper framework for iOS

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

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

pod "bumper"

Input json

This pod creates all A/B Features from an input json file that consists in an array of Features:

[
	{
		"name": "NameOfFirstFeature",
		"values": ["FirstValue", "SecondValue", "ThirdValue"],
		"description": "First test description"
	},
	{
		"name": "NameOfSecondFeature",
		"values": ["Yes", "No"],
		"description": "Boolean test description"
	},
    {
		"name": "NameOfThirdFeature",
		"values": ["true", "false"],
		"description": "Boolean test description"
	}
]

It will generate Enums or Booleans depending on the values you put on the Feature. If a feature consists on two elements and contains positive ("Yes" or "yes" or "true") and negative ("No", "no", "false") values, it will generate a Boolean. The default value for booleans or enums will be the first element of the values array

so

{
"name": "NameOfFirstFeature",
"values": ["FirstValue", "SecondValue", "ThirdValue"],
"description": "First test description"
}

will generate:

// NameOfFirstFeature is an enum with cases: FirstValue, SecondValue, ThirdValue
var nameOfFirstFeature: NameOfFirstFeature 

and

{
	"name": "NameOfSecondFeature",
	"values": ["Yes", "No"],
	"description": "Boolean test description"
}

will generate:

var nameOfSecondFeature: Bool

Script

The pod contains a script (scripts/flags_generator/flags_generator.rb) that takes the input json path and an output dir (where the generated swift file will go):

#> ruby {path_to_project}/scripts/flags_generator/flags_generator.rb -s {path_to_project}/subpath/to/json/file.json -d {path_to_project}/destination/file/dir/

Usage on project

Add the generated BumperFeatures.swift file to your project. Then just add the following line on your AppDeleagate previous to any call to any flag:

Bumper.initialize()

and then in any part of your code you can call:

switch Bumper.nameOfFirstFeature {
	case .FirstValue:
    ...
	default:
    ...
}
// OR
if Bumper.nameOfSecondFeature { ...

Enum types also come with a helper to create them using enum position:

let firstFeature = NameOfFirstFeature.fromPosition(0)

Extra: Fastlane lane:

You can add the following fastlane action (lg_bumper.rb) to your project:

module Fastlane
  module Actions
    module SharedValues
    end

    class LgBumperAction < Action
      def self.run(params)
        source_json = params[:source_json]
        destination_dir = params[:destination_dir]
        scriptCommand = "ruby ./Pods/bumper/scripts/flags_generator/flags_generator.rb -s #{source_json} -d #{destination_dir}"
        puts scriptCommand
        Helper.log.debug scriptCommand
        Actions.sh scriptCommand
      end


      #####################################################
      # @!group Documentation
      #####################################################

      def self.description
        "Bumper pod fastlane action: Generates BumperFeatures.swift file"
      end

      def self.available_options
        [FastlaneCore::ConfigItem.new(key: :source_json,
                                       env_name: "LG_BUMPER_SOURCE_JSON",
                                       description: "Bumper json source path",
                                       optional: false),
        FastlaneCore::ConfigItem.new(key: :destination_dir,
                                       env_name: "LG_BUMPER_DESTINATION_DIR",
                                       description: "Bumper swift generated file dir",
                                       optional: false)]
      end

      def self.output
      end

      def self.authors
        ["letgo"]
      end

      def self.is_supported?(platform)
        platform == :ios
      end
    end
  end
end

Adding the following lane to your Fastfile:

  desc "Will generate BumperFlags.switf based on the sources json"
  lane :bumper do
    lg_bumper(
      source_json: "./path/to/your/bumper_features.json",
      destination_dir: "./dir/where/to/generate/BumperFeatures/"
    )
  end

Author

Eli Kohen, [email protected]

License

bumper is available under the MIT license. See the LICENSE file for more info.