entitlements 0.1.8 → 0.2.0

data/lib/contracts-ruby3/CHANGELOG.markdown

@@ -0,0 +1,117 @@
+
+## [v0.16.1] - 2021-04-17
+
+[v0.16.1]: https://github.com/egonSchiele/contracts.ruby/compare/v0.16.0...v0.16.1
+
+- Enhancement: Pretty-print contracts in error messages - [Corey Farwell](https://github.com/frewsxcv) [#289](https://github.com/egonSchiele/contracts.ruby/pull/289)
+- Bugfix: Fix `attr_accessor_with_contract` with multiple attribute names input - [Kevin Yeh](https://github.com/kyeah) [#259](https://github.com/egonSchiele/contracts.ruby/pull/259)
+- Bugfix: Fix "stack level too deep" in CI builds - [md-work](https://github.com/md-work) [#283](https://github.com/egonSchiele/contracts.ruby/pull/283)
+
+## [v0.16.0] - 2017-04-24
+
+[v0.16.0]: https://github.com/egonSchiele/contracts.ruby/compare/v0.15.0...v0.16.0
+
+- **Support for Ruby 1.8 has been discontinued** - [Corey Farwell](https://github.com/frewsxcv) [#256](https://github.com/egonSchiele/contracts.ruby/pull/256)
+- Enhancement: Add a `Contracts::Attrs` module containing attribute w/ contracts utilities - [Corey Farwell](https://github.com/frewsxcv) [#255](https://github.com/egonSchiele/contracts.ruby/pull/255)
+- Bugfix: Fix StrictHash contract for extra keys - [Maciej Malecki](https://github.com/smt116) [#254](https://github.com/egonSchiele/contracts.ruby/pull/254)
+
+## [v0.15.0] - 2017-02-24
+
+[v0.15.0]: https://github.com/egonSchiele/contracts.ruby/compare/v0.14.0...v0.15.0
+
+- Bugfix: Func contract's return value isn't enforced with blocks - [Piotr Szmielew](https://github.com/esse) [#251](https://github.com/egonSchiele/contracts.ruby/pull/251)
+- Bugfx: Fix contracts used in AR-models - [Gert Goet](https://github.com/eval) [#237](https://github.com/egonSchiele/contracts.ruby/pull/237)
+
+## [v0.14.0] - 2016-04-26
+
+[v0.14.0]: https://github.com/egonSchiele/contracts.ruby/compare/v0.13.0...v0.14.0
+
+- Enhancement: Add StrictHash contract - [Fyodor](https://github.com/cbrwizard) [#236](https://github.com/egonSchiele/contracts.ruby/pull/236)
+- Bugfix: dont fail if something other than a hash is passed to a KeywordArgs - [Dan Padilha](https://github.com/dpad) [#234](https://github.com/egonSchiele/contracts.ruby/pull/234)
+- LICENSE ADDED: Simplified BSD (same as what is specified in the readme) - [Charles Dale](https://github.com/chuckd) [#233](https://github.com/egonSchiele/contracts.ruby/pull/233)
+- Bugfix: fix constant looking when including a module that includes contracts (requires removing the check to see if contracts is already included) - [Aditya Bhargava](https://github.com/egonSchiele) [#232](https://github.com/egonSchiele/contracts.ruby/pull/232)
+- Bugfix for err case when KeywordArgs and Proc are used together - [Aditya Bhargava](https://github.com/egonSchiele) [#230](https://github.com/egonSchiele/contracts.ruby/pull/230)
+- Enhancement: Add DescendantOf contract - [Miguel Palhas](https://github.com/naps62) [#227](https://github.com/egonSchiele/contracts.ruby/pull/227)
+
+## [v0.13.0] - 2016-01-25
+
+[v0.13.0]: https://github.com/egonSchiele/contracts.ruby/compare/v0.12.0...v0.13.0
+
+- Enhancement: Add support for Ruby 2.3 - [Oleksii Fedorov](https://github.com/waterlink) [#216](https://github.com/egonSchiele/contracts.ruby/pull/216)
+- Enhancement: Added Int, Nat and NatPos builtin contracts - [Simon George](https://github.com/sfcgeorge) [#212](https://github.com/egonSchiele/contracts.ruby/pull/212)
+- Bugfix: Allow contracts on singleton of subclass - [Oleksii Federov](https://github.com/waterlink) [#211](https://github.com/egonSchiele/contracts.ruby/pull/211)
+
+## [v0.12.0] - 2015-09-15
+
+[v0.12.0]: https://github.com/egonSchiele/contracts.ruby/compare/v0.11.0...v0.12.0
+
+- Feature: add `Regexp` validator - [Gert Goet](https://github.com/eval) [#196](https://github.com/egonSchiele/contracts.ruby/pull/196)
+- Docs: bootstrap cucumber/aruba/relish setup - [Oleksii Fedorov](https://github.com/waterlink) [#195](https://github.com/egonSchiele/contracts.ruby/pull/195)
+- Bugfix: allow to `extend` module, that has `Contracts` or `Contracts::Core` included without harming current module/class `Contracts` functionality, see: [#176](https://github.com/egonSchiele/contracts.ruby/issues/176) - [Oleksii Fedorov](https://github.com/waterlink) [#198](https://github.com/egonSchiele/contracts.ruby/pull/198)
+- Enhancement: add `include Contracts::Builtin` to allow users to use builtin contracts without `Contracts::` prefix together with `include Contracts::Core` - [PikachuEXE](https://github.com/PikachuEXE) [#199](https://github.com/egonSchiele/contracts.ruby/pull/199)
+
+## [v0.11.0] - 2015-07-30
+
+[v0.11.0]: https://github.com/egonSchiele/contracts.ruby/compare/v0.10.1...v0.11.0
+
+- Enhancement: add `include Contracts::Core` that doesn't pollute the namespace as much as `include Contracts` - [Oleksii Federov](https://github.com/waterlink) [#185](https://github.com/egonSchiele/contracts.ruby/pull/185)
+- Bugfix: fail if a non-hash is provided to a `HashOf` contract - [Abe Voelker](https://github.com/abevoelker) [#190](https://github.com/egonSchiele/contracts.ruby/pull/190)
+- Bugfix: bugfix for using varargs and `Maybe[Proc]` together - [Adit Bhargava](https://github.com/egonSchiele) [#188](https://github.com/egonSchiele/contracts.ruby/pull/188)
+- Bugfix: make KeywordArgs fail if unexpected keys are passed in - [Abe Voelker](https://github.com/abevoelker) [#187](https://github.com/egonSchiele/contracts.ruby/pull/187)
+- Feature: range contract added - [Oleksii Fedorov](https://github.com/waterlink) [#184](https://github.com/egonSchiele/contracts.ruby/pull/184)
+- Feature: enum contract added - [Dennis Günnewig](https://github.com/dg-ratiodata) [#181](https://github.com/egonSchiele/contracts.ruby/pull/181)
+
+## [v0.10.1] - 2015-07-16
+
+[v0.10.1]: https://github.com/egonSchiele/contracts.ruby/compare/v0.10...v0.10.1
+
+- Enhancement: make `@pattern_match` instance variable not render ruby warning. Required to use new aruba versions in rspec tests - [Dennis Günnewig](https://github.com/dg-ratiodata) [#179](https://github.com/egonSchiele/contracts.ruby/pull/179)
+
+## [v0.10] - 2015-07-07
+
+[v0.10]: https://github.com/egonSchiele/contracts.ruby/compare/v0.9...v0.10
+
+- Bugfix: make `Maybe[Proc]` work correctly - [Simon George](https://github.com/sfcgeorge) [#142](https://github.com/egonSchiele/contracts.ruby/pull/142)
+- Bugfix: make `Func` contract verified when used as return contract - [Rob Rosenbaum](https://github.com/robnormal) [#145](https://github.com/egonSchiele/contracts.ruby/pull/145)
+- Bugfix: make `Pos`, `Neg` and `Nat` contracts handle non-numeric values correctly - [Matt Griffin](https://github.com/betamatt) and [Gavin Sinclair](https://github.com/gsinclair) [#147](https://github.com/egonSchiele/contracts.ruby/pull/147) [#173](https://github.com/egonSchiele/contracts.ruby/pull/173)
+- Enhancement: reduce user class pollution through introduction of contracts engine - [Oleksii Fedorov](https://github.com/waterlink) [#141](https://github.com/egonSchiele/contracts.ruby/pull/141)
+- Feature: add builtin `KeywordArgs` and `Optional` contracts for keyword arguments handling - [Oleksii Fedorov](https://github.com/waterlink) [#151](https://github.com/egonSchiele/contracts.ruby/pull/151)
+- Feature: recognize module as a class contract - [Oleksii Fedorov](https://github.com/waterlink) [#153](https://github.com/egonSchiele/contracts.ruby/pull/153)
+- Feature: custom validators with `Contract.override_validator` - [Oleksii Fedorov](https://github.com/waterlink) [#159](https://github.com/egonSchiele/contracts.ruby/pull/159)
+- Feature: add builtin `RangeOf[...]` contract - [Gavin Sinclair](https://github.com/gsinclair) [#171](https://github.com/egonSchiele/contracts.ruby/pull/171)
+
+## [v0.9] - 2015-04-24
+
+[v0.9]: https://github.com/egonSchiele/contracts.ruby/compare/0.8...v0.9
+
+- MAJOR fix in pattern-matching: If the return contract for a pattern-matched function fails, it should NOT try the next pattern-match function. Pattern-matching is only for params, not return values.
+- raise an error if multiple defns have the same contract for pattern matching.
+
+- New syntax for functions with no input params (the old style still works)
+  Old way:
+  ```ruby
+  Contract nil => 1
+  def one
+  ```
+  New way:
+  ```
+  Contract 1
+  def one
+  ```
+
+- Prettier HashOf contract can now be written like this: `HashOf[Num => String]`
+- Add `SetOf` contract
+- various small fixes
+
+## v0.8 - 2015-04-03
+
+- code refactored (very slight loss of performance, big increase in readability)
+- fail when defining a contract on a module without `include Contracts::Modules`
+- fixed several bugs in argument parsing, functions with complex params get contracts applied correctly now.
+- added rubocop to ci.
+- if a contract is set on a protected method, it should not become public.
+- fixed pattern matching when the multiple definitions of functions have different arities.
+- couple of new built-in contracts: Nat, Eq.
+- changed `Invariant` to `invariant`: `invariant(:day) { 1 <= day && day <= 31 }`
+- prettier error messages (`Contracts::Num` is now just `Num`, for example)
+- support for yard-contracts

data/lib/contracts-ruby3/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "aruba"
+  gem "cucumber", "~> 1.3.20"
+  gem "rspec"
+
+  gem "rubocop", ">= 1.0.0"
+  gem "rubocop-performance", ">= 1.0.0"
+end
+
+group :development do
+  gem "method_profiler"
+  gem "rake"
+  gem "relish"
+  gem "ruby-prof"
+end

data/lib/contracts-ruby3/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2012-2016 Aditya Bhargava
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/contracts-ruby3/README.md

@@ -0,0 +1,114 @@
+This project is looking for a new maintainer! [More details here](https://github.com/egonSchiele/contracts.ruby/issues/249)
+
+# contracts.ruby [![GitHub Build Status](https://img.shields.io/github/workflow/status/egonSchiele/contracts.ruby/Tests?style=flat-square)](https://github.com/egonSchiele/contracts.ruby/actions?query=workflow%3ATests) [![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 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.
+
+## 0.17.x = Ruby 3.x only
+
+0.17.x only supports Ruby 3.x  
+Looking for Ruby 2.x support?  
+Use 0.16.x  
+
+## Installation
+
+    gem install contracts
+
+## 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](https://egonschiele.github.io/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`
+  
+3. Run our code style checks
+  
+  `bundle exec rubocop`
+  
+## 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 `2.1`, `2.2`, `2.3`, `2.4`, `2.5`, `2.6` and `2.7`.
+
+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://disnet.github.io/contracts.coffee/).
+
+Copyright 2012-2015 [Aditya Bhargava](http://adit.io).
+Major improvements by [Alexey Fedorov](https://github.com/waterlink).
+
+BSD Licensed.
+

data/lib/contracts-ruby3/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+task :default => [:spec]
+
+task :add_tag do
+  `git tag -a v#{Contracts::VERSION} -m 'v#{Contracts::VERSION}'`
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)

data/lib/contracts-ruby3/TODO.markdown

@@ -0,0 +1,6 @@
+- maybe make some screencasts
+
+- you can now do something like Haskell's quickcheck. Every contract has a method 'test_data' or something. You can use that data to automatically check methods with contracts to make sure they are correct.
+  - http://www.cse.chalmers.se/~rjmh/QuickCheck/manual.html
+  - for stuff like the Not contract, should I make a standard set of classes to check those functions with? Would that be useful at all?
+  - also write specs for this stuff