contracts-lite 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a0087eb9cbfbfbac59abc12f636caccf3699b81
-  data.tar.gz: eb6161c0401a24b4a37ac8fff330de398198fd74
+  metadata.gz: a9c1b2376cd43e4d7d2a992e27f59a4dff19f060
+  data.tar.gz: 33bb50fa438a689706fe7ba08ede597e88e71170
 SHA512:
-  metadata.gz: 681aa159502c17ae1dccc23060193b73cd70f81034a724398003edf886156ecd7c5e23199c53a1a5c1f90a0cd03257ace3de9733058c76c616d2e0af2356fb27
-  data.tar.gz: 170938443f38a9cbc575e1ae4261dc6365d44c7615108fc5cd25195af0554e8f4afc82395f04bdd17e9f0f4eff859d0a262a57a00c527f5ee01843ecb350cbc7
+  metadata.gz: 092d9f8d84c5e6d98f431e93f0297911927ed7ad1671a4319962a6e9fa415188a362e67d42beb3409008bed60e4bef4dd7b7061b7713009181eb4dec9f50ab5e
+  data.tar.gz: 639b6b326b48dbbb2a9fba32310f82fe9475d02a4f2041d5719d2d76b8f5107e6964f48679fee3dfacd639b3711bc9c46ffb106aed07f53257c9ec068b60b80c

data/.codeclimate.yml

@@ -0,0 +1,30 @@
+engines:
+  rubocop:
+    enabled: true
+    exclude_fingerprints:
+    - a6b358051ceb7af2b92a34028cd85b0e
+
+  bundler-audit:
+    enabled: false
+
+  fixme:
+    enabled: true
+
+  duplication:
+    enabled: true
+    exclude_fingerprints:
+    - d155301f1ed91235c5db306b793cddd6
+    - e2ddafaebd868c909253e9231b294e9b
+
+    config:
+      languages:
+      - ruby
+
+ratings:
+  paths:
+  - "**.rb"
+
+exclude_paths:
+- spec/**/*
+- benchmarks/**/*
+- .rubocop.yml

data/.gitignore

@@ -0,0 +1,6 @@
+*.swp
+*.swo
+Gemfile.lock
+tmp/
+coverage/
+.byebug*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,131 @@
+AllCops:
+  Exclude:
+    - "tmp/**/*"
+
+# forces method defs to have params in parens
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# changes x != nil to !x.nil?
+Style/NonNilCheck:
+  Enabled: false
+
+# changes %{} to %()
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# changes lambdas to ruby 1.9-style ->
+# not compatible with ruby 1.8
+Style/Lambda:
+  Enabled: false
+
+# changes to new hash syntax
+# not compatible with ruby 1.8
+Style/HashSyntax:
+  Enabled: false
+
+# we use unused method args a lot in tests/fixtures (a quirk of this lib)
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# changes x ** 2 to x**2
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# doesn't allow vars starting with _
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+# enforces method length of 10 lines
+Metrics/MethodLength:
+  Enabled: false
+
+# forces you to document classes
+# TODO: try to enable this cop
+Style/Documentation:
+  Enabled: false
+
+# enforces line length of 80
+# TODO enable
+Metrics/LineLength:
+  Enabled: false
+
+# triggered by Contract ({ :name => String, :age => Fixnum }) => nil
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: false
+
+# checks how much a method branches.
+# TODO try to get this cop enabled
+Metrics/AbcSize:
+  Enabled: true
+
+# checks complexity of method
+# TODO try to get this cop enabled
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# checks for too many nested ifs, whiles or rescues (but not too many nested blocks)
+# TODO: try to get this cop enabled eventually
+Metrics/BlockNesting:
+  Enabled: false
+
+# calls out class variables.
+# TODO: try to get this cop enabled eventually
+Style/ClassVars:
+  Enabled: false
+
+# enforces class length of < 100 lines
+Metrics/ClassLength:
+  Enabled: false
+
+# TODO: try to get this cop enabled eventually
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# checks for duplicate methods, but contracts
+# provides this functionality (multi-dispatch)
+Lint/DuplicateMethods:
+  Enabled: false
+
+# checks to see if you could've used attr_accessor instead.
+# nice in theory but noisy cop with false positives
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Asks you to use %w{array of words} if possible.
+# Not a style I like.
+Style/WordArray:
+  Enabled: false
+
+# conflicts with contracts
+# we define contracts like `Baz = 1`
+Style/ConstantName:
+  Enabled: false
+
+# `Contract` violates this, otherwise a good cop (enforces snake_case method names)
+# TODO possible to get this enabled but ignore `Contract`?
+Style/MethodName:
+  Enabled: false
+
+# checks for !!
+Style/DoubleNegation:
+  Enabled: false
+
+# enforces < 5 params for a function.
+# contracts-specific (long parameter list for test)
+Metrics/ParameterLists:
+  Enabled: false
+
+# Checks that braces used for hash literals have or don't have surrounding space depending on configuration.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# TODO enable
+Style/SpecialGlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,22 @@
+dist: trusty
+
+language: ruby
+cache: bundler
+rvm:
+  - "2.1"
+  - "2.2"
+  - "2.3"
+
+before_install:
+  - gem install bundler
+
+script:
+  - bundle exec rspec
+  # - bundle exec bin/rubocop
+
+bundler_args: --without development
+
+matrix:
+  include:
+    - rvm: jruby-20mode # JRuby in 1.9 mode
+      dist: precise

data/Gemfile

@@ -1,16 +1,20 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
+
 group :test do
   gem "rspec"
-  gem "rubocop", "~> 0.29.1", :platform => [:ruby_20, :ruby_21, :ruby_22, :ruby_23]
+  gem "codecov"
+  gem "rubocop", "~> 0.46", :platform => [:ruby_20, :ruby_21, :ruby_22, :ruby_23]
 end
 
 group :development do
-  gem "relish"
   gem "method_profiler"
   gem "ruby-prof"
+end
+
+group :test, :development do
+  gem "byebug", :platform => [:ruby_20, :ruby_21, :ruby_22, :ruby_23]
   gem "rake"
-  gem "byebug"
 end

data/README.md

@@ -1,4 +1,14 @@
-# contracts.ruby [![Build Status](https://travis-ci.org/ddd-ruby/contracts.ruby.png?branch=master)](https://travis-ci.org/ddd-ruby/contracts.ruby) [![Join the chat at https://gitter.im/egonSchiele/contracts.ruby](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg)](https://gitter.im/egonSchiele/contracts.ruby)
+# contracts.ruby
+[![Build Status](https://travis-ci.org/ddd-ruby/contracts.ruby.png)](https://travis-ci.org/ddd-ruby/contracts.ruby)
+[![Code Climate](https://codeclimate.com/github/ddd-ruby/contracts.ruby/badges/gpa.svg)](https://codeclimate.com/github/ddd-ruby/contracts.ruby)
+[![codecov](https://codecov.io/gh/ddd-ruby/contracts.ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/ddd-ruby/contracts.ruby)
+[![Dependency Status](https://gemnasium.com/ddd-ruby/contracts.ruby.png)](https://gemnasium.com/ddd-ruby/contracts.ruby)
+
+
+## Fork of https://github.com/egonSchiele/contracts.ruby
+Until this issue https://github.com/egonSchiele/contracts.ruby/pull/246 is resolved, we decided to mainain our own fork of contracts named `contracts-lite`.
+
+<hr>
 
 Contracts let you clearly – even beautifully – express how your code behaves, and free you from writing tons of boilerplate, defensive code.
 
@@ -6,7 +16,7 @@ You can think of contracts as `assert` on steroids.
 
 ## Installation
 
-    gem install contracts
+    gem install contracts-lite
 
 ## Hello World
 
@@ -69,7 +79,7 @@ To get started do the following:
 
 2. Run our test suite
 
-  `bundle exec rake`
+  `bundle exec rspec`
 
 ## Performance
 

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TUTORIAL.md

@@ -214,7 +214,7 @@ product([1, 2, 3, "foo"])
 ### Another Product Function
 
 ```ruby
-Contract C::Args[C::Num] => C::Num
+Contract C::SplatArgs[C::Num] => C::Num
 def product(*vals)
   total = 1
   vals.each do |val|
@@ -224,13 +224,13 @@ def product(*vals)
 end
 ```
 
-This function uses varargs (`*args`) instead of an array. To make a contract on varargs, use the `Args` contract. It takes one contract as an argument and uses it to validate every element passed in through `*args`. So for example,
+This function uses varargs (`*args`) instead of an array. To make a contract on varargs, use the `SplatArgs` contract. It takes one contract as an argument and uses it to validate every element passed in through `*args`. So for example,
 
-`Args[Num]` means they should all be numbers.
+`SplatArgs[Num]` means they should all be numbers.
 
-`Args[Or[Num, String]]` means they should all be numbers or strings.
+`SplatArgs[Or[Num, String]]` means they should all be numbers or strings.
 
-`Args[Any]` means all arguments are allowed (`Any` is a contract that passes for any argument).
+`SplatArgs[Any]` means all arguments are allowed (`Any` is a contract that passes for any argument).
 
 ### Contracts On Arrays
 
@@ -598,7 +598,7 @@ Possible validator overrides:
 - `override_validator(Hash)` - e.g. `{ :a => C::Num, :b => String }`,
 - `override_validator(Range)` - e.g. `(1..10)`,
 - `override_validator(Regexp)` - e.g. `/foo/`,
-- `override_validator(Contracts::Args)` - e.g. `C::Args[C::Num]`,
+- `override_validator(Contracts::SplatArgs)` - e.g. `C::SplatArgs[C::Num]`,
 - `override_validator(Contracts::Func)` - e.g. `C::Func[C::Num => C::Num]`,
 - `override_validator(:valid)` - allows to override how contracts that respond to `:valid?` are handled,
 - `override_validator(:class)` - allows to override how class/module contract constants are handled,

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "contracts"
+
+require_relative "../spec/support"
+require_relative "../spec/fixtures/fixtures"
+puts "preloaded fixtures from spec/fixtures/fixtures"
+
+require "irb"
+IRB.start

data/{script → bin}/rubocop

@@ -2,6 +2,5 @@
 
 if RUBY_VERSION.to_f > 2.1
   puts "running rubocop..."
-  puts `bundle exec rubocop -D spec/ lib/`
-  exit $?.exitstatus
+  exec("bundle exec rubocop -a -D lib/")
 end

data/contracts.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.version     = Contracts::VERSION
   s.summary     = "Contracts for Ruby. (fork)"
   s.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."
-  s.author      = "Aditya Bhargava"
+  s.author      = "Aditya Bhargava, Ruslan Gatyatov, Roman Heinrich"
   s.email       = "bluemangroupie@gmail.com"
   s.files       = `git ls-files`.split("\n")
   s.homepage    = "http://github.com/ddd-ruby/contracts.ruby"

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/docs/index.md

@@ -0,0 +1,112 @@
+# contracts.ruby
+[![Build Status](https://travis-ci.org/ddd-ruby/contracts.ruby.png)](https://travis-ci.org/ddd-ruby/contracts.ruby)
+[![Code Climate](https://codeclimate.com/github/ddd-ruby/contracts.ruby/badges/gpa.svg)](https://codeclimate.com/github/ddd-ruby/contracts.ruby)
+[![codecov](https://codecov.io/gh/ddd-ruby/contracts.ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/ddd-ruby/contracts.ruby)
+[![Dependency Status](https://gemnasium.com/ddd-ruby/contracts.ruby.png)](https://gemnasium.com/ddd-ruby/contracts.ruby)
+
+
+## Fork of https://github.com/egonSchiele/contracts.ruby
+Until this issue https://github.com/egonSchiele/contracts.ruby/pull/246 is resolved, we decided to mainain our own fork of contracts named `contracts-lite`.
+
+<hr>
+
+Contracts let you clearly – even beautifully – express how your code behaves, and free you from writing tons of boilerplate, defensive code.
+
+You can think of contracts as `assert` on steroids.
+
+## Installation
+
+    gem install contracts-lite
+
+## Hello World
+
+A contract is one line of code that you write above a method definition. It validates the arguments to the method, and validates the return value of the method.
+
+Here is a simple contract:
+
+```ruby
+  Contract Num => Num
+  def double(x)
+```
+
+This says that double expects a number and returns a number. Here's the full code:
+
+```ruby
+require 'contracts'
+
+class Example
+  include Contracts::Core
+  include Contracts::Builtin
+
+  Contract Num => Num
+  def double(x)
+    x * 2
+  end
+end
+
+puts Example.new.double("oops")
+```
+
+Save this in a file and run it. Notice we are calling `double` with `"oops"`, which is not a number. The contract fails with a detailed error message:
+
+```
+ParamContractError: Contract violation for argument 1 of 1:
+        Expected: Num,
+        Actual: "oops"
+        Value guarded in: Example::double
+        With Contract: Num => Num
+        At: main.rb:8
+        ...stack trace...
+```
+
+Instead of throwing an exception, you could log it, print a clean error message for your user...whatever you want. contracts.ruby is here to help you handle bugs better, not to get in your way.
+
+## Tutorial
+
+Check out [this awesome tutorial](http://egonschiele.github.com/contracts.ruby).
+
+## Use Cases
+
+Check out [this screencast](https://vimeo.com/85883356).
+
+## Development
+
+To get started do the following:
+
+1. Install required gems for development
+
+  `bundle install`
+
+2. Run our test suite
+
+  `bundle exec rspec`
+
+## Performance
+
+Using contracts.ruby results in very little slowdown. Check out [this blog post](http://adit.io/posts/2013-03-04-How-I-Made-My-Ruby-Project-10x-Faster.html#seconds-6) for more info.
+
+**Q.** What Rubies can I use this with?
+
+**A.** It's been tested with `1.9.2`, `1.9.3`, `2.0.0`, `2.1`, `2.2`, and `jruby` (1.9 mode).
+
+If you're using the library, please [let me know](https://github.com/egonSchiele) what project you're using it on :)
+
+## Testimonials
+
+> Contracts literally saves us hours of pain at Snowplow every day
+
+Alexander Dean, creator of [Snowplow](https://github.com/snowplow/snowplow)
+
+> Contracts caught a bug that saved us several hundred dollars. It took less than 30 seconds to add the contract.
+
+Michael Tomer
+
+## Credits
+
+Inspired by [contracts.coffee](http://disnetdev.com/contracts.coffee/).
+
+Copyright 2012-2015 [Aditya Bhargava](http://adit.io).
+Major improvements by [Alexey Fedorov](https://github.com/waterlink).
+
+BSD Licensed.
+