vanity 2.0.0.beta4 → 2.0.0.beta5

data/gemfiles/rails42.gemfile

@@ -0,0 +1,29 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rack"
+gem "redis", ">= 2.1"
+gem "redis-namespace", ">= 1.1.0"
+gem "bson_ext"
+gem "mongo"
+gem "sqlite3"
+gem "integration", "<= 0.1.0"
+gem "rubystats"
+gem "garb", "< 0.9.2"
+gem "timecop", :require=>false
+gem "webmock", :require=>false
+gem "mocha", "~> 1.0", :require=>false
+gem "rails", "4.2.0"
+gem "fastthread", :git=>"git://github.com/zoltankiss/fastthread.git", :platforms=>:mri_20
+gem "passenger", "~>3.0"
+
+group :development do
+  gem "appraisal", ">= 1.0.0.beta2"
+  gem "jekyll"
+  gem "rake"
+  gem "RedCloth"
+  gem "yard"
+end
+
+gemspec :path=>".././"

data/gemfiles/rails42.gemfile.lock

@@ -0,0 +1,235 @@
+GIT
+  remote: git://github.com/zoltankiss/fastthread.git
+  revision: cefbca3009b9c68df5e473d840462ebcc7fa1504
+  specs:
+    fastthread (1.0.7)
+
+PATH
+  remote: ..
+  specs:
+    vanity (2.0.0.beta5)
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    RedCloth (4.2.9)
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.0)
+    blankslate (2.1.2.4)
+    bson (1.10.0)
+    bson_ext (1.10.0)
+      bson (~> 1.10.0)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    classifier-reborn (2.0.3)
+      fast-stemmer (~> 1.0)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.8.0)
+    colorator (0.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    daemon_controller (1.2.0)
+    erubis (2.7.0)
+    execjs (2.2.2)
+    fast-stemmer (1.0.2)
+    ffi (1.9.6)
+    garb (0.9.1)
+      activesupport (>= 2.2.0)
+      crack (>= 0.1.6)
+    globalid (0.3.0)
+      activesupport (>= 4.1.0)
+    hike (1.2.3)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    integration (0.1.0)
+    jekyll (2.5.3)
+      classifier-reborn (~> 2.0)
+      colorator (~> 0.1)
+      jekyll-coffeescript (~> 1.0)
+      jekyll-gist (~> 1.0)
+      jekyll-paginate (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 2.6.1)
+      mercenary (~> 0.3.3)
+      pygments.rb (~> 0.6.0)
+      redcarpet (~> 3.1)
+      safe_yaml (~> 1.0)
+      toml (~> 0.1.0)
+    jekyll-coffeescript (1.0.1)
+      coffee-script (~> 2.2)
+    jekyll-gist (1.1.0)
+    jekyll-paginate (1.1.0)
+    jekyll-sass-converter (1.3.0)
+      sass (~> 3.2)
+    jekyll-watch (1.2.0)
+      listen (~> 2.7)
+    json (1.8.2)
+    kramdown (1.5.0)
+    liquid (2.6.1)
+    listen (2.8.5)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mercenary (0.3.5)
+    metaclass (0.0.4)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    mongo (1.10.0)
+      bson (~> 1.10.0)
+    multi_json (1.10.1)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    passenger (3.0.21)
+      daemon_controller (>= 1.0.0)
+      fastthread (>= 1.0.1)
+      rack
+      rake (>= 0.8.1)
+    posix-spawn (0.3.9)
+    pygments.rb (0.6.0)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.5)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.2.2)
+    redis (3.2.0)
+    redis-namespace (1.5.1)
+      redis (~> 3.0, >= 3.0.4)
+    rubystats (0.2.3)
+    safe_yaml (1.0.4)
+    sass (3.4.10)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timecop (0.7.1)
+    timers (4.0.1)
+      hitimes
+    toml (0.1.2)
+      parslet (~> 1.5.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yajl-ruby (1.1.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  appraisal (>= 1.0.0.beta2)
+  bson_ext
+  bundler (>= 1.0.0)
+  fastthread!
+  garb (< 0.9.2)
+  integration (<= 0.1.0)
+  jekyll
+  minitest (>= 4.2)
+  mocha (~> 1.0)
+  mongo
+  passenger (~> 3.0)
+  rack
+  rails (= 4.2.0)
+  rake
+  redis (>= 2.1)
+  redis-namespace (>= 1.1.0)
+  rubystats
+  sqlite3
+  timecop
+  vanity!
+  webmock
+  yard

data/lib/generators/templates/vanity_migration.rb

@@ -12,7 +12,7 @@ class VanityMigration < ActiveRecord::Migration
       t.integer :value
       t.string :date
     end
-    add_index :vanity_metric_values, [:vanity_metric_id]
+    add_index :vanity_metric_values, [:vanity_metric_id, :date]
 
     create_table :vanity_experiments do |t|
       t.string :experiment_id

data/lib/generators/vanity/views_generator.rb

@@ -0,0 +1,16 @@
+class Vanity::ViewsGenerator < Rails::Generators::Base
+  desc "Add copies of the vanity views to your app for customization"
+
+  def create_view_files
+    Vanity::ViewsGenerator.source_root(destination_directory)
+    directory source_directory, destination_directory
+  end
+
+  def destination_directory
+    File.join(Rails.root, 'app', 'views', 'vanity')
+  end
+
+  def source_directory
+    File.join(File.dirname(__FILE__), '..', '..', 'vanity', 'templates')
+  end
+end

data/lib/vanity.rb

@@ -29,6 +29,7 @@ require "vanity/adapters/abstract_adapter"
 require "vanity/adapters/mock_adapter"
 # Playground.
 require "vanity/playground"
+require "vanity/templates"
 require "vanity/autoconnect"
 require "vanity/helpers"
 # Integration with various frameworks.

data/lib/vanity/experiment/ab_test.rb

@@ -302,13 +302,13 @@ module Vanity
 
       # Use the result of #score or #bayes_bandit_score to derive a conclusion. Returns an
       # array of claims.
-      def conclusion(score = score)
+      def conclusion(score = score())
         claims = []
         participants = score.alts.inject(0) { |t,alt| t + alt.participants }
-        claims << case participants
-          when 0 ; "There are no participants in this experiment yet."
-          when 1 ; "There is one participant in this experiment."
-          else ; "There are #{participants} participants in this experiment."
+        claims << if participants.zero?
+          I18n.t('vanity.no_participants')
+        else
+          I18n.t('vanity.experiment_participants', :count=>participants)
         end
         # only interested in sorted alternatives with conversion
         sorted = score.alts.select { |alt| alt.measure > 0.0 }.sort_by(&:measure).reverse
@@ -320,34 +320,34 @@ module Vanity
           best, second = sorted[0], sorted[1]
           if best.measure > second.measure
             diff = ((best.measure - second.measure) / second.measure * 100).round
-            better = " (%d%% better than %s)" % [diff, second.name] if diff > 0
-            claims << "The best choice is %s: it converted at %.1f%%%s." % [best.name, best.measure * 100, better]
+            better = I18n.t('vanity.better_alternative_than', :probability=>diff.to_i, :alternative=> second.name) if diff > 0
+            claims << I18n.t('vanity.best_alternative_measure', :best_alternative=>best.name, :measure=>'%.1f' % (best.measure * 100), :better_than=>better)
             if score.method == :bayes_bandit_score
               if best.probability >= 90
-                claims << "With %d%% probability this result is the best." % score.best.probability
+                claims << I18n.t('vanity.best_alternative_probability', :probability=>score.best.probability.to_i)
               else
-                claims << "This result does not have strong confidence behind it, suggest you continue this experiment."
+                claims << I18n.t('vanity.low_result_confidence')
               end
             else
               if best.probability >= 90
-                claims << "With %d%% probability this result is statistically significant." % score.best.probability
+                claims << I18n.t('vanity.best_alternative_is_significant', :probability=>score.best.probability.to_i)
               else
-                claims << "This result is not statistically significant, suggest you continue this experiment."
+                claims << I18n.t('vanity.result_isnt_significant')
               end
             end
             sorted.delete best
           end
           sorted.each do |alt|
             if alt.measure > 0.0
-              claims << "%s converted at %.1f%%." % [alt.name.gsub(/^o/, "O"), alt.measure * 100]
+              claims << I18n.t('vanity.converted_percentage', :alternative=>alt.name.sub(/^\w/, &:upcase), :percentage=>'%.1f' % (alt.measure * 100))
             else
-              claims << "%s did not convert." % alt.name.gsub(/^o/, "O")
+              claims << I18n.t('vanity.didnt_convert', :alternative=>alt.name.sub(/^\w/, &:upcase))
             end
           end
         else
-          claims << "This experiment did not run long enough to find a clear winner."
+          claims << I18n.t('vanity.no_clear_winner')
         end
-        claims << "#{score.choice.name.gsub(/^o/, "O")} selected as the best alternative." if score.choice
+        claims << I18n.t('vanity.selected_as_best', :alternative=>score.choice.name.sub(/^\w/, &:upcase)) if score.choice
         claims
       end
 

data/lib/vanity/experiment/alternative.rb

@@ -7,7 +7,7 @@ module Vanity
       def initialize(experiment, id, value) #, participants, converted, conversions)
         @experiment = experiment
         @id = id
-        @name = "option #{(@id + 65).chr}"
+        @name = I18n.t('vanity.option_number', :char=>(@id + 65).chr.upcase)
         @value = value
       end
 
@@ -90,4 +90,4 @@ module Vanity
       end
     end
   end
-end
+end

data/lib/vanity/frameworks/rails.rb

@@ -320,12 +320,25 @@ module Vanity
 
       # JS callback action used by vanity_js
       def add_participant
-        if params[:e].nil? || params[:e].empty?
+        if params[:v].nil?
           render :status => 404, :nothing => true
           return
         end
-        exp = Vanity.playground.experiment(params[:e].to_sym)
-        exp.chooses(exp.alternatives[params[:a].to_i].value, request)
+
+        h = {}
+        params[:v].split(',').each do |pair|
+          exp_id, answer = pair.split('=')
+          exp = Vanity.playground.experiment(exp_id.to_s.to_sym) rescue nil
+          answer = answer.to_i
+
+          if !exp || !exp.alternatives[answer]
+            render :status => 404, :nothing => true
+            return
+          end
+          h[exp] = exp.alternatives[answer].value
+        end
+
+        h.each{ |e,a| e.chooses(a, request) }
         render :status => 200, :nothing => true
       end
     end

data/lib/vanity/metric/active_record.rb

@@ -91,7 +91,7 @@ module Vanity
 
       def last_update_at
         # SELECT created_at FROM "skies" ORDER BY created_at DESC LIMIT 1
-        record = @ar_scoped.find(:first, :order=>"#@ar_timestamp DESC", :limit=>1, :select=>@ar_timestamp)
+        record = @ar_scoped.order("#{@ar_timestamp} DESC").select(@ar_timestamp).first
         record && record.send(@ar_timestamp)
       end
 

data/lib/vanity/playground.rb

@@ -41,6 +41,8 @@ module Vanity
       @options = defaults.merge(config).merge(options)
 
       @load_path = @options[:load_path] || DEFAULTS[:load_path]
+
+      I18n.load_path += locale_file_paths
       unless @logger = @options[:logger]
         @logger = Logger.new(STDOUT)
         @logger.level = Logger::ERROR
@@ -68,19 +70,10 @@ module Vanity
 
     attr_accessor :request_filter
 
-    # Defines a new experiment. Generally, do not call this directly,
-    # use one of the definition methods (ab_test, measure, etc).
-    #
-    # @see Vanity::Experiment
-    def define(name, type, options = {}, &block)
-      warn "Deprecated: if you need this functionality let's make a better API"
-      id = name.to_s.downcase.gsub(/\W/, "_").to_sym
-      raise "Experiment #{id} already defined once" if experiments[id]
-      klass = Experiment.const_get(type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
-      experiment = klass.new(self, id, name, options)
-      experiment.instance_eval &block
-      experiment.save
-      experiments[id] = experiment
+    # Path to custom templates (overriding those in the gem)
+    attr_writer :custom_templates_path
+    def custom_templates_path
+      @custom_templates_path ||= (File.expand_path(File.join(::Rails.root, 'app', 'views', 'vanity')) if defined?(::Rails))
     end
 
     # Returns the experiment. You may not have guessed, but this method raises
@@ -89,7 +82,7 @@ module Vanity
     # @see Vanity::Experiment
     def experiment(name)
       id = name.to_s.downcase.gsub(/\W/, "_").to_sym
-      warn "Deprecated: pleae call experiment method with experiment identifier (a Ruby symbol)" unless id == name
+      warn "Deprecated: please call experiment method with experiment identifier (a Ruby symbol)" unless id == name
       experiments[id.to_sym] or raise NoExperimentError, "No experiment #{id}"
     end
 
@@ -227,13 +220,12 @@ module Vanity
     #
     # @see Vanity::Experiment
     def experiments
-      unless @experiments
-        @experiments = {}
-        @logger.info "Vanity: loading experiments from #{load_path}"
-        Dir[File.join(load_path, "*.rb")].each do |file|
-          experiment = Experiment::Base.load(self, @loading, file)
-          experiment.save
-        end
+      return @experiments if @experiments
+
+      @experiments = {}
+      @logger.info "Vanity: loading experiments from #{load_path}"
+      Dir[File.join(load_path, "*.rb")].each do |file|
+        Experiment::Base.load(self, @loading, file)
       end
       @experiments
     end
@@ -384,6 +376,11 @@ module Vanity
       YAML.load(ERB.new(File.read(config_file_root + basename)).result)
     end
 
+    def locale_file_paths
+      locale_files_dir = File.expand_path('../../config/locales/', File.dirname(__FILE__))
+      Dir[locale_files_dir+'/*.{rb,yml}']
+    end
+
     # Returns the current connection. Establishes new connection is necessary.
     #
     # @since 1.4.0
@@ -456,9 +453,6 @@ module Vanity
       Thread.current[:vanity_context] = context
     end
 
-    # Path to template.
-    def template(name)
-      File.join(File.dirname(__FILE__), "templates/#{name}")
-    end
+
   end
 end