checkability 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae53afa68f33c527bee835d3c84e304c7596f46665cc41ff1df67b2e4189f595
-  data.tar.gz: 8de80e50a31b5e3c7b2f498b8c81de8793b4d80f9a4665653dd12be745331721
+  metadata.gz: f427c18e28549b00de27a9b29d5c3278be27a07f76b5efeb3c88bd07c9fa8004
+  data.tar.gz: 68c2e5ca988d593452a15b07c2b0a9f6155cf4a170434c40509c2e8f570a1cff
 SHA512:
-  metadata.gz: 32ed1b0305e36d037d38bde6acf78f4c7d4ae04e49764d4129fb5d9f455cf349607131ea17b5a500a0f47ab38f31698d06eeaec07dc9a014b030518be42e66fa
-  data.tar.gz: cec99b497500443955ef650e56948037e8e7855456f14aa66a491e71ecd884c9d1553c64bbb10fd7a1ce23ae535fa1d42bb730a0979bfead71db07a625bc2407
+  metadata.gz: 6f86d27e1c09d25597de9a6f82701aba4ebfe77c29c469857c1cb2b07d492e87485a9f234c957083220df84f03d66d991b1e700a7aa4121782e567a8be9a3cb2
+  data.tar.gz: d52836824181062c8e294b56e27d3b6d486b5860d6f13be64d2fe6cefd6c9e98f22d3980a1d35d5ebde74374f3df3c89a4be8bf1b2feb7be4f69ff750c23713c

data/README.md

@@ -12,12 +12,12 @@ How to use my plugin.
 inside of any rails model do
 ```ruby
 class SomeModel
-  acts_as_checkable strategy: proc { |a, b, c| a && (b || c) },
-                    checkers: uk_postcode_checkers
+  extend UKPostcodeCheckersConf
+  acts_as_checkable uk_postcode_checkers_conf
 end
 ```
 where `uk_postcode_checkers` is method which returns hash with configurations  
-https://github.com/azazelo/postcode_checker/blob/master/app/models/concerns/u_k_postcode_checkers.rb  
+https://github.com/azazelo/postcode_checker/blob/master/app/models/concerns/u_k_postcode_checkers_conf.rb  
 then in your controller:  
 ```ruby
 class ChecksController < ApplicationController
@@ -30,7 +30,7 @@ class ChecksController < ApplicationController
     message, alert_class =
       if @check.valid?
         @check.perform_check
-        [@check.messages.join('<br/>'), _alert_class(@check.allowed)]
+        [@check.ch_messages.join('<br/>'), _alert_class(@check.ch_allowed)]
       else
         [@check.errors.full_messages.join('<br/>'), _alert_class(false)]
       end

data/lib/checkability.rb

@@ -9,5 +9,6 @@ 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/base_checker'
 
 ActiveRecord::Base.include Checkability::ActsAsCheckable

data/lib/checkability/acts_as_checkable.rb

@@ -12,35 +12,42 @@ module Checkability
 
     class_methods do
       def acts_as_checkable(options = {})
-        raise ArgumentError, "Hash expected, got #{options.class.name}" if !options.is_a?(Hash) && !options.empty?
+        if !options.is_a?(Hash) && !options.empty?
+          raise ArgumentError,
+                "Hash expected, got #{options.class.name}"
+        end
 
-        class_attribute :checkable_conf
+        class_attribute :ch_conf
 
-        self.checkable_conf = options
+        self.ch_conf = options
       end
     end
 
-    attr_accessor :allowed, :messages
+    attr_accessor :ch_allowed, :ch_messages
+
+    def initialize(params)
+      @ch_messages = []
+      @ch_allowed = nil
+      super(params)
+    end
 
     def perform_check
-      _setup
-      self.allowed = _check
-      messages << "#{allowed}::'#{value}' is #{_allowness}. "
+      Checkability::Checkable.new(self).check(ch_conf)
+      ch_messages << "#{ch_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
+      ch_conf[:attr_name] || :value
     end
 
-    def _check
-      Checkability::Checkable.new(self).check(checkable_conf)
+    def _allowness
+      ch_allowed ? 'ALLOWED' : 'NOT allowed'
     end
   end
 end

data/lib/checkability/base_checker.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'checker'
+
+module Checkability
+  # @abstract
+  class BaseChecker < Checker
+    # @return [Handler]
+    attr_reader :stop_process_on_success, :stop_process_on_failure,
+                :success_message, :failure_message
+
+    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
+
+    # subclass should implement
+    def post_initialize(_opts)
+      nil
+    end
+
+    # @param [Handler] handler
+    #
+    # @return [Handler]
+    def next_handler(handler)
+      @next_handler = handler
+
+      handler
+    end
+
+    # @abstract
+    #
+    # @param [String] request
+    #
+    # @return [Boolean, nil]
+    def handle(check_obj)
+      res, mess = result_and_message(check_obj)
+      check_obj.ch_messages << mess
+      check_obj.ch_allowed = res
+
+      return if _stop_here?(res)
+
+      @next_handler&.handle(check_obj) if @next_handler
+    end
+
+    def result_and_message(check_obj = nil)
+      res = result(check_obj)
+
+      str = res ? success_message : failure_message
+      [res, message(res, str)]
+      #    rescue StandardError => e
+      #      [false, message(false, e)]
+    end
+
+    # subclass should implement
+    def result(_check_obj)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    # subclass may override
+    def message(res, str)
+      "#{res}::#{str}"
+    end
+
+    private
+
+    def _stop_here?(res)
+      (res && stop_process_on_success) || (!res && stop_process_on_failure)
+    end
+  end
+end

data/lib/checkability/checkable.rb

@@ -1,40 +1,57 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 module Checkability
   # Implements check method to Iterate on chechers
   # Possible to implemet as Iterator in future
   #
   class Checkable
-    attr_reader :checkable
+    attr_accessor :check_obj
+
+    extend Forwardable
+    def_delegators :@check_obj, :ch_messages, :ch_allowed
 
-    def initialize(checkable)
-      @checkable = checkable
+    def initialize(check_obj)
+      @check_obj = check_obj
     end
 
-    # strategy is a proc
-    #   like { |a,b,c| a && ( b || c ) }
-    #   where a,b,c are checkers
-    #   and each should return true|false
-    # checker_confs is an array of checker_conf hashes
-    #   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    .next_handler(storage)
+    # storage      .next_handler(api_validator)
+    # api_validator.next_handler(api_finder)
+    # api_validator.next_handler(nil)
+    #
+    # validator.handle(request)
+    #
+    def check(handler_confs)
+      first_handler_name = handler_confs.keys.first
+      first_handler = _handlers(handler_confs)[first_handler_name]
+
+      first_handler.handle(check_obj)
+    rescue StandardError => e
+      check_obj.ch_messages << "false::#{e}: #{handler_confs}."
+      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 << "false::#{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(confs)
+      confs.transform_values { |conf| _make_handler(conf) }
+    end
+
+    def _make_handler(conf)
+      Checkability.const_get(conf[:name].to_s.camelize)
+                  .new(conf)
     end
   end
 end

data/lib/checkability/checker.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Checkability
+  # @abstract
+  class Checker
+    # hook method to initialize concreet attributes
+    # @abstract
+    #
+    # @param [Hash]
+    #
+    # @return new object
+    def post_initialize(_opts)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    # @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 Array [ [Boolean, true|false], String, message] ]
+    def result_and_message(_object)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    # @abstract
+    #
+    # @param [Checkable object] request
+    #
+    # @return [Boolean, true|false]
+    def result(_object)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+
+    # @abstract
+    #
+    # @params [Boolean], [String]
+    #
+    # @return [String]
+    def message(_res, _str)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
+  end
+end

data/lib/checkability/external_api_checker.rb

@@ -1,55 +1,47 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'net/http'
-require 'net/https'
-require 'json'
+require 'forwardable'
 
 module Checkability
   # Checks if postcode exists in external API
   #
-  class ExternalApiChecker
-    attr_reader :path, :path_suffix, :check_method, :connection, :http_verb,
-                :failure_message, :success_message
+  class ExternalApiChecker < BaseChecker
+    attr_reader :path, :path_suffix, :check_method, :connector, :http_verb
 
-    def initialize(conf = {})
+    extend Forwardable
+    def_delegators :@connector, :connection
+
+    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)
+      @connector = conf[:connector] ||
+                   Checkability::ExternalApiConnector.new(conf[:path])
+      @resp = nil
     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
+    def result(check_obj)
+      return false unless resp(check_obj).status == 200
+
+      check_method.call(_parsed(resp(check_obj)))
     end
 
-    private
+    def resp(check_obj)
+      @resp ||= connection
+                .send(http_verb,
+                      "#{check_obj.value.delete(' ')}#{path_suffix}")
+      # .get('SE17QD')
+    end
 
-    def _message(str, res)
+    def message(res, str = nil)
       "#{res}::#{path}: #{str}"
     end
 
+    private
+
     def _parsed(resp)
       JSON.parse(resp.body)
     end
-
-    def _result_and_message
-      return [false, _message(@resp.status, false)] unless @resp.status == 200
-
-      return [true, _message(success_message, true)] if check_method
-                                                        .call(_parsed(@resp))
-
-      [false, _message(failure_message, false)]
-    rescue StandardError => e
-      [false, _message(e, false)]
-    end
   end
 end

data/lib/checkability/external_api_connector.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
+require 'faraday'
+
 module Checkability
   # Create connection
   #
   class ExternalApiConnector
     attr_reader :path
 
-    def initialize(conf)
-      @path = conf[:path]
+    def initialize(path)
+      @path = path
     end
 
-    def connect
+    def connection
       Faraday.new(url: path) do |faraday|
         faraday.headers['Content-Type'] = 'application/json'
         faraday.adapter Faraday.default_adapter

data/lib/checkability/storage_checker.rb

@@ -1,32 +1,30 @@
 # frozen_string_literal: true
 
+require_relative 'base_checker'
 module Checkability
   # Checks if postcode exists in Storage
   #
-  class StorageChecker
-    attr_reader :storage_class
+  class StorageChecker < BaseChecker
+    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', result) : _message('Not found', result))
-      result
+    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(res, str = nil)
+      "#{res}::Allowed #{storage_class}s list: #{str}"
     end
 
-    def _message(str, res)
-      "#{res}::Allowed #{storage_class}s list: #{str}."
+    private
+
+    def _normalize_value(value)
+      value.delete(' ').upcase
     end
   end
 end

data/lib/checkability/validator.rb

@@ -3,27 +3,15 @@
 module Checkability
   # Checks if postcode comply with regex
   #
-  class Validator
+  class Validator < BaseChecker
     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, "false::Value is NOT COMPLY with format of #{format[:name]}."]
-      else
-        [true, "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,5 +1,5 @@
 # frozen_string_literal: true
 
 module Checkability
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkability
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrey Eremeev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies: []
 description: Provide Checkers functionality.
 email:
@@ -24,7 +24,9 @@ files:
 - bin/checkability
 - lib/checkability.rb
 - lib/checkability/acts_as_checkable.rb
+- lib/checkability/base_checker.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