test_track_rails_client 0.9.13 → 0.9.14

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mjk3ZWY4NzlhYzVkOTE1NWU0ZWE2NmI5YzM2YTFlMzRkY2YyMjlhZg==
+    ODhlNWMwYmU2ZWE5YmMwYTNlYTM0YTkyNDAyM2E0ODgyZjI1YjAyZg==
   data.tar.gz: !binary |-
-    YmI1NDdhNmUxZjllMDRmZGFiNzMzYzdmYzhjNDA2NzI0OTE4ODNiZQ==
+    MDc3MzQwNDcwNGM2MTY1MmY1ZjYwZmIxNDJlMGE5MWUwMjRiNzI4ZQ==
 SHA512:
   metadata.gz: !binary |-
-    MmUxOTEwYTZkODI5YWEwZmY2ZjEwOTg5NjIzM2U0NTY1MGY2NzI2OGM1Mzk0
-    MjU5ZDMzYzE3MTllZWFkODRmNDE2ZDJkZjNhNGViN2NiNjY1MWQwZjQ0MWFm
-    YjYxYzRhOGUwYjBjYWU4MTQwNTk3OWQwMzA3MWU0NTZjNDhmNTQ=
+    ODc1YTE3ZjMxYzMwZTlkOTA2YjU1OTk2NDIyMGI2YjhlNWY0ZjRkZGQ2MzQy
+    Y2VhNmM4ZDRiY2JiMGI3ODBmM2M2NWRmMTI5MDNjNDVmMTQxZDRiZDNmZTQ0
+    ZWE5MjRiNmM4YmMzMzE4NjZmMzMxMDg5NzQwZGU4MDAxYjA5ODA=
   data.tar.gz: !binary |-
-    MGM0MDI4YWRmNjAxNGMxZWI3Yzk4YzU5MzVkMDRhZmZhMjk0YWQxMmIxMGM5
-    ZmFjYTc4YmZiYTFiZmQ4M2YzZjhkOTQ5ZGRlYzk0MzNiNzE1NzgzYTVlNDRk
-    NjNlNmEyNzE5NjQyNDRmMWZhZmE3ZjkyOGNhZDI1YWE4ZmQ5ZmY=
+    ODI2MTViNTM5YjE0YzdkN2NmZjc5NWE5ZmJkODQ5ODIzYTAxZWVmNDI5ODhk
+    ZWY0ZTBmMzM2Y2FiNzUwMTFlMTdhZTNjZGYxNjE2MmVjY2QwMjllOWY0MjU0
+    ODg4ZTVmYzMyOTE0NTFjM2Y4OGE2MjhkM2YxZmY4Yjc2YjQzMDE=

data/README.md

@@ -107,6 +107,76 @@ end
 
 _Note: `drop_split` (a.k.a. `finish_split`) does not physically delete split data from mixpanel or Test Track's database._
 
+### Generating Split Migrations
+
+Split configuration changes can be generated using Rails generators that are included with the TestTrack Rails client.
+
+```
+rails generate test_track:migration add_name_of_split
+```
+
+will generate a timestamped migration file with the content
+
+```ruby
+class AddNameOfSplit < ActiveRecord::Migration
+  def change
+    TestTrack.update_config do |c|
+      c.split :name_of_split, control: 50, treatment: 50
+    end
+  end
+end
+```
+
+The generator infers the type of split from the migration name.
+
+Adding `Drop` to the migration name will create a migration to drop a split.
+
+```
+rails generate test_track:migration drop_name_of_split
+```
+
+```ruby
+class DropNameOfSplit < ActiveRecord::Migration
+  def change
+    TestTrack.update_config do |c|
+      c.drop_split :name_of_split
+    end
+  end
+end
+```
+
+Adding `Enabled` or `FeatureFlag` to the end of the migration name will create sensible defaults for a feature flag split.
+
+```
+rails generate test_track:migration add_name_of_split_enabled
+```
+
+```ruby
+class AddNameOfSplitEnabled < ActiveRecord::Migration
+  def change
+    TestTrack.update_config do |c|
+      c.split :name_of_split_enabled, true: 0, false: 100
+    end
+  end
+end
+```
+
+Adding `Experiment` to the end of the migration name will create sensible defaults for an experiment.
+
+```
+rails generate test_track:migration add_name_of_split_experiment
+```
+
+```ruby
+class AddNameOfSplitExperiment < ActiveRecord::Migration
+  def change
+    TestTrack.update_config do |c|
+      c.split :name_of_split_experiment, control: 50, treatment: 50
+    end
+  end
+end
+```
+
 ## Varying app behavior based on assigned variant
 
 ### Varying app behavior in a web context

data/lib/generators/test_track/migration_generator.rb

@@ -1,38 +1,80 @@
-require 'rails/generators/named_base'
+require 'rails/generators/base'
 
 module TestTrack
   module Generators
-    class MigrationGenerator < Rails::Generators::NamedBase
-      desc "Creates a test track migration file. Files that start with retire or finish will create migrations that finish a split."
+    class MigrationGenerator < Rails::Generators::Base
+      desc "Creates a test track migration file."
+
+      argument :raw_split_name, required: true
 
       def create_test_track_migration_file
-        create_file "db/migrate/#{formatted_time_stamp}_#{file_name}.rb", <<-FILE.strip_heredoc
-          class #{file_name.camelize} < ActiveRecord::Migration
+        create_migration_file
+      end
+
+      private
+
+      def create_migration_file
+        create_file full_file_path, <<-FILE.strip_heredoc
+          class #{split_class_name} < ActiveRecord::Migration
             def change
               TestTrack.update_config do |c|
-                #{split_command} :#{split_name}
+                #{split_command_line}
               end
             end
           end
         FILE
       end
 
-      private
+      def split_command_line
+        "#{split_command} :#{split_name}#{split_variants}"
+      end
+
+      def split_command
+        @split_command ||= split_type == :drop ? 'c.drop_split' : 'c.split'
+      end
+
+      def split_variants
+        case split_type
+          when :drop
+            ''
+          when :gate
+            ', true: 0, false: 100'
+          else
+            ', control: 50, treatment: 50'
+        end
+      end
+
+      def split_type
+        if split_file_name.start_with? 'drop'
+          :drop
+        elsif split_file_name.end_with? 'enabled', 'feature_flag'
+          :gate
+        elsif split_file_name.end_with? 'experiment'
+          :experiment
+        else
+          :default
+        end
+      end
+
+      def full_file_path
+        "db/migrate/#{formatted_time_stamp}_#{split_file_name}.rb"
+      end
 
       def formatted_time_stamp
         Time.zone.now.strftime('%Y%m%d%H%M%S')
       end
 
-      def split_command
-        @split_command ||= finish_split? ? 'c.finish_split' : 'c.split'
+      def split_class_name
+        split_file_name.camelize
       end
 
-      def finish_split?
-        file_name.start_with?('retire', 'finish')
+      def split_name
+        noise_words = /^create_|^update_|^drop_|^add_/
+        split_file_name.gsub(noise_words, '')
       end
 
-      def split_name
-        file_name.split('_').slice(1, file_name.length).join('_')
+      def split_file_name
+        raw_split_name.underscore
       end
     end
   end

data/lib/test_track_rails_client/version.rb

@@ -1,3 +1,3 @@
 module TestTrackRailsClient
-  VERSION = "0.9.13" # rubocop:disable Style/MutableConstant
+  VERSION = "0.9.14" # rubocop:disable Style/MutableConstant
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_track_rails_client
 version: !ruby/object:Gem::Version
-  version: 0.9.13
+  version: 0.9.14
 platform: ruby
 authors:
 - Ryan O'Neill