https://github.com/featurist/interfaceable

Strict interfaces in Ruby
https://github.com/featurist/interfaceable

ruby

Last synced: 2 months ago
JSON representation

Strict interfaces in Ruby

• Host: GitHub
• URL: https://github.com/featurist/interfaceable
• Owner: featurist
• License: mit
• Created: 2020-09-29T15:16:34.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-19T14:23:34.000Z (9 months ago)
• Last Synced: 2024-10-28T22:57:01.063Z (3 months ago)
• Topics: ruby
• Language: Ruby
• Homepage:
• Size: 74.2 KB
• Stars: 92
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Interfaceable [![Ruby](https://github.com/featurist/interfaceable/actions/workflows/ruby.yml/badge.svg)](https://github.com/featurist/interfaceable/actions/workflows/ruby.yml) [![Gem Version](https://badge.fury.io/rb/interfaceable.svg)](https://badge.fury.io/rb/interfaceable)

Impose interfaces on classes and let this gem automatically check that the interface constraints are met.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'interfaceable'

```

And then execute:

    $ bundle install

## Usage

In this example:

```ruby

module Carrier

  def call(number); end

  def text(number, text); end

end

class Giffgaff

  extend Interfaceable

  implements Carrier

end

```

An attempt to _load_ this code will result in the following error:

    Giffgaff must implement: (Interfaceable::Error)

      - Carrier#text

      - Carrier#call

It will keep failing until `Giffgaff` defines those methods.

Correctly! E.g.:

```ruby

class Giffgaff

  def call(number); end

  def text(number, text = ''); end

end

```

Will fail because of method signature mismatch:

    Giffgaff must implement correctly: (Interfaceable::Error)

      - Carrier#text:

        - expected arguments: (req, req)

        - actual arguments: (req, opt=)

Classes may define additional optional or rest arguments.

```ruby

module Carrier

  def call(number); end

  def text(number, text); end

end

class Giffgaff

  def call(number, *opts); end

  def text(number, text, opt1 = nil, opt2 = nil); end

end

```

This will not generate any errors since `Giffgaff` implements the required methods with correct arguments only adding new optional ones.

### Rails

Mix in `Interfaceable` before any of the application code is loaded. For example, in the initializer. For extra peace of mind, you can noop interface checking in production:

```ruby

# config/initializers/interfaceable.rb

class Class

  if Rails.env.production?

    def implements(*args); end

  else

    include Interfaceable

  end

end

```