entitlements 0.1.8 → 0.2.0

data/lib/contracts-ruby3/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/lib/contracts-ruby3/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/lib/contracts-ruby3/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/lib/contracts-ruby3/features/builtin_contracts/range_of.feature

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

data/lib/contracts-ruby3/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
+    """

data/lib/contracts-ruby3/features/builtin_contracts/send.feature

@@ -0,0 +1,147 @@
+Feature: Send
+
+  Takes a variable number of method names as symbols. Given an argument, all of
+  those methods are called on the argument one by one. If they all return true,
+  the contract passes.
+
+  ```ruby
+  Contract C::Send[:valid?, :has_items?] => C::ArrayOf[Item]
+  ```
+
+  This contract will pass only if:
+  `arg.valid? == true && arg.has_items? == true`,
+  where `arg` is the first argument.
+
+  Background:
+    Given a file named "item.rb" with:
+    """ruby
+    Item = Struct.new(:name, :cost)
+    Item::DEFAULT = Item["default", 0]
+    """
+
+    Given a file named "send_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+    require "./item"
+
+    class FetchItemCommand
+      include Contracts::Core
+
+      Contract C::Send[:valid?, :has_items?] => C::ArrayOf[Item]
+      def call(subject)
+        ([Item::DEFAULT] + subject.items).uniq
+      end
+    end
+    """
+
+  Scenario: All methods return `true`
+    Given a file named "box.rb" with:
+    """ruby
+    class Box
+      def valid?
+        true
+      end
+
+      def has_items?
+        true
+      end
+
+      def items
+        [Item["cat", 599.99]]
+      end
+    end
+
+    require "./send_usage"
+    p FetchItemCommand.new.call(Box.new)
+    """
+    When I run `ruby box.rb`
+    Then output should contain:
+    """
+    [#<struct Item name="default", cost=0>, #<struct Item name="cat", cost=599.99>]
+    """
+
+  Scenario: When second method returns `false`
+    Given a file named "cat.rb" with:
+    """ruby
+    class Cat
+      def valid?
+        true
+      end
+
+      def has_items?
+        false
+      end
+    end
+
+    require "./send_usage"
+    p FetchItemCommand.new.call(Cat.new)
+    """
+    When I run `ruby cat.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (a value that returns true for all of [:valid?, :has_items?]),
+    """
+    And output should contain:
+    """
+    Actual: #<Cat
+    """
+
+  Scenario: When first method returns `false`
+    Given a file named "invalid.rb" with:
+    """ruby
+    class Invalid
+      def valid?
+        false
+      end
+
+      def has_items?
+        true
+      end
+
+      def items
+        []
+      end
+    end
+
+    require "./send_usage"
+    p FetchItemCommand.new.call(Invalid.new)
+    """
+    When I run `ruby invalid.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (a value that returns true for all of [:valid?, :has_items?]),
+    """
+    And output should contain:
+    """
+    Actual: #<Invalid
+    """
+
+  Scenario: When all methods return `false`
+    Given a file named "nothing.rb" with:
+    """ruby
+    class Nothing
+      def valid?
+        false
+      end
+
+      def has_items?
+        false
+      end
+    end
+
+    require "./send_usage"
+    p FetchItemCommand.new.call(Nothing.new)
+    """
+    When I run `ruby nothing.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (a value that returns true for all of [:valid?, :has_items?]),
+    """
+    And output should contain:
+    """
+    Actual: #<Nothing
+    """

data/lib/contracts-ruby3/features/builtin_contracts/set_of.feature

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

data/lib/contracts-ruby3/features/builtin_contracts/xor.feature

@@ -0,0 +1,99 @@
+Feature: Xor
+
+  Takes a variable number of contracts. The contract passes if one and only one
+  of the contracts pass.
+
+  ```ruby
+  Contract C::Xor[Float, C::Neg] => String
+  ```
+
+  This example will validate first argument of a method and accept either
+  `Float` or natural integer, but not both.
+
+  Background:
+    Given a file named "xor_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::Xor[Float, C::Neg] => String
+      def strange_number(number)
+        number.to_i.to_s
+      end
+    end
+    """
+
+  Scenario: Accepts float
+    Given a file named "accepts_float.rb" with:
+    """ruby
+    require "./xor_usage"
+    puts Example.new.strange_number(3.7)
+    """
+    When I run `ruby accepts_float.rb`
+    Then output should contain:
+    """
+    3
+    """
+
+  Scenario: Accepts negative integer
+    Given a file named "accepts_negative_integer.rb" with:
+    """ruby
+    require "./xor_usage"
+    puts Example.new.strange_number(-7)
+    """
+    When I run `ruby accepts_negative_integer.rb`
+    Then output should contain:
+    """
+    -7
+    """
+
+  Scenario: Rejects negative float
+    Given a file named "rejects_negative_float.rb" with:
+    """ruby
+    require "./xor_usage"
+    puts Example.new.strange_number(-3.5)
+    """
+    When I run `ruby rejects_negative_float.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (Float xor Neg),
+            Actual: -3.5
+            Value guarded in: Example::strange_number
+            With Contract: Xor => String
+    """
+
+  Scenario: Rejects positive integer
+    Given a file named "rejects_positive_integer.rb" with:
+    """ruby
+    require "./xor_usage"
+    puts Example.new.strange_number(9)
+    """
+    When I run `ruby rejects_positive_integer.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (Float xor Neg),
+            Actual: 9
+            Value guarded in: Example::strange_number
+            With Contract: Xor => String
+    """
+
+  Scenario: Rejects other values
+    Given a file named "rejects_other.rb" with:
+    """ruby
+    require "./xor_usage"
+    puts Example.new.strange_number(:foo)
+    """
+    When I run `ruby rejects_other.rb`
+    Then output should contain:
+    """
+    : Contract violation for argument 1 of 1: (ParamContractError)
+            Expected: (Float xor Neg),
+            Actual: :foo
+            Value guarded in: Example::strange_number
+            With Contract: Xor => String
+    """

data/lib/contracts-ruby3/features/support/env.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "aruba/cucumber"
+require "aruba/jruby" if RUBY_PLATFORM == "java"
+
+Before do
+  @aruba_timeout_seconds = RUBY_PLATFORM == "java" ? 30 : 5
+end

data/lib/contracts-ruby3/lib/contracts/attrs.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Contracts
+  module Attrs
+    def attr_reader_with_contract(*names, contract)
+      names.each do |name|
+        Contract Contracts::None => contract
+        attr_reader(name)
+      end
+    end
+
+    def attr_writer_with_contract(*names, contract)
+      names.each do |name|
+        Contract contract => contract
+        attr_writer(name)
+      end
+    end
+
+    def attr_accessor_with_contract(*names, contract)
+      attr_reader_with_contract(*names, contract)
+      attr_writer_with_contract(*names, contract)
+    end
+  end
+
+  include Attrs
+end