splib 1.0 → 1.1

data/CHANGELOG

@@ -1,2 +1,6 @@
+1.1
+    * Added Splib.type_of? method to the Constants library
+    * Splib.find_const returns nil if constant not found
+    * Added Splib.find_const to the Constants library
 1.0
     * Initial release

data/README.rdoc

@@ -19,14 +19,114 @@ The Spox Library is collection of helper methods and classes.
 
 === 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.
+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.
+
+==== URL Shorteners
+
+Access to a variety of URL shortening services
 
     require 'splib'
 
     Splib.load :UrlShorteners
-    puts Splib.tinyurl 'www.google.com'
+    puts Splib.tiny_url 'www.google.com'
+    puts Splib.trim_url 'www.google.com'
+    puts Splib.isgd_url 'www.google.com'
+    puts Splib.shortest_url 'www.google.com'
+
+    Results:
+
+    http://tinyurl.com/2ty
+    http://tr.im/Ig5f
+    http://is.gd/5wmJ1
+    http://tr.im/Ig5p
+
+==== Conversions
+
+Easy conversion for seconds and bytes to something more human readable
+
+    require 'splib'
+
+    Splib.load :Conversions
+    puts Splib.format_seconds 9999999
+    puts Splib.format_size 9999999999
+
+    Results:
+
+    3 months 3 weeks 1 day 17 hours 46 minutes 39 seconds
+    9.31 Gigabytes
+
+==== Exec
+
+Adding a bit of safety and ease of use to exec
+
+    require 'splib'
+
+    Splib.load :Exec
+    begin
+        Splib.exec('echo test', 10, 1)
+    rescue IOError
+        puts 'Exceeded allowed number of returned bytes'
+    end
+    begin
+        Splib.exec('while [ true ]; do true; done;', 1)
+    rescue Timeout::Error
+        puts 'Exceeded allowed running time'
+    end
+    puts Splib.exec('echo "hello world"')
+
+    Results:
+
+    Exceeded allowed number of returned bytes
+    Exceeded allowed running time
+    hello world
+
+==== Constants
+
+Find constants easily, especially within loaded modules
+
+    require 'splib'
+
+    Splib.load :Constants
+    mod = Module.new
+    mod.class_eval("
+        module Fu
+            class Bar
+            end
+        end"
+    )
+    p Splib.find_const('String')
+    p Splib.find_const('Fu::Bar', [mod])
+
+    Results:
+
+    String
+    #<Module:0x95f02a4>::Fu::Bar
+
+==== PriorityQueue
+
+Add some logic to item queueing
+
+    require 'splib'
+
+    Splib.load :PriorityQueue
+
+    queue = Splib::PriorityQueue.new{|s| s == :last }
+    queue.push(:last, 'last')
+    2.times{ queue.push(:slot1, 'test') }
+    2.times{ queue.push(:slot2, 'fubar') }
+    until(queue.empty?)
+        puts queue.pop
+    end
+
+    Results:
+
+    test
+    fubar
+    test
+    fubar
+    last
 
-    => "http://tinyurl.com/2ty"
+==== TODO: Write examples for CodeReloader and RandomIterator
 
 == Last remarks
 

data/lib/splib/Constants.rb

@@ -3,6 +3,7 @@ module Splib
     # things:: Array of Object/Module constants to look in
     # Finds a constant if it exists
     # Example:: Foo::Bar 
+    # Returns nil if nothing found
     def self.find_const(c, things=[])
         raise ArgumentError.new('Exepcting an array') unless things.is_a?(Array)
         const = nil
@@ -16,6 +17,28 @@ module Splib
             end
             break unless const.nil?
         end
-        const.nil? ? c : const
+        const
+    end
+
+    # a:: an object
+    # b:: constant or string
+    # Returns true of a is a type of b. b can be given as a String
+    # to allow for matching of types contained within a module or
+    # for types that may not be loaded
+    def self.type_of?(a, b)
+        case b
+        when String
+            if(a.class.to_s.slice(0) == '#')
+                name = a.class.to_s
+                return name.slice(name.index('::')+2, name.length) == b
+            else
+                const = self.find_const(b)
+                return const.nil? ? false : a.is_a?(const)
+            end
+        when Class
+            return a.is_a?(b)
+        else
+            raise ArgumentError.new('Comparision type must be a string or constant')
+        end
     end
 end

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.0'
+    s.version           = '1.1'
     s.summary           = 'Spox Library'
     s.platform          = Gem::Platform::RUBY
     s.files             = Dir['**/*']

data/tests/cases/Constants.rb

@@ -24,4 +24,20 @@ class ConstantsTest < Test::Unit::TestCase
         assert_equal(Foo::Bar::Fubar, Splib.find_const('Foo::Bar::Fubar'))
         assert_match(/<.+?>::Fu::Bar/, Splib.find_const('Fu::Bar', [mod]).to_s)
     end
+    def test_type_of?
+        mod = Module.new
+        mod.class_eval("
+            module Fu
+                class Bar
+                end
+            end"
+        )
+        assert(Splib.type_of?('test', 'String'))
+        assert(Splib.type_of?('test', String))
+        assert(Splib.type_of?('test', 'Object'))
+        assert(Splib.type_of?('test', Object))
+        fubar = Splib.find_const('Fu::Bar', [mod]).new
+        assert(Splib.type_of?(fubar, 'Fu::Bar'))
+        assert(Splib.type_of?(fubar, Object))
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: splib
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: "1.1"
 platform: ruby
 authors: 
 - spox
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-17 00:00:00 -08:00
+date: 2009-12-30 00:00:00 -08:00
 default_executable: 
 dependencies: []