stud 0.0.17 → 0.0.18

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d61ca01aaea7a1e6b562d7c03b50a2d0cf1379d
+  data.tar.gz: 55aeb2cdaa20574a2db50982c225129fb81b72ab
+SHA512:
+  metadata.gz: e2ec3dd44726a5c12f42199c2887fc9e644424c58733355447d095b684488d0974cca7e6d55e115e6c8b120324873acd548c559e34171189284cb4bb094e78ee
+  data.tar.gz: 481b4e4b1e75dd949c67fd2dbb3b2e883fae13d292a351a1da26f0c572c2d10189ee6921119c77a3dae0108b6fd7eaae74f266ed8ef1497a5754ca5e89251fe4

data/lib/stud/interval.rb

@@ -1,27 +1,38 @@
+require "stud/task"
 module Stud
   # This implementation tries to keep clock more accurately.
   # Prior implementations still permitted skew, where as this one
   # will attempt to correct for skew.
   #
-  # The execution patterns of this method should be that 
+  # The execution patterns of this method should be that
   # the start time of 'block.call' should always be at time T*interval
-  def self.interval(time, &block)
+  def self.interval(time, opts = {}, &block)
     start = Time.now
     while true
-      block.call
-      duration = Time.now - start
-      # Sleep only if the duration was less than the time interval
-      if duration < time
-        sleep(time - duration)
-        start += time
+      break if Task.interrupted?
+      if opts[:sleep_then_run]
+        start = sleep_for_interval(time, start)
+        block.call
       else
-        # Duration exceeded interval time, reset the clock and do not sleep.
-        start = Time.now
+        block.call
+        start = sleep_for_interval(time, start)
       end
     end # loop forever
   end # def interval
-  
-  def interval(time, &block)
-    return Stud.interval(time, &block)
+
+  def self.sleep_for_interval(time, start)
+    duration = Time.now - start
+    # Sleep only if the duration was less than the time interval
+    if duration < time
+      sleep(time - duration)
+      start += time
+    else
+      # Duration exceeded interval time, reset the clock and do not sleep.
+      start = Time.now
+    end
+  end
+
+  def interval(time, opts = {}, &block)
+    return Stud.interval(time, opts, &block)
   end # def interval
 end # module Stud

data/lib/stud/task.rb

@@ -28,5 +28,13 @@ module Stud
         return result
       end
     end # def wait
+
+    def stop!
+      Thread.current[:stud_task_interrupted] = true
+    end
+
+    def self.interrupted?
+      Thread.current[:stud_task_interrupted]
+    end
   end # class Task
 end # module Stud

data/lib/stud/temporary.rb

@@ -11,7 +11,7 @@ module Stud
     def pathname(prefix=DEFAULT_PREFIX)
 
       root = ENV["TMP"] || ENV["TMPDIR"] || ENV["TEMP"] || "/tmp"
-      return File.join(root, "#{prefix}-#{SecureRandom.uuid}")
+      return File.join(root, "#{prefix}-#{SecureRandom.hex(30)}")
     end
 
     # Return a File handle to a randomly-generated path.

data/lib/stud/trap.rb

@@ -52,6 +52,12 @@ module Stud
   # 'id' is the value returned by a previous Stud.trap() call
   def self.untrap(signal, id)
     @traps[signal].delete_if { |block| block.object_id == id }
+
+    # Restore the default handler if there are no custom traps anymore.
+    if @traps[signal].empty?
+      @traps.delete(signal)
+      Signal::trap(signal, "DEFAULT")
+    end
   end # def self.untrap
 end # module Stud
 

metadata

@@ -1,78 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: stud
 version: !ruby/object:Gem::Version
-  version: 0.0.17
-  prerelease: 
+  version: 0.0.18
 platform: ruby
 authors:
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: metriks
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: insist
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: small reusable bits of code I'm tired of writing over and over. A library
@@ -82,46 +45,40 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELIST
+- LICENSE
+- README.md
+- lib/stud/buffer.rb
+- lib/stud/interval.rb
+- lib/stud/pool.rb
 - lib/stud/secret.rb
-- lib/stud/with.rb
-- lib/stud/benchmark/rusage.rb
 - lib/stud/task.rb
-- lib/stud/pool.rb
-- lib/stud/buffer.rb
-- lib/stud/try.rb
-- lib/stud/time.rb
 - lib/stud/temporary.rb
-- lib/stud/benchmark.rb
 - lib/stud/trap.rb
-- lib/stud/interval.rb
-- lib/stud/time/format.rb
-- lib/stud/time/format.tt
-- LICENSE
-- CHANGELIST
-- README.md
+- lib/stud/try.rb
+- lib/stud/with.rb
 homepage: https://github.com/jordansissel/ruby-stud
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: stud - common code techniques
 test_files: []

data/lib/stud/benchmark.rb

@@ -1,132 +0,0 @@
-# encoding: UTF-8
-# Benchmark Use Cases
-#   * Compare performance of different implementations.
-#     * run each implementation N times, compare runtimes (histogram, etc)
-
-require "metriks"
-require "stud/benchmark/rusage"
-
-module Stud
-  module Benchmark
-    def self.run(iterations=1, &block)
-      timer = Metriks::Timer.new
-      start = Time.now
-      iterations.times { timer.time(&block) }
-      duration = Time.now - start
-      return Results.new(timer, duration)
-    end # def run
-
-    def self.runtimed(seconds=10, &block)
-      timer = Metriks::Timer.new
-      expiration = Time.now + seconds
-
-      start = Time.now
-      timer.time(&block) while Time.now < expiration
-      duration = Time.now - start
-      return Results.new(timer, duration)
-    end # def runtimed
-
-    def self.cputimed(seconds=10, &block)
-      timer = Metriks::Timer.new
-      expiration = Time.now + seconds
-      start_usage = Stud::Benchmark::RUsage.get
-      while Time.now < expiration
-        start = Stud::Benchmark::RUsage.get
-        block.call
-        finish = Stud::Benchmark::RUsage.get
-        cputime = (finish.user + finish.system) - (start.user + start.system)
-        timer.update(cputime)
-      end # while not expired
-      finish_usage = Stud::Benchmark::RUsage.get
-      duration = (finish_usage.user + finish_usage.system) \
-        - (start_usage.user + start_usage.system)
-      return Results.new(timer, duration)
-    end # self.cpu
-
-    class Results
-      include Enumerable
-      # Stolen from https://github.com/holman/spark/blob/master/spark
-      # TICKS = %w{▁ ▂ ▃ ▄ ▅ ▆ ▇ █}
-
-      TICKS = ["\x1b[38;5;#{232 + 8}m_\x1b[0m"] + %w{▁ ▂ ▃ ▄ ▅ ▆ ▇ █}
-
-      #.collect do |tick|
-        # 256 color support, use grayscale
-        #1.times.collect do |shade|
-          # '38' is foreground
-          # '48' is background
-          # Grey colors start at 232, but let's use the brighter half.
-          # escape [ 38 ; 5 ; <color>
-          #"\x1b[38;5;#{232 + 12 + 2 * shade}m#{tick}\x1b[0m"
-        #end
-        #tick
-      #end.flatten
-
-      def initialize(data, duration)
-        @data = data
-        @duration = duration
-      end # def initialize
-
-      def environment
-        # Older rubies don't have the RUBY_ENGINE defiend
-        engine = (RUBY_ENGINE rescue "ruby")
-        # Include jruby version in the engine
-        engine += (JRUBY_VERSION rescue "")
-        version = RUBY_VERSION
-
-        return "#{engine} #{version}"
-      end # def environment
-
-      def each(&block)
-        @data.snapshot.each(&block)
-      end # def each
-
-      def min
-        return @data.min
-      end
-
-      def max
-        return @data.max
-      end
-
-      def rate
-        return @data.count / @duration
-      end
-
-      def mean
-        return @data.mean
-      end # def mean
-
-      def stddev
-        # work around (Timer#stddev reports the variance)
-        # https://github.com/eric/metriks/pull/29
-        return @data.stddev ** 0.5
-      end # def stddev
-
-      def sum
-        return @data.instance_eval { @histogram.sum }
-      end # def sum
-
-      def pretty_print
-        puts self
-      end # def pretty_print
-
-      def to_s(scale=min .. max, ticks=10)
-        snapshot = @data.snapshot
-        values = snapshot.instance_eval { @values }
-        scale_distance = scale.end - scale.begin
-        tick = scale_distance / ticks
-        dist = ticks.to_i.times.collect do |i|
-          range = (scale.begin + tick * i) ... (scale.begin + tick * (i+1))
-          hits = values.select { |v| range.include?(v) }.count
-          percent = hits / values.size.to_f
-          next TICKS[(TICKS.count * percent).ceil] || TICKS.last
-        end
-
-        return sprintf("%20s %s (%.4f ... %.4f, mean: %0.4f, stddev: %0.4f)",
-                       environment, dist.join(""), scale.begin, scale.end,
-                       mean, stddev)
-      end # def to_s
-    end # class Stud::Benchmark::Result
-  end # module Benchmark
-end # module Stud

data/lib/stud/benchmark/rusage.rb

@@ -1,54 +0,0 @@
-require "ffi"
-
-module Stud
-  module Benchmark
-    module LibC
-      extend FFI::Library
-      ffi_lib "libc.so.6"
-
-      attach_function :getrusage, [:int, :pointer], :int
-    end
-
-    class TimeVal < FFI::Struct
-      layout :tv_sec, :long,
-             :tv_usec, :int32
-
-      def to_f
-        return self[:tv_sec] + (self[:tv_usec] / 1_000_000.0)
-      end
-    end
-
-    class RUsage < FFI::Struct
-      layout :utime, TimeVal,
-             :stime, TimeVal,
-             :maxrss, :long,
-             :ixrss, :long,
-             :idrss, :long,
-             :isrss, :long,
-             :minflt, :long,
-             :majflt, :long,
-             :nswap, :long,
-             :inblock, :long,
-             :oublock, :long,
-             :msgsnd, :long,
-             :msgrcv, :long,
-             :nsignals, :long,
-             :nvcsw, :long,
-             :nivcsw, :long
-
-      def self.get
-        usage = RUsage.new
-        LibC.getrusage(0, usage)
-        return usage
-      end
-
-      def user
-        return self[:utime].to_f
-      end
-
-      def system
-        return self[:stime].to_f
-      end
-    end # class RUsage
-  end # module Benchmark
-end # module Stud

data/lib/stud/time.rb

@@ -1,37 +0,0 @@
-module Stud
-  module Time
-    # The following table is copied from joda-time's docs
-    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html
-    # Symbol  Meaning                      Presentation  Examples
-    # ------  -------                      ------------  -------
-    # G       era                          text          AD
-    # C       century of era (>=0)         number        20
-    # Y       year of era (>=0)            year          1996
-
-    # x       weekyear                     year          1996
-    # w       week of weekyear             number        27
-    # e       day of week                  number        2
-    # E       day of week                  text          Tuesday; Tue
-
-    # y       year                         year          1996
-    # D       day of year                  number        189
-    # M       month of year                month         July; Jul; 07
-    # d       day of month                 number        10
-
-    # a       halfday of day               text          PM
-    # K       hour of halfday (0~11)       number        0
-    # h       clockhour of halfday (1~12)  number        12
-
-    # H       hour of day (0~23)           number        0
-    # k       clockhour of day (1~24)      number        24
-    # m       minute of hour               number        30
-    # s       second of minute             number        55
-    # S       fraction of second           number        978
-
-    # z       time zone                    text          Pacific Standard Time; PST
-    # Z       time zone offset/id          zone          -0800; -08:00; America/Los_Angeles
-
-    # '       escape for text              delimiter
-    # ''      single quote                 literal       '
-  end
-end