contracts 0.13.0 → 0.17

data/spec/contracts_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe "Contracts:" do
     it "should fail for insufficient arguments" do
       expect do
         @o.hello
-      end.to raise_error
+      end.to raise_error ArgumentError
     end
 
     it "should fail for insufficient contracts" do
@@ -32,7 +32,7 @@ RSpec.describe "Contracts:" do
             1
           end
         end
-      end.to raise_error
+      end.to raise_error NameError
     end
   end
 
@@ -349,19 +349,19 @@ RSpec.describe "Contracts:" do
 
   describe "Hashes" do
     it "should pass for exact correct input" do
-      expect { @o.person(:name => "calvin", :age => 10) }.to_not raise_error
+      expect { @o.person({ :name => "calvin", :age => 10 }) }.to_not raise_error
     end
 
     it "should pass even if some keys don't have contracts" do
-      expect { @o.person(:name => "calvin", :age => 10, :foo => "bar") }.to_not raise_error
+      expect { @o.person({ :name => "calvin", :age => 10, :foo => "bar" }) }.to_not raise_error
     end
 
     it "should fail if a key with a contract on it isn't provided" do
-      expect { @o.person(:name => "calvin") }.to raise_error(ContractError)
+      expect { @o.person({ :name => "calvin" }) }.to raise_error(ContractError)
     end
 
     it "should fail for incorrect input" do
-      expect { @o.person(:name => 50, :age => 10) }.to raise_error(ContractError)
+      expect { @o.person({ :name => 50, :age => 10 }) }.to raise_error(ContractError)
     end
   end
 
@@ -612,16 +612,19 @@ RSpec.describe "Contracts:" do
 
     it "should contain to_s representation within a Hash contract" do
       expect do
-        @o.hash_complex_contracts(:rigged => "bad")
+        @o.hash_complex_contracts({ :rigged => "bad" })
       end.to raise_error(ContractError, not_s(delim "TrueClass or FalseClass"))
     end
 
     it "should contain to_s representation within a nested Hash contract" do
       expect do
-        @o.nested_hash_complex_contracts(:rigged => true,
-                                         :contents => {
-                                           :kind => 0,
-                                           :total => 42 })
+        @o.nested_hash_complex_contracts({
+          :rigged => true,
+          :contents => {
+            :kind => 0,
+            :total => 42,
+          },
+        })
       end.to raise_error(ContractError, not_s(delim "String or Symbol"))
     end
 
@@ -637,6 +640,28 @@ RSpec.describe "Contracts:" do
       end.to raise_error(ContractError, not_s(delim "String or Symbol"))
     end
 
+    it "should wrap and pretty print for long param contracts" do
+      expect do
+        @o.long_array_param_contracts(true)
+      end.to(
+        raise_error(
+          ParamContractError,
+          /\[\(String or Symbol\),\n                   \(String or Symbol\),/
+        )
+      )
+    end
+
+    it "should wrap and pretty print for long return contracts" do
+      expect do
+        @o.long_array_return_contracts
+      end.to(
+        raise_error(
+          ReturnContractError,
+          /\[\(String or Symbol\),\n                   \(String or Symbol\),/
+        )
+      )
+    end
+
     it "should not contain Contracts:: module prefix" do
       expect do
         @o.double("bad")
@@ -696,7 +721,7 @@ RSpec.describe "Contracts:" do
     it "should apply the contract to an inherited method" do
       c = Child.new
       expect { c.double(2) }.to_not raise_error
-      expect { c.double("asd") }.to raise_error
+      expect { c.double("asd") }.to raise_error ParamContractError
     end
   end
 
@@ -727,5 +752,22 @@ RSpec.describe "Contracts:" do
     it "works correctly with methods with passing contracts" do
       expect { klass.new.foo(42) }.to raise_error(ContractError, /Expected: String/)
     end
+
+    # See the discussion on this issue:
+    # https://github.com/egonSchiele/contracts.ruby/issues/229
+    it "should not fail with 'undefined method 'Contract''" do
+      expect do
+        class ModuleThenContracts
+          include ModuleWithContracts
+          include Contracts::Core
+
+          # fails on this line
+          Contract C::Num => C::Num
+          def double(x)
+            x * 2
+          end
+        end
+      end.to_not raise_error
+    end
   end
 end

data/spec/fixtures/fixtures.rb

@@ -104,6 +104,10 @@ class GenericExample
   def person(data)
   end
 
+  Contract C::StrictHash[{ :name => String, :age => Fixnum }] => nil
+  def strict_person(data)
+  end
+
   Contract ({ :rigged => C::Or[TrueClass, FalseClass] }) => nil
   def hash_complex_contracts(data)
   end
@@ -116,11 +120,11 @@ class GenericExample
   end
 
   Contract C::KeywordArgs[:name => String, :age => Fixnum] => nil
-  def person_keywordargs(data)
+  def person_keywordargs(name: "name", age: 10)
   end
 
   Contract C::KeywordArgs[:hash => C::HashOf[Symbol, C::Num]] => nil
-  def hash_keywordargs(data)
+  def hash_keywordargs(hash:)
   end
 
   Contract (/foo/) => nil
@@ -143,6 +147,30 @@ class GenericExample
   def nested_array_complex_contracts(data)
   end
 
+  Contract [
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol]
+  ] => nil
+  def long_array_param_contracts(data)
+  end
+
+  Contract C::None => [
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol],
+    C::Or[String, Symbol]
+  ]
+  def long_array_return_contracts
+  end
+
   Contract Proc => C::Any
   def do_call(&block)
     block.call
@@ -263,6 +291,10 @@ class GenericExample
     r.first
   end
 
+  Contract C::DescendantOf[Enumerable] => nil
+  def enumerable_descendant_test(enum)
+  end
+
   Contract C::Bool => nil
   def bool_test(x)
   end
@@ -676,3 +708,18 @@ module ModuleContractExample
     :world
   end
 end
+
+module ModuleWithContracts
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    include Contracts::Core
+
+    Contract C::None => String
+    def foo
+      "bar"
+    end
+  end
+end

data/spec/methods_spec.rb

@@ -0,0 +1,54 @@
+RSpec.describe "Contracts:" do
+  describe "method called with blocks" do
+    module FuncTest
+      include Contracts::Core
+      include Contracts::Builtin
+
+      Contract Func[Num=>Num] => nil
+      def foo(&blk)
+        _ = blk.call(2)
+        nil
+      end
+
+      Contract Num, Func[Num=>Num] => nil
+      def foo2(a, &blk)
+        _ = blk.call(2)
+        nil
+      end
+
+      Contract Func[Num=>Num] => nil
+      def bar(blk)
+        _ = blk.call(2)
+        nil
+      end
+
+      Contract Num, Func[Num=>Num] => nil
+      def bar2(a, blk)
+        _ = blk.call(2)
+        nil
+      end
+    end
+
+    def obj
+      Object.new.tap do |o|
+        o.extend(FuncTest)
+      end
+    end
+
+    it "should enforce return value inside block with no other parameter" do
+      expect { obj.foo(&:to_s) }.to raise_error ReturnContractError
+    end
+
+    it "should enforce return value inside block with other parameter" do
+      expect { obj.foo2(2) { |x| x.to_s } }.to raise_error ReturnContractError
+    end
+
+    it "should enforce return value inside lambda with no other parameter" do
+      expect { obj.bar lambda { |x| x.to_s } }.to raise_error ReturnContractError
+    end
+
+    it "should enforce return value inside lambda with other parameter" do
+      expect { obj.bar2(2, lambda { |x| x.to_s }) }.to raise_error ReturnContractError
+    end
+  end
+end

data/spec/override_validators_spec.rb

@@ -30,15 +30,15 @@ RSpec.describe Contract do
       obj = klass.new
 
       expect do
-        obj.something(:a => 35, :b => "hello")
+        obj.something({ :a => 35, :b => "hello" })
       end.to raise_error(ContractError)
 
       expect do
-        obj.something(
+        obj.something({
           :a => 35,
           :b => "hello",
           :it_is_a_hash => true
-        )
+        })
       end.not_to raise_error
     end
 

data/spec/ruby_version_specific/contracts_spec_2.0.rb

@@ -1,12 +1,17 @@
 class GenericExample
-  Contract C::Args[String], { repeat: C::Maybe[C::Num] } => C::ArrayOf[String]
+  Contract C::Args[String], C::KeywordArgs[ repeat: C::Maybe[C::Num] ] => C::ArrayOf[String]
   def splat_then_optional_named(*vals, repeat: 2)
     vals.map { |v| v * repeat }
   end
 
-  Contract ({foo: C::Nat}) => nil
+  Contract C::KeywordArgs[ foo: C::Nat ] => nil
   def nat_test_with_kwarg(foo: 10)
   end
+
+  Contract C::KeywordArgs[name: C::Optional[String]], C::Func[String => String] => String
+  def keyword_args_hello(name: "Adit", &block)
+    "Hey, #{yield name}!"
+  end
 end
 
 RSpec.describe "Contracts:" do
@@ -37,4 +42,14 @@ RSpec.describe "Contracts:" do
       expect { @o.nat_test_with_kwarg }.to raise_error(ContractError)
     end
   end
+
+  describe "keyword args with defaults, with a block" do
+    it "should work when both keyword args and a block is given" do
+      expect(@o.keyword_args_hello(name: "maggie", &:upcase)).to eq("Hey, MAGGIE!")
+    end
+
+    it "should work even when keyword args aren't given" do
+      expect(@o.keyword_args_hello(&:upcase)).to eq("Hey, ADIT!")
+    end
+  end
 end

data/spec/ruby_version_specific/contracts_spec_2.1.rb

@@ -51,7 +51,7 @@ RSpec.describe "Contracts:" do
         end.to raise_error(ContractError)
       end
 
-      it "should fail when passed nil to an optional argument which contract shouldnt accept nil" do
+      it "should fail when passed nil to an optional argument which contract shouldn't accept nil" do
         expect do
           @o.complicated("a", true, :b, :c, 2.0, e: (1..5), f: nil, g: :d) do |x|
             x

data/spec/validators_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe "Contract validators" do
 
     describe "within a hash" do
       it "should pass for a matching string" do
-        expect { o.hash_containing_foo(:host => "foo.example.org") }.to_not raise_error
+        expect { o.hash_containing_foo({ :host => "foo.example.org" }) }.to_not raise_error
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: '0.17'
 platform: ruby
 authors:
 - Aditya Bhargava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2021-05-07 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
@@ -18,12 +18,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/code_style_checks.yaml"
+- ".github/workflows/tests.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.markdown
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - TODO.markdown
@@ -35,8 +38,10 @@ files:
 - benchmarks/wrap_test.rb
 - contracts.gemspec
 - cucumber.yml
+- dependabot.yml
 - features/README.md
 - features/basics/functype.feature
+- features/basics/pretty-print.feature
 - features/basics/simple_example.feature
 - features/builtin_contracts/README.md
 - features/builtin_contracts/and.feature
@@ -67,6 +72,7 @@ files:
 - features/builtin_contracts/xor.feature
 - features/support/env.rb
 - lib/contracts.rb
+- lib/contracts/attrs.rb
 - lib/contracts/builtin_contracts.rb
 - lib/contracts/call_with.rb
 - lib/contracts/core.rb
@@ -83,14 +89,15 @@ files:
 - lib/contracts/support.rb
 - lib/contracts/validators.rb
 - lib/contracts/version.rb
-- script/cucumber
 - script/docs-release
 - script/docs-staging
 - script/rubocop.rb
+- spec/attrs_spec.rb
 - spec/builtin_contracts_spec.rb
 - spec/contracts_spec.rb
 - spec/fixtures/fixtures.rb
 - spec/invariants_spec.rb
+- spec/methods_spec.rb
 - spec/module_spec.rb
 - spec/override_validators_spec.rb
 - spec/ruby_version_specific/contracts_spec_1.9.rb
@@ -100,10 +107,13 @@ files:
 - spec/support.rb
 - spec/support_spec.rb
 - spec/validators_spec.rb
-homepage: http://github.com/egonSchiele/contracts.ruby
-licenses: []
+homepage: https://github.com/egonSchiele/contracts.ruby
+licenses:
+- BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message: "\n    0.16.x will be the supporting Ruby 2.x and be feature
+  frozen (only fixes will be released)\n    For Ruby 3.x use 0.17.x or later (might
+  not be released yet)\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -111,15 +121,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Contracts for Ruby.

data/script/cucumber

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-if ruby -e 'exit(1) unless RUBY_VERSION.to_f >= 2.0'; then
-  bundle exec cucumber
-fi