checkability 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d691bd54ab262dd07d0bdf1120d632a71003cfdc730002275d10333e21045526
-  data.tar.gz: 104e1558d7867413f25e838d3db9aaf54d2a7f96b412dd1121149e9528c9f95d
+  metadata.gz: f427c18e28549b00de27a9b29d5c3278be27a07f76b5efeb3c88bd07c9fa8004
+  data.tar.gz: 68c2e5ca988d593452a15b07c2b0a9f6155cf4a170434c40509c2e8f570a1cff
 SHA512:
-  metadata.gz: 42816cf5985cfcc1d0f680496f0fdde3fd3263f87a4b12010f9d3f33694481703c8ed3785531914cfd5143982001c6fbe2977a52de789d7c559720048d3657ec
-  data.tar.gz: 00e84b4caa4c5fae3eea6ae4e7e1fb0c3550e29948c81df7a85aaf4ea8ae98bf1083e3559b1583d28243faecdd477ebdbb8b7eab33318cd6571f15b5a08b52a0
+  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,7 +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/checker'
-require_relative 'checkability/abstract_checker'
+require_relative 'checkability/base_checker'
 
 ActiveRecord::Base.include Checkability::ActsAsCheckable

data/lib/checkability/acts_as_checkable.rb

@@ -17,19 +17,23 @@ module Checkability
                 "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
-      self.allowed = nil
-      self.messages = []
-      self.allowed = Checkability::Checkable.new(self).check(checkable_conf)
-      messages << "#{allowed}::'#{_value}' is #{_allowness}. "
+      Checkability::Checkable.new(self).check(ch_conf)
+      ch_messages << "#{ch_allowed}::'#{_value}' is #{_allowness}. "
     end
 
     private
@@ -39,13 +43,11 @@ module Checkability
     end
 
     def _attr_name
-      checkable_conf[:attr_name] || :value
+      ch_conf[:attr_name] || :value
     end
 
-    def _setup; end
-
     def _allowness
-      allowed ? 'ALLOWED' : 'NOT allowed'
+      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,55 +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
-      @checkable.messages = []
+    def initialize(check_obj)
+      @check_obj = check_obj
     end
 
     # 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    .next_handler(storage)
+    # storage      .next_handler(api_validator)
+    # api_validator.next_handler(api_finder)
+    # api_validator.next_handler(nil)
     #
     # validator.handle(request)
     #
-    def check(opts)
-      handler_confs = opts[:handler_confs]
-      first_handler_name = opts[:first_handler]
+    def check(handler_confs)
+      first_handler_name = handler_confs.keys.first
       first_handler = _handlers(handler_confs)[first_handler_name]
 
-      first_handler.handle(checkable)
-      #    rescue StandardError => e
-      #      checkable.messages << "false::#{e}: #{opts}."
-      #      false
+      first_handler.handle(check_obj)
+    rescue StandardError => e
+      check_obj.ch_messages << "false::#{e}: #{handler_confs}."
+      false
     end
 
     private
 
     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
+    def _make_handlers(confs)
+      confs.transform_values { |conf| _make_handler(conf) }
     end
 
     def _make_handler(conf)
-      k = Checkability.const_get conf[:name].to_s.camelize
-      k.new(conf)
+      Checkability.const_get(conf[:name].to_s.camelize)
+                  .new(conf)
     end
   end
 end

data/lib/checkability/checker.rb

@@ -3,6 +3,16 @@
 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
@@ -23,17 +33,26 @@ module Checkability
     #
     # @param [String] request
     #
-    # @return [Boolean, true|false]
-    def check_value(_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 [String] request
+    # @param [Checkable object] request
     #
     # @return [Boolean, true|false]
-    def result_and_message(_object)
+    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

data/lib/checkability/external_api_checker.rb

@@ -1,43 +1,45 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'net/http'
-require 'net/https'
-require 'json'
-
-# frozen_string_literal: true
+require 'forwardable'
 
 module Checkability
   # Checks if postcode exists in external API
   #
-  class ExternalApiChecker < AbstractChecker
-    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
+
+    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]
-      @connection = Checkability::ExternalApiConnector.new(conf)
+      @connector = conf[:connector] ||
+                   Checkability::ExternalApiConnector.new(conf[:path])
+      @resp = nil
     end
 
-    private
+    def result(check_obj)
+      return false unless resp(check_obj).status == 200
 
-    def _result(checkable)
-      resp = connection
-             .connect
-             .send(http_verb, "#{checkable.value.delete(' ')}#{path_suffix}")
-      return false unless resp.status == 200
+      check_method.call(_parsed(resp(check_obj)))
+    end
 
-      check_method.call(_parsed(resp))
+    def resp(check_obj)
+      @resp ||= connection
+                .send(http_verb,
+                      "#{check_obj.value.delete(' ')}#{path_suffix}")
+      # .get('SE17QD')
     end
 
-    def message(str, res)
-      str = "#{path}: #{str}"
-      super(str, res)
+    def message(res, str = nil)
+      "#{res}::#{path}: #{str}"
     end
 
+    private
+
     def _parsed(resp)
       JSON.parse(resp.body)
     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,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'abstract_checker'
+require_relative 'base_checker'
 module Checkability
   # Checks if postcode exists in Storage
   #
-  class StorageChecker < AbstractChecker
+  class StorageChecker < BaseChecker
     attr_reader :storage_class, :attr_name
 
     def post_initialize(conf = {})
@@ -12,18 +12,17 @@ module Checkability
       @attr_name = conf[:attr_name] || :value
     end
 
-    private
-
-    def _result(checkable)
+    def result(checkable)
       value = _normalize_value(checkable.send(attr_name))
       storage_class.where(attr_name => value).present?
     end
 
-    def message(str, res)
-      str = "Allowed #{storage_class}s list: #{str}"
-      super(str, res)
+    def message(res, str = nil)
+      "#{res}::Allowed #{storage_class}s list: #{str}"
     end
 
+    private
+
     def _normalize_value(value)
       value.delete(' ').upcase
     end

data/lib/checkability/validator.rb

@@ -3,16 +3,14 @@
 module Checkability
   # Checks if postcode comply with regex
   #
-  class Validator < AbstractChecker
+  class Validator < BaseChecker
     attr_reader :format
 
     def post_initialize(conf = {})
       @format = conf[:format]
     end
 
-    private
-
-    def _result(checkable)
+    def result(checkable)
       !(checkable.value.delete(' ') =~ format[:regex]).nil?
     end
   end

data/lib/checkability/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Checkability
-  VERSION = '0.7.0'
+  VERSION = '1.0.0'
 end

metadata

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

data/lib/checkability/abstract_checker.rb

@@ -1,66 +0,0 @@
-# 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