probability_to_friendly_string 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7059a95d77157d0d310e2333bb4cbff4a4094fc7
-  data.tar.gz: 9f8e25d6c29c9f21f0803ca9df3980bded8cb6e9
+SHA256:
+  metadata.gz: 579e97359c71ab54409353dd83c154dc09e4c357b1069f1455c04125602f39b8
+  data.tar.gz: f290613fadcea9859d6e27432b780f6b91445ebd0fbadde34e5866121cf1d396
 SHA512:
-  metadata.gz: d94985123fab4059d642c6f1ce7060493ddbf49f14bce6981d160e445c332ae90ceb4125be29d54fd169ba5823366f3c6aac85254a69adc694e438f59e197523
-  data.tar.gz: 5a455957440123a35aedbbc2784929a67313fca06dd6750ca9898a35956886d182a5c6e2a82f6981985f512e854abc188d90dd97469e02b878aed5e9a347859f
+  metadata.gz: d68f336766d8adfc11a3252d7448cfdb3b12088e33093485a4100a45175718d9ddcb54a7da98fc4dccdc70cdabbdfd35871772ba11fcaf9caa40bf683662c7b6
+  data.tar.gz: 84c70e153f65e5044605c2ed29b1dc58421c5cdff3a17305c9b79bd47e61bfed29deea21945ad105cb174f45535a0b208e351b1d9bfe54f51f5cb5d26ccc5cfb

data/lib/probability_to_friendly_string.rb

@@ -2,12 +2,31 @@ module ProbabilityToFriendlyString
     # Represents probability represented in a friendly manner.
     class FriendlyProbability
         include Comparable
-        attr_reader :numerator, :denominator, :friendlyString
+        attr_reader :numerator, :denominator, :friendlyDescription, :friendlyString
 
         @@fractionsData = nil
-        def initialize(numerator, denominator, friendlyString = nil)
+        @@friendlyDescriptionValues = [0.005, 0.02, 0.08, 0.15, 0.2, 0.45, 0.55, 0.7, 0.8, 0.85, 0.9, 0.95, 0.995]
+        @@friendlyDescriptionStrings = [
+            "Hard to imagine",
+            "Barely possible",
+            "Still possible",
+            "Some chance",
+            "Could happen",
+            "Perhaps",
+            "Flip a coin",
+            "Likelier than not",
+            "Good chance",
+            "Probably",
+            "Quite likely",
+            "Pretty likely",
+            "Very likely",
+            "Almost certainly",
+		]
+
+        def initialize(numerator, denominator, friendlyDescription, friendlyString = nil)
             @numerator = numerator
             @denominator = denominator
+            @friendlyDescription = friendlyDescription
             if friendlyString
                 @friendlyString = friendlyString 
             else
@@ -45,14 +64,20 @@ module ProbabilityToFriendlyString
             if f < 0 or f > 1
                 raise RangeError, "f is less than 0 or greater than 1"
             end
+            # index of the least element > f
+            index = @@friendlyDescriptionValues.bsearch_index {|x| x > f}
+            if index.nil?
+                index = @@friendlyDescriptionStrings.length - 1
+            end
+            friendlyDescription = @@friendlyDescriptionStrings[index]
             if f == 0
-                return FriendlyProbability.new 0, 1
+                return FriendlyProbability.new 0, 1, friendlyDescription
             elsif f == 1
-                return FriendlyProbability.new 1, 1
+                return FriendlyProbability.new 1, 1, friendlyDescription
             elsif f > 0.99
-                return FriendlyProbability.new 99, 100, ">99 in 100"
+                return FriendlyProbability.new 99, 100, friendlyDescription, ">99 in 100"
             elsif f < 0.01
-                return FriendlyProbability.new 1, 100, "<1 in 100"
+                return FriendlyProbability.new 1, 100, friendlyDescription, "<1 in 100"
             end
 
             FriendlyProbability._createFractionsData
@@ -64,14 +89,14 @@ module ProbabilityToFriendlyString
                 left = @@fractionsData.length - 1
             end
             if (left == (@@fractionsData.length - 1) or (left >= 0 and f - @@fractionsData[left][0] < @@fractionsData[right][0] - f))
-                return FriendlyProbability.new @@fractionsData[left][1], @@fractionsData[left][2]
+                return FriendlyProbability.new @@fractionsData[left][1], @@fractionsData[left][2], friendlyDescription
             else
-                return FriendlyProbability.new @@fractionsData[right][1], @@fractionsData[right][2]
+                return FriendlyProbability.new @@fractionsData[right][1], @@fractionsData[right][2], friendlyDescription
             end
         end
 
         def to_s
-            return "#{@numerator}/#{@denominator} (text: \"#{@friendlyString}\")"
+            return "#{@numerator}/#{@denominator} (text: \"#{@friendlyString}\", description: \"#{@friendlyDescription}\")"
         end
 
         def <=>(another_friendly_string)
@@ -85,7 +110,12 @@ module ProbabilityToFriendlyString
             elsif self.denominator > another_friendly_string.denominator
                 1
             end
-            if self.friendlyString < another_friendly_string.friendlyString
+            if self.friendlyDescription < another_friendly_string.friendlyDescription
+                -1
+            elsif self.friendlyDescription > another_friendly_string.friendlyDescription
+                1
+            end
+             if self.friendlyString < another_friendly_string.friendlyString
                 -1
             elsif self.friendlyString > another_friendly_string.friendlyString
                 1

data/test/friendly_probability_tests.rb

@@ -19,14 +19,36 @@ class FriendlyProbabilityTests < Test::Unit::TestCase
             parts = line.split(',')
             case parts.length
             when 3
-                expected = ProbabilityToFriendlyString::FriendlyProbability.new parts[1].to_i, parts[2].to_i
+                expected = ProbabilityToFriendlyString::FriendlyProbability.new parts[1].to_i, parts[2].to_i, nil
             when 4
-                expected = ProbabilityToFriendlyString::FriendlyProbability.new parts[1].to_i, parts[2].to_i, parts[3]
+                expected = ProbabilityToFriendlyString::FriendlyProbability.new parts[1].to_i, parts[2].to_i, nil, parts[3]
             else
                 flunk "Line badly formatted: #{line} (line #{lineNumber})"
             end
             actual = ProbabilityToFriendlyString::FriendlyProbability.fromProbability(parts[0].to_f)
-            assert_equal expected, actual, "Called on #{parts[0]} (line #{lineNumber})"
+            assert_equal expected.numerator, actual.numerator, "Numerator, called on #{parts[0]} (line #{lineNumber})"
+            assert_equal expected.denominator, actual.denominator, "Denominator, called on #{parts[0]} (line #{lineNumber})"
+            assert_equal expected.friendlyString, actual.friendlyString, "Denominator, called on #{parts[0]} (line #{lineNumber})"
+        end
+    end
+    def test_all_cases_friendly_probability
+        directory = File.absolute_path(File.dirname(__FILE__))
+        path = File.join(directory, 'testCases.friendlyDescription.txt')
+        while !File.exists?(path)
+            directory = File.dirname(directory)
+            path = File.join(directory, 'testCases.friendlyDescription.txt')
+        end
+        lineNumber = 0
+        File.open(path).each do |fullLine|
+            lineNumber += 1
+            line = fullLine.strip
+            if (line.start_with?('#') or line.empty?)
+                next
+            end
+            parts = line.split(',')
+            expected = parts[1]
+            actual = ProbabilityToFriendlyString::FriendlyProbability.fromProbability(parts[0].to_f)
+            assert_equal expected, actual.friendlyDescription, "FriendlyDescription, called on #{parts[0]} (line #{lineNumber})"
         end
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: probability_to_friendly_string
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Greg Stoll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies: []
 description: Make probabilities more intuitive by converting them to odds (i.e. 72.3%
   becomes "5 in 7")
@@ -39,7 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Make probabilities more intuitive by converting them to odds