class_interface 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e465ca44514991917f4a749a1dca839aa52ca7ce0e8c2d00c5d8f0ba319e402
-  data.tar.gz: a53c602ca939703b9f2ecff58d34176d6b9b101ab8cfd587a3e071086d57e35a
+  metadata.gz: 4ce5917f992d73dbb022c7849b7f7fdd39f640c641c770cb16e951b7d247ac1e
+  data.tar.gz: ab90883cb28aba282716f0731240d1547fa51ace82fba15d1fc77ef26eb0bd10
 SHA512:
-  metadata.gz: 7519f9f2f4959c21aa41becf47b68bb5c4a52d95fd9959968d60432c64a4d3108cf63f36561d50ffa5c8b95fafd1cd5c5055c82faa91dfa69731b95cbda80c21
-  data.tar.gz: b9a57035bcf5f05fa76bc064daa4a5b87b147c3575b16c62a41453448a2369317374d42a847438fb3472c29f51bc889bce4267b8edda6d1fb3b79616c9cf62ba
+  metadata.gz: 87ea34b00e74c391fa27a8f6989a5f9cf53c6cb938ad66d3886177c2d6650f882ddc50d00d187da3c838c821438e7f0e449c74884cbf5b71b166801d038a97a8
+  data.tar.gz: 9088a8903b83769b293f737fbf011e13bd44315664de6cce2c5da1f108b93aadc2f49d824d6a50a72f325b9aedc62f5a5aa476bf24cfcef593d1c35f95fe0e39

data/.gitignore

@@ -1,15 +1,15 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.vscode/
-/.idea/
-*.gem
-
-# rspec failure tracking
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+/.idea/
+*.gem
+
+# rspec failure tracking
 .rspec_status

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
---color
+--format documentation
+--color

data/.travis.yml

@@ -1,5 +1,5 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.14.6
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -1,74 +1,74 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at class_interface.gemspec@mail.magynhard.de. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at class_interface.gemspec@mail.magynhard.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in class_interface.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in class_interface.gemspec
+gemspec

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 Matthäus Beyrle
-
-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.
+MIT License
+
+Copyright (c) 2017-2021 Matthäus J. N. Beyrle
+
+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

@@ -1,94 +1,121 @@
-# Ruby gem class_interface
-
-Extends Ruby to support class interfaces.
-
-That can be very handy in teams to declare requirements for specific types of classes.  
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'class_interface'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install class_interface
-    
-## Examples
-
-### Defining an interface
-
-It is a good idea, to start an interface name by convention with an I, following by a capitalized camel case constant name, i.e.: `IMyInterface, IHouse, IClassName, ...` 
-
-```ruby
-class IExample
-  MIN_AGE = Integer
-  DEFAULT_ENV = String
-  SOME_CONSTANT = nil
-
-  def self.some_static_method
-  end
-
-  def some_instance_method
-  end
-end
-```
-
-### Implementing an interface
-
-```ruby
-class MyImplementation
-  MIN_AGE = 21
-  DEFAULT_ENV = 'dev' 
-  SOME_CONSTANT = 'some_value'
-  
-  def specific_method
-    puts "very specific"
-  end
-  
-  def self.some_static_method
-    puts "static method is implemented!"
-  end
-  
-  def some_instance_method
-    # implementation
-  end
-  
-  def self.another_methods
-    # implementation
-  end
-  
-  implements IExample
-end
-```
-
-## Documentation
-```ruby
-#implements(InterfaceClassConstant)
-```
-
-_InterfaceClassConstant_ must be a valid InterfaceClassConstant or a String, containing a valid InterfaceClassConstant, i.e.: IMyInterface / "IMyInterface"
-
-### Methods
-
-All defined methods in the interface class must be implemented in the implementing class.
-The parameter count must be the same.
-
-### Constant Types
-
-All CONSTANTS defined in the interface class must be implemented in the implementing class.
-CONSTANTS of interfaces may be defined = nil, to allow all types of definitions in the implementing class.
-
-To specify a type, assign its class constant, e.g. String, Array, ...
-If a specified type is defined, it is mandatory for the implementation to use that type.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/class_interface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+# class_interface
+
+Ruby gem to extend Ruby to support class interfaces you may know them from other programming languages like C++ or Java.
+
+Raises a variety of different exceptions when the requirements of the interface are not met.
+
+That can be very handy in teams to declare requirements for specific types of classes.
+
+# Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+
+
+
+
+<a name="installation"></a>
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'class_interface'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install class_interface
+
+
+
+
+<a name="usage"></a>
+## Usage
+
+### Defining an interface
+
+It is a good idea, to start an interface name by convention with an I, following by a capitalized camel case constant name, i.e.: `IMyInterface, IHouse, IClassName, ...` 
+
+```ruby
+class IExample
+  MIN_AGE = Integer
+  DEFAULT_ENV = String
+  SOME_CONSTANT = nil
+
+  def self.some_static_method
+  end
+
+  def some_instance_method
+  end
+end
+```
+
+### Implementing an interface
+
+```ruby
+class MyImplementation
+  MIN_AGE = 21
+  DEFAULT_ENV = 'dev' 
+  SOME_CONSTANT = 'some_value'
+  
+  def specific_method
+    puts "very specific"
+  end
+  
+  def self.some_static_method
+    puts "static method is implemented!"
+  end
+  
+  def some_instance_method
+    # implementation
+  end
+  
+  def self.another_methods
+    # implementation
+  end
+  
+  implements IExample
+end
+```
+
+
+
+
+
+<a name="documentation"></a>
+## Documentation
+```ruby
+#implements(InterfaceClassConstant)
+```
+
+_InterfaceClassConstant_ must be a valid InterfaceClassConstant or a String, containing a valid InterfaceClassConstant, i.e.: IMyInterface / "IMyInterface"
+
+### Methods
+
+All defined methods in the interface class must be implemented in the implementing class.
+The parameter count must be the same. A distinction is made between static and dynamic methods.
+
+### Constant Types
+
+All CONSTANTS defined in the interface class must be implemented in the implementing class.
+CONSTANTS of interfaces may be defined with `nil`, to allow all types of definitions in the implementing class.
+
+Otherwise to specify a type, assign its class constant, e.g. `String`, `Array`, `MyCustomClass`, ...
+If a specified type is defined, it is mandatory for the implementation to use that type.
+
+
+
+
+
+<a name="contributing"></a>
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/class_interface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -1,11 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-#
-# run default task to see tasks to build and publish gem
-#
-task :default do
-  system 'rake --tasks'
-end
-
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+#
+# run default task to see tasks to build and publish gem
+#
+task :default do
+  system 'rake --tasks'
+end
+
 RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "class_interface"
-
-# 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__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "class_interface"
+
+# 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

@@ -1,8 +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
+#!/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/class_interface.gemspec

@@ -1,35 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'class_interface/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "class_interface"
-  spec.version       = ClassInterface::VERSION
-  spec.authors       = ["Matthäus Beyrle"]
-  spec.email         = ["class_interface.gemspec@mail.magynhard.de"]
-
-  spec.summary       = %q{Extends Ruby to support class interfaces}
-  spec.homepage      = "https://github.com/magynhard/class_interface"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |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']
-
-  spec.add_development_dependency 'bundler',  '>= 1.14'
-  spec.add_development_dependency 'rake',     '~> 10.0'
-  spec.add_development_dependency 'rspec',    '~> 3.0'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'class_interface/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "class_interface"
+  spec.version       = ClassInterface::VERSION
+  spec.authors       = ["Matthäus Beyrle"]
+  spec.email         = ["class_interface.gemspec@mail.magynhard.de"]
+
+  spec.summary       = %q{Extends Ruby to support class interfaces}
+  spec.homepage      = "https://github.com/magynhard/class_interface"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.add_development_dependency 'bundler',  '>= 1.14'
+  spec.add_development_dependency 'rake',     '>= 12.3.3'
+  spec.add_development_dependency 'rspec',    '~> 3.0'
+end

data/lib/class_interface.rb

@@ -1,109 +1,113 @@
-require 'class_interface/version'
-
-require_relative 'custom_errors/implementation_constant_type_error'
-require_relative 'custom_errors/implementation_incomplete_error'
-require_relative 'custom_errors/implementation_parameter_count_error'
-require_relative 'custom_errors/interface_constant_definition_error'
-require_relative 'custom_errors/interface_not_defined_error'
-
-#
-# Equip classes with the requirement to implement interfaces
-#
-
-#
-# - ensures self.static methods to be defined (checking parameters count to be equal)
-# - ensures instance methods to be defined (checking parameters count to be equal)
-# - ensures CONSTANTS to be defined (checking for type of CONSTANTS)
-#
-# @param interface_constant [Class|String]
-def implements(interface_constant)
-  implementation_class = extract_caller_path caller_locations(1, 16)
-  if Object.const_defined? interface_constant.to_s
-    #--------------------------------------------------------------------------
-    # check if definitions exist
-    #--------------------------------------------------------------------------
-    # instance methods
-    interface_instance_methods = Object.const_get(interface_constant.to_s).instance_methods false
-    implementation_instance_methods = Object.const_get(implementation_class.to_s).instance_methods false
-    unimplemented_instance_methods = interface_instance_methods - implementation_instance_methods
-    # static methods
-    interface_static_methods = Object.const_get(interface_constant.to_s).methods false
-    implementation_static_methods = Object.const_get(implementation_class.to_s).methods false
-    unimplemented_static_methods = interface_static_methods - implementation_static_methods
-    # constants
-    interface_constants = Object.const_get(interface_constant.to_s).constants
-    implementation_constants = Object.const_get(implementation_class.to_s).constants
-    unimplemented_constants = interface_constants - implementation_constants
-    if unimplemented_instance_methods.any? || unimplemented_static_methods.any? || unimplemented_constants.any?
-      error_message = "\nThe interface '#{interface_constant}' was not completely implemented in class '#{implementation_class}'."
-      error_message += "\n  - missing instance methods:\n      #{unimplemented_instance_methods.join(' ')}" if unimplemented_instance_methods.any?
-      error_message += "\n  - missing static methods:\n      #{unimplemented_static_methods.join(' ')}" if unimplemented_static_methods.any?
-      error_message += "\n  - missing constants:\n      #{unimplemented_constants.join(' ')}" if unimplemented_constants.any?
-      raise ClassInterface::ImplementationIncompleteError, error_message
-    end
-
-    #--------------------------------------------------------------------------
-    # check if method parameters count does match on implementation and interface
-    #--------------------------------------------------------------------------
-    interface_instance_methods.each do |method_name|
-      if_params_count_arity = Object.const_get(interface_constant.to_s).new.method(method_name).arity
-      impl_params_count_arity = Object.const_get(implementation_class).new.method(method_name).arity
-      if if_params_count_arity != impl_params_count_arity
-        raise ClassInterface::ImplementationParameterCountError, "Parameters of instance method '#{implementation_class}##{method_name}' do not match with interface '#{interface_constant}##{method_name}' (given #{impl_params_count_arity.abs}, expected #{if_params_count_arity.abs})"
-      end
-    end
-    interface_static_methods.each do |method_name|
-      if_params_count_arity = Object.const_get(interface_constant).method(method_name).arity
-      impl_params_count_arity = Object.const_get(implementation_class).method(method_name).arity
-      if if_params_count_arity != impl_params_count_arity
-        raise ClassInterface::ImplementationParameterCountError, "Parameters of static method '#{implementation_class}##{method_name}' do not match with interface '#{interface_constant}##{method_name}' (given #{impl_params_count_arity.abs}, expected #{if_params_count_arity.abs})"
-      end
-    end
-
-    #--------------------------------------------------------------------------
-    # check if class types of CONSTANTS do match
-    #--------------------------------------------------------------------------
-    invalid_const_definitions = []
-    if_const_class_type = nil
-    interface_constants.each do |const_name|
-      if_const_string = "%s::%s" % [interface_constant, const_name]
-      if_const_class_type = Object.const_get(if_const_string)
-      if_const_class_type = Object.const_get(if_const_string).class unless Object.const_get(if_const_string).class == Class
-      invalid_const_definitions += [const_name] unless if_const_class_type.class == Class
-      next if if_const_class_type.to_s == 'NilClass'
-      impl_const_value_type = Object.const_get("%s::%s" % [implementation_class, const_name]).class
-      # Ruby < 2.4
-      if defined?(Bignum) && if_const_class_type == Numeric && [Fixnum, Float, Bignum].include?(impl_const_value_type)
-        # we are fine, specific case for numbers
-      # Ruby => 2.4
-      elsif defined?(Integer) && if_const_class_type == Numeric && [Integer, Float].include?(impl_const_value_type)
-        # we are fine, specific case for numbers
-      elsif defined?(Bignum) && ((if_const_class_type == Bignum && impl_const_value_type == Integer) ||
-          (if_const_class_type == Fixnum && impl_const_value_type == Integer))
-        # Ruby 2.4 unifies Fixnum and Bignum into Integer
-      elsif if_const_class_type != impl_const_value_type
-        raise ClassInterface::ImplementationConstantTypeError, "Value type of constant '#{implementation_class}::#{const_name}' does not match interface '#{if_const_string}'. (#{impl_const_value_type} given, #{if_const_class_type} expected)"
-      end
-    end
-    raise ClassInterface::InterfaceConstantDefinitionError, "Value of constant(s) '#{invalid_const_definitions.join(" ")}' of interface '#{interface_constant}' must be a class constant or nil" if invalid_const_definitions.any?
-  else
-    raise ClassInterface::InterfaceNotDefinedError, "Interface '#{interface_constant}' is not defined"
-  end
-end
-
-
-# extracts the (module) class name of the caller
-# e.g. ModuleName::ClassName
-#
-# @param caller_locations [Array<Thread::Backtrace::Location>] array containing the result of caller_locations
-# @return [String] full specified constant class name
-def extract_caller_path(caller_locations)
-  path_elements = []
-  caller_locations.each do |el|
-    if el.label.start_with?('<class:') || el.label.start_with?('<module:')
-      name = el.label.gsub(/\<class:|\<module:/, '')[0...-1]
-      path_elements.push name
-    end
-  end
-  path_elements.reverse.join("::")
+require 'class_interface/version'
+
+require_relative 'custom_errors/implementation_constant_type_error'
+require_relative 'custom_errors/implementation_incomplete_error'
+require_relative 'custom_errors/implementation_parameter_count_error'
+require_relative 'custom_errors/interface_constant_definition_error'
+require_relative 'custom_errors/interface_not_defined_error'
+
+#
+# Equip classes with the requirement to implement interfaces
+#
+
+#
+# - ensures self.static methods to be defined (checking parameters count to be equal)
+# - ensures instance methods to be defined (checking parameters count to be equal)
+# - ensures CONSTANTS to be defined (checking for type of CONSTANTS)
+#
+# @param interface_constant [Class|String]
+def implements(interface_constant)
+  implementation_class = extract_caller_path caller_locations(1, 16)
+  if Object.const_defined? interface_constant.to_s
+    #--------------------------------------------------------------------------
+    # check if definitions exist
+    #--------------------------------------------------------------------------
+    # instance methods
+    interface_instance_methods = Object.const_get(interface_constant.to_s).instance_methods false
+    implementation_instance_methods = Object.const_get(implementation_class.to_s).instance_methods false
+    unimplemented_instance_methods = interface_instance_methods - implementation_instance_methods
+    # static methods
+    interface_static_methods = Object.const_get(interface_constant.to_s).methods false
+    implementation_static_methods = Object.const_get(implementation_class.to_s).methods false
+    unimplemented_static_methods = interface_static_methods - implementation_static_methods
+    # constants
+    interface_constants = Object.const_get(interface_constant.to_s).constants
+    implementation_constants = Object.const_get(implementation_class.to_s).constants
+    unimplemented_constants = interface_constants - implementation_constants
+    if unimplemented_instance_methods.any? || unimplemented_static_methods.any? || unimplemented_constants.any?
+      error_message = "\nThe interface '#{interface_constant}' was not completely implemented in class '#{implementation_class}'."
+      error_message += "\n  - missing instance methods:\n      #{unimplemented_instance_methods.join(' ')}" if unimplemented_instance_methods.any?
+      error_message += "\n  - missing static methods:\n      #{unimplemented_static_methods.join(' ')}" if unimplemented_static_methods.any?
+      error_message += "\n  - missing constants:\n      #{unimplemented_constants.join(' ')}" if unimplemented_constants.any?
+      raise ClassInterface::ImplementationIncompleteError, error_message
+    end
+
+    #--------------------------------------------------------------------------
+    # check if method parameters count does match on implementation and interface
+    #--------------------------------------------------------------------------
+    interface_instance_methods.each do |method_name|
+      if_params_count_arity = Object.const_get(interface_constant.to_s).new.method(method_name).arity
+      impl_params_count_arity = Object.const_get(implementation_class).new.method(method_name).arity
+      if if_params_count_arity != impl_params_count_arity
+        raise ClassInterface::ImplementationParameterCountError, "Parameters of instance method '#{implementation_class}##{method_name}' do not match with interface '#{interface_constant}##{method_name}' (given #{impl_params_count_arity.abs}, expected #{if_params_count_arity.abs})"
+      end
+    end
+    interface_static_methods.each do |method_name|
+      if_params_count_arity = Object.const_get(interface_constant.to_s).method(method_name).arity
+      impl_params_count_arity = Object.const_get(implementation_class).method(method_name).arity
+      if if_params_count_arity != impl_params_count_arity
+        raise ClassInterface::ImplementationParameterCountError, "Parameters of static method '#{implementation_class}##{method_name}' do not match with interface '#{interface_constant}##{method_name}' (given #{impl_params_count_arity.abs}, expected #{if_params_count_arity.abs})"
+      end
+    end
+
+    #--------------------------------------------------------------------------
+    # check if class types of CONSTANTS do match
+    #--------------------------------------------------------------------------
+    invalid_const_definitions = []
+    if_const_class_type = nil
+    interface_constants.each do |const_name|
+      if_const_string = "%s::%s" % [interface_constant, const_name]
+      if_const_class_type = Object.const_get(if_const_string)
+      if_const_class_type = Object.const_get(if_const_string).class unless Object.const_get(if_const_string).class == Class
+      invalid_const_definitions += [const_name] unless if_const_class_type.class == Class
+      next if if_const_class_type.to_s == 'NilClass'
+      impl_const_value_type = Object.const_get("%s::%s" % [implementation_class, const_name]).class
+      ruby_version_lt_24 = (1.class.to_s == 'Fixnum')
+      ruby_version_gte_24 = (1.class.to_s == 'Integer')
+      # Ruby < 2.4
+      if ruby_version_lt_24 && if_const_class_type.to_s == 'Numeric' && %w[Fixnum Float Bignum].include?(impl_const_value_type.to_s)
+        # we are fine, specific case for numbers
+      # Ruby => 2.4
+      elsif ruby_version_gte_24 && if_const_class_type.to_s == 'Numeric' && %w[Integer Float].include?(impl_const_value_type.to_s)
+        # we are fine, specific case for numbers
+      elsif ruby_version_lt_24 && ((if_const_class_type.to_s == 'Bignum' && impl_const_value_type.to_s == 'Integer') ||
+          (if_const_class_type.to_s == 'Fixnum' && impl_const_value_type.to_s == 'Integer') ||
+          (if_const_class_type.to_s == 'Integer' && impl_const_value_type.to_s == 'Fixnum') ||
+          (if_const_class_type.to_s == 'Integer' && impl_const_value_type.to_s == 'Bignum'))
+        # Ruby 2.4 unifies Fixnum and Bignum into Integer
+      elsif if_const_class_type != impl_const_value_type
+        raise ClassInterface::ImplementationConstantTypeError, "Value type of constant '#{implementation_class}::#{const_name}' does not match interface '#{if_const_string}'. (#{impl_const_value_type} given, #{if_const_class_type} expected)"
+      end
+    end
+    raise ClassInterface::InterfaceConstantDefinitionError, "Value of constant(s) '#{invalid_const_definitions.join(" ")}' of interface '#{interface_constant}' must be a class constant or nil" if invalid_const_definitions.any?
+  else
+    raise ClassInterface::InterfaceNotDefinedError, "Interface '#{interface_constant}' is not defined"
+  end
+end
+
+
+# extracts the (module) class name of the caller
+# e.g. ModuleName::ClassName
+#
+# @param caller_locations [Array<Thread::Backtrace::Location>] array containing the result of caller_locations
+# @return [String] full specified constant class name
+def extract_caller_path(caller_locations)
+  path_elements = []
+  caller_locations.each do |el|
+    if el.label.start_with?('<class:') || el.label.start_with?('<module:')
+      name = el.label.gsub(/\<class:|\<module:/, '')[0...-1]
+      path_elements.push name
+    end
+  end
+  path_elements.reverse.join("::")
 end

data/lib/class_interface/version.rb

@@ -1,3 +1,3 @@
-module ClassInterface
-  VERSION = '0.1.0'.freeze
-end
+module ClassInterface
+  VERSION = '1.0.1'.freeze
+end

data/lib/custom_errors/implementation_constant_type_error.rb

@@ -1,4 +1,4 @@
-module ClassInterface
-  class ImplementationConstantTypeError < StandardError
-  end
-end
+module ClassInterface
+  class ImplementationConstantTypeError < StandardError
+  end
+end

data/lib/custom_errors/implementation_incomplete_error.rb

@@ -1,4 +1,4 @@
-module ClassInterface
-  class ImplementationIncompleteError < StandardError
-  end
-end
+module ClassInterface
+  class ImplementationIncompleteError < StandardError
+  end
+end

data/lib/custom_errors/implementation_parameter_count_error.rb

@@ -1,4 +1,4 @@
-module ClassInterface
-  class ImplementationParameterCountError < StandardError
-  end
-end
+module ClassInterface
+  class ImplementationParameterCountError < StandardError
+  end
+end

data/lib/custom_errors/interface_constant_definition_error.rb

@@ -1,4 +1,4 @@
-module ClassInterface
-  class InterfaceConstantDefinitionError < StandardError
-  end
-end
+module ClassInterface
+  class InterfaceConstantDefinitionError < StandardError
+  end
+end

data/lib/custom_errors/interface_not_defined_error.rb

@@ -1,4 +1,4 @@
-module ClassInterface
-  class InterfaceNotDefinedError < StandardError
-  end
-end
+module ClassInterface
+  class InterfaceNotDefinedError < StandardError
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_interface
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matthäus Beyrle
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - class_interface.gemspec@mail.magynhard.de
 executables: []
@@ -82,7 +82,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,9 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Extends Ruby to support class interfaces
 test_files: []