side_to_capybara 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4782d6ff7fa955a88f58ed0f998fef8e37564b647a89be7f04383a5d9be10dc5
-  data.tar.gz: 495d92f8a688ebc3b7fd306be24dcc6a413d7c01b59e9d3f13a7e486963a1993
+  metadata.gz: 6a52b89ddaff4e123351e90015c5e18829310efd033a382cb8b5a6986675d283
+  data.tar.gz: 2a339a4ad3707318d107b13b0052110e4d12b774aa1095c1c351b1352f5515fe
 SHA512:
-  metadata.gz: 9744b0e838a57880a1f4b963ffe7cb2627376a00860d4b7f179cdcbe5766b61d33d7c9149a8c3725fa1bd275b4d3306bf6f11ccccd37e0c8cfcda394ef1ee22a
-  data.tar.gz: 1b72b6a7deac061cafe6658af0898c769327126408b204fc3d8cf35b6dd5218a0621c8795a38183f97c403b5829435262343aae8d3edc195c3a0237539978f67
+  metadata.gz: 7d786fd9793ddf43a51aee232c8352eace2fc798ca25747b18c2c86935cad95ddb4953b785da5de747a17eea2ae108dfcf4d7c2a5394dd711926fe9369d7186b
+  data.tar.gz: dfa78373ea259b760ce1d89c8c9d04dfb7d907ebc97e7d45f1275214d12666deaada57f02feb750ee2f34f618fc51b85fc162ed18a90cf881befbc195f67ad98

data/README.md

@@ -67,6 +67,10 @@ In order to create the needed .side files the Selenium IDE plugin must be instal
 2. Save the test to the disk
 3. run `side2capybara path/to/saved/*.side`
 
+## Translation contribution
+
+The translations for minitest are currently placed in `lib/side_to_capybara/minitest.rb`. Feel free to add more or update the existing translations. To add a new translation open the `.side` file in your favourite text editor. It's a JSON file. Search for the command you want to add and define a new method with the name of the command in `minitest.rb`. For a more detailed description of how to add a new command translation please look at the `minitest.rb` file.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/side_to_capybara/base.rb

@@ -43,11 +43,15 @@ module SideToCapybara
       method_id = command.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
       if self.class.public_method_defined?(method_id)
         # the translation itself
-        translation = [public_send(method_id)]
-
-        # add the alternative selectors as comments
-        translation.unshift(commented_targets.join("\n")) if targets.size > 1
-        translation.join("\n")
+        translation = public_send(method_id)
+        return "# WARNING: '#{command}' found but the selector_type '#{selector_type}' is unhandled." if translation.nil?
+
+        # add the alternative selectors as comments if present
+        if targets.size > 1
+          "#{commented_targets.join("\n")}\n#{translation}"
+        else
+          translation
+        end
       else
         "# WARNING: Conversion for '#{command}' not found."
       end

data/lib/side_to_capybara/minitest.rb

@@ -1,5 +1,22 @@
 module SideToCapybara
 
+  # This class holds the translations for minitest.
+  #
+  # To add a translation you need to do the following steps:
+  # 1. Open the .side file and find the command you want to add
+  # 2. Define a method in the Minitest class with the command as name.
+  #    The command name must be translated to the ruby version of the name. `assertText` => `assert_text`
+  # 3. Define the translation
+  #
+  # The properties of the whole .side command object are accessible through ruby methods.
+  # - `target` is the preferred target selector of Selenium IDE
+  # - `targets` holds all possible target selectors identified by Selenium IDE
+  # - `selector_type` identifies the type of the preferred target selector (e.g css, xpath)
+  # - `selector` is the selector of the preferred target selector itself. (e.g 'body .header .title')
+  # - `value` e.g. the value that a text field should get
+  # - `command` the command name itself like `assertText` or `click`
+  # - `comment` a optional comment for that command
+  # - `id` the internal id generated by Selenium IDE
   class Minitest < Base
     def open
       "visit('#{target}')"
@@ -11,6 +28,10 @@ module SideToCapybara
         "find('#{selector}').double_click"
       when 'id'
         "find('##{selector}').double_click"
+      when 'xpath'
+        "find('#{selector}').double_click"
+      when 'name'
+        "find('[name=\"#{selector}\"]').double_click"
       end
     end
 
@@ -20,8 +41,12 @@ module SideToCapybara
         "find('#{selector}').click"
       when 'id'
         "find('##{selector}').click"
+      when 'xpath'
+        "find('#{selector}').click"
+      when 'name'
+        "find('[name=\"#{selector}\"]').click"
       when 'linkText'
-        "click_on('#{selector}')"
+        "click_link_or_button('#{selector}')"
       end
     end
 

data/lib/side_to_capybara/version.rb

@@ -1,3 +1,3 @@
 module SideToCapybara
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/side_to_capybara.rb

@@ -9,11 +9,16 @@ module SideToCapybara
       Minitest.new(command).translate
     end
 
-    <<~EOS
+    warning_present = test_commands.any? {|translation| translation.start_with?('# WARNING:')}
+
+    output = []
+    output << <<~EOS
       test '#{name}' do
       #{test_commands.map {|x| "  #{x.gsub(/\n/, "\n  ")}"}.join("\n\n")}
       end
     EOS
+    output << "\n# WARNING: Some commands are unhandled. Please contribute here: https://github.com/DarkSwoop/side_to_capybara" if warning_present
+    output.join("\n")
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: side_to_capybara
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Benjamin Behr