contracts 0.12.0 → 0.16.1

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
 
@@ -141,32 +141,6 @@ RSpec.describe "Contracts:" do
       end.to raise_error(ContractError, /Expected: String/)
     end
 
-    context "when owner class does not include Contracts" do
-      let(:error) do
-        # NOTE Unable to support this user-friendly error for ruby
-        # 1.8.7 and jruby 1.8, 1.9 it has much less support for
-        # singleton inheritance hierarchy
-        if Contracts::Support.eigenclass_hierarchy_supported?
-          [Contracts::ContractsNotIncluded, Contracts::ContractsNotIncluded::DEFAULT_MESSAGE]
-        else
-          [NoMethodError, /undefined method `Contract'/]
-        end
-      end
-
-      it "fails with descriptive error" do
-        expect do
-          Class.new(GenericExample) do
-            class << self
-              Contract String => String
-              def hoge(name)
-                "super#{name}"
-              end
-            end
-          end
-        end.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 do
@@ -176,6 +150,14 @@ RSpec.describe "Contracts:" do
     end
   end
 
+  describe "usage in the singleton class of a subclass" do
+    subject { SingletonInheritanceExampleSubclass }
+
+    it "should work with a valid contract on a singleton method" do
+      expect(subject.num(1)).to eq(1)
+    end
+  end
+
   describe "no contracts feature" do
     it "disables normal contract checks" do
       object = NoContractsSimpleExample.new
@@ -655,6 +637,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")
@@ -714,7 +718,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
 
@@ -745,5 +749,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
@@ -119,6 +123,11 @@ class GenericExample
   def person_keywordargs(data)
   end
 
+  # Testing overloaded method
+  Contract String, Fixnum => nil
+  def person_keywordargs(name, age)
+  end
+
   Contract C::KeywordArgs[:hash => C::HashOf[Symbol, C::Num]] => nil
   def hash_keywordargs(data)
   end
@@ -143,6 +152,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 +296,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
@@ -621,6 +658,12 @@ class SingletonInheritanceExample
 end
 
 class SingletonInheritanceExampleSubclass < SingletonInheritanceExample
+  class << self
+    Contract Integer => Integer
+    def num(int)
+      int
+    end
+  end
 end
 
 class BareOptionalContractUsed
@@ -670,3 +713,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

@@ -120,7 +120,7 @@ RSpec.describe Contract do
       end.to raise_error(ContractError)
 
       expect(obj.greet(double("name"))).to match(
-        /hello, #\[Double "name"\]/
+        /hello, #\[.*Double.*"name"\]/
       )
     end
 

data/spec/ruby_version_specific/contracts_spec_2.0.rb

@@ -7,6 +7,11 @@ class GenericExample
   Contract ({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

@@ -7,7 +7,7 @@ RSpec.describe "Contract validators" do
     it "passes when value is in range" do
       expect do
         o.method_with_range_contract(5)
-      end.not_to raise_error(ContractError)
+      end.not_to raise_error
     end
 
     it "fails when value is not in range" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Aditya Bhargava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-20 00:00:00.000000000 Z
+date: 2021-04-17 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:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".github/workflows/code_style_checks.yaml"
+- ".github/workflows/tests.yaml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.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
@@ -49,9 +54,11 @@ files:
 - features/builtin_contracts/exactly.feature
 - features/builtin_contracts/func.feature
 - features/builtin_contracts/hash_of.feature
+- features/builtin_contracts/int.feature
 - features/builtin_contracts/keyword_args.feature
 - features/builtin_contracts/maybe.feature
 - features/builtin_contracts/nat.feature
+- features/builtin_contracts/nat_pos.feature
 - features/builtin_contracts/neg.feature
 - features/builtin_contracts/none.feature
 - features/builtin_contracts/not.feature
@@ -65,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
@@ -81,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
@@ -98,26 +107,28 @@ 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
 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.4.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Contracts for Ruby.