interfaceable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54f19bb6bdcdc83dcf60a80e84e4dcbda3cf8a45cc3873213f1e57b40bbe4096
+  data.tar.gz: d2a192cddb7d1b166005d333eec6c88e7e605b41c788de1c123a50467c3122c8
+SHA512:
+  metadata.gz: 75cacdc1919e4ef26a2b51ec875dc21a5b4ebe1ad982ff755fc3a60152cc1627eac2a0d720e2c7e8422aff42d384d0f7d7b21d40c526ad6d73f65dca90ef86b2
+  data.tar.gz: 246b9251c3943540a64308c56e1921d7bab4eea044a3ca185659e96f223144dc3c099837f00d14c9a3833e1a65d634ec5badde3c5b1e20157598c255820db0e5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4
+install: bundle
+script:
+  - bundle exec rubocop
+  - COVERAGE=1 bundle exec rspec

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in interfacable.gemspec
+gemspec
+
+gem 'awesome_print'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    interfaceable (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    awesome_print (1.8.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    parallel (1.19.2)
+    parser (2.7.1.5)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.92.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.5.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  interfaceable!
+  rake
+  rspec
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 artemave
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Interfaceable [![Build Status](https://travis-ci.org/featurist/interfaceable.svg?branch=master)](https://travis-ci.org/featurist/interfaceable) [![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); end
+end
+```
+
+Will fail because of method signature mismatch:
+
+    Giffgaff must implement correctly: (Interfaceable::Error)
+      - Carrier#text:
+        - expected arguments: (req, req)
+        - actual arguments: (req)
+
+### 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
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'interfacable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/interfaceable.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/interfaceable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'interfaceable'
+  spec.version       = Interfaceable::VERSION
+  spec.authors       = ['artemave']
+  spec.email         = ['artemave@gmail.com']
+
+  spec.summary       = 'Strict interfaces in Ruby'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/featurist/interfaceable'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/artemave/interfaceable.git'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/interfaceable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'interfaceable/implementation_check'
+require_relative 'interfaceable/error_formatter'
+
+# Ruby interfaces yeah
+module Interfaceable
+  # Subclassing exceptions because other errors don't raise from within `TracePoint.trace`.
+  # rubocop:disable Lint/InheritException
+  class Error < Exception; end
+  # rubocop:enable Lint/InheritException
+
+  def implements(*interfaces)
+    (@interfaces ||= []).push(*interfaces)
+
+    # rubocop:disable Naming/MemoizedInstanceVariableName
+    @interfaceable_trace ||= TracePoint.trace(:end) do |t|
+      # simplecov does not see inside this block
+      # :nocov:
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+      if self == t.self
+        unless (errors = ImplementationCheck.new(self).perform(@interfaces)).empty?
+          error_message = ErrorFormatter.new(self).format_errors(errors)
+          raise(Error, error_message)
+        end
+
+        t.disable
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/interfaceable/error_formatter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Interfaceable
+  # Formats errors
+  class ErrorFormatter
+    def initialize(class_name)
+      @class_name = class_name
+    end
+
+    def format_errors(errors)
+      error_lines = []
+
+      if (missing_method_errors = all_missing_methods_errors(errors)).any?
+        error_lines << "#{@class_name} must implement:"
+        error_lines << missing_method_errors.map { |error| "  - #{error}" }
+      end
+
+      if (signature_errors = all_signature_errors(errors)).any?
+        error_lines << "#{@class_name} must implement correctly:"
+        error_lines << signature_errors.map(&method(:format_signature_error))
+      end
+
+      error_lines.flatten.join("\n")
+    end
+
+    private
+
+    def format_signature_error(args)
+      meth, check = args
+      [
+        "  - #{meth}:",
+        "    - expected arguments: (#{check[:expected].map(&method(:format_arg)).join(', ')})",
+        "    - actual arguments: (#{check[:actual].map(&method(:format_arg)).join(', ')})"
+      ]
+    end
+
+    def all_missing_methods_errors(errors)
+      errors.map do |interface, methods|
+        methods[:missing_class_methods].map { |meth| "#{interface}.#{meth}" } +
+          methods[:missing_instance_methods].map { |meth| "#{interface}##{meth}" }
+      end.flatten
+    end
+
+    def all_signature_errors(errors)
+      errors.map do |interface, methods|
+        methods[:class_method_signature_errors].map { |meth, check| ["#{interface}.#{meth}", check] } +
+          methods[:instance_method_signature_errors].map { |meth, check| ["#{interface}##{meth}", check] }
+      end.flatten(1)
+    end
+
+    def format_arg(arg)
+      {
+        'req' => 'req',
+        'opt' => 'opt=',
+        'rest' => '*rest',
+        'keyrest' => '**keyrest'
+      }.fetch(arg, "#{arg}:")
+    end
+  end
+end

data/lib/interfaceable/implementation_check.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Interfaceable
+  # Checks if class implements interfaces correctly
+  class ImplementationCheck
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def perform(interfaces)
+      results = validate(interfaces)
+
+      results.reject do |_, checks|
+        checks.values.all?(&:empty?)
+      end
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def validate(interfaces)
+      interfaces.each_with_object({}) do |interface, acc|
+        missing_class_methods = find_missing_class_methods(interface)
+        missing_instance_methods = find_missing_instance_methods(interface)
+        instance_method_signature_errors = find_signature_errors(
+          interface,
+          :instance_method,
+          interface.instance_methods - missing_instance_methods
+        )
+        class_method_signature_errors = find_signature_errors(
+          interface,
+          :method,
+          own_methods(interface.methods) - missing_class_methods
+        )
+
+        acc[interface] = {
+          missing_instance_methods: missing_instance_methods,
+          missing_class_methods: missing_class_methods,
+          instance_method_signature_errors: instance_method_signature_errors,
+          class_method_signature_errors: class_method_signature_errors
+        }
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def find_missing_class_methods(interface)
+      own_methods(interface.methods).reject do |meth|
+        own_methods(@klass.methods).include?(meth)
+      end
+    end
+
+    def find_missing_instance_methods(interface)
+      interface.instance_methods.reject do |meth|
+        @klass.instance_methods.include?(meth)
+      end
+    end
+
+    def find_signature_errors(interface, method_type, implemented_methods)
+      implemented_methods.each_with_object({}) do |meth, acc|
+        expected_parameters = interface.send(method_type, meth).parameters
+        actual_parameters = @klass.send(method_type, meth).parameters
+
+        next unless (errors = check_method_signature(expected_parameters, actual_parameters))
+
+        acc[meth] = {
+          expected: errors[:expected_positional_parameters] + errors[:expected_keyword_parameters],
+          actual: errors[:actual_positional_parameters] + errors[:actual_keyword_parameters]
+        }
+      end
+    end
+
+    def own_methods(methods)
+      methods - Object.methods
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def check_method_signature(expected_parameters, actual_parameters)
+      expected_keyword_parameters, expected_positional_parameters = simplify_parameters(
+        *split_parameters_by_type(expected_parameters)
+      )
+      actual_keyword_parameters, actual_positional_parameters = simplify_parameters(
+        *split_parameters_by_type(actual_parameters)
+      )
+
+      return if expected_positional_parameters == actual_positional_parameters &&
+                expected_keyword_parameters == actual_keyword_parameters
+
+      {
+        expected_positional_parameters: expected_positional_parameters,
+        expected_keyword_parameters: expected_keyword_parameters,
+        actual_positional_parameters: actual_positional_parameters,
+        actual_keyword_parameters: actual_keyword_parameters
+      }
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def simplify_parameters(keyword_parameters, positional_parameters)
+      keyrest = pop_keyrest(keyword_parameters)
+
+      [
+        keyword_parameters.map(&:last).sort + (keyrest ? ['keyrest'] : []),
+        positional_parameters.map(&:first).reject { |p| p == :block }.map(&:to_s)
+      ]
+    end
+
+    def pop_keyrest(keyword_parameters)
+      return unless keyword_parameters.last && keyword_parameters.last.first == :keyrest
+
+      keyword_parameters.pop
+    end
+
+    def split_parameters_by_type(parameters)
+      parameters.partition { |(arg_type)| arg_type.to_s =~ /^key/ }
+    end
+  end
+end

data/lib/interfaceable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Interfaceable
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: interfaceable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- artemave
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- artemave@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- interfaceable.gemspec
+- lib/interfaceable.rb
+- lib/interfaceable/error_formatter.rb
+- lib/interfaceable/implementation_check.rb
+- lib/interfaceable/version.rb
+homepage: https://github.com/featurist/interfaceable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/featurist/interfaceable
+  source_code_uri: https://github.com/artemave/interfaceable.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Strict interfaces in Ruby
+test_files: []