Merge pull request #320 from JaniJegoroff/rubocop-warning-fixes

Rubocop warning fixes

Author: bootstraponline

.gitignore

@@ -1,3 +1,2 @@
 *.gem
-.*
 *.lock

.rubocop.yml

@@ -0,0 +1,10 @@
+# Custom config for RuboCop static code analysis
+
+Metrics/LineLength:
+  Max: 125
+
+Style/ConstantName:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30

Rakefile

@@ -3,6 +3,7 @@ require 'rubygems'
 require 'rake'
 require 'date'
 require 'posix/spawn'
+require 'rubocop/rake_task'
 
 # Defines gem name.
 def repo_name
@@ -226,4 +227,11 @@ end
 desc 'Remove non-ascii bytes'
 task :byte do
   remove_non_ascii
-end
+end
+
+desc 'Execute RuboCop static code analysis'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = %w(lib)
+  t.options = %w(-D)
+  t.fail_on_error = false
+end

android_tests/lib/android/specs/common/device.rb

@@ -24,8 +24,8 @@
     wait { current_activity.include?('Settings').must_equal true }
   end
 
-  t 'is_installed' do
-    wait { is_installed?('fake_app').must_equal false }
+  t 'installed' do
+    wait { app_installed?('fake_app').must_equal false }
   end
 
   t 'reset' do

android_tests/lib/android/specs/install.rb

@@ -5,11 +5,11 @@ def pkg
   end
 
   def installed
-    is_installed?(pkg).must_equal true
+    app_installed?(pkg).must_equal true
   end
 
   def not_installed
-    is_installed?(pkg).must_equal false
+    app_installed?(pkg).must_equal false
   end
 
   t 'install/uninstall' do

appium_lib.gemspec

@@ -28,5 +28,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 10.2', '>= 10.2.2'
   s.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.3'
 
+  s.add_development_dependency 'rubocop', '~> 0.30'
+
   s.files = `git ls-files`.split "\n"
-end
+end

ios_tests/lib/ios/specs/device/device.rb

@@ -27,8 +27,8 @@ def go_back
     screen.must_equal catalog
   end
 
-  t 'is_installed' do
-    installed = is_installed? "Derrp"
+  t 'app_installed' do
+    installed = app_installed? "Derrp"
     installed.must_equal false
   end
 

lib/appium_lib/android/client_xpath.rb

@@ -2,7 +2,7 @@
 
 module Appium
   module Android
-    def _nodeset_to_uiselector opts={}
+    def _nodeset_to_uiselector(opts = {})
       results = ''
 
       nodes = opts[:nodes]
@@ -11,16 +11,16 @@ def _nodeset_to_uiselector opts={}
       nodes = [nodes[0]] if first
 
       nodes.each do |node|
-        results += %Q(new UiSelector().className("#{node.name}").instance(#{node.attr('instance')});)
+        results += %(new UiSelector().className("#{node.name}").instance(#{node.attr('instance')});)
       end
 
       results.strip
     end
 
-    def _client_xpath opts={}
+    def _client_xpath(opts = {})
       root_node = Nokogiri::XML(get_source).children.first
 
-      instance = Hash.new -1
+      instance = Hash.new(-1)
 
       root_node.traverse do |node|
         number = instance[node.name] += 1
@@ -33,15 +33,15 @@ def _client_xpath opts={}
       _nodeset_to_uiselector nodes: nodes, first: first
     end
 
-    def client_xpath xpath
+    def client_xpath(xpath)
       find_element :uiautomator, _client_xpath(xpath: xpath, first: true)
     end
 
-    def client_xpaths xpath
+    def client_xpaths(xpath)
       find_elements :uiautomator, _client_xpath(xpath: xpath, first: false)
     end
   end
 end
 
 # http://stackoverflow.com/questions/9199415/getting-first-node-in-xpath-result-set
-# '(//android.widget.TextView)[1]' not '//android.widget.TextView[1]'
+# '(//android.widget.TextView)[1]' not '//android.widget.TextView[1]'

lib/appium_lib/android/element/alert.rb

@@ -3,7 +3,7 @@ module Android
     # Click the first alert button that contains value or by index.
     # @param value [Integer, String] either an integer index of the button or the button's name
     # @return [void]
-    def alert_click value
+    def alert_click(value)
       button(value).click
     end
 
@@ -35,4 +35,4 @@ def alert_dismiss_text
       first_button.text
     end
   end # module Android
-end # module Appium
+end # module Appium

lib/appium_lib/android/element/button.rb

@@ -7,28 +7,28 @@ module Android
     private
 
     # @private
-    def _button_visible_selectors opts={}
+    def _button_visible_selectors(opts = {})
       button_index       = opts.fetch :button_index, false
       image_button_index = opts.fetch :image_button_index, false
 
       if button_index && image_button_index
-        "new UiSelector().className(#{Button}).instance(#{button_index});" +
-        "new UiSelector().className(#{ImageButton}).instance(#{image_button_index});"
+        "new UiSelector().className(#{Button}).instance(#{button_index});" \
+          "new UiSelector().className(#{ImageButton}).instance(#{image_button_index});"
       else
-        "new UiSelector().className(#{Button});" +
-        "new UiSelector().className(#{ImageButton});"
+        "new UiSelector().className(#{Button});" \
+          "new UiSelector().className(#{ImageButton});"
       end
     end
 
     # @private
-    def _button_exact_string value
+    def _button_exact_string(value)
       button       = string_visible_exact Button, value
       image_button = string_visible_exact ImageButton, value
       button + image_button
     end
 
     # @private
-    def _button_contains_string value
+    def _button_contains_string(value)
       button       = string_visible_contains Button, value
       image_button = string_visible_contains ImageButton, value
       button + image_button
@@ -40,12 +40,12 @@ def _button_contains_string value
     # @param value [String, Integer] the value to exactly match.
     # If int then the button at that index is returned.
     # @return [Button]
-    def button value
+    def button(value)
       # Don't use ele_index because that only works on one element type.
       # Android needs to combine button and image button to match iOS.
       if value.is_a? Numeric
         index = value
-        raise "#{index} is not a valid index. Must be >= 1" if index <= 0
+        fail "#{index} is not a valid index. Must be >= 1" if index <= 0
 
         return find_element :uiautomator, _button_visible_selectors(index: index)
       end
@@ -57,7 +57,7 @@ def button value
     # If value is omitted, all buttons are returned.
     # @param value [String] the value to search for
     # @return [Array<Button>]
-    def buttons value=false
+    def buttons(value = false)
       return find_elements :uiautomator, _button_visible_selectors unless value
       find_elements :uiautomator, _button_contains_string(value)
     end
@@ -73,28 +73,28 @@ def first_button
     def last_button
       # uiautomator index doesn't support last
       # and it's 0 indexed
-      button_index       = tags(Button).length
-      button_index       -= 1 if button_index > 0
+      button_index = tags(Button).length
+      button_index -= 1 if button_index > 0
       image_button_index = tags(ImageButton).length
       image_button_index -= 1 if image_button_index > 0
 
       find_element :uiautomator,
                    _button_visible_selectors(button_index: button_index,
-                                            image_button_index: image_button_index)
+                                             image_button_index: image_button_index)
     end
 
     # Find the first button that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [Button]
-    def button_exact value
+    def button_exact(value)
       find_element :uiautomator, _button_exact_string(value)
     end
 
     # Find all buttons that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<Button>]
-    def buttons_exact value
+    def buttons_exact(value)
       find_elements :uiautomator, _button_exact_string(value)
     end
   end # module Android
-end # module Appium
+end # module Appium

lib/appium_lib/android/element/generic.rb

@@ -1,44 +1,43 @@
 module Appium
   module Android
-
     # Find the first element containing value
     # @param value [String] the value to search for
     # @return [Element]
-    def find value
+    def find(value)
       complex_find_contains '*', value
     end
 
     # Find all elements containing value
     # @param value [String] the value to search for
     # @return [Array<Element>]
-    def finds value
+    def finds(value)
       complex_finds_contains '*', value
     end
 
     # Find the first element exactly matching value
     # @param value [String] the value to search for
     # @return [Element]
-    def find_exact value
+    def find_exact(value)
       complex_find_exact '*', value
     end
 
     # Find all elements exactly matching value
     # @param value [String] the value to search for
     # @return [Array<Element>]
-    def finds_exact value
+    def finds_exact(value)
       complex_finds_exact '*', value
     end
 
     # @private
-     def scroll_uiselector content
-       "new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(#{content}.instance(0));"
-     end
+    def scroll_uiselector(content)
+      "new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(#{content}.instance(0));"
+    end
 
     # Scroll to the first element containing target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
-    def scroll_to text
-      text = %Q("#{text}")
+    def scroll_to(text)
+      text = %("#{text}")
 
       args = scroll_uiselector("new UiSelector().textContains(#{text})") +
              scroll_uiselector("new UiSelector().descriptionContains(#{text})")
@@ -49,13 +48,13 @@ def scroll_to text
     # Scroll to the first element with the exact target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
-    def scroll_to_exact text
-      text = %Q("#{text}")
+    def scroll_to_exact(text)
+      text = %("#{text}")
 
       args = scroll_uiselector("new UiSelector().text(#{text})") +
              scroll_uiselector("new UiSelector().description(#{text})")
 
       find_element :uiautomator, args
     end
   end # module Android
-end # module Appium
+end # module Appium

lib/appium_lib/android/element/text.rb

@@ -7,7 +7,7 @@ module Android
     # @param value [String, Integer] the value to find.
     # If int then the TextView at that index is returned.
     # @return [TextView]
-    def text value
+    def text(value)
       return ele_index TextView, value if value.is_a? Numeric
       complex_find_contains TextView, value
     end
@@ -16,7 +16,7 @@ def text value
     # If value is omitted, all texts are returned.
     # @param value [String] the value to search for
     # @return [Array<TextView>]
-    def texts value=false
+    def texts(value = false)
       return tags TextView unless value
       complex_finds_contains TextView, value
     end
@@ -36,15 +36,15 @@ def last_text
     # Find the first TextView that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [TextView]
-    def text_exact value
+    def text_exact(value)
       complex_find_exact TextView, value
     end
 
     # Find all TextViews that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<TextView>]
-    def texts_exact value
+    def texts_exact(value)
       complex_finds_exact TextView, value
     end
   end # module Android
-end # module Appium
+end # module Appium

lib/appium_lib/android/element/textfield.rb

@@ -6,7 +6,7 @@ module Android
     # @param value [String, Integer] the text to match exactly.
     # If int then the EditText at that index is returned.
     # @return [EditText]
-    def textfield value
+    def textfield(value)
       return ele_index EditText, value if value.is_a? Numeric
       complex_find_contains EditText, value
     end
@@ -15,7 +15,7 @@ def textfield value
     # If value is omitted, all EditTexts are returned.
     # @param value [String] the value to search for
     # @return [Array<EditText>]
-    def textfields value=false
+    def textfields(value = false)
       return tags EditText unless value
       complex_finds_contains EditText, value
     end
@@ -35,15 +35,15 @@ def last_textfield
     # Find the first EditText that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [EditText]
-    def textfield_exact value
+    def textfield_exact(value)
       complex_find_exact EditText, value
     end
 
     # Find all EditTexts that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<EditText>]
-    def textfields_exact value
+    def textfields_exact(value)
       complex_finds_exact EditText, value
     end
   end # module Android
-end # module Appium
+end # module Appium