1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
|
require "date"
C = Contracts
class A
include Contracts::Core
Contract C::Num => C::Num
def self.a_class_method x
x + 1
end
def good
true
end
Contract C::Num => C::Num
def triple x
x * 3
end
Contract C::Num => C::Num
def instance_and_class_method x
x * 2
end
Contract String => String
def self.instance_and_class_method x
x * 2
end
end
class B
include Contracts::Core
def bad
false
end
Contract String => String
def triple x
x * 3
end
end
class F
include Contracts::Core
def good
false
end
def bad
true
end
end
class EmptyCont
def self.to_s
""
end
end
class GenericExample
include Contracts::Core
Contract C::Num => C::Num
def self.a_class_method x
x + 1
end
Contract C::Num => nil
def bad_double(x)
x * 2
end
Contract C::Num => C::Num
def double(x)
x * 2
end
Contract 123, nil => nil
def constanty(num, nul)
0
end
Contract String => nil
def hello(name)
end
Contract lambda { |x| x.is_a? Numeric } => C::Num
def square(x)
x ** 2
end
Contract [C::Num, C::Num, C::Num] => C::Num
def sum_three(vals)
vals.inject(0) do |acc, x|
acc + x
end
end
Contract ({ :name => String, :age => Integer }) => nil
def person(data)
end
Contract C::StrictHash[{ :name => String, :age => Integer }] => nil
def strict_person(data)
end
Contract ({ :rigged => C::Or[TrueClass, FalseClass] }) => nil
def hash_complex_contracts(data)
end
Contract ({ :rigged => C::Bool,
:contents => { :kind => C::Or[String, Symbol],
:total => C::Num }
}) => nil
def nested_hash_complex_contracts(data)
end
Contract C::KeywordArgs[:name => String, :age => Integer] => nil
def person_keywordargs(name: "name", age: 10)
end
Contract C::KeywordArgs[:hash => C::HashOf[Symbol, C::Num]] => nil
def hash_keywordargs(hash:)
end
Contract (/foo/) => nil
def should_contain_foo(s)
end
Contract ({ :host => /foo/ }) => nil
def hash_containing_foo(s)
end
Contract C::ArrayOf[/foo/] => nil
def array_containing_foo(s)
end
Contract [C::Or[TrueClass, FalseClass]] => nil
def array_complex_contracts(data)
end
Contract [C::Bool, [C::Or[String, Symbol]]] => nil
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
end
Contract C::Args[C::Num], C::Maybe[Proc] => C::Any
def maybe_call(*vals, &block)
block.call if block
vals
end
Contract C::Args[C::Num] => C::Num
def sum(*vals)
vals.inject(0) do |acc, val|
acc + val
end
end
Contract C::Args[C::Num], Proc => C::Num
def with_partial_sums(*vals, &blk)
sum = vals.inject(0) do |acc, val|
blk[acc]
acc + val
end
blk[sum]
end
Contract C::Args[C::Num], C::Func[C::Num => C::Num] => C::Num
def with_partial_sums_contracted(*vals, &blk)
sum = vals.inject(0) do |acc, val|
blk[acc]
acc + val
end
blk[sum]
end
# Important to use different arg types or it falsely passes
Contract C::Num, C::Args[String] => C::ArrayOf[String]
def arg_then_splat(n, *vals)
vals.map { |v| v * n }
end
Contract C::Num, Proc => nil
def double_with_proc(x, &blk)
blk.call(x * 2)
nil
end
Contract C::Pos => nil
def pos_test(x)
end
Contract C::Neg => nil
def neg_test(x)
end
Contract C::Nat => nil
def nat_test(x)
end
Contract C::Any => nil
def show(x)
end
Contract C::None => nil
def fail_all(x)
end
Contract C::Or[C::Num, String] => nil
def num_or_string(x)
end
Contract C::Xor[C::RespondTo[:good], C::RespondTo[:bad]] => nil
def xor_test(x)
end
Contract C::And[A, C::RespondTo[:good]] => nil
def and_test(x)
end
Contract C::Enum[:a, :b, :c] => nil
def enum_test(x)
end
Contract C::RespondTo[:good] => nil
def responds_test(x)
end
Contract C::Send[:good] => nil
def send_test(x)
end
Contract C::Not[nil] => nil
def not_nil(x)
end
Contract C::ArrayOf[C::Num] => C::Num
def product(vals)
vals.inject(1) do |acc, x|
acc * x
end
end
Contract C::SetOf[C::Num] => C::Num
def product_from_set(vals)
vals.inject(1) do |acc, x|
acc * x
end
end
Contract C::RangeOf[C::Num] => C::Num
def first_in_range_num(r)
r.first
end
Contract C::RangeOf[Date] => Date
def first_in_range_date(r)
r.first
end
Contract C::DescendantOf[Enumerable] => nil
def enumerable_descendant_test(enum)
end
Contract C::Bool => nil
def bool_test(x)
end
Contract C::Num
def no_args
1
end
# This function has a contract which says it has no args,
# but the function does have args.
Contract nil => C::Num
def old_style_no_args
2
end
Contract C::ArrayOf[C::Num], C::Func[C::Num => C::Num] => C::ArrayOf[C::Num]
def map(arr, func)
ret = []
arr.each do |x|
ret << func[x]
end
ret
end
Contract C::ArrayOf[C::Any], Proc => C::ArrayOf[C::Any]
def tutorial_map(arr, func)
ret = []
arr.each do |x|
ret << func[x]
end
ret
end
# Need to test Func with weak contracts for other args
# and changing type from input to output otherwise it falsely passes!
Contract Array, C::Func[String => C::Num] => Array
def map_plain(arr, func)
arr.map do |x|
func[x]
end
end
Contract C::None => C::Func[String => C::Num]
def lambda_with_wrong_return
lambda { |x| x }
end
Contract C::None => C::Func[String => C::Num]
def lambda_with_correct_return
lambda { |x| x.length }
end
Contract C::Num => C::Num
def default_args(x = 1)
2
end
Contract C::Maybe[C::Num] => C::Maybe[C::Num]
def maybe_double x
if x.nil?
nil
else
x * 2
end
end
Contract C::HashOf[Symbol, C::Num] => C::Num
def gives_max_value(hash)
hash.values.max
end
Contract C::HashOf[Symbol => C::Num] => C::Num
def pretty_gives_max_value(hash)
hash.values.max
end
Contract EmptyCont => C::Any
def using_empty_contract(a)
a
end
Contract (1..10) => nil
def method_with_range_contract(x)
end
Contract String
def a_private_method
"works"
end
private :a_private_method
Contract String
def a_protected_method
"works"
end
protected :a_protected_method
private
Contract String
def a_really_private_method
"works for sure"
end
protected
Contract String
def a_really_protected_method
"works for sure"
end
end
# for testing inheritance
class Parent
include Contracts::Core
Contract C::Num => C::Num
def double x
x * 2
end
end
class Child < Parent
end
class GenericExample
Contract Parent => Parent
def id_ a
a
end
Contract C::Exactly[Parent] => nil
def exactly_test(x)
end
end
# for testing equality
class Foo
end
module Bar
end
Baz = 1
class GenericExample
Contract C::Eq[Foo] => C::Any
def eq_class_test(x)
end
Contract C::Eq[Bar] => C::Any
def eq_module_test(x)
end
Contract C::Eq[Baz] => C::Any
def eq_value_test(x)
end
end
# pattern matching example with possible deep contract violation
class PatternMatchingExample
include Contracts::Core
class Success
attr_accessor :request
def initialize request
@request = request
end
def ==(other)
request == other.request
end
end
class Failure
end
Response = C::Or[Success, Failure]
class StringWithHello
def self.valid?(string)
string.is_a?(String) && !!string.match(/hello/i)
end
end
Contract Success => Response
def process_request(status)
Success.new(decorated_request(status.request))
end
Contract Failure => Response
def process_request(status)
Failure.new
end
Contract StringWithHello => String
def decorated_request(request)
request + "!"
end
Contract C::Num, String => String
def do_stuff(number, string)
"foo"
end
Contract C::Num, String, C::Num => String
def do_stuff(number, string, other_number)
"bar"
end
Contract C::Num => C::Num
def double x
"bad"
end
Contract String => String
def double x
x * 2
end
end
# invariant example (silliest implementation ever)
class MyBirthday
include Contracts::Core
include Contracts::Invariants
invariant(:day) { 1 <= day && day <= 31 }
invariant(:month) { 1 <= month && month <= 12 }
attr_accessor :day, :month
def initialize(day, month)
@day = day
@month = month
end
Contract C::None => Integer
def silly_next_day!
self.day += 1
end
Contract C::None => Integer
def silly_next_month!
self.month += 1
end
Contract C::None => Integer
def clever_next_day!
return clever_next_month! if day == 31
self.day += 1
end
Contract C::None => Integer
def clever_next_month!
return next_year! if month == 12
self.month += 1
self.day = 1
end
Contract C::None => Integer
def next_year!
self.month = 1
self.day = 1
end
end
class SingletonClassExample
# This turned out to be required line here to make singleton classes
# work properly under all platforms. Not sure if it worth trying to
# do something with it.
include Contracts::Core
class << self
Contract String => String
def hoge(str)
"super#{str}"
end
Contract C::Num, C::Num => C::Num
def add(a, b)
a + b
end
end
end
with_enabled_no_contracts do
class NoContractsSimpleExample
include Contracts::Core
Contract String => nil
def some_method(x)
nil
end
end
class NoContractsInvariantsExample
include Contracts::Core
include Contracts::Invariants
attr_accessor :day
invariant(:day_rule) { 1 <= day && day <= 7 }
Contract C::None => nil
def next_day
self.day += 1
end
end
class NoContractsPatternMatchingExample
include Contracts::Core
Contract 200, String => String
def on_response(status, body)
body + "!"
end
Contract Integer, String => String
def on_response(status, body)
"error #{status}: #{body}"
end
end
end
module ModuleExample
include Contracts::Core
Contract C::Num, C::Num => C::Num
def plus(a, b)
a + b
end
Contract String => String
def self.hoge(str)
"super#{str}"
end
class << self
Contract String => nil
def eat(food)
# yummy
nil
end
end
end
class KlassWithModuleExample
include ModuleExample
end
class SingletonInheritanceExample
include Contracts::Core
Contract C::Any => C::Any
def self.a_contracted_self
self
end
end
class SingletonInheritanceExampleSubclass < SingletonInheritanceExample
class << self
Contract Integer => Integer
def num(int)
int
end
end
end
class BareOptionalContractUsed
include Contracts::Core
Contract C::Num, C::Optional[C::Num] => nil
def something(a, b)
nil
end
end
module ModuleContractExample
include Contracts::Core
module AModule
end
module AnotherModule
end
module InheritedModule
include AModule
end
class AClassWithModule
include AModule
end
class AClassWithoutModule
end
class AClassWithAnotherModule
include AnotherModule
end
class AClassWithInheritedModule
include InheritedModule
end
class AClassWithBothModules
include AModule
include AnotherModule
end
Contract AModule => Symbol
def self.hello(thing)
: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
|