https://github.com/waterlink/contracts-noop

Contracts.ruby plugin, allows to use contracts.ruby in gems/libraries only in development mode
https://github.com/waterlink/contracts-noop

Last synced: 30 days ago
JSON representation

Contracts.ruby plugin, allows to use contracts.ruby in gems/libraries only in development mode

• Host: GitHub
• URL: https://github.com/waterlink/contracts-noop
• Owner: waterlink
• License: mit
• Created: 2015-03-25T21:38:46.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-03-26T01:18:54.000Z (almost 10 years ago)
• Last Synced: 2024-04-30T02:02:11.842Z (8 months ago)
• Language: Ruby
• Size: 121 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Contracts::Noop

Allows usage of [contracts.ruby](https://github.com/egonSchiele/contracts.ruby) in gems/libraries only as a development dependency.

This gem needs to be a runtime dependency though.

When it is impossible to load `contracts`, this gem will load its own `Contracts` which will be noop.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'contracts-noop'

```

Or add it to your `my-gem.gemspec`:

```ruby

spec.add_runtime_dependency 'contracts-noop'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install contracts-noop

## Usage

```ruby

require 'contracts/noop'

Contracts::Noop.when_contracts_available do

  # .. assume contracts were loaded here ..

  # .. ie: load custom contracts, other contract plugins, configure

  # failure_callback, etc. ..

end

```

## Contributing

1. Fork it ( https://github.com/waterlink/contracts-noop/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request