prism_checker 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdbe6028d9c35cc6c28a0bfac8c640604cb48cb240ac798255b87c4e957433e7
-  data.tar.gz: 3af8ec42000e92c289da4e9f93fb60e026873b5ecbac3886625ede614df0d629
+  metadata.gz: 708e7858706b3dec7fcdd0afb12ffc69eec006e437c9bedbd510352dc7658b78
+  data.tar.gz: d89e926e401368026a7c352277362f24a409d499e34e24cdfecd528cc28ae321
 SHA512:
-  metadata.gz: 787f9a963511e4990a90ddf082a1fdb21a6671c3d81171e0f5a959e46fd14d6b8750c62b65f59c7c0d92b10fc468e0cec1b7c5daba655157da9803719a9fa7d1
-  data.tar.gz: ec334320865fd4b8a139b3982fe353523a3c627b87bd9d4a9be286b29ecb5048f2ea89b8198c2a4e23db082f70c80d0b6d7ade510cd7577bde60cee69655bdec
+  metadata.gz: c6694745c00973b6322191ec17e5ca6eb60d3b96a131053772873e8734537094b90b2062bf0e03aa6c0ae3b0c643fb8742f67668ca6b8204f4ec75f4a539b4cf
+  data.tar.gz: 555b76320684d68546ae2cba93920046c2de58083a69c17d67d9e8532558d561dd9d50b964556628cc7b18780d4b45d9a22646b73a9660d3a8852ef78eaf1917

data/README.md

@@ -4,14 +4,15 @@
 
 ## Overview
 
-Prism checker - short and easy-to-read browser tests with clear error messages.
-Prism checker - extensions for rspec and minitest, built on top of the site_prism gem and uses its Page Object Model.
+PrismChecker is an extension for rspec and minitest, built on top of the [SitePrism](https://github.com/site-prism/site_prism)
+gem and using its page object model.
+It allows you to write short, easy-to-read browser tests with clear error messages
 
-For example, we need to test the online shop cart:
+Let's assume your application has the following shop cart:
 
 ![Cart](doc/images/cart.png "Cart")
 
-Corresponding SitePrism Page Object Model:
+Corresponding SitePrism PDO::
 
 ```ruby
 class Cart < SitePrism::Page
@@ -107,9 +108,6 @@ In case of errors, an easy-to-read message will be displayed:
 
 ![Result](doc/images/result.png "Result")
 
-**Note.**
-_All examples are for rsepc, for mintest it will be the same, but instead of expect(page).be_like(expectation) it will be assert_page_like(page, expectation)_
-
 ## Install
 To install PrismChecker:
 
@@ -148,7 +146,7 @@ end
 ```
 
 
-#### Check text on the page
+#### Text check
 
 ```ruby
 @page = Cart.new
@@ -158,11 +156,11 @@ expect(page).to be_like('Shopping Cart')
 
 # Same as
 # expect(page.loaded?).to eq(true)
-# expect(page).to match('Shopping Cart')
+# expect(page.text).to match('Shopping Cart')
 ```
 
 
-#### Check element and section
+#### Element and section check
 
 ```ruby
 @page = Cart.new
@@ -188,7 +186,7 @@ expect(page).to be_like(
 ```
 
 
-#### Check element
+#### Element check
 
 ```ruby
 @page = Cart.new
@@ -217,7 +215,7 @@ expect(page).to be_like(header: 'Shopping Cart')
 ```
 
 
-#### Check section
+#### Section check
 
 ```ruby
 expect(page.checkout).to be_like(
@@ -250,7 +248,7 @@ expect(page).to be_like(
 ```
 
 
-#### Check sections
+#### Sections check
 
 ```ruby
 expect(page).to be_like(
@@ -305,7 +303,7 @@ expect(page).to be_like(cart_items: [{name: 'Cup'}, {name: 'Cap'}]) # Ok
 ```
 
 
-#### Check elements
+#### Elements check
 
 ```ruby
 expect(page).to be_like(
@@ -660,7 +658,6 @@ When the comparison method is :inclusion, and it is necessary to compare with an
 expect(page.element_without_text).to be_like(:empty)
 
 # Same as
-# expect(page.element_without_text.visible?).to eq(true)
 # expect(page.element_without_text.text.empty?).to eq(true)
 ```
 or

data/lib/prism_checker/check_dispatcher.rb

@@ -17,45 +17,44 @@ require_relative 'node/bad_expectation'
 
 module PrismChecker
   class CheckDispatcher
-    @check_map = {
+    COMMON_ELEMENT_CHECKERS = {
+      string: [ItemChecker::Element::Visible, ItemChecker::Element::String],
+      empty: [ItemChecker::Element::Empty],
+      regexp: [ItemChecker::Element::Visible, ItemChecker::Element::Regexp],
+      hash: [ItemChecker::Element::Visible],
+      visible: [ItemChecker::Element::Visible],
+      invisible: [ItemChecker::Element::Invisible]
+    }.freeze
+
+    COMMON_ELEMENTS_CHECKERS = {
+      string: [ItemChecker::Elements::String],
+      empty: [ItemChecker::Elements::Empty],
+      regexp: [ItemChecker::Elements::Regexp],
+      array: [ItemChecker::Elements::Array],
+      number: [ItemChecker::Elements::Number]
+    }.freeze
+
+    COMMON_INPUT_CHECKERS = {
+      string: [ItemChecker::Element::Visible, ItemChecker::Input::String],
+      empty: [ItemChecker::Element::Visible, ItemChecker::Input::Empty],
+      regexp: [ItemChecker::Element::Visible, ItemChecker::Input::Regexp],
+      hash: [ItemChecker::Element::Visible],
+      visible: [ItemChecker::Element::Visible],
+      invisible: [ItemChecker::Element::Invisible]
+    }.freeze
+
+    CHECK_MAP = {
       page: {
         string: [ItemChecker::Page::Loaded, ItemChecker::Page::String],
         regexp: [ItemChecker::Page::Loaded, ItemChecker::Page::Regexp],
         hash: [ItemChecker::Page::Loaded]
       },
 
-      section: {
-        string: [ItemChecker::Element::Visible, ItemChecker::Element::String],
-        empty: [ItemChecker::Element::Visible, ItemChecker::Element::Empty],
-        regexp: [ItemChecker::Element::Visible, ItemChecker::Element::Regexp],
-        hash: [ItemChecker::Element::Visible],
-        visible: [ItemChecker::Element::Visible],
-        invisible: [ItemChecker::Element::Invisible]
-      },
+      section: COMMON_ELEMENT_CHECKERS,
+      element: COMMON_ELEMENT_CHECKERS,
 
-      sections: {
-        string: [ItemChecker::Elements::String],
-        regexp: [ItemChecker::Elements::Regexp],
-        array: [ItemChecker::Elements::Array],
-        number: [ItemChecker::Elements::Number]
-      },
-
-      element: {
-        string: [ItemChecker::Element::Visible, ItemChecker::Element::String],
-        empty: [ItemChecker::Element::Visible, ItemChecker::Element::Empty],
-        regexp: [ItemChecker::Element::Visible, ItemChecker::Element::Regexp],
-        hash: [ItemChecker::Element::Visible],
-        visible: [ItemChecker::Element::Visible],
-        invisible: [ItemChecker::Element::Invisible]
-      },
-
-      elements: {
-        string: [ItemChecker::Elements::String],
-        empty: [ItemChecker::Elements::Empty],
-        regexp: [ItemChecker::Elements::Regexp],
-        array: [ItemChecker::Elements::Array],
-        number: [ItemChecker::Elements::Number]
-      },
+      sections: COMMON_ELEMENTS_CHECKERS,
+      elements: COMMON_ELEMENTS_CHECKERS,
 
       image: {
         string: [ItemChecker::Element::Visible, ItemChecker::Image::String],
@@ -65,43 +64,20 @@ module PrismChecker
         invisible: [ItemChecker::Element::Invisible]
       },
 
-      input: {
-        string: [ItemChecker::Element::Visible, ItemChecker::Input::String],
-        empty: [ItemChecker::Element::Visible, ItemChecker::Input::Empty],
-        regexp: [ItemChecker::Element::Visible, ItemChecker::Input::Regexp],
-        hash: [ItemChecker::Element::Visible],
-        visible: [ItemChecker::Element::Visible],
-        invisible: [ItemChecker::Element::Invisible]
-      },
-
-      textarea: {
-        string: [ItemChecker::Element::Visible, ItemChecker::Textarea::String],
-        empty: [ItemChecker::Element::Visible, ItemChecker::Textarea::Empty],
-        regexp: [ItemChecker::Element::Visible, ItemChecker::Textarea::Regexp],
-        hash: [ItemChecker::Element::Visible],
-        visible: [ItemChecker::Element::Visible],
-        invisible: [ItemChecker::Element::Invisible]
-      },
+      input: COMMON_INPUT_CHECKERS,
+      textarea: COMMON_INPUT_CHECKERS,
+      select: COMMON_INPUT_CHECKERS,
 
-      select: {
+      radio: {
         string: [ItemChecker::Element::Visible, ItemChecker::Input::String],
-        empty: [ItemChecker::Element::Visible, ItemChecker::Input::Empty],
         regexp: [ItemChecker::Element::Visible, ItemChecker::Input::Regexp],
-        hash: [ItemChecker::Element::Visible],
-        visible: [ItemChecker::Element::Visible],
-        invisible: [ItemChecker::Element::Invisible]
-      },
-
-      checkbox: {
         hash: [ItemChecker::Element::Visible],
         visible: [ItemChecker::Element::Visible],
         invisible: [ItemChecker::Element::Invisible],
         boolean: [ItemChecker::Element::Visible, ItemChecker::Checkbox::Boolean]
       },
 
-      radio: {
-        string: [ItemChecker::Element::Visible, ItemChecker::Input::String],
-        regexp: [ItemChecker::Element::Visible, ItemChecker::Input::Regexp],
+      checkbox: {
         hash: [ItemChecker::Element::Visible],
         visible: [ItemChecker::Element::Visible],
         invisible: [ItemChecker::Element::Invisible],
@@ -109,8 +85,9 @@ module PrismChecker
       },
 
       array: {
+        array: [ItemChecker::Array::Array],
         string: [ItemChecker::Array::String],
-        empty: [ItemChecker::Array::String],
+        empty: [ItemChecker::Array::Empty],
         regexp: [ItemChecker::Array::Regexp],
         number: [ItemChecker::Elements::Number]
       },
@@ -119,8 +96,9 @@ module PrismChecker
         boolean: [ItemChecker::Any::Any]
       },
 
-      number: {
-        number: [ItemChecker::Any::Any]
+      other: {
+        number: [ItemChecker::Any::Any],
+        other: [ItemChecker::Any::Any]
       },
 
       string: {
@@ -133,12 +111,12 @@ module PrismChecker
         string: [ItemChecker::Nil::String],
         regexp: [ItemChecker::Nil::Regexp]
       }
-    }
+    }.freeze
 
     def self.checkers(_node, element, expectation, item_type)
       expectation_type = ExpectationClassifier.classify(expectation)
 
-      element_expectations = @check_map[item_type]
+      element_expectations = CHECK_MAP[item_type]
 
       raise_bad_element(element) unless element_expectations
 
@@ -159,10 +137,5 @@ module PrismChecker
       error = "Don't know how to compare #{element_class} with #{expectation.class.name}"
       raise Node::BadExpectation, error
     end
-
-    def self.add(element_type, check_type, checks)
-      @check_map[element_type] ||= {}
-      @check_map[element_type][check_type] = checks
-    end
   end
 end

data/lib/prism_checker/checker.rb

@@ -19,24 +19,18 @@ module PrismChecker
     def check(item, expectation)
       prepare(item, expectation)
 
+      # rubocop:disable Style/SymbolProc
+      # rubocop is wrong
       walk_through do |node|
         node.check
       end
+      # rubocop:enable Style/SymbolProc
 
       @result = true
     rescue Node::CheckFail
-      # puts report
       @result = false
-      # rescue Node::BadExpectation => e
-      #   # raise
-      #   raise e.class, report + "\n" + e.message
     rescue StandardError => e
-      # puts '---------------------'
-      # puts e.class
-      # puts e.message
-      # pp e.backtrace
-      # puts '---------------------'
-      raise e.class, report + "\n" + e.message
+      raise e.class, "#{report}\n#{e.message}"
     end
 
     def report

data/lib/prism_checker/element_wrapper.rb

@@ -37,15 +37,9 @@ module PrismChecker
         return @element.send(method, *args)
       end
 
-      # if (ItemClassifier.element_checkbox?(@element) || ItemClassifier.element_radio?(@element)) && method == :checked
-      #   return @element.checked?
-      # end
-
       ret = @element[method]
 
       if ret.nil? && !method.start_with?('data-')
-        # return '' if method.start_with?('data-')
-
         raise NoMethodError, "unknown attribute '#{method}'"
       end
 

data/lib/prism_checker/expectation_classifier.rb

@@ -2,7 +2,7 @@
 
 module PrismChecker
   class ExpectationClassifier
-    @expectations_map = [
+    EXPECTATIONS_MAP = [
       %i[invisible invisible?],
       %i[visible visible?],
       %i[empty empty?],
@@ -12,16 +12,12 @@ module PrismChecker
       %i[hash hash?],
       %i[boolean boolean?],
       %i[number number?]
-    ]
+    ].freeze
 
     def self.classify(expectation)
-      @expectations_map.each do |data|
+      EXPECTATIONS_MAP.each do |data|
         type, probe = data
-        if probe.is_a? Symbol
-          return type if send(probe, expectation)
-        elsif probe.call(expectation)
-          return type
-        end
+        return type if send(probe, expectation)
       end
 
       :other
@@ -62,9 +58,5 @@ module PrismChecker
     def self.number?(expectation)
       expectation.is_a?(Integer)
     end
-
-    def self.add(type, probe, position = 0)
-      @expectations_map.insert(position, [type, probe])
-    end
   end
 end

data/lib/prism_checker/item_checker/array.rb

@@ -3,11 +3,20 @@
 require_relative 'item_check/string'
 require_relative 'item_check/regexp'
 require_relative 'item_check/empty_array'
+require_relative 'item_check/array'
 require_relative 'item_value/array'
 
 module PrismChecker
   module ItemChecker
     module Array
+      class Array
+        def self.value(elements)
+          elements
+        end
+
+        extend ItemCheck::Array
+      end
+
       class String
         extend ItemValue::Array
         extend ItemCheck::String

data/lib/prism_checker/item_checker/checkbox.rb

@@ -16,7 +16,7 @@ module PrismChecker
           value == expectation
         end
 
-        def self.error_message(_checkbox, value, expectation)
+        def self.error_message(_checkbox, _value, expectation)
           if expectation
             'Expected to be checked'
           else

data/lib/prism_checker/item_checker/element.rb

@@ -8,7 +8,6 @@ require_relative 'item_check/empty'
 module PrismChecker
   module ItemChecker
     module Element
-
       class String
         extend ItemValue::Element
         extend ItemCheck::String
@@ -25,7 +24,9 @@ module PrismChecker
       end
 
       class Visible
-        def self.value(_element); end
+        def self.value(element)
+          element
+        end
 
         def self.check(element, _value, _expectation)
           element.visible?

data/lib/prism_checker/item_checker/elements.rb

@@ -43,10 +43,12 @@ module PrismChecker
 
       class Empty
         def self.value(elements)
-          elements
+          elements.map(&:text).join
         end
 
-        extend ItemCheck::EmptyArray
+        def self.check(_elements, value, _expectation)
+          value.empty?
+        end
       end
     end
   end

data/lib/prism_checker/item_checker/item_check/array.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PrismChecker
+  module ItemChecker
+    module ItemCheck
+      module Array
+        def check(_element, value, expectation)
+          value.size == expectation.size
+        end
+
+        def error_message(elements, _value, expectation)
+          "Wrong elements count\nActual: #{elements.size}\nExpected: #{expectation.size}"
+        end
+      end
+    end
+  end
+end

data/lib/prism_checker/item_classifier.rb

@@ -5,7 +5,7 @@ require 'capybara'
 
 module PrismChecker
   class ItemClassifier
-    @elements_map = [
+    ELEMENTS_MAP = [
       %i[checkbox element_checkbox?],
       %i[radio element_radio?],
       %i[input element_input?],
@@ -21,16 +21,12 @@ module PrismChecker
       %i[string string?],
       %i[boolean boolean?],
       %i[nil element_nil?]
-    ]
+    ].freeze
 
     def self.classify(element)
-      @elements_map.each do |data|
+      ELEMENTS_MAP.each do |data|
         type, probe = data
-        if probe.is_a? Symbol
-          return type if send(probe, element)
-        elsif probe.call(element)
-          return type
-        end
+        return type if send(probe, element)
       end
 
       :other
@@ -120,9 +116,5 @@ module PrismChecker
     def self.element_nil?(element)
       element.nil?
     end
-
-    def self.add(type, probe, position = 0)
-      @elements_map.insert(position, [type, probe])
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prism_checker
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Ganglion-17
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: site_prism
@@ -16,16 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -156,36 +170,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.6'
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |
-  Prism checker is an extension for rspec and minitest, built on top of the SitePrism gem and using its page object model.
+  prism_checker is an extension for rspec and minitest, built on top of the site_prism gem and using its page object model.
   It allows you to write short, easy-to-read browser tests with clear error messages
 email:
 - ganglion1717@gmail.com
@@ -210,6 +196,7 @@ files:
 - lib/prism_checker/item_checker/elements.rb
 - lib/prism_checker/item_checker/image.rb
 - lib/prism_checker/item_checker/input.rb
+- lib/prism_checker/item_checker/item_check/array.rb
 - lib/prism_checker/item_checker/item_check/empty.rb
 - lib/prism_checker/item_checker/item_check/empty_array.rb
 - lib/prism_checker/item_checker/item_check/number.rb