type_tempest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18afd85a6340b560400256c512637d298e785d49
+  data.tar.gz: 66deffe30f0c1fe96beb7f90fab1223f93c86e8e
+SHA512:
+  metadata.gz: 2167a1a5300a7d58183500be4977df73e0143338bbb26b62a8492ec8be27e891a327ab7b952cd16e0f97f205a1da751c6de86ca80f2ab995188a76c9f0985942
+  data.tar.gz: 6b1bd173226c45d8c2fdb153d01c97b91923cd1a4a571891a40974aa34614ad3e0ef57ffe18743f1af8fae8134f41208ff876c42e1e70ea2333a6578c5b30b39

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea/
+*.iml
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014, Tom C
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tom's laptop (magnusson)
+
+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,69 @@
+# TypeTempest
+
+Type Tempest is a type-checking gem for Ruby methods, which automates the tedious pattern of `raise ArgumentError, "Blah is ivalid" unless blah.is_a?(String)`
+
+Say what you will about dynamic typing -- this is for those times where one does not want a million possibilities in their inputs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'type_tempest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install type_tempest
+
+## Usage
+
+Type Tempest adds two similar, top-level, and syntactically-odd methods to Ruby: `check()` and `strict()`.
+
+`check()` passes if the given variable matches the given class, or one of its subclasses. (`var.is_a?(Klass)`).
+
+`strict()` passes if the given variable matches the given class. (`var.instance_of?(Klass)`)
+
+**Use these shortcuts as the first line in a method whose parameters you would like to check, as such:**
+
+
+	def checkme(a_string, a_int, another_string)
+		check (String) {:a_string}
+		check (Fixnum) {:a_int}
+		strict (String) {:another_string}
+
+		# some code here...
+
+		"Done!"
+	end
+
+Behind the scenes, TypeTempest eval()s the result of the given block and throws `TypeMismatchError` if the result's type differs from what is expected (as in, it fails `is_a?()` or `instance_of?()`). In this example, the first call to `checkme()` would pass, but the second would throw `TypeMismatchError`:
+
+
+    checkme("Hi", 2, "ada") # => "Done!"
+    checkme(0,0,0) # => Parameter a_string should be of type String, but was instead Fixnum (TypeMismatchError)
+
+## Comments
+
+The `check (String) {:a_string}` syntax is awkward and not very Ruby-like. Using blocks to access the caller's binding is a bit of a hack, and if there were an easier way to walk the call-stack and derive method parameters then the syntax would be different.
+
+An ideal version of this feature would look like this: `check String a_string` or `strict Geometry::Box box_obj`. Unfortunately...
+
+* I am not aware of any way to cheaply retreive both the contents (variable names, etc) and values of a block.
+* I am not aware of any way to cheaply walk the call-stack in a way that allows one to retreive a caller's parameter names and values.
+* I am not aware of any other way to evaluate code in the context of the caller.
+* Block syntax seems to only work when method parameters are wrapped in `(` and `)`.
+* Passing `local_variables`, `_`, or a self-reference to `check()` would further clutter syntax.
+* Blocks must be designated with `{}` or `do..end`
+
+For these reasons, syntax is presented as-is, with possible tweaks towards the stated goal saved for major revisions.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :console do
+  sh "irb -rubygems -I lib -r type_tempest.rb"
+end

data/lib/type_tempest/version.rb

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

data/lib/type_tempest.rb

@@ -0,0 +1,31 @@
+require "type_tempest/version"
+
+class TypeMismatchError < TypeError
+
+end
+
+
+def check(type, &block)
+
+  type = type.to_s.constantize if defined?(ActiveSupport) && (type.instance_of?(Symbol) || type.instance_of?(String))
+  raise TypeError, "`type` must be an object of type Class" unless type.instance_of?(Class)
+
+  var    = yield
+  vartyp = eval("#{var.to_s}", block.binding)
+
+  raise TypeMismatchError, "Parameter #{var} should be of type #{type}, but was instead #{vartyp.class}" unless vartyp.is_a?(type)
+
+end
+
+
+def strict(type, &block)
+
+  type = type.to_s.constantize if defined?(ActiveSupport) && (type.instance_of?(Symbol) || type.instance_of?(String))
+  raise TypeError, "`type` must be an object of type Class" unless type.instance_of?(Class)
+
+  var    = yield
+  vartyp = eval("#{var.to_s}", block.binding)
+
+  raise TypeMismatchError, "Parameter #{var} should be of type #{type}, but was instead #{vartyp.class}" unless vartyp.instance_of?(type)
+
+end

data/type_tempest.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'type_tempest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "type_tempest"
+  spec.version       = TypeTempest::VERSION
+  spec.authors       = ["Lyjia / Tom Corelis"]
+  spec.email         = ["tom@tomcorelis.com"]
+  spec.description   = %q{Simple type-checking for Ruby}
+  spec.summary       = %q{Simple type-checking for Ruby}
+  spec.homepage      = "http://www.lyjia.us"
+  spec.license       = "BSD 2-Clause"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: type_tempest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lyjia / Tom Corelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple type-checking for Ruby
+email:
+- tom@tomcorelis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/type_tempest.rb
+- lib/type_tempest/version.rb
+- type_tempest.gemspec
+homepage: http://www.lyjia.us
+licenses:
+- BSD 2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple type-checking for Ruby
+test_files: []