contracts 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aee00ef1803ee1ac8e84e96156494f7b7c4162a
-  data.tar.gz: a3798c342c9b29170f523f23083baeb2553cbd83
+  metadata.gz: 065efb039a13c2917e10fc96dd77dd2fe858bc08
+  data.tar.gz: 98f3253cc22a5da08f4d3414361db7218c438107
 SHA512:
-  metadata.gz: d1404d6dd2fe5212b9c7a8bfa682b982bf612161200e33bc14ab73609eaac0681b85540a182a3d4d2437d3446380241785d229b6a8145c5a8c3fda8e37f682f5
-  data.tar.gz: 0912d5946702185218f94d1058577e92fd9f7b668e248ab4d796e67b620455f4a43e2a0e02d4871f8def9c8666feb3f4343c4f3f6d04d6c1a25b97541c7afd27
+  metadata.gz: b8486b6e85a38517371403aa4cb7b3e6795ee01a2170e663eab8ff772507971a8e7bfa050b3b98dabb8fc60772153f544a14e9e419025a7c899ebda682b82338
+  data.tar.gz: 44cfdb1101dbe48269e88c5758196e2bc11ce2238f70a791c0f62aa36d0754994dd00f49f4c8e0d98cca43a4b254a085cc83af3673964b6e31198ba66c14527e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    contracts (0.5)
+    contracts (0.6)
 
 GEM
   remote: http://rubygems.org/

data/TUTORIAL.md

@@ -29,14 +29,17 @@ Copy this code into a file and run it:
 
 ```ruby
 require 'contracts'
-include Contracts
 
-Contract Num, Num => Num
-def add(a, b)
-  a + b
+class Math
+  include Contracts
+
+  Contract Num, Num => Num
+  def self.add(a, b)
+    a + b
+  end
 end
 
-puts add(1, "foo")
+puts Math.add(1, "foo")
 ```
 
 You'll see a detailed error message like so:
@@ -60,7 +63,7 @@ This can be useful if you're in a repl and want to figure out how a function sho
 
 ## Builtin Contracts
 
-`Num` is one of the builtin contracts that contracts.ruby comes with. The builtin contracts are in the `Contracts` namespace. The easiest way to use them is to put `include Contracts` at the top of your file, but beware that they will pollute your namespace with new class names.
+`Num` is one of the builtin contracts that contracts.ruby comes with. The builtin contracts are in the `Contracts` namespace. The easiest way to use them is to include the `Contracts` module in your class/module.
 
 contracts.ruby comes with a lot of builtin contracts, including:
 
@@ -401,7 +404,7 @@ If your failure callback returns `false`, the method that the contract is guardi
 
 ## Disabling contracts
 
-If you want to disable contracts, set the `NO_CONTRACTS` environment variable. This will disable contracts completely and you won't have a performance hit.
+If you want to disable contracts, set the `NO_CONTRACTS` environment variable. This will disable contracts and you won't have a performance hit. Pattern matching will still work if you disable contracts in this way! With NO_CONTRACTS only pattern-matching contracts are defined.
 
 ## Method overloading
 
@@ -439,12 +442,12 @@ For an argument, each function will be tried in order. The first function that d
 This allows you write methods more declaratively, rather than using conditional branching. This feature is not only useful for recursion; you can use it to keep parallel use cases separate:
 
 ```ruby
-Contract And[Num, lambda{|n| n < 12 }] => Ticket
+Contract lambda{|n| n < 12 } => Ticket
 def get_ticket(age)
   ChildTicket.new(age: age)
 end
 
-Contract And[Num, lambda{|n| n >= 12 }] => Ticket
+Contract lambda{|n| n >= 12 } => Ticket
 def get_ticket(age)
   AdultTicket.new(age: age)
 end
@@ -486,7 +489,7 @@ A simple example:
 ```ruby
 class MyBirthday < Struct.new(:day, :month)
   include Contracts
-  include Contracts:Invariants
+  include Contracts::Invariants
 
   Invariant(:day) { 1 <= day && day <= 31 }
   Invariant(:month) { 1 <= month && month <= 12 }

data/lib/contracts/eigenclass.rb

@@ -20,6 +20,7 @@ module Contracts
 
       unless eigenclass.respond_to?(:pop_decorators)
         eigenclass.extend(MethodDecorators)
+        eigenclass.send(:include, Contracts)
       end
 
       eigenclass.owner_class = base

data/lib/contracts/method_reference.rb

@@ -24,7 +24,8 @@ module Contracts
 
     # Makes a method private
     def make_private(this)
-      alias_target(this).class_eval { private name }
+      original_name = name
+      alias_target(this).class_eval { private original_name }
     end
 
     # Aliases original method to a special unique name, which is known

data/lib/contracts/version.rb

@@ -1,3 +1,3 @@
 module Contracts
-  VERSION = "0.6"
+  VERSION = "0.7"
 end

data/spec/contracts_spec.rb

@@ -107,6 +107,14 @@ RSpec.describe "Contracts:" do
         }.to raise_error(*error)
       end
     end
+
+    describe "builtin contracts usage" do
+      it "allows to use builtin contracts without namespacing and redundant Contracts inclusion" do
+        expect {
+          SingletonClassExample.add("55", 5.6)
+        }.to raise_error(ContractError, /Expected: Contracts::Num/)
+      end
+    end
   end
 
   describe "no contracts feature" do
@@ -449,6 +457,10 @@ RSpec.describe "Contracts:" do
     it "should raise an error if you try to access a private method" do
       expect { @o.a_private_method }.to raise_error
     end
+
+    it "should raise an error if you try to access a private method" do
+      expect { @o.a_really_private_method }.to raise_error
+    end
   end
 
   describe "inherited methods" do

data/spec/fixtures/fixtures.rb

@@ -214,6 +214,13 @@ class GenericExample
   end
   private :a_private_method
 
+  private
+
+  Contract nil => String
+  def a_really_private_method
+    "works for sure"
+  end
+
 end
 
 # for testing inheritance
@@ -323,6 +330,11 @@ class SingletonClassExample
     def hoge(str)
       "super#{str}"
     end
+
+    Contract Num, Num => Num
+    def add(a, b)
+      a + b
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Aditya Bhargava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-07 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies: []
 description: This library provides contracts for Ruby. Contracts let you clearly express
   how your code behaves, and free you from writing tons of boilerplate, defensive