strong_interface 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a3cd6f325e9f01905b2c69da7391e760d6e0bd55d60f5038a478ba7a14a055
-  data.tar.gz: b8d5f89c62dda435cfac22d81efb744414465b45d6d3f455c7f70e68e5c73540
+  metadata.gz: 7010fd03e0c054d2386425b2ab26c18388ccec88c44dd3cf6ade1c74917141af
+  data.tar.gz: 1ea5cdba16e454fd6dc5386637d4406171db07cd03f5c1ee2850103bf2396200
 SHA512:
-  metadata.gz: ef2277ee74a7426e83b7345929f3b36013ab9e955f2bc23f581b497349ca690baae4882b1fe0ee571ba03de831215548415fbd3b7e0b1ebe5cd2721716f13b8a
-  data.tar.gz: 8685a1b66e1a5dcc9e8a15458c2e5ea0e5db95ba148947027b88437c3b79912e27f3d23bab46444771c820b0ae4f44adf6277b9f8b19149e9220aa9596dc4c48
+  metadata.gz: fdf24793ad076bd234001d1d8f943f3d8e60d159a99cdfbb27924185d0a1305c2c02ccddd635cdb28784baf506f1d7b9c84b189cd09fe15f531cfaff4acfca76
+  data.tar.gz: dd20b7d35a6cbad36f92d613771b8bb14e55e7bbb5a6bbd690c7f70a441aeca7e232ad6f758f132f943abc325c2b60cdbbacdeeed20e9ac583c44529b6905323

data/CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ## main (unreleased)
 
----
+### New Features
+
+- [#1](https://github.com/programyan/strong_interface/pull/1) Added constants validation
 
 ## 0.2.0
 

data/Gemfile.lock

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

data/README.md

@@ -32,6 +32,7 @@ Or install it yourself as:
 
 ```ruby
 module IDog
+  WORD = String
   def self.create(*); end
   def eat(food); end
   def voice; end
@@ -45,6 +46,8 @@ class Lessy
   extend StrongInterface
   implements IDog
   
+  WORD = 'gav'
+
   def self.create(name)
     # Creating...
   end
@@ -54,7 +57,7 @@ class Lessy
   end
   
   def voice
-    'Gav'
+    WORD
   end
 end
 ```
@@ -79,7 +82,8 @@ end
 #### Exception will be raised
 
 ```shell
-StrongInterface::MethodNotImplemented (Class method `create` 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)`
 ```
 
@@ -92,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
@@ -105,6 +109,8 @@ even if it has this kind of a problem in code.
 
 - [x] Check if methods of interfaces all exists in a class or module
 - [x] Check the arguments of methods
+- [x] Check constants
+- [ ] Checking the privacy of methods???
 - [ ] Allow optional arguments at interface methods???
 
 ## Development

data/lib/strong_interface/parameters_validator.rb

@@ -24,16 +24,17 @@ module StrongInterface
       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]
+        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(m)
-      m.inspect.scan(/[\.|#](\S+?\(.*?\))/).last.first
+    def description(metod)
+      metod.inspect.scan(/[.|#](\S+?\(.*?\))/).last.first
     end
   end
-end
+end

data/lib/strong_interface/version.rb

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

data/lib/strong_interface.rb

@@ -4,17 +4,18 @@ 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
@@ -34,13 +35,19 @@ 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|
-      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
@@ -50,7 +57,7 @@ module StrongInterface
 
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_interface
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 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: