strong_interface 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 623aa81d3e30d46a852d757e6911005dca1b09c0cdb1589be7696a216847b2b2
-  data.tar.gz: c39798e031a50dea42bed5c47e335b7072dc62024ecbc2f87c6cc248ee2e291b
+  metadata.gz: 23a3cd6f325e9f01905b2c69da7391e760d6e0bd55d60f5038a478ba7a14a055
+  data.tar.gz: b8d5f89c62dda435cfac22d81efb744414465b45d6d3f455c7f70e68e5c73540
 SHA512:
-  metadata.gz: 2867ff46ed12b7fa6357d697a49cca3c8e7931298b9cbbeaf64fc1f6ea9bb91231609e0c6dd3bbc6ec98071715a0383867b73ff08aab4f00e899b2c8fec1c5d4
-  data.tar.gz: b20a94a556ed3c8c0c41516628889d4b28628947cdec0a331226d5fb168b87bdf9aca25650956a213354b699a2f7eacd2ee7132a5e973f32ca2eaa76f2617572
+  metadata.gz: ef2277ee74a7426e83b7345929f3b36013ab9e955f2bc23f581b497349ca690baae4882b1fe0ee571ba03de831215548415fbd3b7e0b1ebe5cd2721716f13b8a
+  data.tar.gz: 8685a1b66e1a5dcc9e8a15458c2e5ea0e5db95ba148947027b88437c3b79912e27f3d23bab46444771c820b0ae4f44adf6277b9f8b19149e9220aa9596dc4c48

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## main (unreleased)
+
+---
+
+## 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/README.md

@@ -33,7 +33,7 @@ Or install it yourself as:
 ```ruby
 module IDog
   def self.create(*); end
-  def eat(*); end
+  def eat(food); end
   def voice; end
 end
 ```
@@ -46,11 +46,11 @@ class Lessy
   implements IDog
   
   def self.create(name)
-    ...
+    # Creating...
   end
   
   def eat(food)
-    ...
+    # Eating...
   end
   
   def voice
@@ -66,6 +66,10 @@ class Lessy
   extend StrongInterface
   implements IDog
 
+  def eat(food, water)
+    # Eating...
+  end
+
   def voice
     'Gav'
   end
@@ -76,7 +80,7 @@ end
 
 ```shell
 StrongInterface::MethodNotImplemented (Class method `create` is not implemented at `Lessy`)
-Instance method `eat` is not implemented at `Lessy`
+Invalid parameters at method `eat`, expected: `def eat(food)`, got: `def eat(food, water)`
 ```
 
 ## Validation Strategies
@@ -100,7 +104,8 @@ 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
+- [ ] Allow optional arguments at interface methods???
 
 ## Development
 
@@ -110,7 +115,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 +124,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,39 @@
+# 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|
+        if key == :req
+          %i(req opt).include? @klass_method_parameters[index]
+        elsif key == :keyreq
+          %i(keyreq key).include? @klass_method_parameters[index]
+        end
+      end
+    end
+
+    def description(m)
+      m.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.2.0'
 end

data/lib/strong_interface.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'strong_interface/version'
+require 'strong_interface/parameters_validator'
 
 module StrongInterface
   MethodNotImplemented = Class.new(StandardError)
@@ -39,7 +40,11 @@ module StrongInterface
 
   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)
+      unless 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
 
@@ -47,6 +52,8 @@ module StrongInterface
     interface.instance_methods.filter_map do |instance_method|
       unless 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_interface
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Ageev
@@ -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: