contracts 0.7 → 0.8

data/spec/fixtures/fixtures.rb

@@ -45,16 +45,23 @@ class C
   def good
     false
   end
+
   def bad
     true
   end
 end
 
+class EmptyCont
+  def self.to_s
+    ""
+  end
+end
+
 class GenericExample
   include Contracts
 
   Contract Num => Num
-  def GenericExample.a_class_method x
+  def self.a_class_method x
     x + 1
   end
 
@@ -68,6 +75,11 @@ class GenericExample
     x * 2
   end
 
+  Contract 123, nil => nil
+  def constanty(num, nul)
+    0
+  end
+
   Contract String => nil
   def hello(name)
   end
@@ -84,10 +96,29 @@ class GenericExample
     end
   end
 
-  Contract ({:name => String, :age => Fixnum}) => nil
+  Contract ({ :name => String, :age => Fixnum }) => nil
   def person(data)
   end
 
+  Contract ({ :rigged => Or[TrueClass, FalseClass] }) => nil
+  def hash_complex_contracts(data)
+  end
+
+  Contract ({ :rigged => Bool,
+              :contents => { :kind => Or[String, Symbol],
+                             :total => Num }
+            }) => nil
+  def nested_hash_complex_contracts(data)
+  end
+
+  Contract [Or[TrueClass, FalseClass]] => nil
+  def array_complex_contracts(data)
+  end
+
+  Contract [Bool, [Or[String, Symbol]]] => nil
+  def nested_array_complex_contracts(data)
+  end
+
   Contract Proc => Any
   def do_call(&blk)
     blk.call
@@ -118,6 +149,12 @@ class GenericExample
     blk[sum]
   end
 
+  # Important to use different arg types or it falsely passes
+  Contract Num, Args[String] => ArrayOf[String]
+  def arg_then_splat(n, *vals)
+    vals.map { |v| v * n }
+  end
+
   Contract Num, Proc => nil
   def double_with_proc(x, &blk)
     blk.call(x * 2)
@@ -132,6 +169,10 @@ class GenericExample
   def neg_test(x)
   end
 
+  Contract Nat => nil
+  def nat_test(x)
+  end
+
   Contract Any => nil
   def show(x)
   end
@@ -189,6 +230,24 @@ class GenericExample
     ret
   end
 
+  Contract ArrayOf[Any], Proc => ArrayOf[Any]
+  def tutorial_map(arr, func)
+    ret = []
+    arr.each do |x|
+      ret << func[x]
+    end
+    ret
+  end
+
+  # Need to test Func with weak contracts for other args
+  # and changing type from input to output otherwise it falsely passes!
+  Contract Array, Func[String => Num] => Array
+  def map_plain(arr, func)
+    arr.map do |x|
+      func[x]
+    end
+  end
+
   Contract Num => Num
   def default_args(x = 1)
     2
@@ -208,12 +267,23 @@ class GenericExample
     hash.values.max
   end
 
+  Contract EmptyCont => Any
+  def using_empty_contract(a)
+    a
+  end
+
   Contract nil => String
   def a_private_method
     "works"
   end
   private :a_private_method
 
+  Contract nil => String
+  def a_protected_method
+    "works"
+  end
+  protected :a_protected_method
+
   private
 
   Contract nil => String
@@ -221,6 +291,12 @@ class GenericExample
     "works for sure"
   end
 
+  protected
+
+  Contract nil => String
+  def a_really_protected_method
+    "works for sure"
+  end
 end
 
 # for testing inheritance
@@ -247,11 +323,40 @@ class GenericExample
   end
 end
 
+# for testing equality
+class Foo
+end
+module Bar
+end
+Baz = 1
+
+class GenericExample
+  Contract Eq[Foo] => Any
+  def eq_class_test(x)
+  end
+
+  Contract Eq[Bar] => Any
+  def eq_module_test(x)
+  end
+
+  Contract Eq[Baz] => Any
+  def eq_value_test(x)
+  end
+end
+
 # pattern matching example with possible deep contract violation
 class PatternMatchingExample
   include Contracts
 
-  class Success < Struct.new(:request)
+  class Success
+    attr_accessor :request
+    def initialize request
+      @request = request
+    end
+
+    def ==(other)
+      request == other.request
+    end
   end
 
   class Failure
@@ -261,13 +366,13 @@ class PatternMatchingExample
 
   class StringWithHello
     def self.valid?(string)
-      String === string && !!string.match(/hello/i)
+      string.is_a?(String) && !!string.match(/hello/i)
     end
   end
 
   Contract Success => Response
   def process_request(status)
-    Success[decorated_request(status.request)]
+    Success.new(decorated_request(status.request))
   end
 
   Contract Failure => Response
@@ -279,15 +384,31 @@ class PatternMatchingExample
   def decorated_request(request)
     request + "!"
   end
+
+  Contract Num, String => String
+  def do_stuff(number, string)
+    "foo"
+  end
+
+  Contract Num, String, Num => String
+  def do_stuff(number, string, other_number)
+    "bar"
+  end
 end
 
 # invariant example (silliest implementation ever)
-class MyBirthday < Struct.new(:day, :month)
+class MyBirthday
   include Contracts
   include Contracts::Invariants
 
-  Invariant(:day) { 1 <= day && day <= 31 }
-  Invariant(:month) { 1 <= month && month <= 12 }
+  invariant(:day) { 1 <= day && day <= 31 }
+  invariant(:month) { 1 <= month && month <= 12 }
+
+  attr_accessor :day, :month
+  def initialize(day, month)
+    @day = day
+    @month = month
+  end
 
   Contract None => Fixnum
   def silly_next_day!
@@ -354,7 +475,7 @@ with_enabled_no_contracts do
 
     attr_accessor :day
 
-    Invariant(:day_rule) { 1 <= day && day <= 7 }
+    invariant(:day_rule) { 1 <= day && day <= 7 }
 
     Contract None => nil
     def next_day

data/spec/invariants_spec.rb

@@ -1,6 +1,5 @@
 module Contracts
   RSpec.describe Invariants do
-
     def new_subject
       MyBirthday.new(31, 12)
     end
@@ -14,6 +13,5 @@ module Contracts
       expect { new_subject.silly_next_day! }.to raise_error(InvariantError, /day condition to be true/)
       expect { new_subject.silly_next_month! }.to raise_error(InvariantError, /month condition to be true/)
     end
-
   end
 end

data/spec/module_spec.rb

@@ -3,7 +3,7 @@ module Mod
 
   Contract Num => Num
   def self.a_module_method a
-     a + 1
+    a + 1
   end
 end
 
@@ -15,4 +15,4 @@ RSpec.describe "module methods" do
   it "should fail for incorrect input" do
     expect { Mod.a_module_method("bad") }.to raise_error(ContractError)
   end
-end  
+end

data/spec/ruby_version_specific/contracts_spec_1.9.rb

@@ -0,0 +1,18 @@
+class GenericExample
+  Contract Args[String], Num => ArrayOf[String]
+  def splat_then_arg(*vals, n)
+    vals.map { |v| v * n }
+  end
+end
+
+RSpec.describe "Contracts:" do
+  before :all do
+    @o = GenericExample.new
+  end
+
+  describe "Splat not last (or penultimate to block)" do
+    it "should work with arg after splat" do
+      expect { @o.splat_then_arg("hello", "world", 3) }.to_not raise_error
+    end
+  end
+end

data/spec/ruby_version_specific/contracts_spec_2.0.rb

@@ -0,0 +1,22 @@
+class GenericExample
+  Contract Args[String], { repeat: Maybe[Num] } => ArrayOf[String]
+  def splat_then_optional_named(*vals, repeat: 2)
+    vals.map { |v| v * repeat }
+  end
+end
+
+RSpec.describe "Contracts:" do
+  before :all do
+    @o = GenericExample.new
+  end
+
+  describe "Optional named arguments" do
+    it "should work with optional named argument unfilled after splat" do
+      expect { @o.splat_then_optional_named("hello", "world") }.to_not raise_error
+    end
+
+    it "should work with optional named argument filled after splat" do
+      expect { @o.splat_then_optional_named("hello", "world", repeat: 3) }.to_not raise_error
+    end
+  end
+end

data/spec/ruby_version_specific/contracts_spec_2.1.rb

@@ -0,0 +1,55 @@
+class GenericExample
+  Contract String, Bool, Args[Symbol], Float, { e: Range, f: Maybe[Num] }, Proc =>
+           [Proc, Hash, Num, Range, Float, ArrayOf[Symbol], Bool, String]
+  def complicated(a, b = true, *c, d, e:, f:2, **g, &h)
+    h.call [h, g, f, e, d, c, b, a]
+  end
+end
+
+RSpec.describe "Contracts:" do
+  before :all do
+    @o = GenericExample.new
+  end
+
+  describe "Required named arguments" do
+    describe "really complicated method signature" do
+      it "should work with default named args used" do
+        expect do
+          @o.complicated("a", false, :b, 2.0, e: (1..5)) { |x| x }
+        end.to_not raise_error
+      end
+
+      it "should work with all args filled manually, with extra splat and hash" do
+        expect do
+          @o.complicated("a", true, :b, :c, 2.0, e: (1..5), f: 8.3, g: :d) do |x|
+            x
+          end
+        end.to_not raise_error
+      end
+
+      it "should fail when the return is invalid" do
+        expect do
+          @o.complicated("a", true, :b, 2.0, e: (1..5)) { |_x| "bad" }
+        end.to raise_error(ContractError)
+      end
+
+      it "should fail when args are invalid" do
+        expect do
+          @o.complicated("a", "bad", :b, 2.0, e: (1..5)) { |x| x }
+        end.to raise_error(ContractError)
+      end
+
+      it "should fail when splat is invalid" do
+        expect do
+          @o.complicated("a", true, "bad", 2.0, e: (1..5)) { |x| x }
+        end.to raise_error(ContractError)
+      end
+
+      it "should fail when named argument is invalid" do
+        expect do
+          @o.complicated("a", true, :b, 2.0, e: "bad") { |x| x }
+        end.to raise_error(ContractError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -19,6 +19,13 @@ require File.expand_path(File.join(__FILE__, "../fixtures/fixtures"))
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  config.pattern = "*.rb"
+
+  # Only load tests who's syntax is valid in the current Ruby
+  [1.9, 2.0, 2.1].each do |ver|
+    config.pattern << ",ruby_version_specific/*#{ver}.rb" if ruby_version >= ver
+  end
+
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
   # assertions if you prefer.
@@ -58,7 +65,7 @@ RSpec.configure do |config|
 
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
-  #config.warnings = true
+  # config.warnings = true
 
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
@@ -67,7 +74,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    config.default_formatter = "doc"
   end
 
   # Print the 10 slowest examples and example groups at the

data/spec/support.rb

@@ -4,3 +4,7 @@ def with_enabled_no_contracts
   yield
   ENV["NO_CONTRACTS"] = no_contracts
 end
+
+def ruby_version
+  RUBY_VERSION.match(/\d+\.\d+/)[0].to_f
+end

data/spec/support_spec.rb

@@ -0,0 +1,21 @@
+module Contracts
+  RSpec.describe Support do
+    describe "eigenclass?" do
+      it "is falsey for non-singleton classes" do
+        expect(Contracts::Support.eigenclass? String).to be_falsey
+      end
+
+      it "is truthy for singleton classes" do
+        singleton_class = String.instance_exec { class << self; self; end }
+        expect(Contracts::Support.eigenclass? singleton_class).to be_truthy
+      end
+    end
+
+    describe "eigenclass_of" do
+      it "returns the eigenclass of a given object" do
+        singleton_class = String.instance_exec { class << self; self; end }
+        expect(Contracts::Support.eigenclass_of String).to eq singleton_class
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
 platform: ruby
 authors:
 - Aditya Bhargava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-04-02 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
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -28,27 +29,33 @@ files:
 - TUTORIAL.md
 - benchmarks/bench.rb
 - benchmarks/invariants.rb
+- benchmarks/io.rb
 - benchmarks/wrap_test.rb
 - contracts.gemspec
 - lib/contracts.rb
 - lib/contracts/builtin_contracts.rb
-- lib/contracts/core_ext.rb
 - lib/contracts/decorators.rb
 - lib/contracts/eigenclass.rb
 - lib/contracts/errors.rb
+- lib/contracts/formatters.rb
 - lib/contracts/invariants.rb
 - lib/contracts/method_reference.rb
 - lib/contracts/modules.rb
 - lib/contracts/support.rb
 - lib/contracts/testable.rb
 - lib/contracts/version.rb
+- script/rubocop.rb
 - spec/builtin_contracts_spec.rb
 - spec/contracts_spec.rb
 - spec/fixtures/fixtures.rb
 - spec/invariants_spec.rb
 - spec/module_spec.rb
+- spec/ruby_version_specific/contracts_spec_1.9.rb
+- spec/ruby_version_specific/contracts_spec_2.0.rb
+- spec/ruby_version_specific/contracts_spec_2.1.rb
 - spec/spec_helper.rb
 - spec/support.rb
+- spec/support_spec.rb
 homepage: http://github.com/egonSchiele/contracts.ruby
 licenses: []
 metadata: {}
@@ -73,3 +80,4 @@ signing_key:
 specification_version: 4
 summary: Contracts for Ruby.
 test_files: []
+has_rdoc: