contracts 0.12.0 → 0.16.1

data/features/basics/pretty-print.feature

@@ -0,0 +1,241 @@
+Feature: Pretty printing Contract violations
+
+  Scenario: Big array argument being passed to big array method parameter
+    Given a file named "example.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      class << self
+        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 run(data)
+          nil
+        end
+      end
+    end
+
+    puts Example.run([
+      ["foo", "foo"],
+      ["foo", "foo"],
+      ["foo", "foo"],
+      ["foo", "foo"],
+      ["foo", "foo"],
+      ["foo", "foo"],
+      ["foo", "foo"],
+      ["foo", "foo"],
+      ["foo", "foo"]
+    ])
+    """
+    When I run `ruby example.rb`
+    Then the output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: [(String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol)],
+            Actual: [["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"]]
+            Value guarded in: Example::run
+            With Contract: Array => NilClass
+            At: example.rb:17
+    """
+
+  Scenario: Big array value being returned from method expecting different big array type
+    Given a file named "example.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      class << self
+        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 run
+          [
+            ["foo", "foo"],
+            ["foo", "foo"],
+            ["foo", "foo"],
+            ["foo", "foo"],
+            ["foo", "foo"],
+            ["foo", "foo"],
+            ["foo", "foo"],
+            ["foo", "foo"],
+            ["foo", "foo"]
+          ]
+        end
+      end
+    end
+
+    puts Example.run
+    """
+    When I run `ruby example.rb`
+    Then the output should contain:
+    """
+    : Contract violation for return value: (ReturnContractError)
+            Expected: [(String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol),
+                       (String or Symbol)],
+            Actual: [["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"],
+                     ["foo", "foo"]]
+            Value guarded in: Example::run
+            With Contract: None => Array
+            At: example.rb:17
+    """
+
+  Scenario: Big hash argument being passed to big hash method parameter
+    Given a file named "example.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      class << self
+        Contract ({
+            a: C::Or[String, Symbol],
+            b: C::Or[String, Symbol],
+            c: C::Or[String, Symbol],
+            d: C::Or[String, Symbol],
+            e: C::Or[String, Symbol],
+            f: C::Or[String, Symbol],
+            g: C::Or[String, Symbol]
+        }) => nil
+        def run(data)
+          nil
+        end
+      end
+    end
+
+    puts Example.run({
+      a: ["foo", "foo"],
+      b: ["foo", "foo"],
+      c: ["foo", "foo"],
+      d: ["foo", "foo"],
+      e: ["foo", "foo"],
+      f: ["foo", "foo"],
+      g: ["foo", "foo"]
+    })
+    """
+    When I run `ruby example.rb`
+    Then the output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: {:a=>(String or Symbol),
+                       :b=>(String or Symbol),
+                       :c=>(String or Symbol),
+                       :d=>(String or Symbol),
+                       :e=>(String or Symbol),
+                       :f=>(String or Symbol),
+                       :g=>(String or Symbol)},
+            Actual: {:a=>["foo", "foo"],
+                     :b=>["foo", "foo"],
+                     :c=>["foo", "foo"],
+                     :d=>["foo", "foo"],
+                     :e=>["foo", "foo"],
+                     :f=>["foo", "foo"],
+                     :g=>["foo", "foo"]}
+            Value guarded in: Example::run
+            With Contract: Hash => NilClass
+            At: example.rb:17
+    """
+
+  Scenario: Big hash value being returned from method expecting different big hash type
+    Given a file named "example.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      class << self
+        Contract C::None => ({
+            a: C::Or[String, Symbol],
+            b: C::Or[String, Symbol],
+            c: C::Or[String, Symbol],
+            d: C::Or[String, Symbol],
+            e: C::Or[String, Symbol],
+            f: C::Or[String, Symbol],
+            g: C::Or[String, Symbol]
+        })
+        def run
+          {
+            a: ["foo", "foo"],
+            b: ["foo", "foo"],
+            c: ["foo", "foo"],
+            d: ["foo", "foo"],
+            e: ["foo", "foo"],
+            f: ["foo", "foo"],
+            g: ["foo", "foo"]
+          }
+        end
+      end
+    end
+
+    puts Example.run
+    """
+    When I run `ruby example.rb`
+    Then the output should contain:
+    """
+    : Contract violation for return value: (ReturnContractError)
+            Expected: {:a=>(String or Symbol),
+                       :b=>(String or Symbol),
+                       :c=>(String or Symbol),
+                       :d=>(String or Symbol),
+                       :e=>(String or Symbol),
+                       :f=>(String or Symbol),
+                       :g=>(String or Symbol)},
+            Actual: {:a=>["foo", "foo"],
+                     :b=>["foo", "foo"],
+                     :c=>["foo", "foo"],
+                     :d=>["foo", "foo"],
+                     :e=>["foo", "foo"],
+                     :f=>["foo", "foo"],
+                     :g=>["foo", "foo"]}
+            Value guarded in: Example::run
+            With Contract: None => Hash
+            At: example.rb:17
+    """

data/features/builtin_contracts/args.feature

@@ -1 +1,80 @@
-Feature: Args (TODO)
+Feature: Args
+
+  Used for `*args` (variadic functions). Takes contract and uses it to validate
+  every element passed in through `*args`.
+
+  ```ruby
+  Contract C::Args[C::Num] => C::Bool
+  def example(*args)
+  ```
+
+  This example contract will validate all arguments passed through `*args` to
+  accept only numbers.
+
+  Background:
+    Given a file named "args_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::Args[C::Num] => C::Bool
+      def only_nums(*args)
+        args.inspect
+      end
+    end
+    """
+
+  Scenario: Accepts no arguments
+    Given a file named "accepts_no_arguments.rb" with:
+    """ruby
+    require "./args_usage"
+    puts Example.new.only_nums
+    """
+    When I run `ruby accepts_no_arguments.rb`
+    Then the output should contain:
+    """
+    []
+    """
+
+  Scenario: Accepts one valid argument
+    Given a file named "accepts_one_argument.rb" with:
+    """ruby
+    require "./args_usage"
+    puts Example.new.only_nums(42)
+    """
+    When I run `ruby accepts_one_argument.rb`
+    Then the output should contain:
+    """
+    [42]
+    """
+
+  Scenario: Accepts many valid arguments
+    Given a file named "accepts_many_arguments.rb" with:
+    """ruby
+    require "./args_usage"
+    puts Example.new.only_nums(42, 45, 17, 24)
+    """
+    When I run `ruby accepts_many_arguments.rb`
+    Then the output should contain:
+    """
+    [42, 45, 17, 24]
+    """
+
+  Scenario: Rejects invalid argument
+    Given a file named "rejects_invalid_argument.rb" with:
+    """ruby
+    require "./args_usage"
+    puts Example.new.only_nums(42, "foo", 17, 24)
+    """
+    When I run `ruby rejects_invalid_argument.rb`
+    Then the output should contain:
+    """
+    : Contract violation for argument 1 of 4: (ParamContractError)
+            Expected: (Args[Contracts::Builtin::Num]),
+            Actual: "foo"
+            Value guarded in: Example::only_nums
+            With Contract: Args => Bool
+    """

data/features/builtin_contracts/int.feature

@@ -0,0 +1,93 @@
+Feature: Int
+
+  Checks that an argument is an integer.
+
+  ```ruby
+  Contract C::Int => C::Int
+  ```
+
+  Background:
+    Given a file named "int_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Integr
+      include Contracts::Core
+
+      Contract C::Int => C::Int
+      def prev(number)
+        number - 1
+      end
+    end
+    """
+
+  Scenario: Accepts positive integers
+    Given a file named "accepts_positive_integers.rb" with:
+    """ruby
+    require "./int_usage"
+    puts Integr.new.prev(7)
+    """
+    When I run `ruby accepts_positive_integers.rb`
+    Then output should contain:
+    """
+    6
+    """
+
+  Scenario: Accepts zero
+    Given a file named "accepts_zero.rb" with:
+    """ruby
+    require "./int_usage"
+    puts Integr.new.prev(1)
+    """
+    When I run `ruby accepts_zero.rb`
+    Then output should contain:
+    """
+    0
+    """
+
+  Scenario: Accepts negative integers
+    Given a file named "accepts_negative_integers.rb" with:
+    """ruby
+    require "./int_usage"
+    puts Integr.new.prev(-1)
+    """
+    When I run `ruby accepts_negative_integers.rb`
+    Then output should contain:
+    """
+    -2
+    """
+
+  Scenario: Rejects floats
+    Given a file named "rejects_floats.rb" with:
+    """ruby
+    require "./int_usage"
+    puts Integr.new.prev(3.43)
+    """
+    When I run `ruby rejects_floats.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: Int,
+            Actual: 3.43
+            Value guarded in: Integr::prev
+            With Contract: Int => Int
+    """
+    And output should contain "int_usage.rb:8"
+
+  Scenario: Rejects other values
+    Given a file named "rejects_others.rb" with:
+    """ruby
+    require "./int_usage"
+    puts Integr.new.prev("foo")
+    """
+    When I run `ruby rejects_others.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: Int,
+            Actual: "foo"
+            Value guarded in: Integr::prev
+            With Contract: Int => Int
+    """
+    And output should contain "int_usage.rb:8"

data/features/builtin_contracts/nat_pos.feature

@@ -0,0 +1,119 @@
+Feature: NatPos
+
+  Checks that an argument is a positive natural number.
+
+  ```ruby
+  Contract C::NatPos => C::NatPos
+  ```
+
+  Background:
+    Given a file named "nat_pos_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class NaturalPositive
+      include Contracts::Core
+
+      Contract C::NatPos => C::NatPos
+      def prev(number)
+        number - 1
+      end
+    end
+    """
+
+  Scenario: Accepts positive integers
+    Given a file named "accepts_positive_integers.rb" with:
+    """ruby
+    require "./nat_pos_usage"
+    puts NaturalPositive.new.prev(7)
+    """
+    When I run `ruby accepts_positive_integers.rb`
+    Then output should contain:
+    """
+    6
+    """
+
+  Scenario: Rejects zero
+    Given a file named "rejects_zero.rb" with:
+    """ruby
+    require "./nat_pos_usage"
+    puts NaturalPositive.new.prev(0)
+    """
+    When I run `ruby rejects_zero.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: NatPos,
+            Actual: 0
+            Value guarded in: NaturalPositive::prev
+            With Contract: NatPos => NatPos
+    """
+
+  Scenario: Rejects negative integers
+    Given a file named "rejects_negative_integers.rb" with:
+    """ruby
+    require "./nat_pos_usage"
+    puts NaturalPositive.new.prev(-1)
+    """
+    When I run `ruby rejects_negative_integers.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: NatPos,
+            Actual: -1
+            Value guarded in: NaturalPositive::prev
+            With Contract: NatPos => NatPos
+    """
+    And output should contain "nat_pos_usage.rb:8"
+
+  Scenario: Rejects negative integers as a return value
+    Given a file named "rejects_negative_integers.rb" with:
+    """ruby
+    require "./nat_pos_usage"
+    puts NaturalPositive.new.prev(1)
+    """
+    When I run `ruby rejects_negative_integers.rb`
+    Then output should contain:
+    """
+    : Contract violation for return value: (ReturnContractError)
+            Expected: NatPos,
+            Actual: 0
+            Value guarded in: NaturalPositive::prev
+            With Contract: NatPos => NatPos
+    """
+    And output should contain "nat_pos_usage.rb:8"
+
+  Scenario: Rejects floats
+    Given a file named "rejects_floats.rb" with:
+    """ruby
+    require "./nat_pos_usage"
+    puts NaturalPositive.new.prev(3.43)
+    """
+    When I run `ruby rejects_floats.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: NatPos,
+            Actual: 3.43
+            Value guarded in: NaturalPositive::prev
+            With Contract: NatPos => NatPos
+    """
+    And output should contain "nat_pos_usage.rb:8"
+
+  Scenario: Rejects other values
+    Given a file named "rejects_others.rb" with:
+    """ruby
+    require "./nat_pos_usage"
+    puts NaturalPositive.new.prev("foo")
+    """
+    When I run `ruby rejects_others.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: NatPos,
+            Actual: "foo"
+            Value guarded in: NaturalPositive::prev
+            With Contract: NatPos => NatPos
+    """
+    And output should contain "nat_pos_usage.rb:8"