safe-me 0.9.0 → 0.9.1

data/README.rdoc

@@ -40,7 +40,7 @@ The DSL ist very simple. Let me explain on an example:
     end  
   end
   
-For now there are 4 kinds of possible argument types.
+For now there are 5 kinds of possible argument types.
 
 - Classes
 
@@ -52,18 +52,21 @@ Hash: for hashes you can pass Hash.ofType(Class, Class) where the first class is
 
 - Nilable
 
-If you also want to be able to pass nil to a method, if the argument is optional for example, you can pass nilable(Class) as type
+If you also want to be able to pass nil to a method, if the argument is optional for example, you can pass nilable(Class) as type.
 
 - RespondsTo
 
-If you only want to be sure, that an argument responds to some methods you can pass responds_to(*methods) where *methods should be the method names as symbols
+If you only want to be sure, that an argument responds to some methods you can pass responds_to(*methods) where *methods should be the method names as symbols.
 
 
 - QuacksLike
 
 If you need the same responds_to on multiple methods it can be useful to create a clean room class, that contains those methods and call quacks_like(Class) instead.
-quacks_like ensures, that every public instance method of this class is also available on the object, that gets passed to the method
+quacks_like ensures, that every public instance method of this class is also available on the object, that gets passed to the method.
 
+- Unchecked
+
+If you have methods where some arguments should not be checked for their type, you can pass unchecked as type.
 
 == License:
 

data/lib/extensions/class.rb

@@ -1,4 +1,4 @@
-class Class
+Class.class_eval do
   def type_of? obj
     obj.kind_of? self
   end

data/lib/extensions/module.rb

@@ -1,6 +1,6 @@
 require 'safe-me/var_args'
 
-class Module
+Module.class_eval do
   attr_accessor :method_types
   def safe_method(name, safer)
     alias_method "__typeunsafe_#{name}__", name

data/lib/safe-me.rb

@@ -16,7 +16,7 @@ end
 
 module SafeMe
   def self.init
-    Dir.glob("safe/*_safe.rb").each do |f|
+    Dir.glob("safe/**/*_safe.rb").each do |f|
       SafeLoader.instance_eval File.read(f)
     end
   end

data/lib/safe-me/type_safer.rb

@@ -1,6 +1,7 @@
 require 'safe-me/duck_type'
 require 'safe-me/nilable_type'
 require 'safe-me/responds_to'
+require 'safe-me/unchecked_type'
 
 module SafeMe
   class TypeSafer
@@ -35,6 +36,10 @@ module SafeMe
     def responds_to *methods
       RespondsTo.new *methods
     end
+    
+    def unchecked
+      UncheckedType.instance
+    end
   
     private :quacks_like, :argument
   end

data/lib/safe-me/unchecked_type.rb

@@ -0,0 +1,15 @@
+require 'singleton'
+
+module SafeMe
+  class UncheckedType
+    include Singleton
+    
+    def type_of? obj
+      true
+    end
+
+    def to_s
+      "unchecked"
+    end
+  end
+end

data/lib/safe-me/version.rb

@@ -1,6 +1,6 @@
 module SafeMe
   unless defined?(SafeMe::VERSION)
-    VERSION       = '0.9.0'
+    VERSION       = '0.9.1'
     LIBDIR        = File.expand_path(File.dirname(__FILE__) + '/../../lib')
   end
 end

data/safe/{Foo_safe.rb → foo_safe.rb}

@@ -1,4 +1,5 @@
-require 'spec/classes/foo'
+require File.expand_path(File.dirname(__FILE__)) + '/spec/classes/foo'
+
 
 safe Foo do
   for_method :a_method do
@@ -17,4 +18,9 @@ safe Foo do
   for_method :baz do
     argument responds_to :bar
   end
+  
+  for_method :unchecked_method do
+    argument Integer
+    argument unchecked
+  end
 end

data/spec/classes/{Foo.rb → foo.rb}

@@ -14,4 +14,8 @@ class Foo
   def baz a
     "#{a} should respond to :bar"
   end
+  
+  def unchecked_method a,b
+    "#{b} should be unchecked"
+  end
 end

data/spec/extensions/array_spec.rb

@@ -0,0 +1,21 @@
+require 'safe-me'
+
+describe Array do
+  describe "an array filled with integers" do
+    it "should be kind_of? Array.ofType(Integer)" do
+      [1,2,3].kind_of?(Array.ofType(Integer)).should be_true
+    end
+  end
+  
+  describe "an array filled with string" do
+    it "should not be kind_of? Array.ofType(Integer)" do
+      ["a", "b", "c"].kind_of?(Array.ofType(Integer)).should be_false
+    end
+  end
+  
+  describe "an array filled with objects of different types" do
+    it "should not be kind_of? Array.ofType(Integer)" do
+      [1,2,"a"].kind_of?(Array.ofType(Integer)).should be_false
+    end
+  end
+end

data/spec/extensions/hash_spec.rb

@@ -0,0 +1,21 @@
+require 'safe-me'
+
+describe Hash do
+  describe "a hash filled with keys of String and objects of type Integer" do
+    it "should be kind_of? Hash.ofType(String, Integer)" do
+      {"a" => 1, "b" => 2, "c" => 3}.kind_of?(Hash.ofType(String, Integer)).should be_true
+    end
+  end
+  
+  describe "a hash filled with keys of String and objects of type String" do
+    it "should not be kind_of? Hash.ofType(String, Integer)" do
+      {"a" => "1", "b" => "2", "c" => "3"}.kind_of?(Hash.ofType(String, Integer)).should be_false
+    end
+  end
+  
+  describe "a hash filled with keys and objects of different types" do
+    it "should not be kind_of? Hash.ofType(String, Integer)" do
+      {"a" => 1, "b" => 2, 3 => "3"}.kind_of?(Hash.ofType(String, Integer)).should be_false
+    end
+  end
+end

data/spec/safe-me/safe-me_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/classes/foo'
+require File.join(File.expand_path(File.dirname(__FILE__)), '../classes/foo')
 require 'safe-me'
 
 SafeMe.init
@@ -35,5 +35,14 @@ describe SafeMe do
         lambda{Foo.new.baz 1}.should raise_error(ArgumentError, "for argument 1 expected type RespondsTo(bar)")
       end
     end
+    
+    describe "a method with an argument that should be unchecked" do
+      it "should allow arguments of any type for that argument" do
+        lambda{Foo.new.unchecked_method 1, "a"}.should_not raise_error(ArgumentError)
+        lambda{Foo.new.unchecked_method 1, 1}.should_not raise_error(ArgumentError)
+        lambda{Foo.new.unchecked_method 1, nil}.should_not raise_error(ArgumentError)
+        lambda{Foo.new.unchecked_method 1, [1,2,3,"a"]}.should_not raise_error(ArgumentError)
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: safe-me
 version: !ruby/object:Gem::Version 
-  hash: 59
   prerelease: false
   segments: 
   - 0
   - 9
-  - 0
-  version: 0.9.0
+  - 1
+  version: 0.9.1
 platform: ruby
 authors: 
 - Dario Rexin
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-22 00:00:00 +02:00
+date: 2010-10-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -54,12 +52,15 @@ files:
 - lib/safe-me/responds_to.rb
 - lib/safe-me/safe_loader.rb
 - lib/safe-me/type_safer.rb
+- lib/safe-me/unchecked_type.rb
 - lib/safe-me/var_args.rb
 - lib/safe-me/version.rb
 - lib/safe-me.rb
-- spec/classes/Foo.rb
+- spec/classes/foo.rb
+- spec/extensions/array_spec.rb
+- spec/extensions/hash_spec.rb
 - spec/safe-me/safe-me_spec.rb
-- safe/Foo_safe.rb
+- safe/foo_safe.rb
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/drexin/safe-me
@@ -75,7 +76,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -84,7 +84,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"