checkability 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c20a76958ba1f8025605a3ded3101c8a0e3eeb2
-  data.tar.gz: 8b69ff85aea14d3726827e58954cc6efb8bdb502
+SHA256:
+  metadata.gz: 0f584d475c0bf9395f3cbdb0d47a436b7f1a56ab93fb4d76095b58de9a0a4485
+  data.tar.gz: d9ff4ef5b3a877fd0a8efe830958df8e14d3ae0e221903fbb436623457c14e74
 SHA512:
-  metadata.gz: 4fe465c7c77639f20865c2e37df153615298df3b6284587660b030ec0833bedc5bcfb14e59a39252988d1276721ece24fa88d8000291ae188a50ff1897ebb8eb
-  data.tar.gz: 26494daaeae8b5497b2c2db96ee1c21ddfabf027b93a30e6b1dd91d06936f4dd4fdff616d2391cf5fa1620df07a7806fadb8b69899ee232619d95a67cfa0e8a0
+  metadata.gz: e7f9740350a632cea6131709f9e765f0c8e47981b564a8fb426103fe1c55688f7d27ce7190b11278e540807bd0e2dfeabe65d5d47d4e494b4865074db384447d
+  data.tar.gz: 4baa39ca9c3aaec3845e2d84a72f38caf74f662bab1b3f6ff453439763393db4865c7a3912b8c09f606d37a2b15860f779750f9d8cc0e8b19f102362310355d5

data/README.md

@@ -9,8 +9,47 @@ with return of true|false
 ## Usage
 How to use my plugin.
 
-inside of any ruby class include Checkablilty
-next 
+inside of any rails model do
+```ruby
+class SomeModel
+  acts_as_checkable strategy: proc { |a, b, c| a && (b || c) },
+                    checkers: uk_postcode_checkers
+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  
+then in your controller:  
+```ruby
+class ChecksController < ApplicationController
+  def checking
+    @check = Check.new
+  end
+
+  def perform
+    @check = Check.new(value: check_params[:string])
+    message, alert_class =
+      if @check.valid?
+        @check.perform_check
+        [@check.messages.join('<br/>'), _alert_class(@check.allowed)]
+      else
+        [@check.errors.full_messages.join('<br/>'), _alert_class(false)]
+      end
+    redirect_to checking_path, flash: { now: message, alert_class: alert_class }
+  end
+
+  private
+
+  def _alert_class(cond)
+    cond ? 'success' : 'danger'
+  end
+
+  def check_params
+    params.permit(:string)
+  end
+end
+```
+for more detailed example see application   
+in https://github.com/azazelo/postcode_checker
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -34,3 +73,7 @@ Contribution directions go here.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Future works
+
+- [ ] Use ChainOfResponsibility pattern to simplify call of checkers

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'
 
@@ -8,4 +9,3 @@ puts 'Gem provide acts_as_checkable addon to active record models'
 puts "Version: #{Checkability::VERSION}"
 puts ''
 puts '-----------------'
-

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/chain_of_resp/handler'
+require_relative 'checkability/chain_of_resp/abstract_handler'
 
 ActiveRecord::Base.include Checkability::ActsAsCheckable

data/lib/checkability/acts_as_checkable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
   # Adding class and instance methods
   #
@@ -10,9 +12,7 @@ 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}"
-        end
+        raise ArgumentError, "Hash expected, got #{options.class.name}" if !options.is_a?(Hash) && !options.empty?
 
         class_attribute :checkable_conf
 
@@ -21,23 +21,30 @@ module Checkability
     end
 
     attr_accessor :allowed, :messages
-    def setup
-      self.allowed = nil
-      self.messages = []
+
+    def perform_check
+      _setup
+      self.allowed = Checkability::Checkable.new(self).check(checkable_conf)
+      messages << "#{allowed}::'#{_value}' is #{_allowness}. "
     end
 
-    def perform
-      setup
-      self.allowed = _check
-      messages << "#{self.class.name} '#{value}' is #{_allowness}. "
+    private
+
+    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
+      self.allowed = nil
+      self.messages = []
+    end
+
+    def _allowness
+      allowed ? 'ALLOWED' : 'NOT allowed'
     end
   end
 end

data/lib/checkability/chain_of_resp/abstract_handler.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'handler'
+
+module ChainOfResp
+  # @abstract
+  class AbstractHandler < ChainOfResp::Handler
+    # @return [Handler]
+    attr_reader :stop_process_on_failure, :stop_process_on_success
+    attr_accessor :handler, :result
+
+    def initialize(opts = {})
+      @stop_process_on_failure = opts[:stop_process_on_failure] || false
+      @stop_process_on_success = opts[:stop_process_on_success] || false
+      @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
+  end
+end

data/lib/checkability/chain_of_resp/handler.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ChainOfResp
+  # @abstract
+  class Handler
+    # @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(_request)
+      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
+  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,21 +9,43 @@ module Checkability
 
     def initialize(checkable)
       @checkable = checkable
+      @checkable.messages = []
+    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.handle(request)
+    #
+    def check(opts = {})
+      require 'pry'; binding.pry
+      first_handler_name = opts[:first_handler]
+      _handlers(opts)[first_handler_name].handle(checkable)
+    rescue StandardError => e
+      checkable.messages << "false::#{e}: #{opts}."
+      false
+    end
+
+    private
+
+    def _handlers(opts)
+      handler_confs = opts[:handler_confs]
+      handlers = {}
+      handler_confs.each do |handler_name, handler_conf|
+        handlers[handler_name] = _make_handler(handler_name, handler_conf)
+      end
+      handlers.each do |handler_name, handler|
+        next_handler_name = handler_confs[handler_name][:next_handler]
+        handler.next_handler(handlers[next_handler_name])
+      end
     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(conf)
-      conf[:algoritm].call(
-        conf[:checkers].map do |checker_name, checker_conf|
-          k = Checkability.const_get(checker_name.to_s.camelize)
-          k.new(checker_conf).check_value(checkable)
-        end
-      )
+    def _make_handler(_name, conf)
+      k = Checkability.const_get conf[:name].to_s.camelize
+      k.new(conf)
     end
   end
 end

data/lib/checkability/external_api_checker.rb

@@ -1,22 +1,34 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'net/http'
 require 'net/https'
 require 'json'
 
+# frozen_string_literal: true
+
+require_relative 'chain_of_resp/abstract_handler'
 module Checkability
   # Checks if postcode exists in external API
   #
-  class ExternalApiChecker
-    attr_reader :path, :check_method, :connection
+  class ExternalApiChecker < ChainOfResp::AbstractHandler
+    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.get(checkable.value.delete(' '))
+      @resp = connection
+              .connect
+              .send(http_verb, "#{checkable.value.delete(' ')}#{path_suffix}")
       result, message = _result_and_message
       checkable.messages << message
       result
@@ -24,8 +36,8 @@ module Checkability
 
     private
 
-    def _message(str)
-      "#{path}: #{str}"
+    def _message(str, res)
+      "#{res}::#{path}: #{str}"
     end
 
     def _parsed(resp)
@@ -33,13 +45,14 @@ module Checkability
     end
 
     def _result_and_message
-      return [false, _message(@resp.status)] unless @resp.status == 200
+      return [false, _message(@resp.status, false)] unless @resp.status == 200
 
-      return [true, _message('Found.')] if check_method.call(_parsed(@resp))
+      return [true, _message(success_message, true)] if check_method
+                                                        .call(_parsed(@resp))
 
-      [false, _message('Not found in allowed areas.')]
+      [false, _message(failure_message, false)]
     rescue StandardError => e
-      [false, _message(e)]
+      [false, _message(e, false)]
     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,17 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'chain_of_resp/abstract_handler'
 module Checkability
   # Checks if postcode exists in Storage
   #
-  class StorageChecker
+  class StorageChecker < ChainOfResp::AbstractHandler
     attr_reader :storage_class
 
-    def initialize(conf = {})
+    def post_initialize(conf = {})
       @storage_class = conf[:storage_class]
     end
 
     def check_value(checkable)
       value = checkable.value.upcase
       result = _present_in_storage(value)
-      checkable.messages << (result ? _message('Found') : _message('Not found'))
+      checkable.messages << (
+        result ? _message('Found', result) : _message('Not found', result))
       result
     end
 
@@ -22,8 +26,8 @@ module Checkability
                    .present?
     end
 
-    def _message(str)
-      "Allowed #{storage_class}s list: #{str}."
+    def _message(str, res)
+      "#{res}::Allowed #{storage_class}s list: #{str}."
     end
   end
 end

data/lib/checkability/validator.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Checkability
   # Checks if postcode comply with regex
   #
-  class Validator
+  class Validator < ChainOfResp::AbstractHandler
     attr_reader :format
 
-    def initialize(conf = {})
+    def post_initialize(conf = {})
       @format = conf[:format]
     end
 
@@ -14,11 +16,13 @@ module Checkability
       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]}."]
+        [false, "false::Value is NOT COMPLY with format of #{format[:name]}."]
       else
-        [true, "Value comply with format of #{format[:name]}."]
+        [true, "true::Value is COMPLY with format of #{format[:name]}."]
       end
     end
   end

data/lib/checkability/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.6.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.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrey Eremeev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies: []
 description: Provide Checkers functionality.
 email:
@@ -24,6 +24,8 @@ files:
 - bin/checkability
 - lib/checkability.rb
 - lib/checkability/acts_as_checkable.rb
+- lib/checkability/chain_of_resp/abstract_handler.rb
+- lib/checkability/chain_of_resp/handler.rb
 - lib/checkability/checkable.rb
 - lib/checkability/external_api_checker.rb
 - lib/checkability/external_api_connector.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: []