splib 1.1 → 1.2

data/CHANGELOG

@@ -1,3 +1,12 @@
+1.2
+    * Added Array#fixed_flatten for pre 1.9 versions
+    * Remove IO.binread from CodeReloader for pre 1.9 versions
+    * Use array for Conversion information storage since we
+        only have Hash ordering in 1.9
+    * Use #chr for pre 1.9
+    * Make Splib.exec a wrapper for normal and threaded versions
+        Check platform and use threaded version when on java
+        automatically
 1.1
     * Added Splib.type_of? method to the Constants library
     * Splib.find_const returns nil if constant not found

data/README.rdoc

@@ -17,6 +17,15 @@ The Spox Library is collection of helper methods and classes.
 
 {rip}[http://hellorip.com/about.html] makes it easy to install directly from a github repository.
 
+=== Testing
+
+This library has been tested on:
+
+* Ruby 1.8.6-p376
+* Ruby 1.8.7-p248
+* Ruby 1.9.1-p383
+* JRuby 1.4
+
 === Usage
 
 The Spox Library has various things located within it. The Splib#load method will allow you to load individual parts of the library, or the entire thing into your program. Lets take a quick look at some of the things available from this library.

data/lib/splib.rb

@@ -1,5 +1,6 @@
 module Splib
-    LIBS = [:CodeReloader,
+    LIBS = [:Array,
+            :CodeReloader,
             :Constants,
             :Conversions,
             :Exec,

data/lib/splib/Array.rb

@@ -0,0 +1,33 @@
+module Splib
+    # Only add this if we are in the 1.8 world and no one
+    # else has added it yet
+    if(Object::RUBY_VERSION < '1.9.0' && ![].respond_to?(:fixed_flatten))
+        class ::Array
+            # 1.9 compatible flatten method that allows
+            # a level parameter
+            def fixed_flatten(level = -1)
+                arr = self
+                case
+                when level < 0
+                    arr.flatten!
+                when level == 0
+                    self
+                when level > 0
+                    arr = []
+                    curr = self
+                    level.times do
+                        curr.each do |elm|
+                            if(elm.respond_to?(:to_ary))
+                                elm.each{|e| arr << e }
+                            else
+                                arr << elm
+                            end
+                        end
+                        curr = arr.dup
+                    end
+                end
+                arr
+            end
+        end
+    end
+end

data/lib/splib/CodeReloader.rb

@@ -1,4 +1,12 @@
 module Splib
+    # path:: path to file
+    # Read contents of file
+    def self.read_file(path)
+        file = File.open(path, 'rb')
+        cont = file.read
+        file.close
+        cont
+    end
     # path:: path to ruby file
     # type:: return constants only of given type
     # Find all constants in a given ruby file. Array of 
@@ -7,7 +15,7 @@ module Splib
         raise ArgumentError.new('Failed to locate plugin file') unless File.exists?(path)
         consts = []
         sandbox = Module.new
-        sandbox.module_eval(IO.binread(path))
+        sandbox.module_eval(self.read_file(path))
         sandbox.constants.each do |const|
             klass = sandbox.const_get(const)
             if(type.nil? || (type && klass < type))
@@ -27,7 +35,7 @@ module Splib
         else
             holder = self.create_holder(path)
         end
-        holder.module_eval(IO.binread(path))
+        holder.module_eval(self.read_file(path))
         holder
     end
 

data/lib/splib/Constants.rb

@@ -28,7 +28,7 @@ module Splib
     def self.type_of?(a, b)
         case b
         when String
-            if(a.class.to_s.slice(0) == '#')
+            if(a.class.to_s.slice(0).chr == '#')
                 name = a.class.to_s
                 return name.slice(name.index('::')+2, name.length) == b
             else

data/lib/splib/Conversions.rb

@@ -3,19 +3,21 @@ module Splib
     # Converts seconds into a human readable string (This is an estimate
     # and does not account for leaps)
     def self.format_seconds(secs)
-        arg = {:year => 31536000,
-                :month => 2678400,
-                :week => 604800,
-                :day => 86400,
-                :hour => 3600,
-                :minute => 60,
-                :second => 1}
+        arg = [{:year => 31536000},
+                {:month => 2678400},
+                {:week => 604800},
+                {:day => 86400},
+                {:hour => 3600},
+                {:minute => 60},
+                {:second => 1}]
         res = ''
-        arg.each_pair do |k,v|
-            z = (secs / v).to_i
-            next unless z > 0
-            res += " #{z} #{k}#{z == 1 ? '':'s'}"
-            secs = secs % v
+        arg.each do |val|
+            val.each_pair do |k,v|
+                z = (secs / v).to_i
+                next unless z > 0
+                res += " #{z} #{k}#{z == 1 ? '':'s'}"
+                secs = secs % v
+            end
         end
         res = '0 seconds' if res.empty?
         return res.strip

data/lib/splib/Exec.rb

@@ -1,35 +1,98 @@
 require 'timeout'
 
 module Splib
+
+    # command:: command string to execute
+    # timeout:: length of time to execute
+    # maxbytes:: maximum number return bytes allowed
+    # Execute system command. This is a wrapper method
+    # that will redirect to the proper command
+    def self.exec(*args)
+        if(RUBY_PLATFORM == 'java')
+            thread_exec(*args)
+        else
+            standard_exec(*args)
+        end
+    end
+    
     # command:: command to execute
     # timeout:: maximum number of seconds to run
     # maxbytes:: maximum number of result bytes to accept
     # Execute a system command (use with care)
-    def self.exec(command, timeout=10, maxbytes=500)
+    # This is the normal exec command that is used
+    def self.standard_exec(command, timeout=10, maxbytes=500)
+        timout = timeout.to_i
+        maxbytes = maxbytes.to_i
         output = []
         pro = nil
         begin
-            Timeout::timeout(timeout) do
+            if(timeout > 0)
+                Timeout::timeout(timeout) do
+                    pro = IO.popen(command)
+                    until(pro.closed? || pro.eof?)
+                        output << pro.getc.chr
+                        if(maxbytes > 0 && output.size > maxbytes)
+                            raise IOError.new("Maximum allowed output bytes exceeded. (#{maxbytes} bytes)")
+                        end
+                    end
+                end
+            else
                 pro = IO.popen(command)
                 until(pro.closed? || pro.eof?)
-                    if(RUBY_VERSION >= '1.9.0')
-                        output << pro.getc
-                    else
-                        output << pro.getc.chr
+                    output << pro.getc.chr
+                    if(maxbytes > 0 && output.size > maxbytes)
+                        raise IOError.new("Maximum allowed output bytes exceeded. (#{maxbytes} bytes)")
                     end
-                    raise IOError.new("Maximum allowed output bytes exceeded. (#{maxbytes} bytes)") unless output.size <= maxbytes
                 end
             end
             output = output.join('')
-        rescue Exception => boom
-            raise boom
         ensure
-            if(RUBY_PLATFORM == 'java')
-                Process.kill('KILL', pro.pid) unless pro.nil?
-            else
-                Process.kill('KILL', pro.pid) if Process.waitpid2(pro.pid, Process::WNOHANG).nil? # make sure the process is dead
-            end
+            Process.kill('KILL', pro.pid) if Process.waitpid2(pro.pid, Process::WNOHANG).nil? # make sure the process is dead
         end
         return output
     end
+    # Used for the thread_exec method to notify of completion
+    class Complete < StandardError
+    end
+
+    # command:: command to execute
+    # timeout:: maximum number of seconds to run
+    # maxbytes:: maximum number of result bytes to accept
+    # Execute a system command (use with care)
+    # This is the threaded exec command that is generally used
+    # with JRuby. The regular timeout does not work when executing
+    # a process, so we do it in a separate thread and sleep the main
+    # thread until the timeout is reached.
+    def self.thread_exec(command, timeout=10, maxbytes=500)
+        timeout = timeout.to_i
+        maxbytes = maxbytes.to_i
+        current = Thread.current
+        output = []
+        pro = nil
+        thread = Thread.new do
+            boom = Complete.new
+            begin
+                pro = IO.popen(command)
+                until(pro.closed? || pro.eof?)
+                    output << pro.getc.chr
+                    if(maxbytes > 0 && output.size > maxbytes)
+                        raise IOError.new("Maximum allowed output bytes exceeded. (#{maxbytes} bytes)")
+                    end
+                end
+            rescue Exception => boom
+                # just want it set
+            end
+            current.raise boom unless boom.is_a?(Timeout::Error)
+        end
+        begin
+            timeout > 0 ? sleep(timeout) : sleep
+            thread.raise Timeout::Error.new
+            raise Timeout::Error.new
+        rescue Complete
+            # do nothing
+        ensure
+            Process.kill('KILL', pro.pid) unless pro.nil?
+        end
+        output.join('')
+    end
 end

data/lib/splib/PriorityQueue.rb

@@ -1,3 +1,4 @@
+require 'thread'
 module Splib
     # Exception raised when queue is empty
     class EmptyQueue < Exception

data/splib.gemspec

@@ -2,7 +2,7 @@ spec = Gem::Specification.new do |s|
     s.name              = 'splib'
     s.author            = 'spox'
     s.email             = 'spox@modspox.com'
-    s.version           = '1.1'
+    s.version           = '1.2'
     s.summary           = 'Spox Library'
     s.platform          = Gem::Platform::RUBY
     s.files             = Dir['**/*']

data/tests/cases/Array.rb

@@ -0,0 +1,16 @@
+require 'splib'
+require 'test/unit'
+
+class ArrayTest < Test::Unit::TestCase
+    def setup
+        Splib.load :Array
+    end
+
+    def test_flatten_original
+        if([].respond_to?(:fixed_flatten))
+            arr = [1,2,[3,[4,5],6],7]
+            assert_equal(arr, arr.fixed_flatten(0))
+            assert_equal(arr.flatten, arr.fixed_flatten)
+        end
+    end
+end

data/tests/cases/Conversions.rb

@@ -7,47 +7,51 @@ class ConversionsTest < Test::Unit::TestCase
     end
 
     def test_format_seconds
-        inc = {:year => 60 * 60 * 24 * 365,
-               :month => 60 * 60 * 24 * 31,
-               :week => 60 * 60 * 24 * 7,
-               :day => 60 * 60 * 24,
-               :hour => 60 * 60,
-               :minute => 60,
-               :second => 1}
+        inc = [{:year => 60 * 60 * 24 * 365},
+               {:month => 60 * 60 * 24 * 31},
+               {:week => 60 * 60 * 24 * 7},
+               {:day => 60 * 60 * 24},
+               {:hour => 60 * 60},
+               {:minute => 60},
+               {:second => 1}]
         100.times do |i|
             time = rand(i)
             otime = time
             formatted = []
-            inc.each_pair do |name, value|
-                val = (time / value).to_i
-                if(val > 0)
-                    time = time - (val * value)
-                    formatted << "#{val} #{val == 1 ? name : "#{name}s"}"
+            inc.each do |v|
+                v.each_pair do |name, value|
+                    val = (time / value).to_i
+                    if(val > 0)
+                        time = time - (val * value)
+                        formatted << "#{val} #{val == 1 ? name : "#{name}s"}"
+                    end
                 end
             end
             formatted = formatted.empty? ? '0 seconds' : formatted.join(' ')
-            assert_equal(Splib.format_seconds(otime), formatted)
+            assert_equal(formatted, Splib.format_seconds(otime))
         end   
     end
 
     def test_format_size
-        inc = {"byte" => 1024**0,       # 1024^0
-               "Kilobyte" => 1024**1,   # 1024^1
-               "Megabyte" => 1024**2,   # 1024^2
-               "Gigabyte" => 1024**3,   # 1024^3
-               "Terabyte" => 1024**4,   # 1024^4
-               "Petabyte" => 1024**5,   # 1024^5
-               "Exabyte" => 1024**6,    # 1024^6
-               "Zettabyte" => 1024**7,  # 1024^7
-               "Yottabyte" => 1024**8   # 1024^8
-               }
+        inc = [{"byte" => 1024**0},       # 1024^0
+               {"Kilobyte" => 1024**1},   # 1024^1
+               {"Megabyte" => 1024**2},   # 1024^2
+               {"Gigabyte" => 1024**3},   # 1024^3
+               {"Terabyte" => 1024**4},   # 1024^4
+               {"Petabyte" => 1024**5},   # 1024^5
+               {"Exabyte" => 1024**6},    # 1024^6
+               {"Zettabyte" => 1024**7},  # 1024^7
+               {"Yottabyte" => 1024**8}   # 1024^8
+               ]
         100.times do |i|
             val = i**rand(i)
             formatted = nil
-            inc.each_pair do |name, value|
-                v = val / value.to_f
-                if(v.to_i > 0)
-                    formatted = ("%.2f " % v) + " #{name}#{v == 1 ? '' : 's'}".strip
+            inc.each do |v|
+                v.each_pair do |name, value|
+                    v = val / value.to_f
+                    if(v.to_i > 0)
+                        formatted = ("%.2f " % v) + " #{name}#{v == 1 ? '' : 's'}".strip
+                    end
                 end
             end
             formatted = '0 bytes' if formatted.nil?

data/tests/cases/Exec.rb

@@ -5,7 +5,7 @@ class ExecTest < Test::Unit::TestCase
     def setup
         Splib.load :Exec
     end
-    
+
     def test_exec
         assert_raise(IOError) do
             Splib.exec('echo test', 10, 1)

data/tests/run_tests.rb

@@ -1,3 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path("#{__FILE__}/../../lib"))
+
 require 'test/unit'
 require 'splib'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: splib
 version: !ruby/object:Gem::Version 
-  version: "1.1"
+  version: "1.2"
 platform: ruby
 authors: 
 - spox
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-30 00:00:00 -08:00
+date: 2010-01-10 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - README.rdoc
 - CHANGELOG
 files: 
+- tests/cases/Array.rb
 - tests/cases/PriorityQueue.rb
 - tests/cases/UrlShorteners.rb
 - tests/cases/Exec.rb
@@ -34,6 +35,7 @@ files:
 - tests/samplecode2.rb
 - tests/samplecode1.rb
 - lib/splib.rb
+- lib/splib/Array.rb
 - lib/splib/PriorityQueue.rb
 - lib/splib/UrlShorteners.rb
 - lib/splib/Exec.rb