typesafe 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Till Salzer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= typesafe
+
+TypeSafe is a tiny extension to core Ruby to simplify checks for
+kind_of?.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Till Salzer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "typesafe"
+    gem.summary = %Q{provides Object#must_be_kind_of for typesafe development}
+    gem.description = %Q{Simplifies typesafe development by providing the additional
+      methods Object#must_by_kind_of ad Object#must_be_a.}
+    gem.email = "till.salzer@googlemail.com"
+    gem.homepage = "http://github.com/tsalzer/typesafe"
+    gem.authors = ["Till Salzer"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "cucumber"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "typesafe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'typesafe'
+
+require 'spec/expectations'

data/features/typesafe.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/typesafe.rb

@@ -0,0 +1,76 @@
+# additional features for all objects
+
+# TypeSafe module.
+# This module will be included into Object to provide Object#must_be_kind_of.
+#
+# Usage
+#
+# If you need e.g. an argument be of a specific type, you can simply write
+#
+#  def myfunc(arg)
+#    arg.must_be_kind_of(MyFancyClass)
+#    arg.do_fancy_stuff
+#  end
+#
+# This would raise a TypeError in case you somehow passed in a type not matching
+# your MyFancyClass, which would stop your app dead at a point you know. This is
+# probably better than chasing the wrong parameter all the way down your application.
+#
+# However, being dynamic, you might just need to apply a special treatment to your
+# argument in case it's not what you would expect:
+#
+#  def my2ndfunc(arg)
+#    puts arg.must_be_kind_of(String) {|x| x.to_s}
+#  end
+# 
+# In this second case, no exception is raised, but your block is executed. Most
+# important, the return value of your block is returned as value from the method.
+#
+module TypeSafe
+  # this class or object must be kind of a given class.
+  # Method returns <tt>self</tt> unless it raises a TypeError.
+  def must_be_kind_of(clss, &blk)
+    if clss.kind_of?(Class)
+      matched = if self.kind_of?(Class)
+        # classes are expected to "descend" from comparator
+        if self != clss
+          self.superclass ? self.superclass.must_be_kind_of(clss) : self.kind_of?(clss)
+        else
+          true
+        end
+      else
+        # objects are expected to implement comparator
+        self.kind_of?(clss)
+      end
+      
+      unless matched
+        if blk
+          return yield self.class
+        else
+          raise TypeError.new("#{self} must be of type #{clss}")
+        end
+      end
+    elsif clss.kind_of?(Module)
+      # check if the given module is included
+      unless self.included_modules.include?(clss)
+        if blk
+          return yield self.class
+        else
+          raise TypeError.new("#{self} does not include module #{clss}")
+        end
+      end
+    else
+      raise "class to check #{self} for must be a Class or Module, but is  #{clss}"
+    end
+    self
+  end
+  alias must_be_a must_be_kind_of
+
+  # this class or object must be kind of a given class or nil.
+  # This method is probably a bad idea, so it will be removed.
+  def must_be_nil_or_kind_of(clss, &blk)
+    self.kind_of?(NilClass) ? true : must_be_kind_of(clss, &blk)
+  end
+end#TypeSafe
+
+Object.send :include, TypeSafe

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'typesafe'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+# a class hierarchy to check
+
+# plain module
+module ModA
+  def moda_method ; end
+end
+# plain class
+class ClassA
+end
+# class derived from ClassA
+class ClassB < ClassA
+end
+# plain class, extends module ModA, thereby descending ModA
+class ClassC
+  extend ModA
+end
+# plain class, includes module ModA, thereby not descending ModA
+class ClassD
+  include ModA
+end
+

data/spec/typesafe_class_coreclasses_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TypeSafe, ".must_be_kind_of" do
+  it "should recognize Class as kind of Object" do
+    lambda{Class.must_be_kind_of(Object)}.should_not raise_error(TypeError)
+  end
+  it "should recognize Object as kind of Class" do
+    lambda{Object.must_be_kind_of(Class)}.should_not raise_error(TypeError)
+  end
+  it "should recognize Fixnum as kind of Integer" do
+    lambda{Fixnum.must_be_kind_of(Integer)}.should_not raise_error(TypeError)
+  end
+  it "should recognize Bignum as kind of Integer" do
+    lambda{Bignum.must_be_kind_of(Integer)}.should_not raise_error(TypeError)
+  end
+end

data/spec/typesafe_class_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TypeSafe, ".must_be_kind_of" do
+  it "should recognize ClassA as kind of Object" do
+    lambda{ClassA.must_be_kind_of(Object)}.should_not raise_error(TypeError)
+  end
+  it "should recognize ClassB as kind of ClassA" do
+    lambda{ClassB.must_be_kind_of(ClassA)}.should_not raise_error(TypeError)
+  end
+  it "should not recognize ClassC as kind of ClassA" do
+    lambda{ClassC.must_be_kind_of(ClassA)}.should raise_error(TypeError)
+  end
+  it "should not recognize ClassC as kind of ModA" do
+    lambda{ClassC.must_be_kind_of(ModA)}.should raise_error(TypeError)
+  end
+  it "should recognize ClassD as kind of ModA" do
+    lambda{ClassD.must_be_kind_of(ModA)}.should_not raise_error(TypeError)
+  end
+end

data/spec/typesafe_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+{:must_be_kind_of => false, :must_be_a => false, :must_be_nil_or_kind_of => true}.each do |method, nil_allowed|
+  describe TypeSafe, ".#{method}" do
+    it "should be included in Object class" do
+      Object.new.should respond_to(method)
+    end
+    it "should recognize a simple type" do
+      lambda{1.send method, Fixnum}.should_not raise_error(TypeError)
+    end
+    it "should recognize parent classes" do
+      lambda{self.send method, Object}.should_not raise_error(TypeError)
+    end
+    it "should raise a TypeError for mismatching types" do
+      lambda{"1".send method, Fixnum}.should raise_error(TypeError)
+    end
+    it "should not raise a TypeError for mismatching types if a block was given" do
+      lambda{"1".send method, Fixnum do |clss|
+        clss.should be_a Class
+        clss.should == String
+        end}.should_not raise_error(TypeError)
+    end
+    it "should execute the given block for mismatching types" do
+      executed = false
+      lambda{"1".send method, Fixnum do |clss|
+        clss.should be_a Class
+        clss.should == String
+        executed = true
+        end}.should_not raise_error(TypeError)
+        executed.should == true
+    end
+    it "should not execute the given block for matching types" do
+      executed = false
+      lambda{1.send method, Fixnum do |clss|
+        clss.should be_a Class
+        clss.should == Fixnum
+        executed = true
+        end}.should_not raise_error(TypeError)
+        executed.should == false
+    end
+    
+    it "should raise a RuntimeError if the given match is not a Class" do
+      lambda{"1".send method, "Fixnum"}.should raise_error(RuntimeError)
+      lambda{"1".send method, "Fixnum"}.should_not raise_error(TypeError)
+    end
+    
+    it "should #{nil_allowed ? 'not ' : ''}raise a TypeError for mismatching types on nil" do
+      lambda{nil.send method, Fixnum}.send nil_allowed ? :should_not : :should, raise_error(TypeError)
+    end
+    
+    it "should recognize included modules" do
+      module TestModule ; end
+      class TestClass
+        include TestModule
+      end
+      o = TestClass.new
+      lambda{o.send method, TestModule}.should_not raise_error(TypeError)
+    end
+  end
+end

data/typesafe.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{typesafe}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Till Salzer"]
+  s.date = %q{2009-08-30}
+  s.description = %q{Simplifies typesafe development by providing the additional
+      methods Object#must_by_kind_of ad Object#must_be_a.}
+  s.email = %q{till.salzer@googlemail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/step_definitions/typesafe_steps.rb",
+     "features/support/env.rb",
+     "features/typesafe.feature",
+     "lib/typesafe.rb",
+     "spec/spec_helper.rb",
+     "spec/typesafe_class_coreclasses_spec.rb",
+     "spec/typesafe_class_spec.rb",
+     "spec/typesafe_spec.rb",
+     "typesafe.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tsalzer/typesafe}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{provides Object#must_be_kind_of for typesafe development}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/typesafe_class_coreclasses_spec.rb",
+     "spec/typesafe_class_spec.rb",
+     "spec/typesafe_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: typesafe
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Till Salzer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |-
+  Simplifies typesafe development by providing the additional
+        methods Object#must_by_kind_of ad Object#must_be_a.
+email: till.salzer@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/step_definitions/typesafe_steps.rb
+- features/support/env.rb
+- features/typesafe.feature
+- lib/typesafe.rb
+- spec/spec_helper.rb
+- spec/typesafe_class_coreclasses_spec.rb
+- spec/typesafe_class_spec.rb
+- spec/typesafe_spec.rb
+- typesafe.gemspec
+has_rdoc: true
+homepage: http://github.com/tsalzer/typesafe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: provides Object#must_be_kind_of for typesafe development
+test_files: 
+- spec/spec_helper.rb
+- spec/typesafe_class_coreclasses_spec.rb
+- spec/typesafe_class_spec.rb
+- spec/typesafe_spec.rb