typedeaf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 3a8ff4243653190eb9017aabc61f79b3654f4dd2
+  data.tar.gz: 7d7c83e7048c3667c48096ebf812a311c5c375fb
+SHA512: 
+  metadata.gz: a454e734801b2f24eef4d02d2e81d9f46c6b8aacb20ee6f2aad1a85056bcf98647e7375c8d64492c69d4a9dd64c49cfa98b29967b81dec0aa9f07160894fce54
+  data.tar.gz: 92f730e8823c3c7fe8900b051f6277785bac51b9fbf5aa816ce48bd5fe2fc08b03ae82360fb9ea86bcfaa99a10beb1207a6b1e32e4fd244de32147188c55627b

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--order random --fail-fast --color --format doc

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typedeaf.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+  gem 'pry'
+  gem 'debugger-pry', :platform => :mri
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 R. Tyler Croy
+
+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,49 @@
+# Typedeaf
+
+Typedeaf is a gem to help add some type-checking to method declarations in Ruby
+
+
+## Usage
+
+```
+[1] pry(main)> require 'typedeaf'
+=> true
+[2] pry(main)> class Logger
+[2] pry(main)*   include Typedeaf
+[2] pry(main)*   
+[2] pry(main)*   define :log, message: String, level: Symbol do
+[2] pry(main)*     puts "Logging #{message} at level #{level}"
+[2] pry(main)*   end  
+[2] pry(main)* end  
+=> Logger
+[3] pry(main)> l = Logger.new
+=> #<Logger:0x00000803c616b8>
+[4] pry(main)> l.log("Hello World", :debug)
+Logging Hello World at level debug
+=> nil
+[5] pry(main)> l.log(4, :debug)
+Typedeaf::InvalidTypeException: Expected `message` to be a kind of String but was Fixnum
+from /usr/home/tyler/source/github/ruby/typedeaf/lib/typedeaf.rb:41:in `type_validation!'
+[6] pry(main)> l.log('Whoopsies', 'debug')
+Typedeaf::InvalidTypeException: Expected `level` to be a kind of Symbol but was String
+from /usr/home/tyler/source/github/ruby/typedeaf/lib/typedeaf.rb:41:in `type_validation!'
+[7] pry(main)> 
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typedeaf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typedeaf
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec, :build]
+

data/lib/typedeaf/errors.rb

@@ -0,0 +1,5 @@
+
+module Typedeaf
+  class MissingMethodException < StandardError; end
+  class InvalidTypeException < StandardError; end
+end

data/lib/typedeaf/version.rb

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

data/lib/typedeaf.rb

@@ -0,0 +1,86 @@
+require 'typedeaf/errors'
+require "typedeaf/version"
+
+module Typedeaf
+  def self.included(base)
+    base.send(:include, InstanceMethods)
+    base.extend(ClassMethods)
+  end
+
+  module InstanceMethods
+    def __typedeaf_varstack__
+      if @__typedeaf_varstack__.nil?
+        @__typedeaf_varstack__ = []
+      end
+      return @__typedeaf_varstack__
+    end
+
+    def method_missing(sym, *args)
+      # We only want to peek at the stack if we have no args (i.e. not trying
+      # to make a method call
+      if args.empty? && !(__typedeaf_varstack__.empty?)
+        params, values = __typedeaf_varstack__.last
+        # The top of our stack contains something that we want
+        return values[sym] if params[sym]
+      end
+
+      return super
+    end
+
+    def positional_validation!(params, args)
+      if params.size != args.size
+        raise ArgumentError, "wrong number of arguments (#{args.size} for #{params.size}"
+      end
+    end
+
+    def type_validation!(expected, param, value)
+      unless value.is_a?(expected)
+        raise InvalidTypeException,
+            "Expected `#{param}` to be a kind of #{expected} but was #{value.class}"
+      end
+    end
+  end
+
+  module ClassMethods
+    def define(method_sym, params={}, &block)
+      if block.nil?
+        raise MissingMethodException,
+            "You must provide a block for the #{method_sym} body"
+      end
+
+      define_method(method_sym) do |*args|
+        positional_validation!(params.keys, args)
+
+        param_indices = {}
+        params.each.with_index do |(param, type), index|
+          value = args[index]
+          type_validation!(type, param, value)
+          param_indices[param] = value
+        end
+        __typedeaf_varstack__ << [params, param_indices]
+
+        begin
+          instance_exec(*args, &block)
+        ensure
+          __typedeaf_varstack__.pop
+        end
+      end
+      return self
+    end
+  end
+
+  # Install the Typedeaf methods onto Class to be used everywhere
+  def self.global_install
+    Class.class_eval do
+      include Typedeaf
+
+      alias_method :old_inherited, :inherited
+      def inherited(subclass)
+        subclass.class_eval do
+          include Typedeaf
+        end
+        return old_inherited(subclass)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'typedeaf'
+
+unless RUBY_PLATFORM == 'java'
+  require 'debugger/pry'
+end

data/spec/typedeaf_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Typedeaf do
+  subject(:klass) do
+    Class.new do
+      include Typedeaf
+    end
+  end
+
+  context 'with a new class' do
+    it { should be_kind_of Class }
+    it { should respond_to :define }
+  end
+
+  context 'defining typedeaf instance methods' do
+    subject(:instance) { klass.new }
+
+    context 'defining a method with an invalid block' do
+      it 'should raise a MissingMethodException' do
+        expect {
+          klass.class_eval do
+            define :log
+          end
+        }.to raise_error(Typedeaf::MissingMethodException)
+      end
+    end
+
+
+    context 'defining a method with no arguments' do
+      before :each do
+        klass.class_eval do
+          define :log do
+            'hello rspec'
+          end
+        end
+      end
+
+      it { should respond_to :log }
+
+      it 'should return the right value when invoked' do
+        expect(instance.log).to eql('hello rspec')
+      end
+    end
+
+
+    context 'defining a method with arguments' do
+      before :each do
+        klass.class_eval do
+          define :log, message: String do
+            "hello #{message}"
+          end
+        end
+      end
+
+      it { should respond_to :log }
+      it 'should use the arguments to generate a result' do
+        expect(instance.log('world')).to eql('hello world')
+      end
+
+      it 'should raise when not enough args are passed' do
+        expect {
+          instance.log
+        }.to raise_error(ArgumentError)
+      end
+
+      it 'should raise when an incorrectly typed argument is passed' do
+        expect {
+          instance.log 4
+        }.to raise_error(Typedeaf::InvalidTypeException)
+      end
+    end
+  end
+end

data/typedeaf.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typedeaf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "typedeaf"
+  spec.version       = Typedeaf::VERSION
+  spec.authors       = ["R. Tyler Croy"]
+  spec.email         = ["tyler@monkeypox.org"]
+  spec.summary       = %q{Typedeaf is a gem to help add some type-checking to method declarations in Ruby}
+  spec.homepage      = "https://github.com/rtyler/typedeaf"
+  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"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: typedeaf
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- R. Tyler Croy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-10-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.7"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "10.0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: 
+email: 
+- tyler@monkeypox.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typedeaf.rb
+- lib/typedeaf/errors.rb
+- lib/typedeaf/version.rb
+- spec/spec_helper.rb
+- spec/typedeaf_spec.rb
+- typedeaf.gemspec
+homepage: https://github.com/rtyler/typedeaf
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id003 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Typedeaf is a gem to help add some type-checking to method declarations in Ruby
+test_files: 
+- spec/spec_helper.rb
+- spec/typedeaf_spec.rb