contracts 0.4 → 0.5

data/spec/fixtures/fixtures.rb

@@ -0,0 +1,276 @@
+include Contracts
+
+class A
+
+  Contract Num => Num
+  def self.a_class_method x
+    x + 1
+  end
+
+  def good
+    true
+  end
+
+  Contract Num => Num
+  def triple x
+    x * 3
+  end
+
+  Contract Num => 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
+  def bad
+    false
+  end
+
+  Contract String => String
+  def triple x
+    x * 3
+  end
+end
+
+class C
+  def good
+    false
+  end
+  def bad
+    true
+  end
+end
+
+public # we need this otherwise all these methods will automatically be marked private
+Contract Num => Num
+def Object.a_class_method x
+  x + 1
+end
+
+Contract Num => nil
+def bad_double(x)
+  x * 2
+end
+
+Contract Num => Num
+def double(x)
+  x * 2
+end
+
+Contract String => nil
+def hello(name)
+end
+
+Contract lambda { |x| x.is_a? Numeric } => Num
+def square(x)
+  x ** 2
+end
+
+Contract [Num, Num, Num] => Num
+def sum_three(vals)
+  vals.inject(0) do |acc, x|
+    acc + x
+  end
+end
+
+Contract ({:name => String, :age => Fixnum}) => nil
+def person(data)
+end
+
+Contract Proc => Any
+def do_call(&blk)
+  blk.call
+end
+
+Contract Args[Num] => Num
+def sum(*vals)
+  vals.inject(0) do |acc, val|
+    acc + val
+  end
+end
+
+Contract Pos => nil
+def pos_test(x)
+end
+
+Contract Neg => nil
+def neg_test(x)
+end
+
+Contract Any => nil
+def show(x)
+end
+
+Contract None => nil
+def fail_all(x)
+end
+
+Contract Or[Num, String] => nil
+def num_or_string(x)
+end
+
+Contract Xor[RespondTo[:good], RespondTo[:bad]] => nil
+def xor_test(x)
+end
+
+Contract And[A, RespondTo[:good]] => nil
+def and_test(x)
+end
+
+Contract RespondTo[:good] => nil
+def responds_test(x)
+end
+
+Contract Send[:good] => nil
+def send_test(x)
+end
+
+Contract Not[nil] => nil
+def not_nil(x)
+end
+
+Contract ArrayOf[Num] => Num
+def product(vals)
+  vals.inject(1) do |acc, x|
+    acc * x
+  end
+end
+
+Contract Bool => nil
+def bool_test(x)
+end
+
+Contract nil => Num
+def no_args
+  1
+end
+
+Contract ArrayOf[Num], Func[Num => Num] => ArrayOf[Num]
+def map(arr, func)
+  ret = []
+  arr.each do |x|
+    ret << func[x]
+  end
+  ret
+end
+
+Contract Num => Num
+def default_args(x = 1)
+  2
+end
+
+Contract Maybe[Num] => Maybe[Num]
+def maybe_double x
+  if x.nil?
+    nil
+  else
+    x * 2
+  end
+end
+
+Contract HashOf[Symbol, Num] => Num
+def gives_max_value(hash)
+  hash.values.max
+end
+
+Contract nil => String
+def a_private_method
+  "works"
+end
+private :a_private_method
+
+# for testing inheritance
+class Parent
+  Contract Num => Num
+  def double x
+    x * 2
+  end
+end
+
+class Child < Parent
+end
+
+Contract Parent => Parent
+def id_ a
+  a
+end
+
+Contract Exactly[Parent] => nil
+def exactly_test(x)
+end
+
+# pattern matching example with possible deep contract violation
+class PatternMatchingExample
+  class Success < Struct.new(:request)
+  end
+
+  class Failure
+  end
+
+  Response = Or[Success, Failure]
+
+  class StringWithHello
+    def self.valid?(string)
+      String === string && !!string.match(/hello/i)
+    end
+  end
+
+  Contract Success => Response
+  def process_request(status)
+    Success[decorated_request(status.request)]
+  end
+
+  Contract Failure => Response
+  def process_request(status)
+    Failure.new
+  end
+
+  Contract StringWithHello => String
+  def decorated_request(request)
+    request + "!"
+  end
+end
+
+# invariant example (silliest implementation ever)
+class MyBirthday < Struct.new(:day, :month)
+  include Contracts
+  include Contracts::Invariants
+
+  Invariant(:day) { 1 <= day && day <= 31 }
+  Invariant(:month) { 1 <= month && month <= 12 }
+
+  Contract None => Fixnum
+  def silly_next_day!
+    self.day += 1
+  end
+
+  Contract None => Fixnum
+  def silly_next_month!
+    self.month += 1
+  end
+
+  Contract None => Fixnum
+  def clever_next_day!
+    return clever_next_month! if day == 31
+    self.day += 1
+  end
+
+  Contract None => Fixnum
+  def clever_next_month!
+    return next_year! if month == 12
+    self.month += 1
+    self.day = 1
+  end
+
+  Contract None => Fixnum
+  def next_year!
+    self.month = 1
+    self.day = 1
+  end
+end

data/spec/invariants_spec.rb

@@ -0,0 +1,19 @@
+module Contracts
+  RSpec.describe Invariants do
+
+    def new_subject
+      MyBirthday.new(31, 12)
+    end
+
+    it "works when all invariants are holding" do
+      expect { new_subject.clever_next_day! }.not_to raise_error
+      expect { new_subject.clever_next_month! }.not_to raise_error
+    end
+
+    it "raises invariant violation error when any of invariants are not holding" do
+      expect { new_subject.silly_next_day! }.to raise_error(InvariantError, /day condition to be true/)
+      expect { new_subject.silly_next_month! }.to raise_error(InvariantError, /month condition to be true/)
+    end
+
+  end
+end

data/spec/module_spec.rb

@@ -0,0 +1,17 @@
+module Mod
+  include Contracts
+  Contract Num => Num
+  def self.a_module_method a
+     a + 1
+  end
+end
+
+RSpec.describe "module methods" do
+  it "should pass for correct input" do
+    expect { Mod.a_module_method(2) }.to_not raise_error
+  end
+
+  it "should fail for incorrect input" do
+    expect { Mod.a_module_method("bad") }.to raise_error
+  end
+end  

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+require "contracts"
+require File.expand_path(File.join(__FILE__, "../fixtures/fixtures"))
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  #config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # Unable to use it now
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Callbacks
+  config.after :each do
+    ::Contract.restore_failure_callback
+  end
+end

metadata

@@ -1,67 +1,69 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: contracts
-version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: 
-  segments: 
-  - 0
-  - 4
-  version: "0.4"
+version: !ruby/object:Gem::Version
+  version: '0.5'
 platform: ruby
-authors: 
+authors:
 - Aditya Bhargava
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-05-08 00:00:00 Z
+date: 2014-05-08 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 code.
+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
+  code.
 email: bluemangroupie@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/builtin_contracts.rb
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- TODO.markdown
+- TUTORIAL.md
+- benchmarks/bench.rb
+- benchmarks/invariants.rb
+- benchmarks/wrap_test.rb
+- contracts.gemspec
 - lib/contracts.rb
-- lib/decorators.rb
-- lib/testable.rb
+- lib/contracts/builtin_contracts.rb
+- lib/contracts/decorators.rb
+- lib/contracts/invariants.rb
+- lib/contracts/support.rb
+- lib/contracts/testable.rb
+- lib/contracts/version.rb
+- spec/builtin_contracts_spec.rb
+- spec/contracts_spec.rb
+- spec/fixtures/fixtures.rb
+- spec/invariants_spec.rb
+- spec/module_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/egonSchiele/contracts.ruby
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Contracts for Ruby.
 test_files: []
-