lazy-check 1.2.1 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a356d327311f566f5327c5f614e5de2b1978a3e8332e93f46b2e780ba39e266
-  data.tar.gz: 198d81f34d63fb71225b4c639845069feb7f5b0a2a07c25766142cfbd57ed516
+  metadata.gz: 83a4373e41aeeabf3eb57866324069a1134ee606065556cbf17ed78b10de5cff
+  data.tar.gz: 6f7448fe3242c1dcd5189e50e92f2aeead83fe6b6da8dd974b9974c1e14d14a7
 SHA512:
-  metadata.gz: d351d75801a9159e5c07d38eefc9d16d5c1b1799dea46560ffa1be921c1d37a4b1de57daf60f9bbf58af4ecdf7e6518dcf521c18adaf49a90d5fe5dc74bc375f
-  data.tar.gz: 4da6ebe703af6252be932aee3dc1e9c9cf00fe8ac36d8c4c91546e354615d39a497dde210342ac10e31bdf23ac9645b61e3ebfc2fdc46ed7f5e0dd7666f918fd
+  metadata.gz: 1bec5356e9df9a71fb5abe4e8db50c6990551ba1dd360ea7d93511a424cbb7f90c7aeb53aa18988dc0138b2b8f5747c4e6dbdb19c4b1c60d38054f687c233d83
+  data.tar.gz: 0b9b2cff492148a86222f32e01f1ef2b7ba70deafeca6637fa69fdb06e82740dd6a890342565fcfdb2d1a7337ad8be1007d5c8b24df49a4e09753c5746e5b4fb

data/README-fr.md

@@ -37,7 +37,7 @@ Lazy::Checker.check(code, check)
 #       Succès 1 Failure 0 Temps ...
 ~~~
 
-On peut aussi obtenir les résultats en retour de méthode (c'est un `Lazy::Checker::Reporter`)
+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})
@@ -51,7 +51,7 @@ Lazy::Checker.check(code, check, **{return_result: true})
 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"
+require "lazy/check"
 
 checker = Lazy::Checker.new("path/to/recipe.yaml")
 checker.check
@@ -61,7 +61,7 @@ checker.check
 Si la recette se trouve là où le terminal se trouve, il suffit de faire :
 
 ~~~ruby
-require "lazy-check"
+require "lazy/check"
 
 Lazy::Checker.new.check
 ~~~
@@ -83,21 +83,23 @@ tests:
         tag: 'span#range'
         empty: true
   
-  - name: "Une redirection"
-    url: "redirection.html"
-    redirect_to: "https://nouvelle.url.net"
+      - name: "Une redirection"
+        url: "redirection.html"
+        redirect_to: "https://nouvelle.url.net"
 
-  - name: "Une page erronée"
-    url: "page_inexistante.html"
-    response: 404
+      - name: "Une page erronée"
+        url: "page_inexistante.html"
+        response: 404
 ~~~
 
 ### Check Properties
 
+Les "checks" ci-dessus peuvent définir les propriétés suivantes :
+
 ~~~yaml
 tag:                  [String] Le sélector
 count:             [Integer] Nombre attendu d'éléments
-empty:            [Bool] Si true, doit être vide ou non vide
+empty:            [Bool] Si true, doit être vide, si false, 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
@@ -120,7 +122,7 @@ tests:
 		response: 200
 ~~~
 
-Vérifier qu’une page contient les éléments de base
+Vérifier qu’une page contient les éléments de base :
 
 ~~~yaml
 # recipe.yaml
@@ -128,7 +130,7 @@ Vérifier qu’une page contient les éléments de base
 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"
+	- name: "La page index.html contient les éléments de base"
 		url:  'index.html'
 		checks:
 			- tag: 'header'
@@ -136,7 +138,13 @@ tests:
 			- tag: 'footer'
 ~~~
 
+## Tester le gem
+
+Lancer les tests avec :
 
+~~~
+rake test
+~~~
 
 ## Development
 

data/README.md

@@ -37,98 +37,100 @@ Lazy::Checker.check(code, check)
 #       Success 1 Failures 0 Duration ...
 ~~~
 
-On peut aussi obtenir les résultats en retour de méthode (c'est un `Lazy::Checker::Reporter`)
+You can also obtain the results in method return (this is a `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.
+> Note that in this case, nothing is written in the console.
 
-## Pour un test avec recette
+## For a test with a recipe
 
-Une « recette » est un fichier `YAML` qui définit l'url d'une page internet, ainsi que les checks à effectuer dessus. Cf. ci-dessous.
+A "recipe" is a `YAML` file that defines the url of a web page, and the checks to be performed on it. See below.
 
 ~~~ruby
-require "lazy-check"
+require "lazy/check"
 
 checker = Lazy::Checker.new("path/to/recipe.yaml")
 checker.check
-# => Produit le résultat
+# => Produces the result
 ~~~
 
-Si la recette se trouve là où le terminal se trouve, il suffit de faire :
+If the recipe is located where the terminal is, simply do:
 
 ~~~ruby
-require "lazy-check"
+require "lazy/check"
 
 Lazy::Checker.new.check
 ~~~
 
-La recette (`recipe.yaml`) définit les vérifications qu'il faut effectuer.
+The recipe (`recipe.yaml`) defines the checks to be performed.
 
 ~~~yaml
 ---
-name: "Nom général de la recette"
-base: https://www.mon.domaine.net
+name: "Name for this recipe"
+base: https://www.my.domain.net
 tests:
-  - name: "Le premier test"
-    url: "" # donc la base
+  - name: "My first test"
+    url: "" # so the base
     checks:
-      - name: "Existence du DIV#content avec du texte"
+      - name: "Existence of DIV#content with text"
         tag: 'div#content'
         empty: false
-      - name: "Existence du SPAN#range sans texte"
+      - name: "Existence of SPAN#range without text"
         tag: 'span#range'
         empty: true
   
-  - name: "Une redirection"
-    url: "redirection.html"
-    redirect_to: "https://nouvelle.url.net"
+      - name: "A redirection"
+        url: "redirection.html"
+        redirect_to: "https://new.url.net"
 
-  - name: "Une page erronée"
-    url: "page_inexistante.html"
-    response: 404
+      - name: "A wrong page"
+        url: "page_unfound.html"
+        response: 404
 ~~~
 
 ### Check Properties
 
+The above "checks" can define the following 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)
+tag:                  [String] The selector
+count:             [Integer] Expected number of elements
+empty:            [Bool] If true, must be empty, if false, must be non-empty
+direct_child:   [Bool] If true, must be a direct child
+text:                 [String] The text that must be contained
+contains:       [String|Array] What the page should contain
+min_length: 		[Integer] Minimum content length (text only)
+max_length: 		[Integer] Maximum content length (text only)
 ~~~
 
-## Exemples
+## Examples
 
-Simplement vérifier qu’une page réponde correctement :
+Simply check that a page responds correctly:
 
 ~~~yaml
 # recipe.yaml
 ---
-name: "La page existe"
-base: 'https://monsite.net'
+name: "Page exists"
+base: 'https://mywebsite.net'
 tests: 
-	- name: "La page index.html existe et répond correctement"
+	- name: "The index.html page exists and responds correctly"
 		url:  'index.html'
 		response: 200
 ~~~
 
-Vérifier qu’une page contient les éléments de base
+Check that a page contains the basic elements.
 
 ~~~yaml
 # recipe.yaml
 ---
-name: "Check simple de l'existence des éléments de base"
-base: 'https://monsite.net'
+name: "Simple check on the existence of basic elements"
+base: 'https://mywebsite.net'
 tests: 
-	- name: "La page base.html contient les éléments de base"
+	- name: "The index.html page contains the basic elements"
 		url:  'index.html'
 		checks:
 			- tag: 'header'
@@ -136,7 +138,13 @@ tests:
 			- tag: 'footer'
 ~~~
 
+## Tests
+
+Run the tests:
 
+~~~
+rake test
+~~~
 
 ## Development
 

data/lib/lazy/check/Nokogiri_extension.rb

@@ -16,7 +16,7 @@ module Nokogiri
 
     # @return true si le node est vraiment vide
     def empty?
-      not(children?) && content.empty?
+      not(children?) && content.strip.empty?
     end
 
     def children?
@@ -24,11 +24,11 @@ module Nokogiri
     end
 
     def has_text?
-      not(text.empty?)
+      not(text.strip.empty?)
     end
 
     def has_no_text?
-      text.empty?
+      text.strip.empty?
     end
 
     # Test du contenu
@@ -141,7 +141,7 @@ module Nokogiri
 
     # @return [Integer] La longueur du texte
     def length
-      @length ||= text.length
+      @length ||= text.strip.length
     end
   end #/class XML::Element
 end #/module Nokogiri

data/lib/lazy/check/checker.rb

@@ -7,6 +7,8 @@ class Checker
 
   attr_reader :reporter
 
+  attr_reader :options
+
   def initialize(recipe_path = nil)
     recipe_path ||= File.expand_path('.', 'recipe.yaml')
     File.exist?(recipe_path) || raise(ERRORS[200] % {path: recipe_path})
@@ -24,6 +26,7 @@ class Checker
   # La méthode (silencieuse) qui produit le check
   # ("silencieuse" parce qu'elle ne produit que des raises)
   def proceed_check(**options)
+    @options = options
     @reporter = Reporter.new(self)
     @reporter.start
     recipe[:tests].collect do |dtest|
@@ -32,10 +35,10 @@ class Checker
       test.check(**options)
     end
     @reporter.end
-    if options[:return_result]
+    if no_output?
       return @reporter
     else
-      @reporter.display unless no_output?
+      @reporter.display
     end
   end
 
@@ -45,6 +48,10 @@ class Checker
     not(base.nil?)
   end
 
+  def no_output?
+    options[:return_result] === true
+  end
+
   def recipe_valid?
     not(recipe.nil?)            || raise(RecipeError, ERRORS[202])
     recipe.is_a?(Hash)          || raise(RecipeError, ERRORS[203] % {c: recipe.class.name})
@@ -55,10 +62,6 @@ class Checker
     recipe[:tests].is_a?(Array) || raise(RecipeError, ERRORS[205] % {c: recipe[:tests].class.name})
   end
 
-  def no_output?
-    @options[:output] === false
-  end
-
   # --- Données ---
 
   def name

data/lib/lazy/check/checker_code.rb

@@ -33,7 +33,6 @@ class Checker
       checker.check_against(@data_check, **options)
     end
 
-
     private
 
       # Méthode qui vérifie la conformité de la donnée
@@ -80,6 +79,8 @@ class Checker
     # de test)
     attr_reader :report
 
+    attr_reader :options
+
     def initialize(xml_code)
       @xml_code = xml_code
       @urler = Checker::Url.new(xml_code)
@@ -91,6 +92,7 @@ class Checker
     #   :return_result   Si true, on retourne les données au lieu de les afficher
     # 
     def check_against(data_check, **options)
+      @options = options
       @report = Reporter.new(self)
       @report.start
       check_case = Checker::CheckCase.new(urler, data_check, @report)
@@ -103,6 +105,14 @@ class Checker
       end
     end
 
+    def name
+      MESSAGES[:CodeToTest]
+    end
+
+    def no_output?
+      options[:return_result] === true
+    end
+
   end #/class Code
 end #/class Checker
 end #/module Lazy

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

@@ -15,6 +15,7 @@ Success:    'Success'
 Failures:   'Failures'
 Duration:   'Duration'
 PleaseWait: 'Please wait…'
+CodeToTest: 'Code to test'
 
 # -- Les messages de retour des checks --
 

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

@@ -15,6 +15,7 @@ Success: 'Succès'
 Failures: 'Échecs'
 Duration: 'Durée'
 PleaseWait: 'Merci de patienter…'
+CodeToTest: 'Code à tester'
 
 # -- Les messages de retour des checks --
 

data/lib/lazy/check/reporter.rb

@@ -58,10 +58,12 @@ class Checker
     end
 
     def start
-      clear unless debug?
-      puts "\n\n"
-      puts "#{checker.name}".jaune
-      puts MESSAGES[:PleaseWait].bleu
+      unless checker.no_output?
+        clear unless debug?
+        puts "\n\n"
+        puts "#{checker.name}".jaune
+        puts MESSAGES[:PleaseWait].bleu
+      end
       @start_time = Time.now
       @successs = []
       @failures = []

data/lib/lazy/check/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy-check
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.4
 platform: ruby
 authors:
 - Philippe Perret