strong_interface 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 623aa81d3e30d46a852d757e6911005dca1b09c0cdb1589be7696a216847b2b2
-  data.tar.gz: c39798e031a50dea42bed5c47e335b7072dc62024ecbc2f87c6cc248ee2e291b
+  metadata.gz: 8cf1e550ee688057b954e398cd8b74fa8c6622c46ff79e3d5783dab70d977ca2
+  data.tar.gz: b6430938ec444d0a5686560b850143626fca0ecadbe06a6961f960fde0f98030
 SHA512:
-  metadata.gz: 2867ff46ed12b7fa6357d697a49cca3c8e7931298b9cbbeaf64fc1f6ea9bb91231609e0c6dd3bbc6ec98071715a0383867b73ff08aab4f00e899b2c8fec1c5d4
-  data.tar.gz: b20a94a556ed3c8c0c41516628889d4b28628947cdec0a331226d5fb168b87bdf9aca25650956a213354b699a2f7eacd2ee7132a5e973f32ca2eaa76f2617572
+  metadata.gz: 2734acdbd5793a2746beaafd088b7fc9263b9326034a3e7db3004b159024673c7a02bdd94a1fea3a979b56c84c3cf37ce950f486b4fdd54f8b80355a3f03c131
+  data.tar.gz: 5211b5df2b6f50be7ba05dbe698fa36f5f7bd6f99239ceb4afd14e562d9b4282ec9d09ee0e4bdb03d2bef6bc7fcfd0bcb513bfbef9fea4f4c51dfe52791ad192

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## main (unreleased)
+
+---
+
+## 0.3.1
+
+## Bugfixes
+
+- Fixed CHANGELOG.md
+
+## 0.3.0
+
+### New Features
+
+- [#1](https://github.com/programyan/strong_interface/pull/1) Added constants validation
+
+## 0.2.0
+
+### New features
+
+- [9506eb3](https://github.com/programyan/strong_interface/commit/9506eb31666628cd6d06a4a4608ca81081a1315b) Add validation parameters
+
+## 0.1.0
+
+- DSL
+- Basic implementation of methods presence

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strong_interface (0.1.0)
+    strong_interface (0.3.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -32,8 +32,9 @@ Or install it yourself as:
 
 ```ruby
 module IDog
+  WORD = String
   def self.create(*); end
-  def eat(*); end
+  def eat(food); end
   def voice; end
 end
 ```
@@ -45,16 +46,18 @@ class Lessy
   extend StrongInterface
   implements IDog
   
+  WORD = 'gav'
+
   def self.create(name)
-    ...
+    # Creating...
   end
   
   def eat(food)
-    ...
+    # Eating...
   end
   
   def voice
-    'Gav'
+    WORD
   end
 end
 ```
@@ -66,6 +69,10 @@ class Lessy
   extend StrongInterface
   implements IDog
 
+  def eat(food, water)
+    # Eating...
+  end
+
   def voice
     'Gav'
   end
@@ -75,8 +82,9 @@ end
 #### Exception will be raised
 
 ```shell
-StrongInterface::MethodNotImplemented (Class method `create` is not implemented at `Lessy`)
-Instance method `eat` is not implemented at `Lessy`
+StrongInterface::ImplementationError (Constant `WORD` is absent at `Lessy`)
+Class method `create` is not implemented at `Lessy`
+Invalid parameters at method `eat`, expected: `def eat(food)`, got: `def eat(food, water)`
 ```
 
 ## Validation Strategies
@@ -88,7 +96,7 @@ If the variable is not set, the `raise` strategy will be applied.
 
 #### raise (default)
 
-This is a default strategy. When validator finds incorrect implementation, it raises the `StrongInterface::MethodNotImplemented` exception,
+This is a default strategy. When validator finds incorrect implementation, it raises the `StrongInterface::ImplementationError` exception,
 and provides a list of methods which aren't implemented
 
 #### log
@@ -100,7 +108,10 @@ even if it has this kind of a problem in code.
 ## TODO
 
 - [x] Check if methods of interfaces all exists in a class or module
-- [ ] Check the arguments of methods
+- [x] Check the arguments of methods
+- [x] Check constants
+- [ ] Checking the privacy of methods???
+- [ ] Allow optional arguments at interface methods???
 
 ## Development
 
@@ -110,7 +121,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/strong_interface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/strong_interface/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/programyan/strong_interface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/programyan/strong_interface/blob/main/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -119,4 +130,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the StrongInterface project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/strong_interface/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the StrongInterface project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/programyan/strong_interface/blob/main/CODE_OF_CONDUCT.md).

data/lib/strong_interface/parameters_validator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module StrongInterface
+  class ParametersValidator
+    def initialize(interface_method, klass_method)
+      @interface_method = interface_method
+      @interface_method_parameters = interface_method.parameters.map { |param| param[0] }
+      @klass_method = klass_method
+      @klass_method_parameters = klass_method.parameters.map { |param| param[0] }
+    end
+
+    def validate
+      return if valid?
+
+      "Invalid parameters at method `#{@klass_method.name}`, expected: `def #{description(@interface_method)}`," \
+        " got: `def #{description(@klass_method)}`"
+    end
+
+    def valid?
+      return true if @interface_method_parameters == [:rest]
+      return true if @klass_method_parameters == [:rest]
+
+      return true if @interface_method_parameters == @klass_method_parameters
+      return false if @interface_method_parameters.size != @klass_method_parameters.size
+
+      @interface_method_parameters.each.with_index.all? do |key, index|
+        case key
+        when :req
+          %i[req opt].include? @klass_method_parameters[index]
+        when :keyreq
+          %i[keyreq key].include? @klass_method_parameters[index]
+        end
+      end
+    end
+
+    def description(metod)
+      metod.inspect.scan(/[.|#](\S+?\(.*?\))/).last.first
+    end
+  end
+end

data/lib/strong_interface/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StrongInterface
-  VERSION = '0.1.0'
+  VERSION = '0.3.1'
 end

data/lib/strong_interface.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 require 'strong_interface/version'
+require 'strong_interface/parameters_validator'
 
 module StrongInterface
-  MethodNotImplemented = Class.new(StandardError)
+  ImplementationError = Class.new(StandardError)
   UnknownStrategy = Class.new(StandardError)
 
   RAISING_STRATEGIES = {
-    'raise' => ->(error) { raise MethodNotImplemented, error },
+    'raise' => ->(error) { raise ImplementationError, error },
     'log' => ->(error) { Logger.new($stdout).warn { error } }
   }.freeze
 
   # @param interfaces [Module|Class|Array<Module|Class>] the list of interfaces that class or module should implements
-  # @raise [UnknownStrategy] if SI_NOTIFICATION environment variable has wrong value
-  # @raise [ImplementationError] if describing some methods of an interface has been forgotten and SI_NOTIFICATION environment variable is set to `raise`
+  # @raise [UnknownStrategy] if SI_VALIDATION_STRATEGY environment variable has wrong value
+  # @raise [ImplementationError] if describing some methods of an interface has been forgotten and
+  #                              SI_VALIDATION_STRATEGY environment variable is set to `raise`
   def implements(interfaces)
     TracePoint.trace(:end) do |t|
       next if self != t.self
@@ -33,20 +35,32 @@ module StrongInterface
 
   def validate(interfaces)
     Array(interfaces).flat_map do |interface|
-      validate_class_methods(interface) + validate_instance_methods(interface)
+      validate_constants(interface) + validate_class_methods(interface) + validate_instance_methods(interface)
+    end
+  end
+
+  def validate_constants(interface)
+    (interface.constants - constants).map do |missing_constant|
+      "Constant `#{missing_constant}` is absent at `#{self}`"
     end
   end
 
   def validate_class_methods(interface)
     interface.methods(false).filter_map do |klass_method|
-      "Class method `#{klass_method}` is not implemented at `#{self}`" unless methods(false).include?(klass_method)
+      if !methods(false).include?(klass_method)
+        "Class method `#{klass_method}` is not implemented at `#{self}`"
+      else
+        ParametersValidator.new(interface.method(klass_method), method(klass_method)).validate
+      end
     end
   end
 
   def validate_instance_methods(interface)
     interface.instance_methods.filter_map do |instance_method|
-      unless instance_methods.include?(instance_method)
+      if !instance_methods.include?(instance_method)
         "Instance method `#{instance_method}` is not implemented at `#{self}`"
+      else
+        ParametersValidator.new(interface.instance_method(instance_method), instance_method(instance_method)).validate
       end
     end
   end

data/strong_interface.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/programyan/strong_interface'
+  spec.metadata['changelog_uri'] = 'https://github.com/programyan/strong_interface/blob/main/CHANGELOG.md'
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_interface
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Ageev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-06-11 00:00:00.000000000 Z
 dependencies: []
 description: Simple implementation of an interface pattern for Ruby
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -28,6 +29,7 @@ files:
 - bin/console
 - bin/setup
 - lib/strong_interface.rb
+- lib/strong_interface/parameters_validator.rb
 - lib/strong_interface/version.rb
 - strong_interface.gemspec
 homepage: https://github.com/programyan/strong_interface
@@ -36,6 +38,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/programyan/strong_interface
   source_code_uri: https://github.com/programyan/strong_interface
+  changelog_uri: https://github.com/programyan/strong_interface/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: