yacc-vanity 1.5.1

data/CHANGELOG

@@ -0,0 +1,243 @@
+== 1.5.1 (2010-12-20)
+
+Fixes some minor bugs in RoR when including the Dashboard (netguru)
+
+
+== 1.5.0 (2010-10-23)
+
+Note: MongoDB URI scheme changed from mongo: to mongodb: to be consistent with
+the rest of the civilized world. If you get an error because Vanity can't find
+the MongoDB adapter, fear not! It's still there, just need to update your
+config/vanity.yml file.
+
+
+Rails 3 support (Adam Keys, Stephen Celis, Brian Leonard, Ryan Carver)
+
+Changed MongoDB URI scheme from 'mongo://' to the standard 'mongodb://' and
+renamed the mongodb adapter filename to make it match (JS Boulanger)
+
+Added support for ERB in YAML configuration files (JS Boulanger)
+
+Fixed initialization of playground's Rails defaults such that they can be
+overriden in the environment (JS Boulanger)
+
+
+== 1.4.0 (2010-08-06)
+
+Note: Run this command to upgrade your database to 1.4, or you will not have
+access to collected metrics and experiment data:
+
+  vanity upgrade
+
+
+Connection adapters! We have a new way for managing connections which extends
+to multiple adapters (not just Redis). The easiest is to use the configuration
+file config/vanity.yml. For example:
+
+  development:
+	  adapter: redis
+	production:
+	  adapter: mongodb
+
+We get to keep Redis, add new MongoDB adapter, but lose Mock. It's still there,
+but there's a new way to use Vanity outside production: you can turn data
+collection on/off.
+
+Under Rails, data collection is turned off in all environments except
+production. To turn if on/off:
+
+  Vanity.playground.collecting = true/false.
+
+
+This release switches to latest Redis gem and uses redis-namespace (what took
+me so long?) If your own code relies on the Redis gem, watch out: there are
+some subtle incompatibilities between 1.x and 2.x.
+
+
+Now using RVM, gemsets and Bundler to test Vanity in different configurations.
+To run the full set of tests in all the supported versions of Ruby:
+  rake test:rubies
+To test specific version of Ruby:
+  rake test:rubies[1.8.7]
+To switch around:
+  rvm 1.9.2@vanity
+
+* Added: Adapter API, see Vanity::Adapters::AbstractAdapter and
+Vanity::Adapters::RedisAdapter.
+* Added: MongoDB support.
+* Added: Upgrade command.
+* Added: Metric.last_update_at.
+* Added: Vanity.playground.collecting. You want this to be true only in
+production environment. When false, disables collecting of metric and
+experiment data.
+* Added: Remote metrics. Push data to remote service.
+* Added: Partial support for multi-series metrics. Laying the ground for the
+future.
+* Change: Vanity.playground.redis and redis= methods are deprecated, use
+connection and establish_connection instead.
+* Removed: Metric.created_at, derived from experiment and never used.
+
+
+== 1.3.0 (2010-03-01)
+
+This release adds support for Google Analytics, AdWords and forking servers
+(Passenger, Unicorn).
+
+To view Google Analytics metrics from within Vanity, first make sure you are
+using Garb.  For example, in your Gemfile:
+
+  gem "vanity", "1.3.0"
+  gem "garb",   "0.5.0" 
+
+Next, authenticate using your account credentials.  For example, in your
+config/environments/production.rb:
+
+  require "garb"
+	Garb::Session.login('..email..', '..password..', account_type: "GOOGLE") rescue nil
+
+Last, define Vanity metrics that tap to Google Analytics metrics.  For example:
+
+  metric "Acquisition: Visitors" do
+    description "Unique visitors on any given page, as tracked by Google Analytics"
+    google_analytics "UA-1828623-6", :visitors
+  end
+
+* Added: Support for Google Analytics metrics, thanks to Tony Pitale's Garb and blog post: http://www.viget.com/extend/user-goal-tracking-in-rails-with-vanity-and-google-analytics/
+* Added: Vanity query parameter that you can use to choose a particular alternative, e.g. to tie an advertisement banner with content of the site.
+* Added: Command line "vanity list" catalogs all ongoing experiments, their alternatives (and fingerprints) and all metrics.
+* Added: Playground.reconnect!, particularly useful when forking (Passenger, Unicorn, etc).
+* Added: Vanity loads Redis configuration from config/redis.yml (if you have such a file).
+* Changed: New way to specify connection configuration: Vanity.playground.redis = "localhost:6379". Use this instead of the separate host/port/db attribute.
+* Changed: Rails integration now separates use_vanity method, filters and helpers.
+* Changed: Explicit vanity_context_filter and vanity_reload_filter so you can skip them, or order filters relative to them.
+* Fixed: If metric cannot be loaded (e.g. offline, no db access) show error message for that metric but don't break dashboard.
+* Fixed: AbTest incorrectly calls identify method instead of identity (issue #2)
+* Fixed: Running vanity command, automatically detects and loads Rails.
+* Fixed: Vanity now picks up on load_path set from within config/environment.rb.
+* Removed: Vanity.playground.define is deprecated. Bad choice for a method name. If you need this feature, make a suggestion and let's create a better API.
+
+== 1.2.0 (2009-12-14)
+This release introduces metrics backed by ActiveRecord.  Use them when your model is already tracking a metric, and you get instant historical data.
+
+Example, track sign ups using User model:
+
+  metric "Signups" do
+    model Account
+  end
+
+Example, track satisfaction using Survey model:
+  metric "Satisfaction" do
+    model Survey, :average=>:rating
+  end
+
+Example, track only high ratings:
+  metric "High ratings" do
+    model Rating, :conditions=>["stars >= 4"]
+  end
+
+There's no need to call track! on these metrics.
+
+* Added: Metrics backed by ActiveRecord.
+* Added: track! and ab_test methods now available from Object (i.e. everywhere).
+* Added: Playground.load!. Now loading all metrics and experiments from Rails initializer.
+* Changed: Decoupled metric name from identifier.  You can now define a metric with more descriptive name, e.g. "Cheers per second (user satisfaction)" and keep their ID simple.  Identifier is matched against the file name (for metrics loaded from experiments/metrics).
+* Changed: Metrics no longer defined on-demand, i.e. calling playground.metric either returns existing metric or raises exception.
+* Changed: Playground.experiments returns hash instead of array.
+* Changed: All dates in report are UTC, since we don't know which locale to use.
+* Removed: Object.experiment is deprecated, please call Vanity.playground.experiment directly.
+* Fixed: Playground no longer changes logging level on supplied logger.
+
+== 1.1.1 (2009-12-4)
+* Fixed: Binding issue that shows up on 1.8.6/7.
+
+== 1.1.0 (2009-12-4)
+This release introduces metrics.  Metrics are the gateway drug to better software.
+
+It’s as simple as defining a metric:
+
+	metric "Cheers" do
+		description "They love us, don't they?"
+	end
+
+Tracking it from your code:
+
+	track! :cheers
+
+And watching the graph from the Dashboard.
+
+You can (should) also use metrics with your A/B tests, for example:
+
+  ab_test "Pricing options" do
+	  metrics :signup
+		alternatives 15, 25, 29
+	end
+
+This new usage may become requirement in a future release.
+
+Much thanks to Ian Sefferman for fixing issues with Ruby 1.8.7 and Rails support.
+
+* Added: Metrics.
+* Added: Use Vanity.playground.mock! when running tests and you'd rather not access a live Redis server.
+* Changed: A/B tests now using metrics for tracking.
+* Changed: Now throwing NameError instead of LoadError when failing to load experiment/metric.  NameError can be rescued on same line. 
+* Changed: New, easier URL mapping for Dashboard: map.vanity "/vanity", :controller=>:vanity.
+* Changed: All tests are green on Ruby 1.8.6, 1.8.7 and 1.9.1.
+* Changed: Switched to redis-rb from http://github.com/ezmobius/redis-rb.
+* Deprecated: Please call experiment method with experiment identifier (a symbol) and not experiment name.
+
+== 1.0.0 (2009-11-19)
+This release changes the way you define a new experiment.  You can use a method suitable for the type of experiment you want to define, or call the generic define method (previously: experiment method).  For example:
+
+  ab_test "My A/B test" do
+	  alternatives :a, :b
+	end
+
+The experiment method is no longer overloaded: it looks up an experiment (loading its definition if necessary), but does not define an experiment.  The ab_test method is overloaded, though this may change in the future.
+
+In addition, the ab_goal! method is now track!.  This method may be used for other tests in the future.
+
+* Added: A/B test report now showing number of participants.
+* Added: AbTest.score method accepts minimum probability (default 90), and
+* Removed: Experiment.reset! method. Destroy and save have the same effect.
+* Changed: Playground.define now requires an experiment type, ab_test is not the default any more.
+* Changed: When you run Vanity in development mode (configuration.cache_classes = false), it will reload experiments on each request. You can also Vanity.playground.reload!.
+* Changed: Fancy AJAX trickery in Rails console.
+* Changed: You can break long experiment descriptions into multiple paragraphs using two consecutive newlines.
+* Changed: AbTest confidence becomes probability; only returns choice alternative with probability equal or higher than that.
+* Changed: ab_goal! becomes track!.
+* Changed: Console becomes Dashboard, which is less confusing with rails console (script/console).
+
+== 0.3.1 (2009-11-13)
+* Changed: Redis 1.0 is now vendored into Vanity. This means one less dependecy ... actually two, since Redis brings with it RSpec.
+
+== 0.3.0 (2009-11-13)
+* Added: score now includes least performing alternatives, names and values.
+* Added: shiny reports.
+* Added: Rails console shows current experiments status and also allows you to choose which alternative you want to see.
+* Changed: letters instead of numbers for options (option 1 => option A).
+* Changed: experiment.alternatives is now an immutable snapshot.
+* Changed: experiment.score returns populated alternative objects instead of structs.
+* Changed: experiment.chooses uses Redis to store state, better for (when we get to) browser integration.
+* Changed: experiment.chooses skips recording participant or conversion.
+* Changed: to MIT license.
+
+== 0.2.2 (2009-11-12)
+* Added: vanity binary, with single command for generating a report.
+* Added: return alternative by value from experiment.alternative(val) method.
+* Added: reset an experiment by calling reset!.
+* Added: experiment alternative name (option 1, option 2, etc).
+* Added: new scoring algorithm: use experiment.score instead of alternative.z_score/confidence.
+* Added: experiment.conclusion for plain English results.
+
+== 0.2.1 (2009-11-11)
+* Added: z-score and confidence level for A/B test alternatives.
+* Added: test auto-completion and auto-outcome (complete_it, outcome_is).
+* Changed: default alternatives are now false/true, so if can't decide outcome, fall back on false.
+
+== 0.2.0 (2009-11-10)
+* Added: experiment method on object, used to define and access experiments.
+* Added: playground configuration (Vanity.playground.namespace = , etc).
+* Added: use_vanity now accepts block instead of symbol.
+* Changed: Vanity::Helpers becomes Vanity::Rails.
+* Changed: A/B test experiments alternatives now handled using Alternatives object.
+* Removed: A/B test measure method no longer in use.

data/Gemfile

@@ -0,0 +1,24 @@
+source :rubygems
+gemspec
+
+group :development do
+  gem "jekyll"
+  gem "rake"
+  gem "RedCloth"
+  gem "yard"
+end
+
+group :test do
+  gem "bson_ext"
+  gem "garb"
+  gem "mocha"
+  gem "mongo"
+  gem "passenger"
+  gem "rails", "2.3.8"
+  gem "rack", "1.1.0"
+  gem "shoulda"
+  gem "sqlite3-ruby", "1.2.5" # 1.3.0 doesn't like Ruby 1.9.1
+  gem "timecop"
+  #gem "SystemTimer"
+  gem "webmock"
+end

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Assaf Arkin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,74 @@
+Vanity is an Experiment Driven Development framework for Rails.
+
+* All about Vanity: http://vanity.labnotes.org
+* On github: http://github.com/assaf/vanity
+
+http://farm3.static.flickr.com/2540/4099665871_497f274f68_o.jpg
+
+
+== A/B Testing With Rails (In 5 Easy Steps)
+
+<b>Step 1:</b> Start using Vanity in your Rails application:
+
+  Rails::Initializer.run do |config|
+    gem.config "vanity"
+
+    config.after_initialize do
+      require "vanity"
+    end
+  end
+
+And:
+
+  class ApplicationController < ActionController::Base
+    use_vanity :current_user
+  end
+
+<b>Step 2:</b> Define your first A/B test.  This experiment goes in the file <code>experiments/price_options.rb</code>:
+
+  ab_test "Price options" do
+    description "Mirror, mirror on the wall, who's the better price of all?"
+    alternatives 19, 25, 29
+    metrics :signups
+  end
+
+<b>Step 3:</b> Present the different options to your users:
+
+  <h2>Get started for only $<%= ab_test :price_options %> a month!</h2>
+
+<b>Step 4:</b> Measure conversion:
+
+  class SignupController < ApplicationController
+    def signup
+      @account = Account.new(params[:account])
+      if @account.save
+        track! :signups
+        redirect_to @acccount
+      else
+        render action: :offer
+      end
+    end
+  end
+
+<b>Step 5:</b> Check the report:
+
+  vanity report --output vanity.html
+
+
+== Contributing
+
+* Fork the project
+* Please use a topic branch to make your changes, it's easier to test them that way
+* Fix, patch, enhance, document, improve, sprinkle pixie dust
+* At minimum run rake test, if possible, please run rake test:all
+* Tests. Please. Run rake test, of if you can, rake test:all
+* Send a pull request on GitHub
+
+
+== Credits/License
+
+Original code, copyright of Assaf Arkin, released under the MIT license.  
+
+Documentation available under the Creative Commons Attribution license.
+
+For full list of credits and licenses: http://vanity.labnotes.org/credits.html.

data/Rakefile

@@ -0,0 +1,189 @@
+require "rake/testtask"
+
+# -- Building stuff --
+
+spec = Gem::Specification.load(Dir["*.gemspec"].first)
+
+desc "Build the Gem"
+task :build do
+  sh "gem build #{spec.name}.gemspec"
+end
+
+desc "Install #{spec.name} locally"
+task :install=>:build do
+  sudo = "sudo" unless File.writable?( Gem::ConfigMap[:bindir])
+  sh "#{sudo} gem install #{spec.name}-#{spec.version}.gem"
+end
+
+desc "Push new release to gemcutter and git tag"
+task :push=>["test:all", "build"] do
+  sh "git push"
+  puts "Tagging version #{spec.version} .."
+  sh "git tag v#{spec.version}"
+  sh "git push --tag"
+  puts "Building and pushing gem .."
+  sh "gem push #{spec.name}-#{spec.version}.gem"
+end
+
+
+# -- Testing stuff --
+
+desc "Test everything"
+task "test:all"=>"test:rubies"
+
+# Ruby versions we're testing with.
+RUBIES = %w{1.8.7 1.9.2}
+
+# Use rake test:rubies to run all combination of tests (see test:adapters) using
+# all the versions of Ruby specified in RUBIES. Or to test a specific version of
+# Ruby, rake test:rubies[1.8.7].
+#
+# This task uses RVM to install all the Ruby versions it needs, and creates a
+# vanity gemset in each one that includes Bundler and all the gems specified in
+# Gemfile. If anything goes south you can always wipe these gemsets or uninstall
+# these Rubies and start over.
+desc "Test using multiple versions of Ruby"
+task "test:rubies", :ruby do |t, args|
+  rubies = args.ruby ? [args.ruby] : RUBIES
+  rubies.each do |ruby|
+    puts "** Setup #{ruby}"
+    sh "env rvm_install_on_use_flag=1 rvm_gemset_create_on_use_flag=1 rvm use #{ruby}@vanity"
+    sh "rvm #{ruby}@vanity rake test:setup"
+    puts
+    puts "** Test using #{ruby}"
+    sh "rvm #{ruby}@vanity -S bundle exec rake test:adapters #{'--trace' if Rake.application.options.trace}"
+  end
+end
+
+task "test:setup" do
+  # Intended to be used from test:rubies, within specific RVM context.
+  begin # Make sure we got Bundler installed.
+    require "bundler"
+  rescue LoadError
+    sh "gem install bundler"
+  end
+  begin # Make sure we got all the dependencies
+    sh "bundle exec ruby -e puts > /dev/null"
+  rescue
+    sh "bundle install"
+  end
+end
+
+# These are all the adapters we're going to test with.
+ADAPTERS = %w{redis mongodb}
+
+desc "Test using different back-ends"
+task "test:adapters", :adapter do |t, args|
+  adapters = args.adapter ? [args.adapter] : ADAPTERS
+  adapters.each do |adapter|
+    puts "** Testing #{adapter} adapter"
+    sh "rake test ADAPTER=#{adapter} #{'--trace' if Rake.application.options.trace}"
+  end
+end
+
+# Run the test suit.
+
+task :default=>:test
+desc "Run all tests"
+Rake::TestTask.new do |task|
+  task.test_files = FileList['test/**/*_test.rb']
+  if Rake.application.options.trace
+    #task.warning = true
+    task.verbose = true
+  elsif Rake.application.options.silent
+    task.ruby_opts << "-W0"
+  else
+    task.verbose = true
+  end
+    task.ruby_opts << "-I."
+end
+
+task(:clobber) { rm_rf "tmp" }
+
+
+# -- Documenting stuff --
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new(:yardoc) do |task|
+    task.files  = FileList["lib/**/*.rb"].exclude("lib/vanity/backport.rb")
+    task.options = "--output", "html/api", "--title", "Vanity #{spec.version}", "--main", "README.rdoc", "--files", "CHANGELOG"
+  end
+rescue LoadError
+end
+
+desc "Jekyll generates the main documentation (sans API)"
+task(:jekyll) { sh "jekyll", "doc", "html" }
+file "html/vanity.pdf"=>:jekyll do |t|
+  pages = %w{index metrics ab_testing rails identity configuring contributing}.map{ |p| "html/#{p}.html" }
+  args = %w{--disable-javascript --outline --title Vanity --header-html doc/_layouts/_header.html --print-media-type}
+  args.concat %w{--margin-left 20 --margin-right 20 --margin-top 20 --margin-bottom 20 --header-spacing 5}
+  args.concat pages << t.name
+  sh "wkhtmltopdf", *args
+end
+
+file "html/vanity-api.zip"=>:yardoc do |t|
+  Dir.chdir "html" do
+    sh "zip vanity-api.zip -r api"
+  end
+end
+desc "Create documentation in docs directory (including API)"
+task :docs=>[:jekyll, :yardoc, "html/vanity-api.zip", "html/vanity.pdf"]
+desc "Remove temporary files and directories"
+task(:clobber) { rm_rf "html" ; rm_rf ".yardoc" }
+
+desc "Publish documentation to vanity.labnotes.org"
+task :publish=>[:clobber, :docs] do
+  sh "rsync -cr --del --progress html/ labnotes.org:/var/www/vanity/"
+end
+
+
+# -- Misc --
+
+task :report do
+  $LOAD_PATH.unshift "lib"
+  require "vanity"
+  require "timecop"
+  Vanity.playground.load_path = "test/experiments"
+  Vanity.playground.experiments.values.each(&:destroy)
+  Vanity.playground.metrics.values.each(&:destroy!)
+  Vanity.playground.reload!
+
+  # Control	182	35	19.23%	N/A
+  # Treatment A	180	45	25.00%	1.33
+  # Treatment B	189	28	14.81%	-1.13
+  # Treatment C	188	61	32.45%	2.94
+  Vanity.playground.experiment(:null_abc).instance_eval do
+    fake nil=>[182,35], :red=>[180,45], :green=>[189,28], :blue=>[188,61]
+    @created_at = (Date.today - 40).to_time
+    @completed_at = (Date.today - 35).to_time
+  end
+
+  Vanity.playground.experiment(:age_and_zipcode).instance_eval do
+    fake false=>[80,35], true=>[84,32]
+    @created_at = (Date.today - 30).to_time
+    @completed_at = (Date.today - 15).to_time
+  end
+
+  Vanity.context = Object.new
+  Vanity.context.instance_eval { def vanity_identity ; 0 ; end }
+  signups = 50
+  (Date.today - 90..Date.today).each do |date|
+    Timecop.travel date do
+      signups += rand(15) - 5
+      Vanity.playground.track! :signups, signups
+    end
+  end
+
+  cheers, yawns = 0, 0
+  (Date.today - 80..Date.today).each do |date|
+    Timecop.travel date do
+      cheers = cheers - 5 + rand(20)
+      Vanity.playground.track! :yawns, cheers
+      yawns = yawns - 5 + rand(30)
+      Vanity.playground.track! :cheers, yawns
+    end
+  end
+
+  Vanity::Commands.report ENV["OUTPUT"]
+end