rufus-scheduler 1.0.2 → 1.0.3

data/CHANGELOG.txt

@@ -2,6 +2,11 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 1.0.3    released 2008/02/29
+
+- todo  #18472 : added Rufus::to_time_string - s181
+
+
 == rufus-scheduler - 1.0.2    released 2008/01/26
 
 - patch #17505 : added params :first_at and :first_in for schedule_every()

data/CREDITS.txt

@@ -0,0 +1,8 @@
+
+= CREDITS.txt
+
+== Feedback
+
+* many people gave feedback previously, see
+  http://openwferu.rubyforge.org/svn/trunk/openwfe-ruby/CREDITS.txt
+

data/README.txt

@@ -17,7 +17,22 @@ http://rubyforge.org/frs/?group_id=4812
 
 == usage
 
-See the Rufus::Scheduler class rdoc itself or the original OpenWFEru scheduler documentation at http://openwferu.rubyforge.org/scheduler.html
+For all the scheduling related information, see the Rufus::Scheduler class rdoc itself or the original OpenWFEru scheduler documentation at http://openwferu.rubyforge.org/scheduler.html
+
+Apart from scheduling, There are also two interesting methods in this gem, they are named parse_time_string and to_time_string :
+
+    require 'rubygems'
+    require 'rufus/otime' # gem 'rufus_scheduler'
+
+    Rufus.parse_time_string "500"        # => 0.5
+    Rufus.parse_time_string "1000"       # => 1.0
+    Rufus.parse_time_string "1h"         # => 3600.0
+    Rufus.parse_time_string "1h10s"      # => 3610.0
+    Rufus.parse_time_string "1w2d"       # => 777600.0
+
+    Rufus.to_time_string 60                   # => '1m'
+    Rufus.to_time_string 3661                 # => '1h1m1s'
+    Rufus.to_time_string 7 * 24 * 3600        # => '1w'
 
 
 == dependencies

data/lib/rufus/otime.rb

@@ -97,7 +97,9 @@ module Rufus
     end
 
     #
-    # turns a string like '1m10s' into a float like '70.0'
+    # Turns a string like '1m10s' into a float like '70.0', more formally,
+    # turns a time duration expressed as a string into a Float instance 
+    # (millisecond count).
     #
     # w -> week
     # d -> day
@@ -108,6 +110,14 @@ module Rufus
     # y -> year
     # 'nada' -> millisecond
     #
+    # Some examples :
+    #
+    #   Rufus.parse_time_string "500"        # => 0.5
+    #   Rufus.parse_time_string "1000"       # => 1.0
+    #   Rufus.parse_time_string "1h"         # => 3600.0
+    #   Rufus.parse_time_string "1h10s"      # => 3610.0
+    #   Rufus.parse_time_string "1w2d"       # => 777600.0
+    #
     def Rufus.parse_time_string (string)
 
         string = string.strip
@@ -226,6 +236,64 @@ module Rufus
         Time.send(method, d.year, d.month, d.day, d.hour, d.min, d.sec, usec)
     end
 
+    #
+    # Turns a number of seconds into a a time string
+    #
+    #     Rufus.to_time_string 0                    # => '0s'
+    #     Rufus.to_time_string 60                   # => '1m'
+    #     Rufus.to_time_string 3661                 # => '1h1m1s'
+    #     Rufus.to_time_string 7 * 24 * 3600        # => '1w'
+    #     Rufus.to_time_string 30 * 24 * 3600 + 1   # => "4w2d1s"
+    #
+    # It goes from seconds to the year. Months are not counted (as they
+    # are of variable length). Weeks are counted.
+    #
+    # For 30 days months to be counted, the second parameter of this
+    # method can be set to true.
+    #
+    #     Rufus.to_time_string 30 * 24 * 3600 + 1, true   # => "1M1s"
+    #
+    # If a Float value is passed, milliseconds will be displayed without
+    # 'marker'
+    #
+    #     Rufus.to_time_string 0.051                         #=>"51"
+    #     Rufus.to_time_string 7.051                         #=>"7s51"
+    #     Rufus.to_time_string 0.120 + 30 * 24 * 3600 + 1    #=>"4w2d1s120"
+    #
+    # (this behaviour mirrors the one found for parse_time_string()).
+    #
+    def Rufus.to_time_string (seconds, months=false)
+
+        return '0s' if seconds <= 0
+
+        ms = nil
+
+        if seconds.is_a?(Float)
+            ms = (seconds % 1 * 1000).to_i
+            seconds = seconds.to_i
+        end
+
+        durations = months ? DURATIONS2w : DURATIONS2
+
+        s = durations.inject([ seconds, "" ]) { |r, d|
+
+            #puts "result :   " + r.inspect
+            #puts "duration : " + d.inspect
+
+            sec, str = r
+            s, d = d
+
+            count = sec / d
+            rest = sec % d
+
+            str << "#{count}#{s}" if count > 0
+
+            [ rest, str ]
+        }[1]
+
+        "#{s}#{ms}"
+    end
+
     protected
 
         DURATIONS = {
@@ -238,5 +306,17 @@ module Rufus
             "s" => 1
         }
 
+        DURATIONS2w = [
+            [ "y", DURATIONS["y"] ],
+            [ "M", DURATIONS["M"] ],
+            [ "w", DURATIONS["w"] ],
+            [ "d", DURATIONS["d"] ],
+            [ "h", DURATIONS["h"] ],
+            [ "m", DURATIONS["m"] ],
+            [ "s", DURATIONS["s"] ]
+        ]
+        DURATIONS2 = DURATIONS2w.dup
+        DURATIONS2.delete_at 1
+
 end
 

data/test/scheduler_6_test.rb

@@ -0,0 +1,51 @@
+
+#
+# Testing the 'rufus-scheduler'
+#
+# John Mettraux at openwfe.org
+#
+# Thu Feb 14 08:19:10 JST 2008
+#
+
+require 'test/unit'
+require 'rufus/scheduler'
+
+
+class Scheduler6Test < Test::Unit::TestCase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    #
+    # just a small test
+    #
+    def test_0
+
+        s = Rufus::Scheduler.new
+        s.start
+
+        st = ""
+        s0 = -1
+        s1 = -2
+
+        t = Time.now + 2
+
+        s.schedule_at t do
+            st << "0"
+            s0 = Time.now.to_i % 60
+        end
+        s.schedule_at t do
+            st << "1"
+            s1 = Time.now.to_i % 60
+        end
+
+        sleep 2.5
+
+        assert_equal "01", st
+        assert_equal s0, s1
+    end
+end
+

data/test/test.rb

@@ -1,5 +1,6 @@
 
-require 'time_test'
+require 'time_0_test'
+require 'time_1_test'
 
 require 'scheduler_0_test'
 require 'scheduler_1_test'
@@ -7,6 +8,7 @@ require 'scheduler_2_test'
 require 'scheduler_3_test'
 require 'scheduler_4_test'
 require 'scheduler_5_test'
+require 'scheduler_6_test'
 
 require 'cron_test'
 require 'cronline_test'

data/test/{time_test.rb → time_0_test.rb}

@@ -12,10 +12,10 @@ require 'test/unit'
 require 'rufus/otime'
 
 #
-# testing otime and the scheduler
+# testing otime
 #
 
-class TimeTest < Test::Unit::TestCase
+class Time0Test < Test::Unit::TestCase
 
     #def setup
     #end
@@ -23,8 +23,7 @@ class TimeTest < Test::Unit::TestCase
     #def teardown
     #end
 
-    #def test_to_iso_date
-    def XXXX_to_iso_date
+    def _test_to_iso_date
         #
         # well... this test is not timezone friendly...
         # commented out thus...
@@ -34,17 +33,19 @@ class TimeTest < Test::Unit::TestCase
         s = Rufus.to_iso8601_date(t)
         puts s
 
-        assert \
-            Rufus.to_iso8601_date(t) == "2007-01-17 02:43:33-0500",
-            "conversion to iso8601 date failed"
+        assert_equal(
+            "2007-01-17 02:43:33-0500",
+            Rufus.to_iso8601_date(t),
+            "conversion to iso8601 date failed")
 
         d = Rufus.to_ruby_time(s)
 
         #puts d.to_s
 
-        assert \
-            d.to_s == "2007-01-17T02:43:33-0500",
-            "iso8601 date parsing failed"
+        assert_equal(
+            "2007-01-17T02:43:33-0500",
+            d.to_s,
+            "iso8601 date parsing failed")
     end
 
     def test_is_digit
@@ -66,19 +67,21 @@ class TimeTest < Test::Unit::TestCase
 
     def test_parse_time_string
 
-        pts("500", 0.5)
-        pts("1000", 1.0)
-        pts("1h", 3600.0)
-        pts("1h10s", 3610.0)
+        pts "500", 0.5
+        pts "1000", 1.0
+        pts "1h", 3600.0
+        pts "1h10s", 3610.0
+        pts "1w2d", 777600.0
     end
 
     protected
 
         def pts (time_string, seconds)
 
-            assert \
-                Rufus::parse_time_string(time_string) == seconds,
-                "'#{time_string}' did not map to #{seconds} seconds"
+            assert_equal(
+                seconds, 
+                Rufus::parse_time_string(time_string),
+                "'#{time_string}' did not map to #{seconds} seconds")
         end
 
 end

data/test/time_1_test.rb

@@ -0,0 +1,58 @@
+
+#
+# Testing OpenWFE
+#
+# John Mettraux at openwfe.org
+#
+# Fri Feb 29 11:18:48 JST 2008
+#
+
+require 'test/unit'
+
+require 'rufus/otime'
+
+#
+# testing otime
+#
+
+class Time1Test < Test::Unit::TestCase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    def test_0
+
+        tts 0, "0s"
+        tts 60, "1m"
+        tts 61, "1m1s"
+        tts 3661, "1h1m1s"
+        tts 24 * 3600, "1d"
+        tts 7 * 24 * 3600 + 1, "1w1s"
+        tts 30 * 24 * 3600 + 1, "4w2d1s"
+    end
+
+    def test_1
+
+        tts 30 * 24 * 3600 + 1, "1M1s", true
+    end
+
+    def test_2
+
+        tts 0.120 + 30 * 24 * 3600 + 1, "4w2d1s120"
+        tts 0.130, "130"
+    end
+
+    protected
+
+        def tts (seconds, time_string, months=false)
+
+            assert_equal(
+                time_string,
+                Rufus::to_time_string(seconds, months),
+                "#{seconds} seconds did not map to '#{time_string}'")
+        end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-scheduler
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-26 00:00:00 +09:00
+date: 2008-02-29 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - README.txt
 - CHANGELOG.txt
+- CREDITS.txt
 files: 
 - lib/openwfe
 - lib/openwfe/util
@@ -37,10 +38,13 @@ files:
 - test/scheduler_3_test.rb
 - test/scheduler_4_test.rb
 - test/scheduler_5_test.rb
+- test/scheduler_6_test.rb
 - test/test.rb
-- test/time_test.rb
+- test/time_0_test.rb
+- test/time_1_test.rb
 - README.txt
 - CHANGELOG.txt
+- CREDITS.txt
 has_rdoc: true
 homepage: http://openwferu.rubyforge.org/scheduler.html
 post_install_message: