split 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3272611f8e1b67b852c92022c86d10c79d60adfa
-  data.tar.gz: 560dc5662f892e2dd5909c1d1588954bedf11feb
+  metadata.gz: 1c048eebd0c41a821d257be6a6ee61175df3d413
+  data.tar.gz: 1585aa44b15a8ba0258f545f84a880d06b1b58fc
 SHA512:
-  metadata.gz: 17cdb89c56142fccc390986303f156d1a71a6c65e1e2759c1ad96394dc8620ccf2515e9d3ecc8fad0f6db7503381c5cb056ac985b2ba235d6130a171f7d82441
-  data.tar.gz: 330ae49fc82430ec36f810f6b07e0a6b78802f9610b531d86995955284e4252fcc37d7d7ed63c69056f6a4c069d125492ceab2f40183ae11864b00a15cf86a4f
+  metadata.gz: d65b2592b5c29c53da81491234d00264444a5261bcb354eed72914aa3b6e9faf9b9b9a533412895899d54dffb93b9483b6943318b53771a257faf71518860361
+  data.tar.gz: 856c23b850dee54c658c73cca8bb6b5f02220f5c44d394bb2281c4d948eeb7529773867fa1403ca6b20122c2a032c405378faa1baac7dff8eaf6e9f64e153066

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 1.4.5 (June 7th, 2016)
+
+Bugfixes:
+
+- FIX Negative numbers on non-finished (@divineforest, #408)
+- Eliminate extra RedisAdapter hget (@karmakaze, #407)
+- Remove unecessary code from Experiment class (@pakallis, #391, #392, #393)
+
+Misc:
+
+- Simplify Configuration#normalized_experiments (@pakallis, #395)
+- Clarify test running instructions (@henrik, #397)
+
 ## 1.4.4 (May 9th, 2016)
 
 Bugfixes:

data/README.md

@@ -700,11 +700,19 @@ Over 70 different people have contributed to the project, you can see them all h
 
 ## Development
 
+Run the tests like this:
+
+    # Start a Redis server in another tab.
+    redis-server
+
+    bundle
+    rake spec
+
 Source hosted at [GitHub](http://github.com/splitrb/split).
+
 Report Issues/Feature requests on [GitHub Issues](http://github.com/splitrb/split/issues).
-Discussion at [Google Groups](https://groups.google.com/d/forum/split-ruby)
 
-Tests can be ran with `rake spec`
+Discussion at [Google Groups](https://groups.google.com/d/forum/split-ruby).
 
 ### Note on Patches/Pull Requests
 

data/lib/split/configuration.rb

@@ -130,38 +130,32 @@ module Split
     end
 
     def normalized_experiments
-      if @experiments.nil?
-        nil
-      else
-        experiment_config = {}
-        @experiments.keys.each do |name|
-          experiment_config[name.to_sym] = {}
-        end
-
-        @experiments.each do |experiment_name, settings|
-          if alternatives = value_for(settings, :alternatives)
-            experiment_config[experiment_name.to_sym][:alternatives] = normalize_alternatives(alternatives)
-          end
+      return nil if @experiments.nil?
 
-          if goals = value_for(settings, :goals)
-            experiment_config[experiment_name.to_sym][:goals] = goals
-          end
-
-          if metadata = value_for(settings, :metadata)
-            experiment_config[experiment_name.to_sym][:metadata] = metadata
-          end
-
-          if algorithm = value_for(settings, :algorithm)
-            experiment_config[experiment_name.to_sym][:algorithm] = algorithm
-          end
+      experiment_config = {}
+      @experiments.keys.each do |name|
+        experiment_config[name.to_sym] = {}
+      end
 
-          if (resettable = value_for(settings, :resettable)) != nil
-            experiment_config[experiment_name.to_sym][:resettable] = resettable
-          end
+      @experiments.each do |experiment_name, settings|
+        alternatives = if (alts = value_for(settings, :alternatives))
+                         normalize_alternatives(alts)
+                       end
+
+        experiment_data = {
+          alternatives: alternatives,
+          goals: value_for(settings, :goals),
+          metadata: value_for(settings, :metadata),
+          algorithm: value_for(settings, :algorithm),
+          resettable: value_for(settings, :resettable)
+        }
+
+        experiment_data.each do |name, value|
+          experiment_config[experiment_name.to_sym][name] = value if value != nil
         end
-
-        experiment_config
       end
+
+      experiment_config
     end
 
     def normalize_alternatives(alternatives)

data/lib/split/experiment.rb

@@ -21,22 +21,22 @@ module Split
       alternatives = extract_alternatives_from_options(options)
 
       if alternatives.empty? && (exp_config = Split.configuration.experiment_for(name))
-        set_alternatives_and_options(
+        options = {
           alternatives: load_alternatives_from_configuration,
           goals: Split::GoalsCollection.new(@name).load_from_configuration,
           metadata: load_metadata_from_configuration,
           resettable: exp_config[:resettable],
           algorithm: exp_config[:algorithm]
-        )
+        }
       else
-        set_alternatives_and_options(
-          alternatives: alternatives,
-          goals: options[:goals],
-          metadata: options[:metadata],
-          resettable: options[:resettable],
-          algorithm: options[:algorithm]
-        )
+        options[:alternatives] = alternatives
       end
+
+      set_alternatives_and_options(options)
+    end
+
+    def self.finished_key(key)
+      "#{key}:finished"
     end
 
     def set_alternatives_and_options(options)
@@ -67,10 +67,9 @@ module Split
         end
       end
 
-      self.alternatives = alts
-      self.goals = options[:goals]
-      self.algorithm = options[:algorithm]
-      self.resettable = options[:resettable]
+      options[:alternatives] = alts
+
+      set_alternatives_and_options(options)
 
       # calculate probability that each alternative is the winner
       @alternative_probabilities = {}
@@ -86,7 +85,6 @@ module Split
         @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
         goals_collection.save
         save_metadata
-        Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
       else
         existing_alternatives = load_alternatives_from_redis
         existing_goals = Split::GoalsCollection.new(@name).load_from_redis
@@ -227,7 +225,7 @@ module Split
     end
 
     def finished_key
-      "#{key}:finished"
+      self.class.finished_key(key)
     end
 
     def metadata_key
@@ -267,11 +265,16 @@ module Split
 
     def load_from_redis
       exp_config = Split.redis.hgetall(experiment_config_key)
-      self.resettable = exp_config['resettable']
-      self.algorithm = exp_config['algorithm']
-      self.alternatives = load_alternatives_from_redis
-      self.goals = Split::GoalsCollection.new(@name).load_from_redis
-      self.metadata = load_metadata_from_redis
+
+      options = {
+        resettable: exp_config['resettable'],
+        algorithm: exp_config['algorithm'],
+        alternatives: load_alternatives_from_redis,
+        goals: Split::GoalsCollection.new(@name).load_from_redis,
+        metadata: load_metadata_from_redis
+      }
+
+      set_alternatives_and_options(options)
     end
 
     def calc_winning_alternatives

data/lib/split/trial.rb

@@ -67,15 +67,18 @@ module Split
 
         if exclude_user?
           self.alternative = @experiment.control
-        elsif @user[@experiment.key]
-          self.alternative = @user[@experiment.key]
         else
-          self.alternative = @experiment.next_alternative
+          value = @user[@experiment.key]
+          if value
+            self.alternative = value
+          else
+            self.alternative = @experiment.next_alternative
 
-          # Increment the number of participants since we are actually choosing a new alternative
-          self.alternative.increment_participation
+            # Increment the number of participants since we are actually choosing a new alternative
+            self.alternative.increment_participation
 
-          run_callback context, Split.configuration.on_trial_choose
+            run_callback context, Split.configuration.on_trial_choose
+          end
         end
       end
 

data/lib/split/user.rb

@@ -9,10 +9,11 @@ module Split
     end
 
     def cleanup_old_experiments!
-      user.keys.each do |key|
+      keys_without_finished(user.keys).each do |key|
         experiment = ExperimentCatalog.find key_without_version(key)
         if experiment.nil? || experiment.has_winner? || experiment.start_time.nil?
           user.delete key
+          user.delete Experiment.finished_key(key)
         end
       end
     end
@@ -45,6 +46,10 @@ module Split
       keys.reject { |k| k.match(Regexp.new("^#{experiment_key}(:finished)?$")) }
     end
 
+    def keys_without_finished(keys)
+      keys.reject { |k| k.include?(":finished") }
+    end
+
     def key_without_version(key)
       key.split(/\:\d(?!\:)/)[0]
     end

data/lib/split/version.rb

@@ -2,6 +2,6 @@
 module Split
   MAJOR   = 1
   MINOR   = 4
-  PATCH   = 4
+  PATCH   = 5
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/spec/user_spec.rb

@@ -44,6 +44,20 @@ describe Split::User do
       allow(experiment).to receive(:has_winner?).and_return(false)
       @subject.cleanup_old_experiments!
       expect(@subject.keys).to be_empty
-    end    
+    end
+
+    context 'with finished key' do
+      let(:user_keys) { { 'link_color' => 'blue', 'link_color:finished' => true } }
+
+      it 'does not remove finished key for experiment without a winner' do
+        allow(Split::ExperimentCatalog).to receive(:find).with('link_color').and_return(experiment)
+        allow(Split::ExperimentCatalog).to receive(:find).with('link_color:finished').and_return(nil)
+        allow(experiment).to receive(:start_time).and_return(Date.today)
+        allow(experiment).to receive(:has_winner?).and_return(false)
+        @subject.cleanup_old_experiments!
+        expect(@subject.keys).to include("link_color")
+        expect(@subject.keys).to include("link_color:finished")
+      end
+    end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -272,3 +272,4 @@ test_files:
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
 - spec/user_spec.rb
+has_rdoc: