type_hinting 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in type_hinting.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Zeligson
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# TypeHinting
+
+I sometimes find myself writing code like this:
+
+```ruby
+  def do_something_with_argument(argument)
+    unless argument.kind_of?(SomeClassImExpecting)
+      raise Exception, 'Whatever'
+    end
+    do_more_stuff
+  end
+```
+
+This gem provides a mixin which add two class methods, return\_type and  
+param\_types, that are a bit nicer to work with.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'type_hinting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install type_hinting
+
+## Usage
+
+Dead simple, here's the example used in the tests:
+
+```ruby
+
+class TypeHinted
+  include TypeHinting
+
+  def return_should_work
+    []
+  end
+  return_type(:return_should_work, Array)
+  # raise if method returns anything other than array
+
+  def return_should_raise
+    nil
+  end
+  return_type(:return_should_raise, Array)
+  # same as above
+
+  def hinted_params(a, b = 4)
+    [a, b]
+  end
+  param_types(:hinted_params, Array, Fixnum) 
+  # raise if passed anything other than Array for arg1,
+  # raise if passed anything other than Fixnum for arg2
+  # nil is allowed for arg2 since there is a default value specified
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/type_hinting/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/type_hinting/version.rb

@@ -0,0 +1,3 @@
+module TypeHinting
+  VERSION = "0.0.1"
+end

data/lib/type_hinting.rb

@@ -0,0 +1,40 @@
+require "type_hinting/version"
+
+module TypeHinting
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def skipped_optional_param(param_type, value)
+    param_type != :req && value.nil?
+  end
+  
+  module ClassMethods
+
+    def return_type(name, type)
+      method = instance_method(name)
+      define_method(name) do |*args|
+        r = method.bind(self).call(*args)
+        unless r.kind_of?(type)
+          raise Exception, "Invalid return type of #{r.class}, expecting #{type}"
+        end
+        r
+      end
+    end
+
+    def param_types(name, *arg_types)
+      method = instance_method(name)
+      sig_args = method.parameters
+      define_method(name) do |*args|
+        arg_types.zip(sig_args, args).each do |(type, (required, name), arg)|
+          if !arg.kind_of?(type) && !skipped_optional_param(required, arg)
+            raise Exception, "Invalid type #{arg.class} for " <<
+              "parameter #{name}, expecting #{type}"
+          end
+        end
+        method.bind(self).call(*args)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'pry'
+require 'pry-debugger'
+require 'type_hinting'

data/spec/type_hinting_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class TypeHinted
+  include TypeHinting
+
+  def return_should_work
+    []
+  end
+  return_type(:return_should_work, Array)
+
+  def return_should_raise
+    nil
+  end
+  return_type(:return_should_raise, Array)
+
+  def hinted_params(a, b = 4)
+    [a, b]
+  end
+  param_types(:hinted_params, Array, Fixnum) 
+end
+
+describe TypeHinting do
+  let(:h) { TypeHinted.new }
+
+  describe '.return_type' do
+
+    it 'raises when method returns other than specified return type' do
+      expect{h.return_should_work}.to_not raise_error
+    end
+
+    it 'doesnt raise when method returns the specified return type' do
+      expect{h.return_should_raise}.to raise_error
+    end
+  end
+
+  describe '.param_types' do
+    
+    it 'raises on param passed of incorrect type' do
+      expect{h.hinted_params('b', 'd')}.to raise_error
+      expect{h.hinted_params('b', 3)}.to raise_error
+      expect{h.hinted_params(['b'], :d)}.to raise_error
+    end
+
+    it 'does not raise when all passed params are correct type' do
+      expect{h.hinted_params([:c, :d], 5)}.to_not raise_error
+      expect{h.hinted_params(['foo'])}.to_not raise_error
+    end
+  end
+end

data/type_hinting.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'type_hinting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "type_hinting"
+  spec.version       = TypeHinting::VERSION
+  spec.authors       = ["Brian Zeligson"]
+  spec.email         = ["bzeligson@localytics.com"]
+  spec.summary       = %q{Get type safety in your Ruby code}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: type_hinting
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Zeligson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bzeligson@localytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/type_hinting.rb
+- lib/type_hinting/version.rb
+- spec/spec_helper.rb
+- spec/type_hinting_spec.rb
+- type_hinting.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Get type safety in your Ruby code
+test_files:
+- spec/spec_helper.rb
+- spec/type_hinting_spec.rb
+has_rdoc: