contracts 0.11.0 → 0.12.0

data/features/builtin_contracts/none.feature

@@ -0,0 +1,145 @@
+Feature: None
+
+  Fails for any argument.
+
+  Often used to explicitly specify that method does not accept any arguments:
+
+  ```ruby
+  Contract C::None => Symbol
+  def a_symbol
+    :a_symbol
+  end
+  ```
+
+  The same behavior can be achieved when argument list omitted:
+
+  ```ruby
+  Contract Symbol
+  def a_symbol
+    :a_symbol
+  end
+  ```
+
+  Background:
+    Given a file named "helper.rb" with:
+    """ruby
+    def autorescue
+      yield
+    rescue => e
+      puts e.inspect
+    end
+    """
+    Given a file named "none_usage.rb" with:
+    """ruby
+    require "contracts"
+    require "./helper"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::None => Symbol
+      def self.a_symbol(*args)
+        :a_symbol
+      end
+    end
+    """
+
+  Scenario: Accepts nothing
+    Given a file named "nothing.rb" with:
+    """ruby
+    require "./none_usage"
+    puts Example.a_symbol
+    """
+    When I run `ruby nothing.rb`
+    Then output should contain:
+    """
+    a_symbol
+    """
+
+  Scenario: Rejects any argument
+    Given a file named "anything.rb" with:
+    """ruby
+    require "./none_usage"
+    autorescue { Example.a_symbol(nil) }
+    autorescue { Example.a_symbol(12) }
+    autorescue { Example.a_symbol(37.5) }
+    autorescue { Example.a_symbol("foo") }
+    autorescue { Example.a_symbol(:foo) }
+    autorescue { Example.a_symbol({}) }
+    autorescue { Example.a_symbol([]) }
+    autorescue { Example.a_symbol(Object) }
+    """
+    When I run `ruby anything.rb`
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: nil
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: 12
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: 37.5
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: "foo"
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: :foo
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: {}
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: []
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """
+
+    Then output should contain:
+    """
+    ParamContractError: Contract violation for argument 1 of 1:
+            Expected: None,
+            Actual: Object
+            Value guarded in: Example::a_symbol
+            With Contract: None => Symbol
+    """

data/features/builtin_contracts/not.feature

@@ -0,0 +1 @@
+Feature: Not (TODO)

data/features/builtin_contracts/num.feature

@@ -0,0 +1,64 @@
+Feature: Num
+
+  Checks that an argument is `Numeric`.
+
+  ```ruby
+  Contract C::Num => C::Num
+  ```
+
+  Background:
+    Given a file named "num_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::Num => C::Num
+      def increase(number)
+        number + 1
+      end
+    end
+    """
+
+  Scenario: Accepts integers
+    Given a file named "accepts_integers.rb" with:
+    """ruby
+    require "./num_usage"
+    puts Example.new.increase(7)
+    """
+    When I run `ruby accepts_integers.rb`
+    Then output should contain:
+    """
+    8
+    """
+
+  Scenario: Accepts floats
+    Given a file named "accepts_floats.rb" with:
+    """ruby
+    require "./num_usage"
+    puts Example.new.increase(7.5)
+    """
+    When I run `ruby accepts_floats.rb`
+    Then output should contain:
+    """
+    8.5
+    """
+
+  Scenario: Rejects other values
+    Given a file named "rejects_others.rb" with:
+    """ruby
+    require "./num_usage"
+    puts Example.new.increase("foo")
+    """
+    When I run `ruby rejects_others.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: Num,
+            Actual: "foo"
+            Value guarded in: Example::increase
+            With Contract: Num => Num
+    """
+    And output should contain "num_usage.rb:8"

data/features/builtin_contracts/or.feature

@@ -0,0 +1,83 @@
+Feature: Or
+
+  Takes a variable number of contracts. The contract passes if any of the
+  contracts pass.
+
+  ```ruby
+  Contract C::Or[Float, C::Nat] => String
+  ```
+
+  This example will validate first argument of a method and accept either
+  `Float` or natural integer.
+
+  Background:
+    Given a file named "or_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::Or[Float, C::Nat] => String
+      def nat_string(number)
+        number.to_i.to_s
+      end
+    end
+    """
+
+  Scenario: Accepts float
+    Given a file named "accepts_float.rb" with:
+    """ruby
+    require "./or_usage"
+    puts Example.new.nat_string(3.7)
+    """
+    When I run `ruby accepts_float.rb`
+    Then output should contain:
+    """
+    3
+    """
+
+  Scenario: Accepts natural
+    Given a file named "accepts_natural.rb" with:
+    """ruby
+    require "./or_usage"
+    puts Example.new.nat_string(7)
+    """
+    When I run `ruby accepts_natural.rb`
+    Then output should contain:
+    """
+    7
+    """
+
+  Scenario: Rejects negative integer
+    Given a file named "rejects_negative_integer.rb" with:
+    """ruby
+    require "./or_usage"
+    puts Example.new.nat_string(-3)
+    """
+    When I run `ruby rejects_negative_integer.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (Float or Nat),
+            Actual: -3
+            Value guarded in: Example::nat_string
+            With Contract: Or => String
+    """
+
+  Scenario: Rejects other values
+    Given a file named "rejects_other.rb" with:
+    """ruby
+    require "./or_usage"
+    puts Example.new.nat_string(nil)
+    """
+    When I run `ruby rejects_other.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (Float or Nat),
+            Actual: nil
+            Value guarded in: Example::nat_string
+            With Contract: Or => String
+    """

data/features/builtin_contracts/pos.feature

@@ -0,0 +1,116 @@
+Feature: Pos
+
+  Checks that an argument is positive `Numeric`.
+
+  ```ruby
+  Contract C::Pos => C::Pos
+  ```
+
+  Background:
+    Given a file named "pos_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::Pos, C::Pos => C::Pos
+      def power(number, power)
+        return number if power <= 1
+        number * self.power(number, power - 1)
+      end
+    end
+    """
+
+  Scenario: Accepts positive integers
+    Given a file named "accepts_positive_integers.rb" with:
+    """ruby
+    require "./pos_usage"
+    puts Example.new.power(3, 4)
+    """
+    When I run `ruby accepts_positive_integers.rb`
+    Then output should contain:
+    """
+    81
+    """
+
+  Scenario: Accepts positive floats
+    Given a file named "accepts_positive_floats.rb" with:
+    """ruby
+    require "./pos_usage"
+    puts Example.new.power(3.7, 4.5)
+    """
+    When I run `ruby accepts_positive_floats.rb`
+    Then output should contain:
+    """
+    693.4395
+    """
+
+  Scenario: Rejects negative integers
+    Given a file named "rejects_negative_integers.rb" with:
+    """ruby
+    require "./pos_usage"
+    puts Example.new.power(3, -4)
+    """
+    When I run `ruby rejects_negative_integers.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 2 of 2: (ParamContractError)
+            Expected: Pos,
+            Actual: -4
+            Value guarded in: Example::power
+            With Contract: Pos, Pos => Pos
+    """
+    And output should contain "pos_usage.rb:8"
+
+  Scenario: Rejects negative floats
+    Given a file named "rejects_negative_floats.rb" with:
+    """ruby
+    require "./pos_usage"
+    puts Example.new.power(3.7, -4.4)
+    """
+    When I run `ruby rejects_negative_floats.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 2 of 2: (ParamContractError)
+            Expected: Pos,
+            Actual: -4.4
+            Value guarded in: Example::power
+            With Contract: Pos, Pos => Pos
+    """
+    And output should contain "pos_usage.rb:8"
+
+  Scenario: Rejects zero
+    Given a file named "rejects_zero.rb" with:
+    """ruby
+    require "./pos_usage"
+    puts Example.new.power(3, 0)
+    """
+    When I run `ruby rejects_zero.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 2 of 2: (ParamContractError)
+            Expected: Pos,
+            Actual: 0
+            Value guarded in: Example::power
+            With Contract: Pos, Pos => Pos
+    """
+    And output should contain "pos_usage.rb:8"
+
+  Scenario: Rejects other values
+    Given a file named "rejects_others.rb" with:
+    """ruby
+    require "./pos_usage"
+    puts Example.new.power("foo", 2)
+    """
+    When I run `ruby rejects_others.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 2: (ParamContractError)
+            Expected: Pos,
+            Actual: "foo"
+            Value guarded in: Example::power
+            With Contract: Pos, Pos => Pos
+    """
+    And output should contain "pos_usage.rb:8"

data/features/builtin_contracts/range_of.feature

@@ -0,0 +1 @@
+Feature: RangeOf (TODO)

data/features/builtin_contracts/respond_to.feature

@@ -0,0 +1,78 @@
+Feature: RespondTo
+
+  Takes a variable number of method names as symbols. The contract passes if
+  the argument responds to all of those methods.
+
+  ```ruby
+  Contract C::RespondTo[:email, :password, :confirmation] => C::Bool
+  ```
+
+  This contract will pass only for objects that `respond_to?` `:email`,
+  `:password` and `:confirmation`.
+
+  Background:
+    Given a file named "signup_validator.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class SignupValidator
+      include Contracts::Core
+
+      Contract C::RespondTo[:email, :password, :confirmation] => C::Bool
+      def valid?(signup)
+        !!signup.email.match("@") &&
+          signup.password.length > 6 &&
+          signup.password == signup.confirmation
+      end
+    end
+    """
+
+    Given a file named "signup.rb" with:
+    """ruby
+    Signup = Struct.new(:email, :password, :confirmation)
+    """
+
+    Given a file named "signin.rb" with:
+    """ruby
+    Signin = Struct.new(:email, :password)
+    """
+
+    Given a file named "helper.rb" with:
+    """ruby
+    require "./signup_validator"
+    require "./signup"
+    require "./signin"
+    """
+
+  Scenario: Accepts correct object
+    Given a file named "correct.rb" with:
+    """ruby
+    require "./helper"
+
+    puts SignupValidator.new.valid?(Signup["john@example.org", "welcome", "welcome"])
+    puts SignupValidator.new.valid?(Signup["john@example.org", "welcome", "welcomr"])
+    """
+    When I run `ruby correct.rb`
+    Then output should contain:
+    """
+    true
+    false
+    """
+
+  Scenario: Rejects incorrect object
+    Given a file named "incorrect.rb" with:
+    """ruby
+    require "./helper"
+
+    puts SignupValidator.new.valid?(Signin["john@example.org", "welcome"])
+    """
+    When I run `ruby incorrect.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (a value that responds to [:email, :password, :confirmation]),
+            Actual: #<struct Signin email="john@example.org", password="welcome">
+            Value guarded in: SignupValidator::valid?
+            With Contract: RespondTo => Bool
+    """