appium_failure_helper 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4801975d902d4f0a6877d409f7989c7c80581a10899615e34c53fff35052518b
-  data.tar.gz: cd1a18c7941c603ed9c0055fb87c28ca55fbd702a38996ff2613edce6f347780
+  metadata.gz: f76409f1b9c5f4bd448918dd57bcf691b317f2e9f8e49fdc077fb051b731c9c2
+  data.tar.gz: c38273c8afae6609ca72a3a0fdea5713ca3d358f1d0ee50a562f9d9cff9d62bf
 SHA512:
-  metadata.gz: b29a72379bebe025aee27dff7468de7dbaaa68a42f340eb090acecc472ff4a161fd598ea979852ca735b22e6187dd439bc453448b0f7647bc6f927edf7663934
-  data.tar.gz: 60b1df4b0c0fbd0ba35e6a761069cc7eb36db0ae961a8c718f77beea616a7a69b5f4817090e5e6ef98f56de3067e5cd115d4c353c3df1ca621d3e9a78a022174
+  metadata.gz: e7824f6860fb399ff2d735f410e779f1cc93582131e5ab5672eff5f85f8f0d5c8bfb3c434defa92de4aea24ec75714b3f7920cb7c500d7a48d81612b30fda052
+  data.tar.gz: 7761f6376e1f9a2b284a6df260873af206ac550fa9374676eb1673e4fa2abf448deab8f4529e22d1c1b168c044d0486b548b1aba64e79f2e56199d7a183374a1

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 David Nascimento
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2025 David Nascimento
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,62 +1,62 @@
-# Appium Failure Helper
-
-Este módulo Ruby foi projetado para auxiliar na **análise de falhas em testes de automação Appium**. Ao ser invocado, ele captura o estado da aplicação no momento da falha e gera um conjunto de artefatos de diagnóstico, facilitando a identificação da causa raiz do problema e a sugestão de novos localizadores de elementos.
-
-## Funcionalidades Principais
-
-* **Captura de Screenshot:** Salva uma imagem PNG da tela do dispositivo no momento da falha.
-
-* **Captura de Page Source:** Salva o XML do `page_source` completo, representando a hierarquia de elementos da tela.
-
-* **Geração de Sugestões de Elementos:** Analisa o `page_source` e gera um arquivo `.yaml` com sugestões de nomes e caminhos XPath para os elementos visíveis na tela.
-
-## Como Funciona
-
-A lógica central do módulo `AppiumFailureHelper` é acionada por um evento de falha no seu framework de testes (ex: Cucumber `After` hook). A função `handler_failure` executa as seguintes etapas:
-
-1. **Criação de Diretório:** Garante que a pasta `screenshots/` exista para armazenar os artefatos.
-
-2. **Captura de Screenshot e Page Source:** Utiliza o driver do Appium para obter o screenshot e o XML do `page_source`, salvando-os com um timestamp para evitar sobrescrever arquivos.
-
-3. **Análise com Nokogiri:** O XML do `page_source` é parseado utilizando a gem `Nokogiri`.
-
-4. **Processamento de Elementos:** O código itera sobre cada nó do XML (exceto o nó raiz 'hierarchy') e extrai atributos-chave como `resource-id`, `content-desc` e `text`.
-
-5. **Geração de Nomes e XPath:**
-
-   * `suggest_name`: Constrói um nome descritivo para cada elemento, utilizando prefixos comuns (`btn`, `txt`, `input`, etc.) e o valor dos atributos principais.
-
-   * `xpath_generator`: Prioriza atributos mais confiáveis (`resource-id`, `content-desc`, `text`) para gerar um XPath robusto.
-
-6. **Saída Final:** O resultado é um arquivo `.yaml` contendo uma lista formatada de sugestões de locators no formato `["nome_sugerido", "xpath", "caminho_xpath"]`.
-
-## Uso
-
-Para usar este helper, integre-o ao seu framework de testes. Um exemplo comum é utilizá-lo em um hook `After` do Cucumber:
-
-**`features/support/hooks.rb`**
-
-```
-require 'caminho/para/o/seu/modulo' # Ajuste o caminho
-
-After do |scenario|
-  if scenario.failed?
-    AppiumFailureHelper::Capture.handler_failure(appium_driver)
-  end
-end
-
-```
-
-**Observação:** O nome da sua variável de driver pode variar. No exemplo, `appium_driver` deve ser o objeto de driver do seu teste.
-
-## Artefatos Gerados
-
-Após uma falha, os seguintes arquivos serão gerados na pasta `screenshots/`:
-
-* `screenshot_20231027_153045.png`
-
-* `page_source_20231027_153045.xml`
-
-* `element_suggestions_20231027_153045.yaml`
-
+# Appium Failure Helper
+
+Este módulo Ruby foi projetado para auxiliar na **análise de falhas em testes de automação Appium**. Ao ser invocado, ele captura o estado da aplicação no momento da falha e gera um conjunto de artefatos de diagnóstico, facilitando a identificação da causa raiz do problema e a sugestão de novos localizadores de elementos.
+
+## Funcionalidades Principais
+
+* **Captura de Screenshot:** Salva uma imagem PNG da tela do dispositivo no momento da falha.
+
+* **Captura de Page Source:** Salva o XML do `page_source` completo, representando a hierarquia de elementos da tela.
+
+* **Geração de Sugestões de Elementos:** Analisa o `page_source` e gera um arquivo `.yaml` com sugestões de nomes e caminhos XPath para os elementos visíveis na tela.
+
+## Como Funciona
+
+A lógica central do módulo `AppiumFailureHelper` é acionada por um evento de falha no seu framework de testes (ex: Cucumber `After` hook). A função `handler_failure` executa as seguintes etapas:
+
+1. **Criação de Diretório:** Garante que a pasta `screenshots/` exista para armazenar os artefatos.
+
+2. **Captura de Screenshot e Page Source:** Utiliza o driver do Appium para obter o screenshot e o XML do `page_source`, salvando-os com um timestamp para evitar sobrescrever arquivos.
+
+3. **Análise com Nokogiri:** O XML do `page_source` é parseado utilizando a gem `Nokogiri`.
+
+4. **Processamento de Elementos:** O código itera sobre cada nó do XML (exceto o nó raiz 'hierarchy') e extrai atributos-chave como `resource-id`, `content-desc` e `text`.
+
+5. **Geração de Nomes e XPath:**
+
+   * `suggest_name`: Constrói um nome descritivo para cada elemento, utilizando prefixos comuns (`btn`, `txt`, `input`, etc.) e o valor dos atributos principais.
+
+   * `xpath_generator`: Prioriza atributos mais confiáveis (`resource-id`, `content-desc`, `text`) para gerar um XPath robusto.
+
+6. **Saída Final:** O resultado é um arquivo `.yaml` contendo uma lista formatada de sugestões de locators no formato `["nome_sugerido", "xpath", "caminho_xpath"]`.
+
+## Uso
+
+Para usar este helper, integre-o ao seu framework de testes. Um exemplo comum é utilizá-lo em um hook `After` do Cucumber:
+
+**`features/support/hooks.rb`**
+
+```
+require 'caminho/para/o/seu/modulo' # Ajuste o caminho
+
+After do |scenario|
+  if scenario.failed?
+    AppiumFailureHelper::Capture.handler_failure(appium_driver)
+  end
+end
+
+```
+
+**Observação:** O nome da sua variável de driver pode variar. No exemplo, `appium_driver` deve ser o objeto de driver do seu teste.
+
+## Artefatos Gerados
+
+Após uma falha, os seguintes arquivos serão gerados na pasta `screenshots/`:
+
+* `screenshot_20231027_153045.png`
+
+* `page_source_20231027_153045.xml`
+
+* `element_suggestions_20231027_153045.yaml`
+
 O arquivo `.yaml` é um recurso valioso para inspecionar os elementos da tela e atualizar seus localizadores de forma eficiente.

data/Rakefile

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-task default: %i[]
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/appium_failure_helper/capture.rb

@@ -9,9 +9,6 @@ module AppiumFailureHelper
         timestamp = Time.now.strftime('%Y%m%d_%H%M%S')
         folder_path = "screenshots"
         
-        # Lógica melhorada para criar a pasta.
-        # O método mkdir_p cria a pasta apenas se ela não existir,
-        # tornando a verificação Dir.exist? desnecessária.
         FileUtils.mkdir_p(folder_path)
         
         screenshot_path = "#{folder_path}/screenshot_#{timestamp}.png"
@@ -36,32 +33,14 @@ module AppiumFailureHelper
           'Switch' => 'switch',
         }
 
-        def suggest_name(tag, attrs, prefix)
-          type = tag.split('.').last
-          pfx = prefix[type] || 'elm'
-          name = attrs['content-desc'] || attrs['text'] || attrs['resource-id'] || 'unknown' || type
-          name = name.strip.gsub(/[^0-9a-z]/, '').split.map(&:capitalize).join
-          "#{pfx}#{name}"
-        end
-
-        def xpath_generator(tag, attrs)
-          type = tag.split('.').last
-          if attrs['resource-id'] && !attrs['resource-id'].empty?
-            "//*[@resource-id='#{attrs['resource-id']}']"
-          elsif attrs['content-desc'] && !attrs['content-desc'].empty?
-            "//*[@content-desc='#{attrs['content-desc']}']"
-          elsif attrs['text'] && !attrs['text'].empty?
-            "//*[@text='#{attrs['text']}']"
-          else
-            "//#{type}"
-          end
-        end
-
         line = doc.xpath('//*').map do |node|
           next if node.name == 'hierarchy'
           attrs = node.attributes.transform_values(&:value)
-          name = suggest_name(node.name, attrs, prefix)
-          xpath = xpath_generator(node.name, attrs)
+          
+          # Os métodos agora estão no escopo correto.
+          name = self.suggest_name(node.name, attrs, prefix)
+          xpath = self.xpath_generator(node.name, attrs)
+          
           "[\"#{name}\", \"xpath\", \"#{xpath}\"]"
         end
 
@@ -73,5 +52,29 @@ module AppiumFailureHelper
         puts "Error capturing failure details: #{e.message}"
       end
     end
+
+    private
+
+    # Mova os métodos para cá.
+    def self.suggest_name(tag, attrs, prefix)
+      type = tag.split('.').last
+      pfx = prefix[type] || 'elm'
+      name = attrs['content-desc'] || attrs['text'] || attrs['resource-id'] || 'unknown' || type
+      name = name.strip.gsub(/[^0-9a-z]/, '').split.map(&:capitalize).join
+      "#{pfx}#{name}"
+    end
+
+    def self.xpath_generator(tag, attrs)
+      type = tag.split('.').last
+      if attrs['resource-id'] && !attrs['resource-id'].empty?
+        "//*[@resource-id='#{attrs['resource-id']}']"
+      elsif attrs['content-desc'] && !attrs['content-desc'].empty?
+        "//*[@content-desc='#{attrs['content-desc']}']"
+      elsif attrs['text'] && !attrs['text'].empty?
+        "//*[@text='#{attrs['text']}']"
+      else
+        "//#{type}"
+      end
+    end
   end
-end
+end

data/lib/appium_failure_helper/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module AppiumFailureHelper
-  VERSION = "0.2.0"
-end
+# frozen_string_literal: true
+
+module AppiumFailureHelper
+  VERSION = "0.3.1"
+end

data/lib/appium_failure_helper.rb

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-require_relative "appium_failure_helper/version"
-require_relative "appium_failure_helper/capture"
-module AppiumFailureHelper
-  class Error < StandardError; end
-  # Your code goes here...
-end
+# frozen_string_literal: true
+
+require_relative "appium_failure_helper/version"
+require_relative "appium_failure_helper/capture"
+module AppiumFailureHelper
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/appium_failure_helper.rbs

@@ -1,4 +1,4 @@
-module AppiumFailureHelper
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end
+module AppiumFailureHelper
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_failure_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - David Nascimento
@@ -9,7 +9,77 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2025-09-23 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: appium_lib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Appium Failure Helper is a Ruby gem that provides utilities to capture
   failures during Appium test executions. It extracts and saves relevant information
   from the page source, including screenshots and element details, to aid in debugging