ruby_contracts 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+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 ruby_contracts.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nicolas ZERMATI
+
+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,47 @@
+# RubyContracts
+
+RubyContracts is a small DSL to add pre & post condition to methods. It try to bring some design by contract in the Ruby world.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_contracts'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_contracts
+
+## Usage
+
+    class Example
+      include Contracts::DSL
+      
+      def initialize(val)
+        @value = val
+      end
+      
+      type :in => [Integer, Proc], :out => Numeric
+      pre  "a must be > the example's value" do |a| a < @value end
+      post "result must be between a and val" do |result, a| result >= a && result < @value end
+      
+      def method(a)
+        a * 3 + yield - 4
+      end
+    end
+
+Run this sample with `ENABLE_ASSERTION=1 bundle exec ruby example.rb`.
+
+Without the environment variable `ENABLE_ASSERTION` you have zero overhead and zero verification.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ruby_contracts/version.rb

@@ -0,0 +1,3 @@
+module RubyContracts
+  VERSION = "0.1.0"
+end

data/lib/ruby_contracts.rb

@@ -0,0 +1,111 @@
+require "ruby_contracts/version"
+
+module Contracts
+  class Error < Exception ; end
+
+  module DSL
+    def self.included(base)
+      base.extend Contracts::DSL::ClassMethods
+    end
+
+    module ClassMethods
+      def self.extended(base)
+        base.instance_eval "@__contracts = {:before => [], :after => []}"
+      end
+
+      def __contract_failure!(name, message, result, *args)
+        args.pop if args.last.kind_of?(Proc)
+        raise Contracts::Error.new("#{self}##{name}(#{args.join ', '}) => #{result || "?"} ; #{message}.")
+      end
+
+      def type(options)
+        @__contracts[:before] << [:type, options[:in]] if ENV['ENABLE_ASSERTION'] && options.has_key?(:in)
+        @__contracts[:after] << [:type, options[:out]] if ENV['ENABLE_ASSERTION'] && options.has_key?(:out)
+      end
+
+      def pre(message=nil, &block)
+        @__contracts[:before] << [:params, message, block] if ENV['ENABLE_ASSERTION']
+      end
+
+      def post(message=nil, &block)
+        @__contracts[:after] << [:result, message, block] if ENV['ENABLE_ASSERTION']
+      end
+
+      def method_added(name)
+        if ENV['ENABLE_ASSERTION'] && (!@__contracts[:before].empty? || !@__contracts[:after].empty?)
+          __contracts_copy = @__contracts
+          @__contracts = {:before => [], :after => []}
+
+          original_method_name = "#{name}__with_contracts"
+          define_method(original_method_name, instance_method(name))
+
+
+          count = 0
+          before_contracts = __contracts_copy[:before].reduce("") do |code, contract|
+            type, *args = contract
+            case type
+            when :type
+              classes = args[0]
+              code << "if __args.size < #{classes.size} then\n"
+              code << "  self.class.__contract_failure!('#{name}', \"need at least #{classes.size} arguments (%i given)\" % [__args.size], nil, *args)\n"
+              code << "else\n"
+              conditions = []
+              classes.each_with_index{ |klass, i| conditions << "__args[#{i}].kind_of?(#{klass})" }
+              code << "  if !(#{conditions.join(' && ')}) then\n"
+              code << "    self.class.__contract_failure!('#{name}', 'input type error', nil, *__args)\n"
+              code << "  end\n"
+              code << "end\n"
+              code
+
+            when :params
+              # Define a method that verify the assertion
+              contract_method_name = "__verify_contract_#{name}_in_#{count = count + 1}"
+              define_method(contract_method_name) { |*params| self.instance_exec(*params, &args[1]) }
+
+              code << "if !#{contract_method_name}(*__args) then\n"
+              code << "  self.class.__contract_failure!('#{name}', \"invalid precondition: #{args[0]}\", nil, *__args)\n"
+              code << "end"
+              code
+            else
+              code
+            end
+          end
+
+          after_contracts = __contracts_copy[:after].reduce("") do |code, contract|
+            type, *args = contract
+            case type
+            when :type
+              code << "if !result.kind_of?(#{args[0]}) then\n"
+              code << "self.class.__contract_failure!(name, \"result must be a kind of '#{args[0]}' not '%s'\" % [result.class.to_s], result, *__args)\n"
+              code << "end\n"
+              code
+            when :result
+              # Define a method that verify the assertion
+              contract_method_name = "__verify_contract_#{name}_out_#{count = count + 1}"
+              define_method(contract_method_name) { |*params| self.instance_exec(*params, &args[1]) }
+
+              code << "if !#{contract_method_name}(result, *__args) then\n"
+              code << "  self.class.__contract_failure!('#{name}', \"invalid postcondition: #{args[0]}\", result, *__args)\n"
+              code << "end"
+              code
+            else
+              code
+            end
+          end
+
+          method = <<-EOM
+            def #{name}(*args, &block)
+              __args = block.nil? ? args : args + [block]
+              #{before_contracts}
+              result = #{original_method_name}(*args, &block)
+              #{after_contracts}
+              return result
+            end
+          EOM
+
+          class_eval method
+        end
+      end
+    end
+  end
+end

data/ruby_contracts.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'ruby_contracts/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nicolas ZERMATI"]
+  gem.email         = ["nicoolas25@gmail.com"]
+  gem.description   = %q{Micro DSL to add pre & post condition to methods. It try to bring some design by contract in the Ruby world.}
+  gem.summary       = %q{Micro DSL to add pre & post condition to methods. It try to bring some design by contract in the Ruby world.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ruby_contracts"
+  gem.require_paths = ["lib"]
+  gem.version       = RubyContracts::VERSION
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ruby_contracts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nicolas ZERMATI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-03 00:00:00.000000000 Z
+dependencies: []
+description: Micro DSL to add pre & post condition to methods. It try to bring some
+  design by contract in the Ruby world.
+email:
+- nicoolas25@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ruby_contracts.rb
+- lib/ruby_contracts/version.rb
+- ruby_contracts.gemspec
+homepage: ''
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Micro DSL to add pre & post condition to methods. It try to bring some design
+  by contract in the Ruby world.
+test_files: []
+has_rdoc: