ab-split 1.0.0

data/spec/configuration_spec.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Split::Configuration do
+
+  before(:each) { @config = Split::Configuration.new }
+
+  it "should provide a default value for ignore_ip_addresses" do
+    expect(@config.ignore_ip_addresses).to eq([])
+  end
+
+  it "should provide default values for db failover" do
+    expect(@config.db_failover).to be_falsey
+    expect(@config.db_failover_on_db_error).to be_a Proc
+  end
+
+  it "should not allow multiple experiments by default" do
+    expect(@config.allow_multiple_experiments).to be_falsey
+  end
+
+  it "should be enabled by default" do
+    expect(@config.enabled).to be_truthy
+  end
+
+  it "disabled is the opposite of enabled" do
+    @config.enabled = false
+    expect(@config.disabled?).to be_truthy
+  end
+
+  it "should not store the overridden test group per default" do
+    expect(@config.store_override).to be_falsey
+  end
+
+  it "should provide a default pattern for robots" do
+    %w[Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg YandexBot AdsBot-Google Wget curl bitlybot facebookexternalhit spider].each do |robot|
+      expect(@config.robot_regex).to match(robot)
+    end
+
+    expect(@config.robot_regex).to match("EventMachine HttpClient")
+    expect(@config.robot_regex).to match("libwww-perl/5.836")
+    expect(@config.robot_regex).to match("Pingdom.com_bot_version_1.4_(http://www.pingdom.com)")
+
+    expect(@config.robot_regex).to match(" - ")
+  end
+
+  it "should accept real UAs with the robot regexp" do
+    expect(@config.robot_regex).not_to match("Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US; rv:1.9.1.4) Gecko/20091017 SeaMonkey/2.0")
+    expect(@config.robot_regex).not_to match("Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; F-6.0SP2-20041109; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.5.21022; .NET CLR 1.1.4322; InfoPath.3)")
+  end
+
+  it "should allow adding a bot to the bot list" do
+    @config.bots["newbot"] = "An amazing test bot"
+    expect(@config.robot_regex).to match("newbot")
+  end
+
+  it "should use the session adapter for persistence by default" do
+    expect(@config.persistence).to eq(Split::Persistence::SessionAdapter)
+  end
+
+  it "should load a metric" do
+    @config.experiments = {:my_experiment=>
+        {:alternatives=>["control_opt", "other_opt"], :metric=>:my_metric}}
+
+    expect(@config.metrics).not_to be_nil
+    expect(@config.metrics.keys).to eq([:my_metric])
+  end
+
+  it "should allow loading of experiment using experment_for" do
+    @config.experiments = {:my_experiment=>
+        {:alternatives=>["control_opt", "other_opt"], :metric=>:my_metric}}
+    expect(@config.experiment_for(:my_experiment)).to eq({:alternatives=>["control_opt", ["other_opt"]]})
+  end
+
+  context "when experiments are defined via YAML" do
+    context "as strings" do
+      context "in a basic configuration" do
+        before do
+          experiments_yaml = <<-eos
+            my_experiment:
+              alternatives:
+                - Control Opt
+                - Alt One
+                - Alt Two
+              resettable: false
+            eos
+          @config.experiments = YAML.load(experiments_yaml)
+        end
+
+        it 'should normalize experiments' do
+          expect(@config.normalized_experiments).to eq({:my_experiment=>{:resettable=>false,:alternatives=>["Control Opt", ["Alt One", "Alt Two"]]}})
+        end
+      end
+
+      context "in a configuration with metadata" do
+        before do
+          experiments_yaml = <<-eos
+            my_experiment:
+              alternatives:
+                - name: Control Opt
+                  percent: 67
+                - name: Alt One
+                  percent: 10
+                - name: Alt Two
+                  percent: 23
+              metadata:
+                Control Opt:
+                  text: 'Control Option'
+                Alt One:
+                  text: 'Alternative One'
+                Alt Two:
+                  text: 'Alternative Two'
+              resettable: false
+            eos
+          @config.experiments = YAML.load(experiments_yaml)
+        end
+
+        it 'should have metadata on the experiment' do
+          meta = @config.normalized_experiments[:my_experiment][:metadata]
+          expect(meta).to_not be nil
+          expect(meta['Control Opt']['text']).to eq('Control Option')
+        end
+      end
+
+      context "in a complex configuration" do
+        before do
+          experiments_yaml = <<-eos
+            my_experiment:
+              alternatives:
+                - name: Control Opt
+                  percent: 67
+                - name: Alt One
+                  percent: 10
+                - name: Alt Two
+                  percent: 23
+              resettable: false
+              metric: my_metric
+            another_experiment:
+              alternatives:
+                - a
+                - b
+            eos
+          @config.experiments = YAML.load(experiments_yaml)
+        end
+
+        it "should normalize experiments" do
+          expect(@config.normalized_experiments).to eq({:my_experiment=>{:resettable=>false,:alternatives=>[{"Control Opt"=>0.67},
+            [{"Alt One"=>0.1}, {"Alt Two"=>0.23}]]}, :another_experiment=>{:alternatives=>["a", ["b"]]}})
+        end
+
+        it "should recognize metrics" do
+          expect(@config.metrics).not_to be_nil
+          expect(@config.metrics.keys).to eq([:my_metric])
+        end
+
+      end
+    end
+
+    context "as symbols" do
+
+      context "with valid YAML" do
+        before do
+          experiments_yaml = <<-eos
+            :my_experiment:
+              :alternatives:
+                - Control Opt
+                - Alt One
+                - Alt Two
+              :resettable: false
+            eos
+          @config.experiments = YAML.load(experiments_yaml)
+        end
+
+        it "should normalize experiments" do
+          expect(@config.normalized_experiments).to eq({:my_experiment=>{:resettable=>false,:alternatives=>["Control Opt", ["Alt One", "Alt Two"]]}})
+        end
+      end
+
+      context "with invalid YAML" do
+
+        let(:yaml) { YAML.load(input) }
+
+        context "with an empty string" do
+          let(:input) { '' }
+
+          it "should raise an error" do
+            expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
+          end
+        end
+
+        context "with just the YAML header" do
+          let(:input) { '---' }
+
+          it "should raise an error" do
+            expect { @config.experiments = yaml }.to raise_error(Split::InvalidExperimentsFormatError)
+          end
+        end
+      end
+    end
+  end
+
+  it "should normalize experiments" do
+    @config.experiments = {
+      :my_experiment => {
+        :alternatives => [
+          { :name => "control_opt", :percent => 67 },
+          { :name => "second_opt", :percent => 10 },
+          { :name => "third_opt", :percent => 23 },
+        ],
+      }
+    }
+
+    expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
+  end
+
+  context 'redis_url configuration [DEPRECATED]' do
+    it 'should warn on set and assign to #redis' do
+      expect(@config).to receive(:warn).with(/\[DEPRECATED\]/) { nil }
+      @config.redis_url = 'example_url'
+      expect(@config.redis).to eq('example_url')
+    end
+
+    it 'should warn on get and return #redis' do
+      expect(@config).to receive(:warn).with(/\[DEPRECATED\]/) { nil }
+      @config.redis = 'example_url'
+      expect(@config.redis_url).to eq('example_url')
+    end
+  end
+
+  context "redis configuration" do
+    it "should default to local redis server" do
+      expect(@config.redis).to eq("redis://localhost:6379")
+    end
+
+    it "should allow for redis url to be configured" do
+      @config.redis = "custom_redis_url"
+      expect(@config.redis).to eq("custom_redis_url")
+    end
+
+    context "provided REDIS_URL environment variable" do
+      it "should use the ENV variable" do
+        ENV['REDIS_URL'] = "env_redis_url"
+        expect(Split::Configuration.new.redis).to eq("env_redis_url")
+      end
+    end
+  end
+
+  context "persistence cookie length" do
+    it "should default to 1 year" do
+      expect(@config.persistence_cookie_length).to eq(31536000)
+    end
+
+    it "should allow the persistence cookie length to be configured" do
+      @config.persistence_cookie_length = 2592000
+      expect(@config.persistence_cookie_length).to eq(2592000)
+    end
+  end
+
+end

data/spec/dashboard/pagination_helpers_spec.rb

@@ -0,0 +1,200 @@
+require 'spec_helper'
+require 'split/dashboard/pagination_helpers'
+
+describe Split::DashboardPaginationHelpers do
+  include Split::DashboardPaginationHelpers
+
+  let(:url) { '/split/' }
+
+  describe '#pagination_per' do
+    context 'when params empty' do
+      let(:params) { Hash[] }
+
+      it 'returns the default (10)' do
+        default_per_page = Split.configuration.dashboard_pagination_default_per_page
+        expect(pagination_per).to eql default_per_page
+        expect(pagination_per).to eql 10
+      end
+    end
+
+    context 'when params[:per] is 5' do
+      let(:params) { Hash[per: 5] }
+
+      it 'returns 5' do
+        expect(pagination_per).to eql 5
+      end
+    end
+  end
+
+  describe '#page_number' do
+    context 'when params empty' do
+      let(:params) { Hash[] }
+
+      it 'returns 1' do
+        expect(page_number).to eql 1
+      end
+    end
+
+    context 'when params[:page] is "2"' do
+      let(:params) { Hash[page: '2'] }
+
+      it 'returns 2' do
+        expect(page_number).to eql 2
+      end
+    end
+  end
+
+  describe '#paginated' do
+    let(:collection) { (1..20).to_a }
+    let(:params) { Hash[per: '5', page: '3'] }
+
+    it { expect(paginated(collection)).to eql [11, 12, 13, 14, 15] }
+  end
+
+  describe '#show_first_page_tag?' do
+    context 'when page is 1' do
+      it { expect(show_first_page_tag?).to be false }
+    end
+
+    context 'when page is 3' do
+      let(:params) { Hash[page: '3'] }
+      it { expect(show_first_page_tag?).to be true }
+    end
+  end
+
+  describe '#first_page_tag' do
+    it { expect(first_page_tag).to eql '<a href="/split?page=1&per=10">1</a>' }
+  end
+
+  describe '#show_first_ellipsis_tag?' do
+    context 'when page is 1' do
+      it { expect(show_first_ellipsis_tag?).to be false }
+    end
+
+    context 'when page is 4' do
+      let(:params) { Hash[page: '4'] }
+      it { expect(show_first_ellipsis_tag?).to be true }
+    end
+  end
+
+  describe '#ellipsis_tag' do
+    it { expect(ellipsis_tag).to eql '<span>...</span>' }
+  end
+
+  describe '#show_prev_page_tag?' do
+    context 'when page is 1' do
+      it { expect(show_prev_page_tag?).to be false }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(show_prev_page_tag?).to be true }
+    end
+  end
+
+  describe '#prev_page_tag' do
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+
+      it do
+        expect(prev_page_tag).to eql '<a href="/split?page=1&per=10">1</a>'
+      end
+    end
+
+    context 'when page is 3' do
+      let(:params) { Hash[page: '3'] }
+
+      it do
+        expect(prev_page_tag).to eql '<a href="/split?page=2&per=10">2</a>'
+      end
+    end
+  end
+
+  describe '#show_prev_page_tag?' do
+    context 'when page is 1' do
+      it { expect(show_prev_page_tag?).to be false }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(show_prev_page_tag?).to be true }
+    end
+  end
+
+  describe '#current_page_tag' do
+    context 'when page is 1' do
+      let(:params) { Hash[page: '1'] }
+      it { expect(current_page_tag).to eql '<span><b>1</b></span>' }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(current_page_tag).to eql '<span><b>2</b></span>' }
+    end
+  end
+
+  describe '#show_next_page_tag?' do
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+
+      context 'when collection length is 20' do
+        let(:collection) { (1..20).to_a }
+        it { expect(show_next_page_tag?(collection)).to be false }
+      end
+
+      context 'when collection length is 25' do
+        let(:collection) { (1..25).to_a }
+        it { expect(show_next_page_tag?(collection)).to be true }
+      end
+    end
+  end
+
+  describe '#next_page_tag' do
+    context 'when page is 1' do
+      let(:params) { Hash[page: '1'] }
+      it { expect(next_page_tag).to eql '<a href="/split?page=2&per=10">2</a>' }
+    end
+
+    context 'when page is 2' do
+      let(:params) { Hash[page: '2'] }
+      it { expect(next_page_tag).to eql '<a href="/split?page=3&per=10">3</a>' }
+    end
+  end
+
+  describe '#total_pages' do
+    context 'when collection length is 30' do
+      let(:collection) { (1..30).to_a }
+      it { expect(total_pages(collection)).to eql 3 }
+    end
+
+    context 'when collection length is 35' do
+      let(:collection) { (1..35).to_a }
+      it { expect(total_pages(collection)).to eql 4 }
+    end
+  end
+
+  describe '#show_last_ellipsis_tag?' do
+    let(:collection) { (1..30).to_a }
+    let(:params) { Hash[per: '5', page: '2'] }
+    it { expect(show_last_ellipsis_tag?(collection)).to be true }
+  end
+
+  describe '#show_last_page_tag?' do
+    let(:collection) { (1..30).to_a }
+
+    context 'when page is 5/6' do
+      let(:params) { Hash[per: '5', page: '5'] }
+      it { expect(show_last_page_tag?(collection)).to be false }
+    end
+
+    context 'when page is 4/6' do
+      let(:params) { Hash[per: '5', page: '4'] }
+      it { expect(show_last_page_tag?(collection)).to be true }
+    end
+  end
+
+  describe '#last_page_tag' do
+    let(:collection) { (1..30).to_a }
+    it { expect(last_page_tag(collection)).to eql '<a href="/split?page=3&per=10">3</a>' }
+  end
+end