eenie_meenie 0.0.3 → 0.0.4

data/README.md

@@ -8,6 +8,79 @@ Installation
 
 EenieMeenie is a Ruby gem, and can be installed using `gem install eenie_meenie`
 
+Usage
+-----
+
+EenieMeenie currently provides two algorithms for assigning members to experimental groups.
+
+`EenieMeenie::Assignment` was the first algorithm, and was intended to handle situations where members of a population are to be assigned to ONE of TWO groups.  As I started working with a greater variety of research studies, I found the algorithm to be both overcomplicated and inadequate.
+
+`EeenieMeenie::PolyAssignment` is a new algorithm.  With this algorithm you'll be able to:
+
+1. Assign a threshold (a `Float` to represent percentage) to each experimental group.
+2. Assign a threshold of "DO NOT CARE" to any group by passing `false` instead of a `Float`
+3. Tell EeenieMeenie which groups can be assigned by the algorithm.  Any group with a threshold should be included here.
+4. Tell it how to scope the member class (tell it which study, if you're using one member class for all studies)
+
+Example Configurations
+----------------------
+
+```ruby
+# Control: Do not care  (chosen manually, if ever)
+# Experimental A: %50   (randomly assign)
+# Experimental B: %50   (randomly assign)
+
+EenieMeenie::Assignment.new({
+  groups: ["Experimental A", "Experimental B"],  # EenieMeenie's assignment options
+  member: @obj,                                  # Member of population
+  group_rules: {
+    "Control"         => { threshold: false },   # Don't care
+    "Full-Incentive"  => { threshold: 0.5 },     # No more than 50%
+    "Split-Incentive" => { threshold: 0.5 }      # No more than 50%
+  },
+  class_rules: { organization_id: 1}             # Only consider members belonging to Organization 1
+}).execute!
+```
+
+```ruby
+# Control:        %33.3   (randomly assign)
+# Experimental A: %33.3   (randomly assign)
+# Experimental B: %33.3   (randomly assign)
+
+EenieMeenie::Assignment.new({
+  groups: ["Control", "Experimental A", "Experimental B"],      # EenieMeenie's assignment options
+  member: @obj,                                      # Member of population
+  group_rules: {
+    "Control"         => { threshold: (1.0 / 3.0) },    # No more than one-third
+    "Full-Incentive"  => { threshold: (1.0 / 3.0) },    # No more than one-third
+    "Split-Incentive" => { threshold: (1.0 / 3.0) }     # No more than one-third
+  },
+  class_rules: { organization_id: 1} # Only consider members belonging to Organization 1
+}).execute!
+```
+
+```ruby
+# Control:        %50         (randomly assign)
+# Experimental:   Do not care (randomly assign)
+# Experimental A: Do not care (manually assign)
+# Experimental B: Do not care (manually assign)
+
+# If "Control" is too full, put them in "Experimental"          ...
+# Later someone will choose whether they're in "Experimental A" ...
+# or in "Experimental B"
+
+EenieMeenie::Assignment.new({
+  groups: ["Control", "Experimental"],       # EenieMeenie's assignment options
+  member: @obj,                              # Member of population
+  group_rules: {
+    "Control"        => { threshold: 0.5 },   # No more than one-third
+    "Experimental"   => { threshold: false }, # Don't care
+    "Experimental A" => { threshold: false }  # Don't care
+    "Experimental B" => { threshold: false }  # Don't care
+  }
+}).execute!
+```
+
 ### Pull requests/issues
 
 Please submit any useful pull requests through GitHub. Please report any bugs using Github's issue tracker

data/lib/eenie_meenie/poly_assignment.rb

@@ -0,0 +1,41 @@
+module EenieMeenie
+  class PolyAssignment < ::EenieMeenie::Base
+    def initialize(options)
+      options = {
+        class_rules: {}
+      }.merge(options)
+
+      load_options(:group_rules, :class_rules, :groups, :member, options)
+    end
+
+    def execute!
+      set_group_counts
+      return random_group
+    end
+
+    private
+
+    # Total population
+    def population
+      @members ||= @member.class.where(@class_rules)
+    end
+
+    # Current population in each group
+    def set_group_counts
+      @group_rules.each do |k,v|
+        v[:count] = population.where(experimental_group: k.to_s).count
+      end
+    end
+
+    # Groups not over threshold
+    def group_candidates
+      @group_candidates ||= @group_rules.reject { |k,v|
+        v[:threshold] && (v[:count] / @members.count.to_f) >= v[:threshold]
+      }.keys.map(&:to_s)
+    end
+
+    def random_group
+      group_candidates.sample || @groups.sample
+    end
+  end
+end

data/lib/eenie_meenie/version.rb

@@ -1,3 +1,3 @@
 module EenieMeenie
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,66 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: eenie_meenie
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  prerelease:
+  version: 0.0.4
 platform: ruby
 authors:
 - Tad Hosford
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: !binary |-
+          MA==
     none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-description: ! " Attempts to provide a random but (mostly)\n                      even
-  distribution of samples amongst\n                      specified groups\n                    "
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: ! " Attempts to provide a random but (mostly)\n                     \
+  \ even distribution of samples amongst\n                      specified groups\n\
+  \                    "
 email:
 - tad.hosford@gmail.com
 executables: []
@@ -68,9 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - eenie_meenie.gemspec
@@ -78,6 +83,7 @@ files:
 - lib/eenie_meenie/assignment.rb
 - lib/eenie_meenie/base.rb
 - lib/eenie_meenie/miny_moe.rb
+- lib/eenie_meenie/poly_assignment.rb
 - lib/eenie_meenie/result.rb
 - lib/eenie_meenie/sorters/bucket_shuffle.rb
 - lib/eenie_meenie/sorters/late_coercion.rb
@@ -89,26 +95,34 @@ files:
 - test/minitest_helper.rb
 homepage: http://github.com/rthbound/eenie_meenie
 licenses: []
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
+  none: false
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 1.8.24
-signing_key: 
+signing_key:
 specification_version: 3
 summary: ''
 test_files: []

data/CHANGELOG.md

@@ -1,13 +0,0 @@
-0.0.1 - Initial release, allows you to initialize an instance of Rubeuler::Problem with required options `:number` (int) and `:answer` (string of ruby code). Answer is evaluated and compared to answer predefined in Rubeuler::Problem#solutions method.   Result is returned indicating success/failure and the time elapsed when running the code in `:answer`
-
-0.0.2 - Fixed Rakefile (gave myself the ability to use `rake release`); Updated description in gemspec
-
-0.0.3 - Moved Rubeuler::Problem#solutions to Rubeuler::Solution#for_problem to make the intended use more intuitive
-
-0.0.4 - Add tests using minitest
-
-0.0.5 - Feature: Track other variables... the options `tracked: {foo: @foo}` would track a variable set as `@foo` in Rubeuler::Problem's `:answer` argument
-				Improve on tests, improve timer by moving Benchmark closer to code being evaluated
-
-0.0.6 - Reverting the change to the Benchmark implementation from 0.0.5
-        

data/Gemfile.lock

@@ -1,33 +0,0 @@
-PATH
-  remote: .
-  specs:
-    eenie_meenie (0.0.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    coderay (1.0.7)
-    method_source (0.8)
-    minitest (3.5.0)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-    pry (0.9.10-java)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-      spoon (~> 0.0)
-    rake (0.9.2.2)
-    slop (3.3.3)
-    spoon (0.0.1)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  eenie_meenie!
-  minitest
-  pry
-  rake