vanity 3.1.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c54611b7ef436ec37192b30fa8451ab592b7117df14f3d3937747484b8b9a299
-  data.tar.gz: 7601b961767d868205a68bf02f5a44447c01f01083f5d53d4a8d7ab242c0f0fc
+  metadata.gz: ea9d4e9d211abdf50a36e8d8bd1ede2d826b4d556ae52ef7537ee8f86cf3e0e8
+  data.tar.gz: 583ba00d677b13d9c27f0e5556f238f99b197614ada1a5fa3d68d1822fb1edca
 SHA512:
-  metadata.gz: 60f112ca86a32c938d762699cfc40e24ccb662294ac4059ff12035af6785a3ed294f56ffb2c99c1519bb254fab438062f39cd7b62b87f6df452180066c3d515a
-  data.tar.gz: 382f2fc0afcc52d375594d2586bb41a46f7bc6f3812d242de725cf9828bbb4c82938daf1e8a29e61ddcdfa82844433f8d5d9dec05d5c960d4a01c4eccf8de203
+  metadata.gz: 679b3b9e5f5271b96bf57e7275edbcdd59765c0ccf80be786a71f8bfcf091dfb2d820eee1a6e3b4105ee49c462aed87ac4278f0146d5791f1923a3ecbf527ae6
+  data.tar.gz: 1a905082e51bfe15294333e43bd18b55c2c22926194b22ac7c03f74902578fcc5865c82b2cd0580d10dae0d42b3c4e7edf50a024ed996a5d846a1afe1f5b27f8

data/.github/workflows/linting.yml

@@ -0,0 +1,28 @@
+name: Linting
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.5
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+    - name: Cache gems
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-rubocop-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-rubocop-
+    - name: Install gems
+      run: |
+        bundle config path vendor/bundle
+        bundle config set without 'default doc job cable storage ujs test db'
+        bundle install --jobs 4 --retry 3
+    - name: Run RuboCop
+      run: bundle exec rubocop --parallel

data/.github/workflows/test.yml

@@ -30,15 +30,10 @@ jobs:
           - redis
           - active_record
         gemfile:
-          - gemfiles/rails42.gemfile
-          - gemfiles/rails42_protected_attributes.gemfile
-          - gemfiles/rails51.gemfile
           - gemfiles/rails52.gemfile
           - gemfiles/rails60.gemfile
           - gemfiles/rails61.gemfile
-        exclude:
-          - ruby: jruby-9.1.13.0
-            gemfile: gemfiles/rails5.gemfile
+
     env:
       DB: ${{ matrix.db }}
       BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
@@ -51,5 +46,7 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+      - name: Info
+        run: bundle env
       - name: Run Tests
         run: bundle exec rake test

data/.rubocop.yml

@@ -0,0 +1,114 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  SuggestExtensions: false
+  Include:
+    - Rakefile
+  Exclude:
+    - pkg/**/*
+    - spec/test_app/**/*
+    - vendor/**/*
+    - scripts/**/*
+    - gemfiles/**/*
+  NewCops: enable
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 500
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/integration/*
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Exclude:
+    - spec/lib/tasks/*
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/QuotedSymbols:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/.rubocop_todo.yml

@@ -0,0 +1,67 @@
+Style/SpecialGlobalVars:
+  Enabled: false
+# Style/FrozenStringLiteralComment:
+#   Exclude:
+#     - gemfiles/*.gemfile
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Performance/Sum:
+  Enabled: false
+
+Performance/StringInclude:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/GlobalStdStream:
+  Enabled: false
+
+Style/IdenticalConditionalBranches:
+  Enabled: false
+
+Performance/InefficientHashSearch:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Lint/UselessMethodDefinition:
+  Enabled: false
+
+Style/PreferredHashMethods:
+  Enabled: false
+
+Performance/Count:
+  Enabled: false
+
+Lint/UselessTimes:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false

data/Appraisals

@@ -1,42 +1,20 @@
-appraise "rails42" do
-  gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "4.2.9"
-  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
-  gem "passenger", "~>3.0"
-end
-
-appraise "rails42-protected_attributes" do
-  gem "protected_attributes", "1.1.0"
-  gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "4.2.9"
-  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
-  gem "passenger", "~>3.0"
-end
-
-appraise "rails51" do
-  gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "~>5.1.0"
-  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
-  gem "passenger", "~>3.0"
-end
-
 appraise "rails52" do
-  gem "mocha",  "~> 1.0", :require=>false
+  gem "mocha", "~> 1.0", require: false
   gem "rails", "~>5.2.0"
-  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
-  gem "passenger", "~>3.0"
+  gem "fastthread", github: "zoltankiss/fastthread", platforms: :mri_20
+  gem "passenger"
 end
 
 appraise "rails60" do
-  gem "mocha",  "~> 1.0", :require=>false
+  gem "mocha", "~> 1.0", require: false
   gem "rails", "~>5.2.0"
-  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
-  gem "passenger", "~>3.0"
+  gem "fastthread", github: "zoltankiss/fastthread", platforms: :mri_20
+  gem "passenger"
 end
 
 appraise "rails61" do
-  gem "mocha",  "~> 1.0", :require=>false
+  gem "mocha",  "~> 1.0", require: false
   gem "rails", "~>5.2.0"
-  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
-  gem "passenger", "~>3.0"
+  gem "fastthread", github: "zoltankiss/fastthread", platforms: :mri_20
+  gem "passenger"
 end

data/CHANGELOG

@@ -1,3 +1,18 @@
+CHANGELOG
+
+== 4.0.2 (2022-03-03)
+
+* Use Redis#exists? and fallback to #exists which could be either boolean or integer in recent redis gem versions (@bsedin)
+
+== 4.0.1 (2022-03-06)
+
+* Fix YAML alias support in `vanity.yml` (@frostmark)
+
+== 4.0.0 (2022-03-03)
+
+* Drop support for Ruby < 2.5 (@frostmark)
+* Drop support for Rails < 5.2 (@bensheldon)
+
 == 3.1.0 (2022-01-29)
 
 * Invoke on_assignment callback after assignment is stored in database; add global on_assignment callback (@frostmark)

data/Gemfile

@@ -9,20 +9,20 @@ gemspec development_group: :test
 gem "rack"
 
 # Persistence
+gem "mongo", "~> 2.1"
 gem "redis", ">= 3.2.1"
 gem "redis-namespace", ">= 1.1.0"
-gem "mongo", "~> 2.1"
 
 # Math libraries
 gem "integration", "<= 0.1.0"
 gem "rubystats", ">= 0.2.5"
 
 # APIs
-gem "garb", "< 0.9.2", :require => false # API changes at this version
+gem "garb", "< 0.9.2", require: false # API changes at this version
 
 platform :ruby do
-  gem "sqlite3", "~> 1.3.10"
   gem "jekyll", "~> 2.5.3"
+  gem "sqlite3", "~> 1.3.10"
 end
 
 platform :jruby do
@@ -34,4 +34,8 @@ group :development do
   gem "rake"
   gem "RedCloth"
   gem "yard"
+
+  gem "rubocop"
+  gem "rubocop-performance"
+  gem "rubocop-rspec"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (3.1.0)
+    vanity (4.0.2)
       i18n
 
 GEM
@@ -19,6 +19,7 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
+    ast (2.4.2)
     blankslate (2.1.2.4)
     bson (4.0.2)
     bson (4.0.2-java)
@@ -32,7 +33,7 @@ GEM
       execjs
     coffee-script-source (1.9.1)
     colorator (0.1)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crack (0.3.1)
     execjs (2.5.2)
     fakefs (0.6.7)
@@ -43,7 +44,7 @@ GEM
       activesupport (>= 2.2.0)
       crack (>= 0.1.6)
     hitimes (1.2.2)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     integration (0.1.0)
     jdbc-sqlite3 (3.8.7)
@@ -81,6 +82,9 @@ GEM
     minitest (4.7.5)
     mongo (2.2.3)
       bson (~> 4.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
     parslet (1.5.0)
       blankslate (~> 2.0)
     posix-spawn (0.3.11)
@@ -97,14 +101,34 @@ GEM
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.2.0)
     rack (1.1.3)
+    rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    redcarpet (3.2.3)
-    redis (4.0.3)
-    redis-namespace (1.6.0)
+    redcarpet (3.5.1)
+    redis (4.6.0)
+    redis-namespace (1.8.2)
       redis (>= 3.0.4)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.2)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.8.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     rubystats (0.2.5)
     safe_yaml (1.0.4)
     sass (3.4.13)
@@ -118,6 +142,7 @@ GEM
       hitimes
     toml (0.1.2)
       parslet (~> 1.5.0)
+    unicode-display_width (2.1.0)
     webmock (1.8.0)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
@@ -145,6 +170,9 @@ DEPENDENCIES
   rake
   redis (>= 3.2.1)
   redis-namespace (>= 1.1.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
   rubystats (>= 0.2.5)
   sqlite3 (~> 1.3.10)
   timecop
@@ -153,4 +181,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/README.md

@@ -380,15 +380,10 @@ your view no participants will be recorded.
 
 Here's what's tested and known to work:
 
-    Ruby 2.3
-      Persistence: Redis (redis-rb >= 3.2.1), Mongo, ActiveRecord
-      Rails: 4.1, 4.2, 5
-    Ruby 2.4
-      Persistence: Redis (redis-rb >= 3.2.1), Mongo, ActiveRecord
-      Rails: 4.1, 4.2, 5
-    JRuby 9.1
-      Persistence: Redis (redis-rb >= 3.2.1), Mongo, ActiveRecord
-      Rails: 4.1, 4.2
+    Rails: 5.2+
+    Ruby: 2.5+
+    JRuby: 9.1+
+    Persistence: Redis (redis-rb >= 3.2.1), Mongo, ActiveRecord
 
 ## Testing
 

data/Rakefile

@@ -1,11 +1,10 @@
 require "rake/testtask"
 require "bundler/gem_tasks"
 
-
 # -- Testing stuff --
 
 desc "Test everything"
-task "test:all"=>"test:adapters"
+task "test:all" => "test:adapters"
 
 # Ruby versions we're testing with.
 RUBIES = %w{1.9.3 2.0.0 jruby-1.7.13}
@@ -19,7 +18,7 @@ RUBIES = %w{1.9.3 2.0.0 jruby-1.7.13}
 # 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|
+task "test:rubies", :ruby do |_t, args|
   rubies = args.ruby ? [args.ruby] : RUBIES
   rubies.each do |ruby|
     puts "** Setup #{ruby}"
@@ -49,18 +48,17 @@ end
 ADAPTERS = %w{redis mongodb active_record}
 
 desc "Test using different back-ends"
-task "test:adapters", :adapter do |t, args|
-  begin # Make sure we have appraisal installed and available
-    require "appraisal"
-
-    adapters = args.adapter ? [args.adapter] : ADAPTERS
-    adapters.each do |adapter|
-      puts "** Testing #{adapter} adapter"
-      sh "bundle exec appraisal rake test DB=#{adapter} #{'--trace' if Rake.application.options.trace}"
-    end
-  rescue LoadError
-    warn "The appraisal gem must be available"
+task "test:adapters", :adapter do |_t, args|
+  # Make sure we have appraisal installed and available
+  require "appraisal"
+
+  adapters = args.adapter ? [args.adapter] : ADAPTERS
+  adapters.each do |adapter|
+    puts "** Testing #{adapter} adapter"
+    sh "bundle exec appraisal rake test DB=#{adapter} #{'--trace' if Rake.application.options.trace}"
   end
+rescue LoadError
+  warn "The appraisal gem must be available"
 end
 
 # Run the test suit.
@@ -72,29 +70,27 @@ Rake::TestTask.new(:test) do |task|
   task.warning = false
 end
 
-task :default=>:test
+task default: :test
 desc "Run all tests"
 
 task(:clobber) { rm_rf "tmp" }
 
-
 # -- Documenting stuff -- #TODO make sure works under 1.9/2.0
 
 desc "Jekyll generates the main documentation (sans API)"
 task(:jekyll) { sh "jekyll build -s doc -d html" }
 
 desc "Create documentation in docs directory"
-task :docs=>[:jekyll]
+task docs: [:jekyll]
 
 desc "Remove temporary files and directories"
 task(:clobber) { rm_rf "html" }
 
 desc "Publish documentation to vanity.labnotes.org via Github Pages on gh-pages git branch"
-task :publish=>[:clobber, :docs] do
+task publish: [:clobber, :docs] do
   # TODO
 end
 
-
 # -- Misc --
 
 task :report do
@@ -111,28 +107,33 @@ task :report do
   # 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]
+    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]
+    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 }
+  Vanity.context.instance_eval do
+    def vanity_identity
+      0
+    end
+  end
   signups = 50
   (Date.today - 90..Date.today).each do |date|
     Timecop.travel date do
-      signups += rand(15) - 5
+      signups += rand(-5..9)
       Vanity.playground.track! :signups, signups
     end
   end
 
-  cheers, yawns = 0, 0
+  cheers = 0
+  yawns = 0
   (Date.today - 80..Date.today).each do |date|
     Timecop.travel date do
       cheers = cheers - 5 + rand(20)

data/bin/vanity

@@ -35,7 +35,7 @@ parser = OptionParser.new("", 24, "  ") do |opts|
     puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
     exit
   end
-  opts.on_tail "-v", "--version", "Show version"  do
+  opts.on_tail "-v", "--version", "Show version" do
     puts "Vanity #{Vanity::Version::STRING}"
     exit
   end

data/doc/configuring.textile

@@ -51,6 +51,7 @@ Available configuration options are:
 | cookie_path                | The path of the cookie | @nil@ |
 | cookie_secure              | The secure (ssl-only) parameter of the cookie. | @false@ |
 | cookie_httponly            | The httponly parameter of the cookie | @false@ |
+| on_assignment              | A proc that called when a new assignment is made for the experiment | @nil@ |
 
 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.
 

data/gemfiles/rails52.gemfile

@@ -3,26 +3,29 @@
 source "https://rubygems.org"
 
 gem "rack"
+gem "mongo", "~> 2.1"
 gem "redis", ">= 3.2.1"
 gem "redis-namespace", ">= 1.1.0"
-gem "mongo", "~> 2.1"
 gem "integration", "<= 0.1.0"
 gem "rubystats", ">= 0.2.5"
 gem "garb", "< 0.9.2", require: false
 gem "mocha", "~> 1.0", require: false
 gem "rails", "~>5.2.0"
 gem "fastthread", platforms: :mri_20, git: "https://github.com/zoltankiss/fastthread.git"
-gem "passenger", "~>3.0"
+gem "passenger"
 
 group :development do
   gem "rake"
   gem "RedCloth"
   gem "yard"
+  gem "rubocop"
+  gem "rubocop-performance"
+  gem "rubocop-rspec"
 end
 
 platforms :ruby do
-  gem "sqlite3", "~> 1.3.10"
   gem "jekyll", "~> 2.5.3"
+  gem "sqlite3", "~> 1.3.10"
 end
 
 platforms :jruby do