rasam 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edb330f4a39afa919a29872b4249db6d69508633
-  data.tar.gz: 42ce22267bff052d5fbccd87503de4ea949a2035
+  metadata.gz: cefaa3715a0010c00504feb32a12fae7e5d4a538
+  data.tar.gz: 841cd1f623188c8eaf49a18e6ff540f1b703abbc
 SHA512:
-  metadata.gz: 8e78d630959c5df719f4f591b5201bd6536fe260e97975218612fd747e7dccc3c0aac53bc36787d5dd693545efae1ae541d8132d8c50451c42516aec873e8336
-  data.tar.gz: a57da9411abc696ae28bcb13b7bc0defb5f82d46cf3d722ec3eff699da9cb4209ead5c613e39b6d4ce822c17b3ad2ed311c6ebecf16cd30d1f5517473197d7e8
+  metadata.gz: 7bf0f4b37ca5b1b7ec31961723ffd48b4c7ddfd1ed82612da9b6b1ca161c181fd33c16e135e59507c20229527c6fab41468ffaa629c091c4a54e34ff19fb6c49
+  data.tar.gz: f5bbd8648953a8071926de7e7c5e012a1dfc6d8d266265d3cf48529c8d4932e0e0efafc1c7664f4d0961ed52416724b3fd0ce777d0e2644d50d1fe03e72a5f86

data/.ruby-gemset

@@ -0,0 +1 @@
+rasam

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/README.md

@@ -1,9 +1,11 @@
 # Rasam
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rasam`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 Ranked pairs (RP) or the Tideman method is a voting system developed in 1987 by Nicolaus Tideman that selects a single winner using votes that express preferences. RP can also be used to create a sorted list of winners.
 
+## Console
+
+To experiment with the code, run `bin/console` for an interactive prompt.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +24,80 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Here is a simple script that uses the highline gem for command line interface to the gem. Just enter Salary <enter>, Stocks <enter>, Telecommuting <enter> and hit <enter><enter> when prompted for choices:
+
+```ruby
+require 'highline/import'
+require "pp"
+require_relative '../lib/rasam'
+
+include Rasam
+
+def get_user_choice_for(pair)
+  choose do |menu|
+    menu.prompt = "Please choose your favorite: "
+        
+    pair.each do |c|
+      menu.choice(c) do
+        say(c)
+        rationale = ask("Why?  ")
+        say(rationale)
+        
+        @pr.make_rational_choice(pair, c, rationale)
+      end
+    end
+  end
+end
+
+def display_score(options)
+  options.each do |option|
+    p "Score for #{option} : #{@pr.score_for(option)}"
+  end     
+end
+
+options = ask("Enter your choices (or a blank line to quit):",
+lambda { |ans| ans =~ /^-?\d+$/ ? Integer(ans) : ans} ) do |q|
+  q.gather = ""
+end
+
+@pr = PairRank.new(options)
+
+def display_decisions
+  @pr.decisions.each do |d|
+    p d.to_s
+  end
+end
+
+pair = @pr.combination
+
+loop do
+  p pair    
+  break if pair.nil?
+  get_user_choice_for(pair) 
+  pair = @pr.combination
+end
+
+display_decisions
+display_score(options)
+
+p 'Processing ties'
+
+loop do
+  tie = @pr.tied_pair
+  if tie.empty?
+    break
+  else tie.empty?
+    p 'Handling a tie'
+  
+    get_user_choice_for(tie)
+
+    display_decisions    
+    display_score(options)  
+  end  
+end
+```
+
+You can find this script prank.rb in the scripts folder.
 
 ## Development
 
@@ -31,11 +106,25 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 Run the test with color:
 
 ```ruby
-$ ruby -rminitest/pride test/pair_rank_test.rb 
+$ ruby -rminitest/pride test/pair_rank_test.rb --verbose
+$ ruby -rminitest/pride test/pair_rank_simulator_test.rb --verbose
+$ ruby -rminitest/pride test/combination_test.rb --verbose
 ```
 
+To run all tests:
+
+```ruby
+$ rake
+```
+
+Default rake task will not run all the tests if you mix Test::Unit::TestCase and Minitest::Test. It will only run tests with Test::Unit::TestCase as it's parent. The coverage report gets clobbered if all the tests extend from Test::Unit::TestCase. So one of the test is extending from Minitest::Test to generate the coverage report.
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Articles
+
+[TDD Beyond Basics : Outside In Perspective] (https://rubyplus.com/articles/2531 'TDD Beyond Basics : Outside In Perspective')
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/bparanj/rasam.
@@ -45,5 +134,4 @@ gem push rasam-0.1.0.gem
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rasam.rb

@@ -1,5 +1,4 @@
 require "rasam/version"
-require 'forwardable'
 
 module Rasam
   # Value Object
@@ -20,61 +19,97 @@ module Rasam
     end
   end
   
+  class Combination
+    def initialize(options)
+      @list = options.combination(2).to_a
+      @index = -1
+    end  
+  
+    def pair
+      @index += 1
+      @list[@index]
+    end
+  end
+  
   class PairRank
-    attr_reader :combinations, :decisions
+    attr_reader :decisions
     
     def initialize(options)
+      @options = options
       @decisions = []
       @votes = Hash.new(0)
-      @combinations = options.combination(2).to_a
+      @combination = Combination.new(@options)
     end
-        
-    def make(rational_choice)
-      @decisions << rational_choice
-      @votes[rational_choice.choice] += 1
+    
+    def combinations
+      @options.combination(2).to_a
+    end    
+    
+    def combination
+      @combination.pair
     end
-
+    
     def score_for(choice)
       @votes[choice]
     end
+        
+    def tied_pair
+      return [] if zeros?
+      
+      find_tie
+    end
+        
+    def break_tie(pair, choice, criteria)
+      make_rational_choice(pair, choice, criteria)
+    end
+        
+    def make_rational_choice(pair, choice, criteria)
+      rc = RationalChoice.new(pair, choice, criteria)
+      make(rc)
+    end
+        
+    # :nocov:
+    private
     
-    def rationale_for(choice)
-      decision = @decisions.find{|x| x.choice == choice}
-      decision.criteria
+    # All choices with 0 scores mean the Pair Ranking process has not begun
+    def zeros?
+      list = @options.collect{|c| score_for(c)} 
+      list.uniq == [0]
     end
     
-    def pair_for(choice)
-      decision = @decisions.find{|x| x.choice == choice}
-      decision.pair      
+    def tie(combination)
+      first = score_for(combination[0])
+      second = score_for(combination[1])
+      first == second
     end
     
-    def tied_pair
-      result = []
-      @combinations.each do |combination|
-        first = score_for(combination[0])
-        second = score_for(combination[1])
-        
-        if tie(first, second)
-          result = combination
-          break
-        end
-      end
-      result
+    def make(rational_choice)
+      store(rational_choice)
+      vote_for(rational_choice)
     end
     
-    def break_tie(pair, choice, criteria)
-      make_rational_choice(pair, choice, criteria)
+    def has_tie?
+      !tied_pair.empty?  
     end
     
-    def make_rational_choice(pair, choice, criteria)
-      rc = RationalChoice.new(pair, choice, criteria)
-      make(rc)
+    def vote_for(rational_choice)
+      @votes[rational_choice.choice] += 1
     end
     
-    private
+    # For display at the end of the Pair Ranking process
+    def store(rational_choice)
+      @decisions << rational_choice
+    end
     
-    def tie(a, b)
-      a == b
+    def find_tie
+      result = []
+      combinations.each do |combination|
+        if tie(combination)
+          result = combination
+          break
+        end
+      end
+      result
     end
   end
     

data/lib/rasam/version.rb

@@ -1,3 +1,3 @@
 module Rasam
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/rasam.gemspec

@@ -19,7 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.2.2'
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.4"
+  spec.add_development_dependency "simplecov", "~> 0.10.0"
+  spec.add_development_dependency "highline", "~> 1.7"
 end

data/scripts/prank.rb

@@ -0,0 +1,69 @@
+require 'highline/import'
+require "pp"
+require_relative '../lib/rasam'
+
+include Rasam
+
+def get_user_choice_for(pair)
+  choose do |menu|
+    menu.prompt = "Please choose your favorite: "
+        
+    pair.each do |c|
+      menu.choice(c) do
+        say(c)
+        rationale = ask("Why?  ")
+        say(rationale)
+        
+        @pr.make_rational_choice(pair, c, rationale)
+      end
+    end
+  end
+end
+
+def display_score(options)
+  options.each do |option|
+    p "Score for #{option} : #{@pr.score_for(option)}"
+  end     
+end
+
+options = ask("Enter your choices (or a blank line to quit):",
+lambda { |ans| ans =~ /^-?\d+$/ ? Integer(ans) : ans} ) do |q|
+  q.gather = ""
+end
+
+@pr = PairRank.new(options)
+
+def display_decisions
+  @pr.decisions.each do |d|
+    p d.to_s
+  end
+end
+
+pair = @pr.combination
+
+loop do
+  p pair    
+  break if pair.nil?
+  get_user_choice_for(pair) 
+  pair = @pr.combination
+end
+
+display_decisions
+display_score(options)
+
+p 'Processing ties'
+
+loop do
+  tie = @pr.tied_pair
+  if tie.empty?
+    break
+  else tie.empty?
+    p 'Handling a tie'
+  
+    get_user_choice_for(tie)
+
+    display_decisions    
+    display_score(options)  
+  end  
+end
+

data/todo.txt

@@ -1,2 +1,11 @@
-1. Use highline library to simulate a user session.
-2. Update the existing rational choices with the tie break results. This will update the existing decisions array.
+1. Demo using realistic example for job offer negotiation:
+
+Salary
+Stocks
+Bonus
+Signon Bonus
+Vacation
+Telecommuting
+
+2. Buying a car.
+3. Choosing a job.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rasam
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Bala Paranj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-27 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 description: Select a single winner using votes that express preferences. This can
   also be used to create a sorted list of winners
 email:
@@ -61,6 +89,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -71,6 +101,7 @@ files:
 - lib/rasam.rb
 - lib/rasam/version.rb
 - rasam.gemspec
+- scripts/prank.rb
 - todo.txt
 homepage: https://bitbucket.org/bparanj/rasam
 licenses:
@@ -84,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Pair Rank a given list of items.