checkability 0.4.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae846f196e0b6d2648429f824e02205b9a3fe04d
-  data.tar.gz: 10156c70279d72817146d19fceaef9cbba3f116d
+SHA256:
+  metadata.gz: d691bd54ab262dd07d0bdf1120d632a71003cfdc730002275d10333e21045526
+  data.tar.gz: 104e1558d7867413f25e838d3db9aaf54d2a7f96b412dd1121149e9528c9f95d
 SHA512:
-  metadata.gz: 990b1575b7ebfb0e667aa1ab2e6a0601e3388ea1b2ecd7f4808d843d1341085f454477804fa8f0edeb743fd2508fdb16d2b7a9eb2d8451a20a212791f67f411d
-  data.tar.gz: 445c267c33c75d63188d6ec04767409afed7734292a369e880d8e1d1cc03b5b8a9af80339b076968d60816ec9834901ab9ed6a7299606b9d3fe496276e869af3
+  metadata.gz: 42816cf5985cfcc1d0f680496f0fdde3fd3263f87a4b12010f9d3f33694481703c8ed3785531914cfd5143982001c6fbe2977a52de789d7c559720048d3657ec
+  data.tar.gz: 00e84b4caa4c5fae3eea6ae4e7e1fb0c3550e29948c81df7a85aaf4ea8ae98bf1083e3559b1583d28243faecdd477ebdbb8b7eab33318cd6571f15b5a08b52a0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 
 require 'bundler/gem_tasks'

data/bin/checkability

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/checkability'
 

data/lib/checkability.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'active_support'
 require_relative 'checkability/version'
@@ -7,5 +9,7 @@ require_relative 'checkability/external_api_checker'
 require_relative 'checkability/external_api_connector'
 require_relative 'checkability/validator'
 require_relative 'checkability/acts_as_checkable'
+require_relative 'checkability/checker'
+require_relative 'checkability/abstract_checker'
 
 ActiveRecord::Base.include Checkability::ActsAsCheckable

data/lib/checkability/abstract_checker.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'checker'
+
+module Checkability
+  # @abstract
+  class AbstractChecker < Checker
+    # @return [Handler]
+    attr_reader :stop_process_on_failure, :stop_process_on_success
+    attr_accessor :success_message, :failure_message, :handler
+
+    def initialize(opts = {})
+      @stop_process_on_failure = opts[:stop_process_on_failure] || false
+      @stop_process_on_success = opts[:stop_process_on_success] || false
+      @success_message = opts[:success_message] || 'Success.'
+      @failure_message = opts[:failure_message] || 'Failed.'
+
+      @next_handler = nil
+      post_initialize(opts) # implemented in subclass
+    end
+
+    # @param [Handler] handler
+    #
+    # @return [Handler]
+    def next_handler(handler)
+      @handler = handler if handler
+
+      handler
+    end
+
+    # @abstract
+    #
+    # @param [String] request
+    #
+    # @return [Boolean, nil]
+    def handle(request)
+      check = check_value(request) # imlemented in subclass
+
+      return true  if check && stop_process_on_success
+
+      return false if !check && stop_process_on_failure
+
+      handler&.handle(request)
+    end
+
+    def check_value(checkable)
+      result, message = result_and_message(checkable)
+      checkable.messages << message
+      result
+    end
+
+    def result_and_message(checkable)
+      result = _result(checkable)
+      str = result ? success_message : failure_message
+      [result, message(str, result)]
+    rescue StandardError => e
+      [false, message(e, false)]
+    end
+
+    def _result; end
+
+    def message(str, res)
+      "#{res}::#{str}"
+    end
+  end
+end

data/lib/checkability/acts_as_checkable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
   # Adding class and instance methods
   #
@@ -11,7 +13,8 @@ module Checkability
     class_methods do
       def acts_as_checkable(options = {})
         if !options.is_a?(Hash) && !options.empty?
-          raise ArgumentError, "Hash expected, got #{options.class.name}"
+          raise ArgumentError,
+                "Hash expected, got #{options.class.name}"
         end
 
         class_attribute :checkable_conf
@@ -23,24 +26,26 @@ module Checkability
     attr_accessor :allowed, :messages
 
     def perform_check
-      _setup
-      self.allowed = _check
-      messages << "'#{value}' is #{_allowness}. "
+      self.allowed = nil
+      self.messages = []
+      self.allowed = Checkability::Checkable.new(self).check(checkable_conf)
+      messages << "#{allowed}::'#{_value}' is #{_allowness}. "
     end
 
     private
 
-    def _setup
-      self.allowed = nil
-      self.messages = []
+    def _value
+      send(_attr_name)
     end
 
-    def _allowness
-      allowed ? 'ALLOWED' : 'NOT allowed'
+    def _attr_name
+      checkable_conf[:attr_name] || :value
     end
 
-    def _check
-      Checkability::Checkable.new(self).check(checkable_conf)
+    def _setup; end
+
+    def _allowness
+      allowed ? 'ALLOWED' : 'NOT allowed'
     end
   end
 end

data/lib/checkability/checkable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
   # Implements check method to Iterate on chechers
   # Possible to implemet as Iterator in future
@@ -7,32 +9,47 @@ module Checkability
 
     def initialize(checkable)
       @checkable = checkable
+      @checkable.messages = []
     end
 
-    # sentence is a proc
-    #   like { |a,b,c| a && ( b || c ) }
-    #   where a,b,c are checkers
-    #   and each should return true|false
-    # checkers is an array of checker objects
-    #   e.g. [storage_checker, external_api_checker]
-    def check(opts = {})
-      results = []
-      opts[:checker_confs].each do |checker_conf|
-        results << (res = _checker_to_check_value(checker_conf))
-        break if res && checker_conf[:stop_process_if_success]
-        break if res == false && checker_conf[:stop_process_if_failure]
-      end
-      opts[:strategy].call(results)
+    # As in result handlers should behave like this:
+    # validator    .set_next(storage)
+    # storage      .set_next(api_validator)
+    # api_validator.set_next(api_finder)
+    # api_validator.set_next(nil)
+    #
+    # validator.handle(request)
+    #
+    def check(opts)
+      handler_confs = opts[:handler_confs]
+      first_handler_name = opts[:first_handler]
+      first_handler = _handlers(handler_confs)[first_handler_name]
+
+      first_handler.handle(checkable)
+      #    rescue StandardError => e
+      #      checkable.messages << "false::#{e}: #{opts}."
+      #      false
     end
 
     private
 
-    def _checker_to_check_value(checker_conf)
-      k = "Checkability::#{checker_conf[:name].to_s.camelize}".constantize
-      k.new(checker_conf).check_value(checkable)
-    rescue NameError => e
-      checkable.messages << "#{e}: #{checker_conf[:name]}."
-      false
+    def _handlers(handler_confs)
+      handlers = _make_handlers(handler_confs)
+      handlers.each do |handler_name, handler|
+        next_handler_name = handler_confs[handler_name][:next_handler]
+        handler.next_handler(handlers[next_handler_name]) if handlers[next_handler_name]
+      end
+    end
+
+    def _make_handlers(handler_confs)
+      handler_confs.transform_values do |handler_conf|
+        _make_handler(handler_conf)
+      end
+    end
+
+    def _make_handler(conf)
+      k = Checkability.const_get conf[:name].to_s.camelize
+      k.new(conf)
     end
   end
 end

data/lib/checkability/checker.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Checkability
+  # @abstract
+  class Checker
+    # @abstract
+    #
+    # @param [Handler] handler
+    def next_handler=(_handler)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    # @abstract
+    #
+    # @param [String] request
+    #
+    # @return [String, nil]
+    def handle(_handler)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    # @abstract
+    #
+    # @param [String] request
+    #
+    # @return [Boolean, true|false]
+    def check_value(_request)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    # @abstract
+    #
+    # @param [String] request
+    #
+    # @return [Boolean, true|false]
+    def result_and_message(_object)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+  end
+end

data/lib/checkability/external_api_checker.rb

@@ -1,52 +1,45 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'net/http'
 require 'net/https'
 require 'json'
 
+# frozen_string_literal: true
+
 module Checkability
   # Checks if postcode exists in external API
   #
-  class ExternalApiChecker
+  class ExternalApiChecker < AbstractChecker
     attr_reader :path, :path_suffix, :check_method, :connection, :http_verb,
                 :failure_message, :success_message
 
-    def initialize(conf = {})
+    def post_initialize(conf = {})
       @path = conf[:path]
       @http_verb = conf[:http_verb] || :get
       @path_suffix = conf[:path_suffix] || ''
       @check_method = conf[:check_method]
-      @failure_message = conf[:failure_message] || 'Failed.'
-      @success_message = conf[:success_message] || 'Success.'
       @connection = Checkability::ExternalApiConnector.new(conf)
     end
 
-    def check_value(checkable)
-      @resp = connection.connect.send(http_verb,
-                                      checkable.value.delete(' ') + path_suffix)
-      result, message = _result_and_message
-      checkable.messages << message
-      result
-    end
-
     private
 
-    def _message(str)
-      "#{path}: #{str}"
-    end
+    def _result(checkable)
+      resp = connection
+             .connect
+             .send(http_verb, "#{checkable.value.delete(' ')}#{path_suffix}")
+      return false unless resp.status == 200
 
-    def _parsed(resp)
-      JSON.parse(resp.body)
+      check_method.call(_parsed(resp))
     end
 
-    def _result_and_message
-      return [false, _message(@resp.status)] unless @resp.status == 200
-
-      return [true, _message(success_message)] if check_method
-                                                  .call(_parsed(@resp))
+    def message(str, res)
+      str = "#{path}: #{str}"
+      super(str, res)
+    end
 
-      [false, _message(failure_message)]
-    rescue StandardError => e
-      [false, _message(e)]
+    def _parsed(resp)
+      JSON.parse(resp.body)
     end
   end
 end

data/lib/checkability/external_api_connector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
   # Create connection
   #

data/lib/checkability/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
   class Railtie < ::Rails::Railtie
   end

data/lib/checkability/storage_checker.rb

@@ -1,29 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'abstract_checker'
 module Checkability
   # Checks if postcode exists in Storage
   #
-  class StorageChecker
-    attr_reader :storage_class
+  class StorageChecker < AbstractChecker
+    attr_reader :storage_class, :attr_name
 
-    def initialize(conf = {})
+    def post_initialize(conf = {})
       @storage_class = conf[:storage_class]
+      @attr_name = conf[:attr_name] || :value
     end
 
-    def check_value(checkable)
-      value = checkable.value.upcase
-      result = _present_in_storage(value)
-      checkable.messages << (result ? _message('Found') : _message('Not found'))
-      result
+    private
+
+    def _result(checkable)
+      value = _normalize_value(checkable.send(attr_name))
+      storage_class.where(attr_name => value).present?
     end
 
-    def _present_in_storage(value)
-      storage_class.where(value: value)
-                   .or(storage_class.where(value: value.strip))
-                   .or(storage_class.where(value: value.delete(' ')))
-                   .present?
+    def message(str, res)
+      str = "Allowed #{storage_class}s list: #{str}"
+      super(str, res)
     end
 
-    def _message(str)
-      "Allowed #{storage_class}s list: #{str}."
+    def _normalize_value(value)
+      value.delete(' ').upcase
     end
   end
 end

data/lib/checkability/validator.rb

@@ -1,27 +1,19 @@
+# frozen_string_literal: true
+
 module Checkability
   # Checks if postcode comply with regex
   #
-  class Validator
+  class Validator < AbstractChecker
     attr_reader :format
 
-    def initialize(conf = {})
+    def post_initialize(conf = {})
       @format = conf[:format]
     end
 
-    def check_value(checkable)
-      result, message = _result_and_message(checkable)
-      checkable.messages << message
-      result
-    end
-
     private
 
-    def _result_and_message(checkable)
-      if (checkable.value.delete(' ') =~ format[:regex]).nil?
-        [false, "Value is NOT COMPLY with format of #{format[:name]}."]
-      else
-        [true, "Value is COMPLY with format of #{format[:name]}."]
-      end
+    def _result(checkable)
+      !(checkable.value.delete(' ') =~ format[:regex]).nil?
     end
   end
 end

data/lib/checkability/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.7.0'
 end

data/lib/tasks/checkability_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :checkability do
 #   # Task goes here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkability
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Eremeev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies: []
 description: Provide Checkers functionality.
 email:
@@ -23,8 +23,10 @@ files:
 - Rakefile
 - bin/checkability
 - lib/checkability.rb
+- lib/checkability/abstract_checker.rb
 - lib/checkability/acts_as_checkable.rb
 - lib/checkability/checkable.rb
+- lib/checkability/checker.rb
 - lib/checkability/external_api_checker.rb
 - lib/checkability/external_api_connector.rb
 - lib/checkability/railtie.rb
@@ -40,7 +42,7 @@ metadata:
   homepage_uri: https://github.com/azazelo/checkability
   source_code_uri: https://rubygems.org
   changelog_uri: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,16 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Provide Checkers functionality.
 test_files: []