sometimes 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccb9ae4d24901c0c3e8c281b0a472757886b960114efd2522a98e541eaf62979
-  data.tar.gz: 31f5ea8578f47a910f01053ac0ac5d7173a19875253e5ce6470b63a1c4b70b02
+  metadata.gz: 60c3688a8dd7b7b16bf79a3f1949e52b11b87331553d94189ad070297f042433
+  data.tar.gz: e07d362391db192f46557c5c2ce5328c770f9a1a442781aa8ccae2e29979cdbf
 SHA512:
-  metadata.gz: de1851cdd5e43008141669e83f67d7d9a288c50831534e27091f9c05263eba54388601cb14ba842abd863610603d2e56388d0785150f24e93dbb11f322de221e
-  data.tar.gz: 736c27a6b843706b1aef4cfeeb06ebb6e982db39f35cbb4c977abe7aea4fbe4721601e49014a5b50143450b8df98e2ec15fca38791509ac4f8a91de7f5317013
+  metadata.gz: 2ae125a0a5c25cb46dfbfb2e54e086c061a28bce0bbda46b08fdcb073c612b84ee85a5461402a1fc6389583efc19f941640a48b05b2ef88632ed78a02744461b
+  data.tar.gz: 397b6f0b55bf1c340d88bcd93389179b87edd40c992ba56f474f3b3b470d805fa3ee0a95f724e80f9bbdb90ef164b1a629999173dd225dc15aef27fc779a1102

data/README.md

@@ -1,17 +1,11 @@
 # Sometimes
 
-[![Build Status](https://travis-ci.org/rubytune/sometimes.svg?branch=master)](https://travis-ci.org/rubytune/sometimes)
-
+[![Build Status](https://github.com/sudara/sometimes/workflows/rubyCI/badge.svg
+)](https://github.com/sudara/sometimes/actions)
 
 Stop being so black and white. Mix things up a bit and execute code *sometimes*.
 
-A (very) simple collection of lil' helpers polluting namespaces because...why the hell not?
-
-## Versions
-
-Works with ruby 2.2 and up as of version 0.0.3.
-
-Use version 0.0.2 if you want to support earlier rubies.
+A (very) simple collection of lil' helpers polluting Object namespaces since 2013 because...why the hell not?
 
 ## Installation
 
@@ -38,24 +32,29 @@ require 'sometimes'
 Say something every other time
 
 ```ruby
+# executes warm fuzzies 50% of the time
 sometimes do
-  puts "Hey, you are awesome. You really are."  # executes warm fuzzies 50% of the time
+  puts "Hey, you are awesome. You really are."
 end
 ```
 
+
 Maybe you want to do something several times, but not always the exact same number of times
 
 ```ruby
+# between 4 and 10 boogers made, it's unpredictable!
 (4..10).times do
-  pick_nose  # between 4 and 10 boogers made, it's unpredictable!
+  pick_nose
 end
 ```
 
+
 Maybe you want to remind someone of something, but not toooo often (It gets annoying!)
 
 ```ruby
+# be annoying, but only 15% of the time
 15.percent_of_the_time do
-  puts "Howdy, Don't forget to register!"  # be annoying, but only 15% of the time
+  puts "Howdy, Don't forget to register!"
 end
 
 33.percent_of_the_time do
@@ -66,8 +65,9 @@ end
 Share a rare moment with your user
 
 ```ruby
+# be really annoying about 5% of the time
 rarely do
-  puts "How would you like some spammy spam spam!"  # be really annoying about 5% of the time
+  puts "How would you like some spammy spam spam!"
 end
 
 1.percent_of_the_time do
@@ -90,12 +90,43 @@ always do
   puts "Thanks for sharing!"
 end
 ```
+
+### Otherwise
+
+Counting precisely is overrated.
+
+```ruby
+# Sometimes increment, sometimes don't
+i += sometimes(1)
+
+# 5% of the time add 10, otherwise increment
+i += rarely(10, otherwise:1)
+```
+
+Model real life state, like your calendar
+```ruby
+# 95% of the time you are in meetings
+status = mostly ? "busy" : "free"
+
+# same as above
+status = mostly("busy", otherwise: "free")
+
+```
+
 ## Why?
 
 This gem was made so [alonetone](http://github.com/sudara/alonetone) could bit more fun when displaying notices and communicating to our users.
 
 We are human, and have personality. Shouldn't our applications reflect this? Be predictable where it counts. But toss in some spice here and there — it is always a good thing.
 
+
+## Versions
+
+Works with ruby 2.7 and higher.
+
+Use version 1.0.0 to support ruby < 2.7
+Use version 0.0.2 to support ruby < 2.2
+
 ## Updating and Releasing this gem
 
 * Update lib/sometimes/version.rb

data/lib/sometimes.rb

@@ -1,6 +1,5 @@
 require "sometimes/version"
 
-# -*- encoding : utf-8 -*-
 # OH SO FUN HELPERS!
 
 # RANDOMLY EXECUTES A BLOCK X percent OF THE TIME
@@ -17,14 +16,45 @@ require "sometimes/version"
 #
 #
 # 40.percent_of_the_time do
+#   some_task
+# end
+#
+# 40.percent_of_the_time(true, otherwise: false)
+#
+# 40.percent_of_the_time ? something : something_else
 class Integer
-  def percent_of_the_time(&block)
+  def percent_of_the_time(*arg, otherwise: nil)
     return if self == 0
 
-    if self < 0 || self > 100
-      raise(ArgumentError, 'Integer should be between 0 and 100 to be used with the percent_of_the_time method')
+    raise(ArgumentError, 'Integer should be between 0 and 100 to be used
+      with the percent_of_the_time method') if self < 0 || self > 100
+
+    if Kernel.rand(1..100) <= self
+      if block_given?
+        yield
+      elsif arg.empty?
+        true
+      else
+        arg.first
+      end
+    else
+      format_otherwise(arg, otherwise)
+    end
+  end
+
+  protected
+
+  def format_otherwise(arg, otherwise)
+    return false if arg.empty?
+
+    if arg.first.is_a? Integer
+      otherwise.to_i
+    elsif arg.first.is_a? Float
+      otherwise.to_f
+    elsif arg.first.respond_to? :to_str
+      otherwise.to_s
     else
-      yield block if Kernel.rand(1..100) <= self
+      otherwise
     end
   end
 end
@@ -39,20 +69,20 @@ end
 # half_the_time do
 # sometimes do
 class Object
-  def half_the_time(&block)
-    50.percent_of_the_time(&block)
+  def half_the_time(...)
+    50.percent_of_the_time(...)
   end
   alias sometimes half_the_time
 
-  def rarely(&block)
-    5.percent_of_the_time(&block)
+  def rarely(...)
+    5.percent_of_the_time(...)
   end
 
-  def mostly(&block)
-    95.percent_of_the_time(&block)
+  def mostly(...)
+    95.percent_of_the_time(...)
   end
 
-  def never(&block); end
+  def never(...); end
 
   def always
     yield

data/lib/sometimes/version.rb

@@ -1,3 +1,3 @@
 module Sometimes
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/sometimes.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sometimes/version'

data/test/test_otherwise.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+require 'sometimes'
+
+class OtherwiseTest < Test::Unit::TestCase
+  def test_percent_with_implicit_integer_otherwise
+    i = 0
+    100000.times do
+      i += 50.percent_of_the_time(1)
+    end
+    assert_in_delta(i, 50000, 500)
+  end
+
+  def test_sometimes_with_implicit_integer_otherwise
+    i = 0
+    100000.times do
+      i += sometimes(1)
+    end
+    assert_in_delta(i, 50000, 500)
+  end
+
+  def test_percent_with_explicit_integer_otherwise
+    i = 0
+    100000.times do
+      i += 50.percent_of_the_time(1, otherwise: 1)
+    end
+    assert_equal i, 100000
+  end
+
+  def test_percent_with_explicit_integer_otherwise_2
+    options = []
+    10.times do
+      options << 50.percent_of_the_time(1, otherwise: 2)
+    end
+    assert_equal options.uniq.sort, [1, 2]
+  end
+
+  def test_percent_with_implicit_string_otherwise
+    options = []
+    10.times do
+      options << 50.percent_of_the_time("1")
+    end
+    assert_equal options.uniq.sort, ["", "1"]
+  end
+
+  def test_percent_with_explicit_string_otherwise
+    options = []
+    10.times do
+      options << 50.percent_of_the_time("1", otherwise: "2")
+    end
+    assert_equal options.uniq.sort, ["1", "2"]
+  end
+
+  def test_percent_with_implicit_boolean_otherwise
+    options = []
+    10.times do
+      options << 50.percent_of_the_time
+    end
+
+    assert_equal options.uniq - [true], [false]
+
+    # only contains true and false values
+    assert options.uniq.difference([true, false]).empty?
+  end
+
+  def test_sometimes_with_implicit_boolean
+    i = 0
+    100000.times do
+      i += sometimes ? 1 : 0
+    end
+    assert_in_delta(i, 50000, 500)
+  end
+end

data/test/test_percent_of_the_time.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'sometimes'
+
+class PercentOfTheTimeTest < Test::Unit::TestCase
+  def test_percent
+    i = 0
+    100000.times do
+      75.percent_of_the_time do
+        i += 1
+      end
+    end
+    assert i > 73000
+    assert i < 76000
+  end
+
+  def test_99
+    i = 0
+    100000.times do
+      99.percent_of_the_time do
+        i += 1
+      end
+    end
+    assert i > 97000
+  end
+
+  def test_1
+    i = 0
+    100000.times do
+      1.percent_of_the_time do
+        i += 1
+      end
+    end
+    assert i < 1100
+  end
+
+  def test_0
+    bool = true
+    100000.times do
+      0.percent_of_the_time do
+        bool = false
+      end
+    end
+    assert_equal true, bool
+  end
+end

data/test/test_sometimes.rb

@@ -1,16 +1,14 @@
 require 'test/unit'
 require 'sometimes'
-require 'helper'
 
 class SometimesTest < Test::Unit::TestCase
-  def test_sometimes
+  def test_sometimes_with_block
     i = 0
     100000.times do
       sometimes do
         i += 1
       end
     end
-    puts i
     assert (i < 51000) && (i > 49000)
   end
 
@@ -21,17 +19,6 @@ class SometimesTest < Test::Unit::TestCase
     assert i < 51
   end
 
-  def test_percent
-    i = 0
-    100000.times do
-      75.percent_of_the_time do
-        i += 1
-      end
-    end
-    assert i > 73000
-    assert i < 76000
-  end
-
   def test_rarely
     i = 0
     100000.times do
@@ -52,36 +39,6 @@ class SometimesTest < Test::Unit::TestCase
     assert i > 90000
   end
 
-  def test_99
-    i = 0
-    100000.times do
-      99.percent_of_the_time do
-        i += 1
-      end
-    end
-    assert i > 97000
-  end
-
-  def test_1
-    i = 0
-    100000.times do
-      1.percent_of_the_time do
-        i += 1
-      end
-    end
-    assert i < 1100
-  end
-
-  def test_0
-    bool = true
-    100000.times do
-      0.percent_of_the_time do
-        bool = false
-      end
-    end
-    assert_equal true, bool
-  end
-
   def test_never
     bool = true
     never do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sometimes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sudara
@@ -55,6 +55,8 @@ files:
 - lib/sometimes/version.rb
 - sometimes.gemspec
 - test/helper.rb
+- test/test_otherwise.rb
+- test/test_percent_of_the_time.rb
 - test/test_sometimes.rb
 homepage: ''
 licenses: []
@@ -80,4 +82,6 @@ specification_version: 4
 summary: Be random. Be unpredictable. But only sometimes
 test_files:
 - test/helper.rb
+- test/test_otherwise.rb
+- test/test_percent_of_the_time.rb
 - test/test_sometimes.rb