typestrict 0.0.6 → 0.0.8

data/History.txt

@@ -1,5 +1,17 @@
+=== 0.0.8 / 2010-08-08
+* 1 major enhancement
+
+  * Updated manifest + version bump
+
+=== 0.0.7 / 2010-08-08
+* 2 major enhancements
+
+  * Revamped implementation and architecture
+  * Supertypes are now implemented using dynamic handlers + dynamic handlers
+
+
 === 0.0.5 / 2010-08-07
-* 2 major enhancement
+* 2 major enhancements
 
   * Added :procedure supertype
   * Added :character supertype

data/Manifest.txt

@@ -5,4 +5,6 @@ README.txt
 Rakefile
 bin/typestrict
 lib/typestrict.rb
+lib/base.rb
+lib/supertypes.rb
 test/test_strict.rb

data/README

@@ -105,9 +105,3 @@ valid_data = {
   }
 
 validate_map!(type_matrix, invalid_data) # => all checks pass
-
-TODO
-----
-Implement generic handler for super-types
-Performance analysis
-Implement low-level?

data/lib/base.rb

@@ -0,0 +1,149 @@
+module Strict
+  module Base
+    
+    class StrictTypeError < Exception
+      attr :errors
+      def initialize(error_list)
+        enforce_primitive!(Array, error_list, "lib/typestrict")
+        error_list.each {|item| enforce_primitive!(String, item, "lib/typestrict")}
+        @errors = error_list
+      end
+
+      def inspect
+        msg = "StrictTypeError#{@errors.size > 1 ? "s" : ""} caught:\n"
+        @errors.each do |e|
+          msg += "#{e}\n"
+        end
+        return msg
+      end
+    end
+    @@errors = []
+    @@raise_exception = true
+    @@dynamic_handlers = {}
+
+    def setmode_raise!
+      @@errors = []
+      @@raise_exception = true
+    end
+
+    def setmode_catch!
+      @@errors = []
+      @@raise_exception = false
+    end
+
+    def catch_error error
+      if @@raise_exception
+        t = StrictTypeError.new([error])
+        raise(t, t.inspect, caller)
+      else
+        @@errors << error
+      end
+    end
+
+    def raise_hell!
+      if @@errors.size > 0
+        t = StrictTypeError.new(@@errors)
+        setmode_raise!
+        raise(t, t.inspect, caller)
+      end
+    end
+
+    def register_supertype(supertype, handler, verbose=true)
+      enforce_primitive!(Symbol, supertype, "typestrict/register_supertype")
+      enforce_primitive!(Proc, handler, "typestrict/register_supertype")
+
+      @@dynamic_handlers[supertype] = handler
+      puts "registered a handler for supertype: #{supertype}" if verbose
+    end
+
+    def header(context, data)
+      "#{context}; #{data.class.inspect}::#{data.inspect}"
+    end
+
+    def enforce_primitive!(type, data, context="Value")
+      catch_error "#{header(context, data)} must be of type #{type}" unless (data.is_a? type and type.is_a? Class)
+      return data
+    end
+
+    def enforce_strict_primitives!(types, data, context="Value")
+      enforce_primitive!(Array, types, 'lib/typestrict')
+      types.each {|type| enforce_primitive!(Object, type, 'lib/typestrict')}
+      types.each do |type|
+        enforce_primitive!(type, data, context)
+      end
+      return data
+    end
+
+    def enforce_weak_primitives!(types, data, context="Value")
+      enforce_primitive!(Array, types, 'lib/typestrict')
+      types.each {|type| enforce_primitive!(Object, type, 'lib/typestrict')}
+
+      raise_set_before = @@raise_exception
+      previous_errors = @@errors
+      setmode_catch!
+
+      match_found = false
+      types.each do |type|
+        begin
+          s = @@errors.size
+          enforce_primitive!(type, data, context)
+          match_found = true unless @@errors.size > s
+        rescue
+          next
+        end
+      end
+
+      @@errors = previous_errors
+
+      catch_error "#{header(context, data)} must be of one of the types of #{types.inspect}" unless match_found
+
+      if raise_set_before
+        raise_hell! unless match_found
+        setmode_raise!
+      end
+
+      return data
+    end
+
+    def enforce_non_nil!(obj, context="Value")
+      catch_error "#{context}: Object is nil!" if obj.nil?
+      return obj
+    end
+
+    def enforce!(supertype, data, context="Value")
+      enforce_non_nil!(data, context)
+      
+      if supertype.is_a? Array #enumeration of values
+        catch_error "#{header(context, data)} should take on a value within #{supertype.inspect}" unless supertype.include? data
+
+      else
+        if supertype.is_a? Symbol #distinct supertype
+          if @@dynamic_handlers.has_key? supertype
+            @@dynamic_handlers[supertype].call(data, context)
+          else
+            catch_error "undefined symbol-supertype encountered: #{supertype.inspect}"
+          end
+        end
+      end
+      return data
+    end
+
+    def enforce_map!(matrix, map)
+      enforce_primitive!(Hash, matrix, "lib/typestrict")
+      enforce_primitive!(Hash, map, "lib/typestrict")
+
+      setmode_catch!
+
+      matrix.each do |param, type|
+        if map.has_key? param
+          enforce!(type, map[param], "map[#{param.inspect}]")
+        else
+          catch_error "map: missing required param: #{param.inspect}"
+        end
+      end
+      raise_hell!
+      setmode_raise!
+      return map
+    end
+  end
+end

data/lib/supertypes.rb

@@ -0,0 +1,85 @@
+module Strict
+  module SuperTypes
+
+    @@handlers = {}
+    @@called = false
+
+    def registered?(supertype)
+      enforce_primitive!(Symbol, supertype)
+      Strict::Base.has_key? supertype
+    end
+
+    def register_default_supertypes! #must be called from an env including Base
+      if @@called
+        return
+      else
+        @@called = true
+      end
+
+      @@handlers[:string] = proc do |data, context|
+        enforce_primitive!(String, data, context)
+        catch_error "#{header(context, data)} can't be empty string" unless (data.size > 0)
+      end
+
+      @@handlers[:natural_number] = proc do |data, context|
+        enforce_primitive!(Fixnum, data, context)
+        catch_error "#{header(context, data)} must be > 0" unless (data > 0)
+      end
+
+      @@handlers[:integer] = proc do |data, context|
+        enforce_primitive!(Fixnum, data, context)
+      end
+
+      @@handlers[:numeric] = proc do |data, context|
+        enforce_primitive!(Numeric, data, context)
+      end
+
+      @@handlers[:boolean] = proc do |data, context|
+        enforce_weak_primitives!([TrueClass, FalseClass], data, context)
+      end
+
+      @@handlers[:float] = proc do |data, context|
+        enforce_primitive!(Float, data, context)
+      end
+
+      @@handlers[:character] = proc do |data, context|
+        enforce!(:string, data, context)
+        catch_error "#{header(context, data)} must be a single character!" unless data.size == 1
+      end
+
+      @@handlers[:procedure] = proc do |data, context|
+        enforce_primitive!(Proc, data, context)
+      end
+
+      @@handlers[:string_array] = proc do |data, context|
+        enforce_primitive!(Array, data, context)
+        data.each {|item| enforce_primitive!(String, item, context)}
+      end
+
+      @@handlers[:numeric_array] = proc do |data, context|
+        enforce_primitive!(Array, data, context)
+        data.each {|item| enforce_primitive!(Numeric, item, context)}
+      end
+
+      @@handlers[:float_array] = proc do |data, context|
+        enforce_primitive!(Array, data, context)
+        data.each {|item| enforce_primitive!(Float, item, context)}
+      end
+
+      @@handlers[ :integer_array] = proc do |data, context|
+        enforce_primitive!(Array, data, context)
+        data.each {|item| enforce_primitive!(Fixnum, item, context)}
+      end
+
+      @@handlers[:hex_color] = proc do |data, context|
+        enforce!(:string, data, context)
+        catch_error "#{header(context, data)} must be six characters long" unless (data.size == 6)
+        data.upcase.each_byte {|c| catch_error "#{header(context, data)} must contain only hexadecimal characters" unless ((48 <= c  and c <= 57) or (65 <= c and c <= 70))}
+      end
+
+      @@handlers.each do |supertype, handler|
+        Base::register_supertype(supertype, handler, false) #verbose set to false
+      end
+    end
+  end
+end

data/lib/typestrict.rb

@@ -1,185 +1,11 @@
-module Strict
-  VERSION = '0.0.6'
-  
-  class TypeError < Exception
-    attr :errors
-    def initialize(error_list)
-      enforce!(:string_array, error_list, 'lib/typestrict')
-      @errors = error_list
-    end
-
-    def inspect
-      msg = "TypeError#{@errors.size > 1 ? "s" : ""} caught:\n"
-      @errors.each do |e|
-        msg += "#{e}\n"
-      end
-      return msg
-    end
-  end
-
-  @@errors = []
-  @@raise_exception = true
-  @@dynamic_handlers = {}
-
-  def setmode_raise!
-    @@errors = []
-    @@raise_exception = true
-  end
-
-  def setmode_catch!
-    @@errors = [] unless @@errors.is_a? Array
-    @@raise_exception = false
-  end
-
-  def catch_error error
-    @@errors << error
-    t = TypeError.new([error])
-    raise(t, t.inspect, caller) if @@raise_exception
-  end
-
-  def raise_hell!
-    t = TypeError.new(@@errors)
-    raise(t, t.inspect, caller) if @@errors.size > 0
-  end
-
-  def register_supertype(supertype, handler)
-    enforce_primitive!(Symbol, supertype, "typestrict/register_supertype")
-    enforce_primitive!(Proc, handler, "typestrict/register_supertype")
-
-    @@dynamic_handlers[supertype] = handler
-    puts "registered a dynamic handler for supertype: #{supertype}"
-  end
-
-  def header(context, data)
-    "#{context}; #{data.class.inspect}::#{data.inspect}"
-  end
-
-  def enforce_primitive!(type, data, context="Value")
-    catch_error "#{header(context, data)} must be of type #{type}" unless (data.is_a? type and type.is_a? Class)
-    return data
-  end
-
-  def enforce_strict_primitives!(types, data, context="Value")
-    enforce_primitive!(Array, types, 'lib/typestrict')
-    types.each {|type| enforce_primitive!(Object, type, 'lib/typestrict')}
-    types.each do |type|
-      enforce_primitive!(type, data, context)
-    end
-    return data
-  end
-
-  def enforce_weak_primitives!(types, data, context="Value")
-    enforce_primitive!(Array, types, 'lib/typestrict')
-    types.each {|type| enforce_primitive!(Object, type, 'lib/typestrict')}
-
-    raise_set_before  = @@raise_exception
-    setmode_catch!
-
-    match_found = false
-    types.each do |type|
-      begin
-        s = @@errors.size
-        enforce_primitive!(type, data, context)
-        match_found = true unless s != @@errors.size
-      rescue
-        next
-      end
-    end
-
-    setmode_raise! if raise_set_before
-
-    catch_error "#{header(context, data)} must be of one of the types of #{types.inspect}" unless match_found
-    return data
-  end
-
-  def enforce_non_nil!(obj, context="Value")
-    catch_error "#{context}: Object is nil!" if obj.nil?
-    return obj
-  end
-
-  def enforce!(supertype, data, context="Value") #write a more generic handler, for new types?
-    enforce_non_nil!(data, context)
-    
-    if supertype.is_a? Array #enumeration of values
-      catch_error "#{header(context, data)} should take on a value within #{supertype.inspect}" unless supertype.include? data
+require File.join(File.dirname(__FILE__), 'base')
+require File.join(File.dirname(__FILE__), 'supertypes')
 
-    else if supertype.is_a? Symbol #distinct type
-      case supertype
-        when :string
-          enforce_primitive!(String, data, context)
-          catch_error "#{header(context, data)} can't be empty string" unless (data.size > 0)
-
-        when :natural_number
-          enforce_primitive!(Fixnum, data, context)
-          catch_error "#{header(context, data)} must be > 0" unless (data > 0)
-
-        when :integer
-          enforce_primitive!(Fixnum, data, context)
-
-        when :numeric
-          enforce_primitive!(Numeric, data, context)
-
-        when :boolean
-          enforce_weak_primitives!([TrueClass, FalseClass], data, context)
-
-        when :float
-          enforce_primitive!(Float, data, context)
-
-        when :character
-          enforce!(:string, data, context)
-          catch_error "#{header(context, data)} must be a single character!" unless data.size == 1
-
-        when :procedure
-          enforce_primitive!(Proc, data, context)
-
-        when :string_array
-          enforce_primitive!(Array, data, context)
-          data.each {|item| enforce_primitive!(String, item, context)}
-
-        when :numeric_array
-          enforce_primitive!(Array, data, context)
-          data.each {|item| enforce_primitive!(Numeric, item, context)}
-
-        when :float_array
-          enforce_primitive!(Array, data, context)
-          data.each {|item| enforce_primitive!(Float, item, context)}
-
-        when :integer_array
-          enforce_primitive!(Array, data, context)
-          data.each {|item| enforce_primitive!(Fixnum, item, context)}
-
-        when :hex_color
-          enforce!(:string, data, context)
-          catch_error "#{header(context, data)} must be six characters long" unless (data.size == 6)
-          data.upcase.each_byte {|c| catch_error "#{header(context, data)} must contain only hexadecimal characters" unless ((48 <= c  and c <= 57) or (65 <= c and c <= 70))}
-
-        else
-          if @@dynamic_handlers.has_key? supertype
-            @@dynamic_handlers[supertype].call(data, context="Value")
-          else
-            catch_error "undefined symbol-supertype encountered: #{supertype.inspect}"
-          end
-        end
-      end
-    end
-    return data
-  end
-
-  def enforce_map!(matrix, map)
-    enforce_primitive!(Hash, matrix, "lib/typestrict")
-    enforce_primitive!(Hash, map, "lib/typestrict")
-
-    setmode_catch!
-
-    matrix.each do |param, type|
-      if map.has_key? param
-        enforce!(type, map[param], "map[#{param.inspect}]")
-      else
-        catch_error "map: missing required param: #{param.inspect}"
-      end
-    end
-    raise_hell!
-    setmode_raise!
-    return map
-  end
+module Strict
+  VERSION = '0.0.8'
+  include Strict::Base
+  include Strict::SuperTypes
 end
+
+include Strict
+SuperTypes::register_default_supertypes!

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: typestrict
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Raeez Lorgat
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-07 00:00:00 -04:00
+date: 2010-08-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,8 @@ files:
 - Rakefile
 - bin/typestrict
 - lib/typestrict.rb
+- lib/base.rb
+- lib/supertypes.rb
 - test/test_strict.rb
 has_rdoc: true
 homepage: http://www.raeez.com/strict