lazy-check 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4540dba4a1ad89f81bd1bb54e043eb34f25713e4d2ccf42c2641973980354bd
-  data.tar.gz: c858d4a60f915abf1d48536573f47333b54c6db6aeaaa10bdff05a4c686b2e69
+  metadata.gz: 8a356d327311f566f5327c5f614e5de2b1978a3e8332e93f46b2e780ba39e266
+  data.tar.gz: 198d81f34d63fb71225b4c639845069feb7f5b0a2a07c25766142cfbd57ed516
 SHA512:
-  metadata.gz: 940d1b4d6923e86683567e14da74632f877bad2666cda026a5804812d96ff2a824978e4c18951fe1edbaff259c534e0f5cc487c7648ee6056cc2fe6f197376b1
-  data.tar.gz: b36023a7a8711fe75c5df0851ee81ce9f28f23ee52523e7363402c89e7516641b3d39ccefcff3cf3d47c9cb9166e58154bca1b0c952d515744c2677d020ee026
+  metadata.gz: d351d75801a9159e5c07d38eefc9d16d5c1b1799dea46560ffa1be921c1d37a4b1de57daf60f9bbf58af4ecdf7e6518dcf521c18adaf49a90d5fe5dc74bc375f
+  data.tar.gz: 4da6ebe703af6252be932aee3dc1e9c9cf00fe8ac36d8c4c91546e354615d39a497dde210342ac10e31bdf23ac9645b61e3ebfc2fdc46ed7f5e0dd7666f918fd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lazy-check (0.1.0)
+    lazy-check (1.2.1)
       clir
       nokogiri
 

data/README-fr.md

@@ -0,0 +1,150 @@
+# Lazy::Check
+
+Ce gem permet de tester de façon paresseuse un site web.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazy-check'
+require 'lazy/check'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lazy-check
+
+## Usage
+
+### Pour un test simple (sans recette)
+
+Si on a juste du code XML-like à tester, on peut utiliser la méthode `Lazy::Checker.check`.
+
+~~~ruby
+gem 'lazy-check'
+require 'lazy/check'
+
+code = "<root><div class="contient">du texte</div></root>"
+check = {tag: 'div.contient', text: "du texte"}
+Lazy::Checker.check(code, check)
+# => Écrit :
+#       -------------------------------------
+#       Succès 1 Failure 0 Temps ...
+~~~
+
+On peut aussi obtenir les résultats en retour de méthode (c'est un `Lazy::Checker::Reporter`)
+
+~~~ruby
+Lazy::Checker.check(code, check, **{return_result: true})
+# => Reporter
+~~~
+
+> Noter que dans ce cas-là, rien n'est écrit en console.
+
+## Pour un test avec recette
+
+Une « recette » est un fichier `YAML` qui définit l'url d'une page internet, ainsi que les checks à effectuer dessus. Cf. ci-dessous.
+
+~~~ruby
+require "lazy-check"
+
+checker = Lazy::Checker.new("path/to/recipe.yaml")
+checker.check
+# => Produit le résultat
+~~~
+
+Si la recette se trouve là où le terminal se trouve, il suffit de faire :
+
+~~~ruby
+require "lazy-check"
+
+Lazy::Checker.new.check
+~~~
+
+La recette (`recipe.yaml`) définit les vérifications qu'il faut effectuer.
+
+~~~yaml
+---
+name: "Nom général de la recette"
+base: https://www.mon.domaine.net
+tests:
+  - name: "Le premier test"
+    url: "" # donc la base
+    checks:
+      - name: "Existence du DIV#content avec du texte"
+        tag: 'div#content'
+        empty: false
+      - name: "Existence du SPAN#range sans texte"
+        tag: 'span#range'
+        empty: true
+  
+  - name: "Une redirection"
+    url: "redirection.html"
+    redirect_to: "https://nouvelle.url.net"
+
+  - name: "Une page erronée"
+    url: "page_inexistante.html"
+    response: 404
+~~~
+
+### Check Properties
+
+~~~yaml
+tag:                  [String] Le sélector
+count:             [Integer] Nombre attendu d'éléments
+empty:            [Bool] Si true, doit être vide ou non vide
+direct_child:   [Bool] Si true, doit être un enfant direct
+text:                 [String] Le texte qui doit être contenu
+contains:       [String|Array] Ce que doit contenir la page
+min_length: 		[Integer] La longueur minimum du contenu (text seulement)
+max_length: 		[Integer] La longueur maximum du contenu (text seulement)
+~~~
+
+## Exemples
+
+Simplement vérifier qu’une page réponde correctement :
+
+~~~yaml
+# recipe.yaml
+---
+name: "La page existe"
+base: 'https://monsite.net'
+tests: 
+	- name: "La page index.html existe et répond correctement"
+		url:  'index.html'
+		response: 200
+~~~
+
+Vérifier qu’une page contient les éléments de base
+
+~~~yaml
+# recipe.yaml
+---
+name: "Check simple de l'existence des éléments de base"
+base: 'https://monsite.net'
+tests: 
+	- name: "La page base.html contient les éléments de base"
+		url:  'index.html'
+		checks:
+			- tag: 'header'
+			- tag: 'section#body'
+			- tag: 'footer'
+~~~
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PhilippePerret/lazy-check.
+

data/README.md

@@ -1,6 +1,6 @@
 # Lazy::Check
 
-Ce gem permet de tester de façon paresseuse un site web.
+This gem allows you to lazily test a website.
 
 ## Installation
 
@@ -8,7 +8,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'lazy-check'
-gem 'lazy/check'
+require 'lazy/check'
 ```
 
 And then execute:
@@ -21,20 +21,20 @@ Or install it yourself as:
 
 ## Usage
 
-### Pour un test simple
+### For a simple test (without a recipe)
 
-Si on a juste du code XML-like à tester, on peut utiliser la méthode `Lazy::Checker.check`.
+If you only have XML-like code to test, you can use the `Lazy::Checker#check` method.
 
 ~~~ruby
 gem 'lazy-check'
 require 'lazy/check'
 
-code = "<root><div class="contient">du texte</div></root>"
-check = {tag: 'div.contient', text: "du texte"}
+code = "<root><div class="contains">some text</div></root>"
+check = {tag: 'div.contains', text: "some text"}
 Lazy::Checker.check(code, check)
-# => Écrit :
+# => Output:
 #       -------------------------------------
-#       Succès 1 Failure 0 Temps ...
+#       Success 1 Failures 0 Duration ...
 ~~~
 
 On peut aussi obtenir les résultats en retour de méthode (c'est un `Lazy::Checker::Reporter`)

data/lazy-check.gemspec

@@ -3,11 +3,11 @@ require_relative 'lib/lazy/check/version'
 Gem::Specification.new do |s|
   s.name          = "lazy-check"
   s.version       = Lazy::Check::VERSION
-  s.authors       = ["PhilippePerret"]
+  s.authors       = ["Philippe Perret"]
   s.email         = ["philippe.perret@yahoo.fr"]
 
-  s.summary       = %q{Vérification paresseuse d'un site web}
-  s.description   = %q{Ce gem permet de façon paresseuse mais néanmoins sérieuse de tester qu'un site web est valide au niveau de ses pages et de son contenu.}
+  s.summary       = %q{Check lazilly your web site pages}
+  s.description   = %q{This gem is a lazy but serious way of testing that a website is valid in terms of its pages and content.}
   s.homepage      = "https://rubygems.org/gems/lazy-check"
   s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

data/lib/lazy/check/locales/en/errors.yaml

@@ -1,4 +1,56 @@
 ---
+# -- Erreurs de recette --
+200: |
+  The recipe file '%{path}' could not be found.
+201: |
+  The data %{a} is not valid for instantiating a Checker::Url. It should 
+  be either a (valid) URL or valid HTML code.
+202: |
+  The recipe file does not contain any data.
+203: |
+  The recipe data should be a table (Hash), not a %{c}.
+204: |
+  The recipe should define the key :tests. It only defines the keys %{ks}.
+205: |
+  The :tests data should be an Array, not a %{c}.
+206: |
+  The recipe should define its name with the key :name.
+
+# -- Errors in test definition. --
+
+300: |
+  The test data should be a Hash table, not a %{c}.
+301: |
+  The test table should define the :url property, which is the page to reach.
+  I only find the %{ks} properties.
+302: |
+  The provided URL (%{u}) is not valid: %{e}.
+303: |
+  it must be defined, not nil.
+304: |
+  it must be a string, not a %{c}.
+305: |
+  it must start with 'http' or 'https' necessarily.
+306: |
+  it should not contain any spaces.
+307: |
+  A test must define its name (in :name); it only defines the keys %{ks}.
+308: |
+  A test must define the checks to perform in a property called, specifically, 
+  :checks. The test only defines the %{ks} properties.
+309: |
+  The checks to be performed for the test (:checks) should be a list (Array), 
+  not a %{c}.
+310: |
+  The redirection %{a} should be a string, not a %{c}.
+311: |
+  The redirection %{a} should start with 'http[s]'.
+312: |
+  To test the HTTP response, you must provide the expected status code, which should 
+  be an Integer. However, %{a} is a %{c}.
+  For example, you can use: 404.
+800: |
+  -- UNUSED --
 1000: |
   Lazy::Checker::CheckCase instanciation requires a Lazy::Checker::Url (first argument).
   Actual value is %{a}::%{c}.
@@ -11,3 +63,75 @@
 1003: |
   :tag value of the CheckCase data should define at least a id (tagName#id) or a css 
   class (tagName.css_class). '%{a}' defines neither.
+1004: |
+  In the :tag data, :count (%{a}) should be a number, not a %{c}.
+2000: |
+  The definition of :contains is incorrect. It should be a table (defining at 
+  least :tag), a string (text to be contained or a tag with an identifier and/or 
+  CSS class), or a list of these elements. The class of the element, in any case, 
+  cannot be %{c}.
+
+# --- Errors in page check. ---
+
+4999: |
+  No %{tag} element was found when %{e} were expected.
+5000: |
+  Wrong count. We expected %{e} %{tag} elements, but found %{a} on the page.
+5001: |
+  The content of %{tag} should be empty, but it contains the text 
+  "%{a}".
+5002: |
+  The content of %{tag} should not be empty, but it is.
+5003: |
+  The content of %{tag} should not contain any text, but it 
+  contains %{a}.
+5004: |
+  The content of %{tag} should contain text, but it doesn't display any.
+5010: |
+  We should find %{tag} containing %{e}. The following issues were 
+  encountered: %{a}.
+5011: |
+  We should find %{tag} containing the text %{e}.
+5020: |
+  should contain the string %{e}
+5021: |
+  should contain the tag defined by %{e}
+5030: |
+  should define the attributes
+5031: |
+  missing or unequal attributes: %{e}.
+5032: |
+  the content is not long enough. It should be at least %{e} characters long, 
+  but it is %{a} characters long.
+5033: |
+  the content is too long. It should be less than %{e} characters, but it 
+  is %{a} characters long.
+
+5500: |
+  The URL is not redirected. It should have been redirected to 
+  %{e}.
+5501: |
+  The URL is redirected to the wrong address. It should have been redirected to: %{e}.
+  It is redirected to: %{a}.
+5502: |
+  The expected HTTP Response is not correct...
+  We were expecting the response: %{e}
+  We received the response: %{a}
+5503: |
+  Error 404. The page %{e} could not be found.
+6000: |
+  The first argument of Lazy::Checker.check must be valid XML code. 
+  However, %{se}.
+6001: |
+  %{a} is not a String; it's a %{c}.
+6002: |
+  a valid XML code should be wrapped in a root node. This is not the case 
+  for %{a}.
+6003: |
+  the data is null (nil).
+6010: |
+  The second argument of Lazy::Checker.check must be a valid Hash table, containing
+  the correct keys: %{se}.
+6011: |
+  %{a} is not a Hash; it's a %{c}.
+

data/lib/lazy/check/locales/en/messages.yaml

@@ -0,0 +1,23 @@
+---
+# -- Termes de messages --
+10: 'count '
+11: 'length '
+12: 'min length '
+13: 'max length '
+14: 'empty'
+15: 'not empty'
+16: 'containing'
+17: 'containing the string'
+20: 'only as direct child'
+21: 'with attributes'
+
+Success:    'Success'
+Failures:   'Failures'
+Duration:   'Duration'
+PleaseWait: 'Please wait…'
+
+# -- Les messages de retour des checks --
+
+4999: |
+  %{tag} tag found with expected data:
+  %{f_data}

data/lib/lazy/check/locales/fr/messages.yaml

@@ -11,6 +11,11 @@
 20: 'seulement parmi les enfants directs'
 21: 'avec les attributs'
 
+Success: 'Succès'
+Failures: 'Échecs'
+Duration: 'Durée'
+PleaseWait: 'Merci de patienter…'
+
 # -- Les messages de retour des checks --
 
 4999: |

data/lib/lazy/check/reporter.rb

@@ -29,7 +29,7 @@ class Checker
         display_list_resultats(success = false)
       end
       color = nombre_erreurs > 0 ? :red : :vert
-      msg = "Success #{@successs.count} Failures #{@failures.count} Temps #{formated_duree}"
+      msg = "#{MESSAGES[:Success]} #{@successs.count} #{MESSAGES[:Failures]} #{@failures.count} #{MESSAGES[:Duration]} #{formated_duree}"
       puts "-" * msg.length
       puts msg.send(color)
     end
@@ -46,7 +46,7 @@ class Checker
       methode = success ? :message   : :errors
       color   = success ? :vert      : :red
       liste   = success ? @successs  : @failures
-      prefix  = success ? 'SUCCESS'  : 'FAILURE'
+      prefix  = success ? '👍'  : '👎'
 
       max_index = liste.count + 1
       max_len_index = "[#{prefix} #{max_index}] ".length
@@ -61,7 +61,7 @@ class Checker
       clear unless debug?
       puts "\n\n"
       puts "#{checker.name}".jaune
-      puts "Merci de patienter…".bleu
+      puts MESSAGES[:PleaseWait].bleu
       @start_time = Time.now
       @successs = []
       @failures = []

data/lib/lazy/check/version.rb

@@ -1,5 +1,5 @@
 module Lazy
   module Check
-    VERSION = "1.1.0"
+    VERSION = "1.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy-check
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
-- PhilippePerret
+- Philippe Perret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,8 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ce gem permet de façon paresseuse mais néanmoins sérieuse de tester qu'un
-  site web est valide au niveau de ses pages et de son contenu.
+description: This gem is a lazy but serious way of testing that a website is valid
+  in terms of its pages and content.
 email:
 - philippe.perret@yahoo.fr
 executables: []
@@ -80,6 +80,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Notes-developper.md
+- README-fr.md
 - README.md
 - Rakefile
 - bin/console
@@ -96,6 +97,7 @@ files:
 - lib/lazy/check/checker_url.rb
 - lib/lazy/check/constants.rb
 - lib/lazy/check/locales/en/errors.yaml
+- lib/lazy/check/locales/en/messages.yaml
 - lib/lazy/check/locales/fr/errors.yaml
 - lib/lazy/check/locales/fr/messages.yaml
 - lib/lazy/check/reporter.rb
@@ -126,5 +128,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Vérification paresseuse d'un site web
+summary: Check lazilly your web site pages
 test_files: []