vanity 2.0.0.beta9 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d7da7caf628667cd793e5a3191fa8f0975a7ae0
+  data.tar.gz: 9a538d9f392b717675079c8ea35cfaf8b8457733
+SHA512:
+  metadata.gz: b8a5faf62c21f4562b5b4e17c78e340b53547e90d0a9b657c3fd8bc44b724fa813dc3a1e681e6fdf3617c9d70141819608e05f9c1221dc8ac137210d4d46dae5
+  data.tar.gz: c23d96c189bae198ba68c60f5ff7ba93cd0aef614b40b746a217979be6f6ebf66966217693a6c753e0e560921461711956b89712b7d5fc002037b4ac04a21ebb

data/CHANGELOG

@@ -1,3 +1,17 @@
+== 2.0.0 (2015-12-14)
+
+Extract configuration from Vanity::Playground to Vanity::Configuration (@phillbaker)
+Remove `track!` and `ab_test` from the global scope, they're now available on the `Vanity` module. (@phillbaker)
+Reduce test frameworks to just minitest (@phillbaker)
+Replace deprecated ActiveRecord finders (@bogdan-dumitru, @leematos, @aaronjensen)
+Add date to vanity_metric_values index (@aaronjensen)
+Fix insecure wildcard route (@modosc)
+Introduce Ruby 2.2 support. (@sebjacobs)
+Added support for testing against jruby. (@Matt343)
+Adding internationalization to reports (@teonimesic)
+Allow Rails applications to override default views (@rsslldnphy)
+Add support to reset experiments (@davidguthu)
+
 == 1.9.0 (2014-04-20)
 
 Include db:reset in blacklist for autoconnect. (@phillbaker)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (2.0.0.beta9)
+    vanity (2.0.0)
       i18n
 
 GEM
@@ -34,10 +34,9 @@ GEM
     coffee-script-source (1.9.1)
     colorator (0.1)
     crack (0.3.1)
-    directory_watcher (1.4.1)
     execjs (2.5.2)
-    fast-stemmer (1.0.2)
     fakefs (0.6.7)
+    fast-stemmer (1.0.2)
     ffi (1.9.8)
     garb (0.9.1)
       activesupport (>= 2.2.0)

data/README.rdoc

@@ -46,8 +46,8 @@ A sample <code>config/vanity.yml</code> might look like:
 If you want to use your test environment with RSpec you will need to add an adapter to test:
 
   test:
-  adapter: redis
-  collecting: false
+    adapter: redis
+    collecting: false
 
 ===== MongoDB Setup
 
@@ -123,13 +123,13 @@ If the experiment uses a metric as above ("signups"), there needs to be a corres
 
 === <b>Step 4:</b> Measure conversion
 
-Conversions are created via the <code>track!</code> method. For example:
+Conversions are created via the <code>Vanity.track!</code> method. For example:
 
   class SignupController < ApplicationController
     def signup
       @account = Account.new(params[:account])
       if @account.save
-        track! :signups
+        Vanity.track!(:signups)
         redirect_to @acccount
       else
         render action: :offer
@@ -166,11 +166,17 @@ The controller should look like:
 
 If robots or spiders make up a significant portion of your sites traffic they can affect your conversion rate. Vanity can optionally add participants to the experiments using asynchronous javascript callbacks, which will keep many robots out. For those robots that do execute Javascript and are well-behaved (like Googlebot), Vanity filters out requests based on their user-agent string.
 
-To set this up simply do the following:
+In Rails, add the following to <code>application.rb</code>:
+
+  Vanity.configure do |config|
+    config.use_js = true
 
-* Add <code>Vanity.playground.use_js!</code>
-* Set <code>Vanity.playground.add_participant_path = '/path/to/vanity/action'</code>, this should point to the add_participant path that is added with Vanity::Rails::Dashboard, make sure that this action is accessible by all users (ie does not require authentication).
-* Add <code><%= vanity_js %></code> to any page that XX an ab_test. <code>vanity_js</code> needs to be included after your call to ab_test so that it knows which version of the experiment the participant is a member of. The helper will render nothing if the there are no ab_tests running on the current page, so adding <code>vanity_js</code> to the bottom of your layouts is a good option. Keep in mind that if you call <code>use_js!</code> and don't include <code>vanity_js</code> in your view no participants will be recorded.
+    # Optionally configure the add_participant route that is added with Vanity::Rails::Dashboard,
+    # make sure that this action does not require authentication
+    # config.add_participant_route = '/vanity/add_participant'
+  end
+
+Then add <code><%= vanity_js %></code> to any page that calls an A/B test <b>after calling <code>ab_test</code></b>. <code>vanity_js</code> needs to be included after your call to ab_test so that it knows which version of the experiment the participant is a member of. The helper will render nothing if the there are no ab_tests running on the current page, so adding <code>vanity_js</code> to the bottom of your layouts is a good option. Keep in mind that if you set <code>use_js</code> and don't include <code>vanity_js</code> in your view no participants will be recorded.
 
 == Compatibility
 
@@ -189,8 +195,6 @@ Here's what's tested and known to work:
     Persistence: Redis, Mongo, ActiveRecord
     Rails: 3.2, 4.x
 
-If you receive 'a warning: circular argument reference - score' this was fixed in [2.0.7 beta](https://github.com/assaf/vanity/commit/1b5bf18636caa5eae279e2aef2e24c923e63b141)
-
 == Testing
 
 For view tests/specs or integration testing, it's handy to set the outcome of an experiment. This may be done using the <code>chooses</code> method. For example:

data/doc/ab_testing.textile

@@ -59,7 +59,7 @@ Remember that we're measuring signups, so we already have this in the code:
 class SignupController < ApplicationController
   def signup
     Account.create(params[:account])
-    track! :signup
+    Vanity.track!(:signup)
   end
 end
 </pre>
@@ -73,7 +73,7 @@ Vanity splits the audience randomly -- using "cookies and other mechanisms":iden
 
 !images/clear_winner.png!
 
-Vanity will show the conversion rate for each alternative, and how that conversion compares to the worst performing alternative.  In the example above, option A has 80.6% conversion rate, 11% more than option B's 72.6% conversion rate (72.6 * 111% ~ 80.6%). 
+Vanity will show the conversion rate for each alternative, and how that conversion compares to the worst performing alternative.  In the example above, option A has 80.6% conversion rate, 11% more than option B's 72.6% conversion rate (72.6 * 111% ~ 80.6%).
 
 (These large numbers are easily explained by the fact that this report was generated from made up data)
 
@@ -113,7 +113,7 @@ end
 The @ab_test@ method returns the value of one of the chosen alternatives, so in your views you can write:
 
 <pre>
-<h2>Get started for only $<%= ab_test :price_options %> a month!</h2>
+<h2>Get started for only $<%= ab_test(:price_options) %> a month!</h2>
 </pre>
 
 !images/price_options.png!
@@ -122,17 +122,17 @@ If you don't given any values, Vanity will run your experiment with the values f
 
 <pre>
 def index
-  # alternatives are names of templates 
-  render template: ab_test(:new_page)
+  # alternatives are names of templates
+  render template: Vanity.ab_test(:new_page)
 end
 </pre>
-   
+
 <pre>
 <%= ab_test(:greeting) %> <%= current_user.name %>
 </pre>
-   
+
 <pre>
-<% ab_test :features do |count| %>
+<% ab_test(:features) do |count| %>
   <%= count %> features to choose from!
 <% end %>
 </pre>
@@ -156,7 +156,7 @@ Here's another example using Webrat:
 
 <pre>
 def test_price_option
-  [19, 25, 29].each do |price| 
+  [19, 25, 29].each do |price|
     experiment(:price_options).chooses(price)
     visit root_path
     assert_contain "Get started for only $#{price} a month!"

data/doc/configuring.textile

@@ -26,18 +26,46 @@ The available database adapters are:
 * +mongodb+ -- Available options are host, port, database (defaults to "vanity"), username and password.
 * +active_record+ -- Uses existing ActiveRecord configuration, by you can over-ride by supplying different options. To pick different underlying adapter, set +active_record_adapter+.
 
+h4. Configuration Options
+
 Available configuration options are:
 
-|_. name      |_. Is all about ...                      |_. Default      |
-| load_path   | Directory containing experiment files   | experiments    |
-| logger      | This should be obvious                  | default/Rails  |
-| collecting  | False if you won't want data collected  | true           |
+|_. name                     |_. Is all about ...                    |_. Default      |
+| add_participant_route      | URL to use to add participants via JS | /vanity/add_participant |
+| collecting                 | False if you won't want data collected| true           |
+| config_file                | File name to use to configure vanity  | vanity.yml     |
+| config_path                | Path to the config_file               | ./config/      |
+| environment                | What environment use for configuration| development    |
+| experiments_path           | Directory containing experiment files | ./experiments  |
+| failover_on_datastore_error| Whether to pass errors to on_datastore_error | false   |
+| locales_path               | Path to locales for translations      | in the gem     |
+| logger                     | This should be obvious                | default/Rails  |
+| on_datastore_error         | A proc that handles datastore errors  | logs to logger |
+| request_filter             | A proc that returns whether to to ignore the request for the add JS participant route | Ignore requests with a HTTP_USER_AGENT that contain a URL |
+| templates_path             | Path to templates for Vanity admin | the templates in the gem |
+| use_js                     | Whether to use JS to add particpants, useful to ignore bots | false |
 
 When "running under Rails":rails.html, Vanity defaults to using the Rails logger, locates the load_path relative to Rails root, uses the @config/vanity.yml@ configuration file (if present) and turns collection on only in production mode.
 
-If you run a different setup, use the playground object to configure Vanity.  For example:
+Use the playground object to configure Vanity. For example:
 
 <pre>
-Vanity.playground.load_path = "exp"
-Vanity.playground.establish_connection "redis://db.example.com"
+Vanity.configure do |config|
+  config.use_js = true
+  config.experiments_path = 'config/ab_tests'
+  config.add_participant_route = '/vanity/participant/new'
+  # ...
+end
 </pre>
+
+
+h4. Using metrics from Google Analytics
+
+If you want to use Vanity with metrics from Google Analytics, you must require the @garb@ gem, and login for a new session.  You'll want to do that for production, not for development if you like developing offline. For example in Rails, in the config/:
+
+<pre>
+config.after_initialize do
+  require "garb"
+  Garb::Session.login('..ga email..', '..ga pwd..', account_type: "GOOGLE")
+end
+</pre>

data/doc/contributing.textile

@@ -47,47 +47,9 @@ $ rake DB=mysql
 </pre>
 
 
-Before making a release, we run the full test suite against multiple Ruby VMs
-and using multiple database adapters.  Doing this on your own is easier than it
-sounds:
+Before making a release, we run the full test suite against multiple Ruby VMs and using multiple database adapters.  Doing this on your own is easier than it sounds:
 
 # "Fork the project":http://github.com/assaf/vanity
 # Go to "Travis CI":http://travis-ci.org/, setup a new account if you don't already have one
 # "In your profile page":http://travis-ci.org/profile, tell Travis to build your fork
 # @git push@ your changes into your fork and "watch Travis":http://travis-ci.org/ run the tests
-
-
-To package Vanity as a gem and install on your machine:
-
-<pre>
-$ rake install
-</pre>
-
-
-h3(#doc). Documentation
-
-Documentation is written in "Textile":http://redcloth.org/textile/writing-paragraph-text/, and converted to HTML using "Jekyll":http://jekyllrb.com/.
-
-API reference is "RDoc":http://rdoc.sourceforge.net/doc/index.html, converted to HTML using "Yardoc":http://yardoc.org/.
-
-To build and view documentation:
-
-<pre>
-$ rake docs
-$ open html/index.html
-</pre>
-
-To clean up after yourself:
-
-<pre>
-$ rake clobber
-</pre>
-
-
-h3(#open). Open Issues
-
-<notextile>
-<table id="issues">
-  <tbody></tbody>
-</table>
-</notextile>

data/doc/experimental.textile

@@ -24,8 +24,8 @@ Next proposed change would allow the metric to define multiple columns. Those ca
 metric :purchase do
   columns :count, :total
 end
-metric(:purchase).track! p.items.length. p.total
-metric(:purchase).track! :total=>p.total, :count=>p.items.length
+metric(:purchase).track!(p.items.length. p.total)
+metric(:purchase).track!(:total=>p.total, :count=>p.items.length)
 </pre>
 
 The metric's @values@ method will have to be changed to return an array of arrays, or new method introduced to keep the API backward compatible. And, of course, UI modified to display multiple series in a single graph.

data/doc/metrics.textile

@@ -43,7 +43,7 @@ class AccountsController < ApplicationController
   def create
     @person = Person.new(params[:person])
     if @person.save
-      track! :signup      # track successful sign up
+      Vanity.track!(:signup)      # track successful sign up
       UserSession.create person
       redirect_to root_url
     else
@@ -60,7 +60,7 @@ You can call @track!@ with a value to track.  This example tracks how many items
 
 <pre>
 def checkout
-  track! :items, @cart.items.count
+  Vanity.track!(:items, @cart.items.count)
   . . .
 end
 </pre>
@@ -144,8 +144,8 @@ Login to Google Analytics using either username and password, or OAuth authentic
 Rails::Initializer.run do |config|
   gems.config "vanity"
   gems.config "garb"
- 
-  . . . 
+
+  . . .
   config.after_initialize do
     require "garb"
     ga = YAML.load_file(Rails.root + "config/ga.yml")

data/doc/rails.textile

@@ -35,31 +35,6 @@ end
 This example assumes you have a @current_user@ controller method which will return a consistent value for each user.
 There are other ways to identify people as well, you can read more about the options in Managing Identity.
 
-h4. Configuring datastore
-
-If you have a @config/vanity.yml@ file, Vanity will read the configuration for the current environment.  For example:
-
-<pre>
-staging:
-  adapter: redis
-  host: staging.internal
-production:
-  adapter: mongo
-  host: live.internal
-  database: vanity
-</pre>
-
-h4. Using metrics from Google Analytics
-
-If you want to use Vanity with metrics from Google Analytics, you must also tell Rails to include the @garb@ gem, and login for a new session.  You'll want to do that for production, not for development if you like developing offline:
-
-<pre>
-config.after_initialize do
-  require "garb"
-  Garb::Session.login('..ga email..', '..ga pwd..', account_type: "GOOGLE")
-end
-</pre>
-
 h4. Enabling/disable collection
 
 When collection is off, Vanity doesn't connect to the database server, so there's no need to set a database configuration for these environments.
@@ -75,7 +50,9 @@ rails g vanity:views
 You can then edit them to your heart's content. If you need to use an alternative location for your custom templates, set the configuration variable @custom_templates_path@ on @Vanity.playground@ like this:
 
 <pre>
-Vanity.playground.custom_templates_path = 'views/vanity'
+Vanity.configure do |config|
+  config.templates_path = 'views/vanity'
+end
 </pre>
 
 h3(#fork).  Unicorn and Forking Servers
@@ -91,4 +68,5 @@ after_fork do |server, worker|
 end
 </pre>
 
-You'll run into this issue with other forking servers.  Vanity can detect when it runs under Passenger and automatically reconnect each forked process.
+You'll run into this issue with other forking servers like Passenger as well.
+

data/doc/site.js

@@ -1,21 +1,4 @@
 $(function() {
-  var issuesTable = $("table#issues");
-  if (issuesTable.size() > 0) {
-    $.getJSON("http://github.com/api/v2/json/issues/list/assaf/vanity/open?callback=?", function(response) {
-      $.each(response.issues, function(i, issue) {
-        issuesTable.append(
-          $("<tr>").append(
-            $("<td>").append(
-              $("<a>").text(issue.title).attr("href", "http://github.com/assaf/vanity/issues#issue/" + issue.number)
-            ).append(
-              $("<span class='votes'>").text(issue.votes == 0 ? "no votes" : issue.votes == 1 ? "1 vote" : issue.votes + " votes")
-            )
-          )
-        );
-      });
-    });
-  }
-
   var statsTable = $("#sidebar ul#stats");
   if (statsTable.size() > 0) {
     $.getJSON("http://github.com/api/v2/json/repos/show/assaf/vanity?callback=?", function(response) {

data/gemfiles/rails32.gemfile

@@ -8,11 +8,11 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2", :require=>false
+gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false
+gem "fakefs", :require => "fakefs/safe"
 gem "mocha", "~> 1.0", :require => false
-gem "fakefs", :require=>"fakefs/safe"
 gem "minitest", "~>4.2.0"
 gem "rails", "3.2.22"
 gem "minitest_tu_shim", "~> 1.3.3", :platforms => :mri_22

data/gemfiles/rails32.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.0.beta9)
+    vanity (2.0.0)
       i18n
 
 GEM

data/gemfiles/rails4.gemfile

@@ -8,11 +8,11 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2", :require=>false
+gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false
+gem "fakefs", :require => "fakefs/safe"
 gem "mocha", "~> 1.0", :require => false
-gem "fakefs", :require=>"fakefs/safe"
 gem "rails", "4.0.13"
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"

data/gemfiles/rails4.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.0.beta9)
+    vanity (2.0.0)
       i18n
 
 GEM
@@ -61,8 +61,8 @@ GEM
     daemon_controller (1.1.7)
     directory_watcher (1.4.1)
     erubis (2.7.0)
-    fast-stemmer (1.0.2)
     fakefs (0.6.7)
+    fast-stemmer (1.0.2)
     garb (0.9.1)
       activesupport (>= 2.2.0)
       crack (>= 0.1.6)

data/gemfiles/rails41.gemfile

@@ -8,11 +8,11 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2", :require=>false
+gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false
+gem "fakefs", :require => "fakefs/safe"
 gem "mocha", "~> 1.0", :require => false
-gem "fakefs", :require=>"fakefs/safe"
 gem "rails", "4.1.9"
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"

data/gemfiles/rails41.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .././
   specs:
-    vanity (2.0.0.beta9)
+    vanity (2.0.0)
       i18n
 
 GEM

data/gemfiles/rails42.gemfile

@@ -8,11 +8,11 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2", :require=>false
+gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false
+gem "fakefs", :require => "fakefs/safe"
 gem "mocha", "~> 1.0", :require => false
-gem "fakefs", :require=>"fakefs/safe"
 gem "rails", "4.2.0"
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"

data/gemfiles/rails42.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.0.beta9)
+    vanity (2.0.0)
       i18n
 
 GEM

data/lib/vanity/frameworks/rails.rb

@@ -160,7 +160,7 @@ module Vanity
       # alternative.
       def vanity_track_filter
         if request.get? && params[:_track]
-          track! params[:_track]
+          Vanity.track! params[:_track]
         end
       end
 

data/lib/vanity/helpers.rb

@@ -6,14 +6,14 @@ module Vanity
   # @example From Rails controller
   #   class AccountController < ApplicationController
   #     def create
-  #       track! :signup
-  #       Acccount.create! params[:account]
+  #       Vanity.track!(:signup)
+  #       Acccount.create!(params[:account])
   #     end
   #   end
   # @example From ActiveRecord
   #   class Posts < ActiveRecord::Base
   #     after_create do |post|
-  #       track! :images if post.type == :image
+  #       Vanity.track!(:images if post.type == :image)
   #     end
   #   end
   module Helpers
@@ -22,7 +22,7 @@ module Vanity
     #
     # @example A/B two alternatives for a page
     #   def index
-    #     if ab_test(:new_page) # true/false test
+    #     if Vanity.ab_test(:new_page) # true/false test
     #       render action: "new_page"
     #     else
     #       render action: "index"
@@ -30,11 +30,12 @@ module Vanity
     #   end
     # @example Similar, alternative value is page name
     #   def index
-    #     render action: ab_test(:new_page)
+    #     render action: Vanity.ab_test(:new_page)
     #   end
     # @since 1.2.0
     def ab_test(name, &block)
-      # TODO refactor with Vanity::Rails::Helpers#ab_test
+      # TODO refactor with Vanity::Rails::Helpers#ab_test, however that's used
+      # within Rails views
       request = respond_to?(:request) ? self.request : nil
       if Vanity.playground.using_js?
         value = Vanity.context.vanity_store_experiment_for_js name, Vanity.playground.experiment(name).choose(request)
@@ -44,7 +45,6 @@ module Vanity
 
       if block
         content = capture(value, &block)
-        block_called_from_erb?(block) ? concat(content) : content
       else
         value
       end
@@ -56,9 +56,9 @@ module Vanity
     # tracked, but the user will not be added to the experiment.
     #
     # @example
-    #   track! :invitation
+    #   Vanity.track!(:invitation)
     # @example
-    #   track! :click, { :identity=>Identity.new(env['rack.session']), :values=>[1] }
+    #   Vanity.track!(:click, { :identity=>Identity.new(env['rack.session']), :values=>[1] })
     #
     # @param count_or_options Defaults to a count of 1. Also accepts a hash
     #   of options passed (eventually) to AbTest#track!.
@@ -68,8 +68,3 @@ module Vanity
     end
   end
 end
-
-# TODO do we actually want to do this?
-Object.class_eval do
-  include Vanity::Helpers
-end

data/lib/vanity/playground.rb

@@ -5,11 +5,25 @@ module Vanity
   # Vanity::Configuration, for connection management, please see
   # Vanity::Connection.
   class Playground
+    # Returns hash of metrics (key is metric id).
+    #
+    # @see Vanity::Metric
+    # @since 1.1.0
+    # @deprecated
+    attr_reader :metrics
+
+    # Returns hash of experiments (key is experiment id). This creates the
+    # Experiment and persists it to the datastore.
+    #
+    # @see Vanity::Experiment
+    attr_reader :experiments
 
     # Created new Playground. Unless you need to, use the global
     # Vanity.playground.
     def initialize
       @loading = []
+      set_metrics
+      set_experiments
     end
 
     # @deprecated
@@ -136,21 +150,6 @@ module Vanity
       Vanity.load!
     end
 
-    # Returns hash of experiments (key is experiment id). This creates the
-    # Experiment and persists it to the datastore.
-    #
-    # @see Vanity::Experiment
-    def experiments
-      return @experiments if @experiments
-
-      @experiments = {}
-      Vanity.logger.info("Vanity: loading experiments from #{Vanity.configuration.experiments_path}")
-      Dir[File.join(Vanity.configuration.experiments_path, "*.rb")].each do |file|
-        Experiment::Base.load(self, @loading, file)
-      end
-      @experiments
-    end
-
     def experiments_persisted?
       experiments.keys.all? { |id| connection.experiment_persisted?(id) }
     end
@@ -163,23 +162,6 @@ module Vanity
       metrics[id.to_sym] or raise NameError, "No metric #{id}"
     end
 
-    # Returns hash of metrics (key is metric id).
-    #
-    # @see Vanity::Metric
-    # @since 1.1.0
-    # @deprecated
-    def metrics
-      unless @metrics
-        @metrics = {}
-        Vanity.logger.info("Vanity: loading metrics from #{Vanity.configuration.experiments_path}/metrics")
-
-        Dir[File.join(Vanity.configuration.experiments_path, "metrics/*.rb")].each do |file|
-          Metric.load(self, @loading, file)
-        end
-      end
-      @metrics
-    end
-
     # Tracks an action associated with a metric.
     #
     # @example
@@ -254,5 +236,27 @@ module Vanity
     def reconnect!
       Vanity.reconnect!
     end
+
+    private
+
+    def set_experiments
+      @experiments = {}
+
+      Vanity.logger.info("Vanity: loading experiments from #{Vanity.configuration.experiments_path}")
+
+      Dir[File.join(Vanity.configuration.experiments_path, "*.rb")].each do |file|
+        Experiment::Base.load(self, @loading, file)
+      end
+    end
+
+    def set_metrics
+      @metrics = {}
+
+      Vanity.logger.info("Vanity: loading metrics from #{Vanity.configuration.experiments_path}/metrics")
+
+      Dir[File.join(Vanity.configuration.experiments_path, "metrics/*.rb")].each do |file|
+        Metric.load(self, @loading, file)
+      end
+    end
   end
 end

data/lib/vanity/vanity.rb

@@ -2,6 +2,8 @@
 # Run time configuration and helpers
 #
 module Vanity
+  extend Vanity::Helpers
+
   # Returns the current configuration.
   #
   # @see Vanity::Configuration

data/lib/vanity/version.rb

@@ -1,5 +1,5 @@
 module Vanity
-  VERSION = "2.0.0.beta9"
+  VERSION = "2.0.0"
 
   module Version
     version = VERSION.to_s.split(".").map { |i| i.to_i }

data/test/experiment/ab_test.rb

@@ -5,7 +5,7 @@ class AbTestController < ActionController::Base
   attr_accessor :current_user
 
   def test_render
-    render :text=>ab_test(:simple)
+    render :text=>Vanity.ab_test(:simple)
   end
 
   def test_view
@@ -13,11 +13,11 @@ class AbTestController < ActionController::Base
   end
 
   def test_capture
-    render :inline=>"<%= ab_test :simple do |value| %><%= value %><% end %>"
+    render :inline=>"<%= ab_test(:simple) do |value| %><%= value %><% end %>"
   end
 
   def track
-    track! :coolness
+    Vanity.track!(:coolness)
     render :text=>""
   end
 end

data/test/experiment/base_test.rb

@@ -17,13 +17,12 @@ describe Vanity::Experiment::Base do
     File.open "tmp/experiments/ice_cream_flavor.rb", "w" do |f|
       f.write <<-RUBY
         ab_test "Ice Cream Flavor" do
-          metrics :happiness
         end
         ab_test "Ice Cream Flavor" do
-          metrics :happiness
         end
       RUBY
     end
+    Vanity.unload!
     assert_raises NameError do
       experiment(:ice_cream_flavor)
     end
@@ -45,10 +44,10 @@ describe Vanity::Experiment::Base do
           def xmts
             "x"
           end
-          metrics :happiness
         end
       RUBY
     end
+    Vanity.unload!
     assert_equal "x", experiment(:ice_cream_flavor).xmts
   end
 
@@ -56,6 +55,7 @@ describe Vanity::Experiment::Base do
     File.open "tmp/experiments/ice_cream_flavor.rb", "w" do |f|
       f.write "fail 'yawn!'"
     end
+    Vanity.unload!
     assert_raises NameError do
       experiment(:ice_cream_flavor)
     end
@@ -65,6 +65,7 @@ describe Vanity::Experiment::Base do
     File.open "tmp/experiments/ice_cream_flavor.rb", "w" do |f|
       f.write ""
     end
+    Vanity.unload!
     assert_raises NameError do
       experiment(:ice_cream_flavor)
     end
@@ -91,11 +92,10 @@ describe Vanity::Experiment::Base do
     File.open "tmp/experiments/ice_cream_flavor.rb", "w" do |f|
       f.write <<-RUBY
         ab_test "Ice Cream Flavor" do
-          metrics :happiness
-          expects(:save).at_least_once
         end
       RUBY
     end
+    Vanity.unload!
     Vanity.playground.experiment(:ice_cream_flavor)
   end
 

data/test/frameworks/rails/action_controller_test.rb

@@ -4,51 +4,27 @@ require "test_helper"
 class UseVanityController < ActionController::Base
   class TestModel
     def test_method
-      ab_test(:pie_or_cake)
+      Vanity.ab_test(:pie_or_cake)
     end
   end
-  
+
   attr_accessor :current_user
 
   def index
-    render :text=>ab_test(:pie_or_cake)
+    render :text=>Vanity.ab_test(:pie_or_cake)
   end
 
   def js
-    ab_test(:pie_or_cake)
+    Vanity.ab_test(:pie_or_cake)
     render :inline => "<%= vanity_js -%>"
   end
-  
+
   def model_js
     TestModel.new.test_method
     render :inline => "<%= vanity_js -%>"
   end
 end
 
-# class UseVanityControllerTest < ActionController::TestCase
-#   tests UseVanityController
-
-#   def setup
-#     super
-#     new_ab_test :pie_or_cake do
-#       metrics :sugar_high
-#     end
-
-#     # Class eval this instead of including in the controller to delay
-#     # execution until the request exists in the context of the test
-#     UseVanityController.class_eval do
-#       use_vanity :current_user
-#     end
-#   end
-
-#   def teardown
-#     super
-#   end
-
-#   def test_bootstraps_metric
-#   end
-# end
-
 class UseVanityControllerTest < ActionController::TestCase
   tests UseVanityController
 
@@ -80,7 +56,7 @@ class UseVanityControllerTest < ActionController::TestCase
     get :js
     assert_match /script.*v=pie_or_cake=.*script/m, @response.body
   end
-  
+
   def test_render_model_js_for_tests
     Vanity.playground.use_js!
     get :model_js
@@ -103,6 +79,7 @@ class UseVanityControllerTest < ActionController::TestCase
   end
 
   def test_does_not_add_invalid_participant_to_experiment
+    Vanity.playground.use_js!
     @request.user_agent = "Googlebot/2.1 ( http://www.google.com/bot.html)"
     get :index
     assert_equal 0, experiment(:pie_or_cake).alternatives.map(&:participants).sum

data/test/helper_test.rb

@@ -1,6 +1,6 @@
 require "test_helper"
 
-describe Object do
+describe Vanity::Helpers do
   describe "#track!" do
     it "identity option sets identity" do
       metric "Coolness"
@@ -8,7 +8,7 @@ describe Object do
         alternatives "foo", "bar"
         metrics :coolness
       end
-      track!(:coolness, :identity=>'quux')
+      Vanity.track!(:coolness, :identity=>'quux')
 
       assert_equal 1, experiment(:foobar).alternatives.sum(&:conversions)
     end
@@ -19,7 +19,7 @@ describe Object do
         alternatives "foo", "bar"
         metrics :coolness
       end
-      track!(:coolness, :identity=>'quux', :values=>[2])
+      Vanity.track!(:coolness, :identity=>'quux', :values=>[2])
 
       assert_equal 2, experiment(:foobar).alternatives.sum(&:conversions)
     end

data/test/metric/active_record_test.rb

@@ -219,7 +219,7 @@ describe Vanity::Metric::ActiveRecord do
       f.write <<-RUBY
         metric "Sky is limit" do
           model Sky, :conditions=>["height > 3"]
-          Sky.after_save { |sky| track!(:sky_is_limit) if sky.height_changed? && sky.height > 3 }
+          Sky.after_save { |sky| Vanity.track!(:sky_is_limit) if sky.height_changed? && sky.height > 3 }
         end
       RUBY
     end
@@ -239,7 +239,7 @@ describe Vanity::Metric::ActiveRecord do
     File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
       f.write <<-RUBY
         metric "Sky is limit" do
-          Sky.after_save { |sky| track!(:sky_is_limit) if sky.height_changed? && sky.height > 3 }
+          Sky.after_save { |sky| Vanity.track!(:sky_is_limit) if sky.height_changed? && sky.height > 3 }
         end
       RUBY
     end

data/test/metric/remote_test.rb

@@ -16,10 +16,12 @@ describe "Remote metrics" do
   end
 
   it "loads from metrics files" do
+    Vanity.unload!
     assert Vanity.playground.metric(:sandbox)
   end
 
   it "creates remote metric from metric file" do
+    Vanity.unload!
     stub_request :post, /vanitydash/
     metric(:sandbox).track!
     assert_requested :post, /api\.vanitydash\.com/

data/test/playground_test.rb

@@ -7,45 +7,73 @@ describe Vanity::Playground do
     assert_equal instance, Vanity.playground
   end
 
-  describe "#use_js!" do
-    it "sets via use_js" do
-      assert !Vanity.playground.using_js?
-      Vanity.playground.use_js!
-      assert Vanity.playground.using_js?
+  it "creates metrics hooks on initialization for tracking" do
+    File.open "tmp/experiments/metrics/coolness.rb", "w" do |f|
+      f.write <<-RUBY
+        metric "coolness" do
+        end
+      RUBY
     end
-  end
 
-  describe "#failover_on_datastore_error" do
-    it "sets failover_on_datastore_error" do
-      assert !Vanity.playground.failover_on_datastore_error?
-      Vanity.playground.failover_on_datastore_error!
-      assert Vanity.playground.failover_on_datastore_error?
+    File.open "tmp/experiments/foobar.rb", "w" do |f|
+      f.write <<-RUBY
+        ab_test :foobar do
+          metrics :coolness
+        end
+      RUBY
     end
+
+    # new_ab_test :foobar do
+    #   alternatives "foo", "bar"
+    #   identify { "abcdef" }
+    #   metrics :coolness
+    # end
+
+    Vanity::Metric.any_instance.expects(:hook).once
+    Vanity::Playground.new
   end
 
-  describe "#on_datastore_error" do
-    it "has a default failover_on_datastore_error" do
-      proc = Vanity.playground.on_datastore_error
-      assert proc.respond_to?(:call)
-      assert_silent do
-        proc.call(Exception.new("datastore error"), self.class, caller[0][/`.*'/][1..-2], [1, 2, 3])
+  describe "deprecated settings" do
+    describe "#use_js!" do
+      it "sets via use_js" do
+        assert !Vanity.playground.using_js?
+        Vanity.playground.use_js!
+        assert Vanity.playground.using_js?
       end
     end
-  end
 
-  describe "#request_filter" do
-    it "sets request_filter" do
-      proc = Vanity.playground.request_filter
-      assert proc.respond_to?(:call)
-      assert_silent do
-        proc.call(dummy_request)
+    describe "#failover_on_datastore_error" do
+      it "sets failover_on_datastore_error" do
+        assert !Vanity.playground.failover_on_datastore_error?
+        Vanity.playground.failover_on_datastore_error!
+        assert Vanity.playground.failover_on_datastore_error?
+      end
+    end
+
+    describe "#on_datastore_error" do
+      it "has a default failover_on_datastore_error" do
+        proc = Vanity.playground.on_datastore_error
+        assert proc.respond_to?(:call)
+        assert_silent do
+          proc.call(Exception.new("datastore error"), self.class, caller[0][/`.*'/][1..-2], [1, 2, 3])
+        end
+      end
+    end
+
+    describe "#request_filter" do
+      it "sets request_filter" do
+        proc = Vanity.playground.request_filter
+        assert proc.respond_to?(:call)
+        assert_silent do
+          proc.call(dummy_request)
+        end
       end
     end
-  end
 
-  describe "#add_participant_path" do
-    it "sets a default add participant path" do
-      assert_equal Vanity.playground.add_participant_path, Vanity::Configuration::DEFAULTS[:add_participant_route]
+    describe "#add_participant_path" do
+      it "sets a default add participant path" do
+        assert_equal Vanity.playground.add_participant_path, Vanity::Configuration::DEFAULTS[:add_participant_route]
+      end
     end
   end
 

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: vanity
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta9
-  prerelease: 6
+  version: 2.0.0
 platform: ruby
 authors:
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-15 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
 description: Mirror, mirror on the wall ...
@@ -214,10 +207,11 @@ files:
 homepage: http://vanity.labnotes.org
 licenses:
 - MIT
+metadata: {}
 post_install_message: To get started run vanity --help
 rdoc_options:
 - --title
-- Vanity 2.0.0.beta9
+- Vanity 2.0.0
 - --main
 - README.rdoc
 - --webcvs
@@ -225,22 +219,20 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Experience Driven Development framework for Ruby
 test_files:
 - test/adapters/redis_adapter_test.rb