watirsome 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55acaa1b98823ce111123d39f9bbe1fc790858a4
-  data.tar.gz: 54a6024bb51080cc4b210a56b950644c22138063
+  metadata.gz: fe636cb3b0cae995c534f29c111f641c893c231b
+  data.tar.gz: 7de7589b70e4a487f50fed9e1a6928c308faa896
 SHA512:
-  metadata.gz: edd340975762139ecf58896937901031ff12f0a8557f844adce8a449f2f2975ccc28decf2305c077c10875f86f19138d13876d60beae54c837810f3ecd4f7ea3
-  data.tar.gz: fb8c2f41ff5e263d9571a5c1d8596b38a90d4817f07873a5d0271443b5e689bf19090f963ad6a1da364bb22da136ea031cef5d20d87c8e47af03abd9cd957ff6
+  metadata.gz: 6dc9bab5a99c4db9460d4c3e34fa084adf1f4c3db3b56776be0d0e5c5b5492430f7df0a2c754cafbb63443fe15698647dc15764f8612b052154c627f8284293e
+  data.tar.gz: 0f853e10baafc6ef04c69c2210a5ccad5d4c4f4bfc225a333134a0ce11dd85be36371b5ab8216228b64c43d362c4681efbf3969b815f4d8bcf23a3fbc5ac341f

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Metrics/AbcSize:
+  Max: 17
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ModuleLength:
+  Max: 110
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%w': '[]'

data/.travis.yml

@@ -1,4 +1,7 @@
-langauge: ruby
+sudo: false
+language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.3.0
+before_script:
+  - mkdir ~/.yard
+  - bundle exec yard config load_plugins true

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### v0.1.7
+
+* Massive refactoring
+* Added support for read accessors on checkbox/radio element (#4)
+
 #### v0.1.4
 
 * Support element subtype boolean locators (e.g. `select_list :list, selected: 'Default'`)

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Alex Rodionov
+Copyright (c) 2016 Alex Rodionov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-## watirsome [![Gem Version](https://badge.fury.io/rb/watirsome.png)](http://badge.fury.io/rb/watirsome) [![Build Status](https://secure.travis-ci.org/p0deje/watirsome.png)](http://travis-ci.org/p0deje/watirsome) [![Coverage Status](https://coveralls.io/repos/p0deje/watirsome/badge.png?branch=master)](https://coveralls.io/r/p0deje/watirsome)
+## watirsome [![Gem Version](https://badge.fury.io/rb/watirsome.svg)](http://badge.fury.io/rb/watirsome) [![Build Status](https://secure.travis-ci.org/p0deje/watirsome.svg)](http://travis-ci.org/p0deje/watirsome) [![Coverage Status](https://coveralls.io/repos/p0deje/watirsome/badge.svg?branch=master)](https://coveralls.io/r/p0deje/watirsome)
 
 Pure dynamic Watir-based page object DSL.
 
@@ -73,7 +73,7 @@ class Page
 end
 
 page = Page.new(@browser)
-page.body_element  # equals to @browser.body
+page.body_body     # equals to @browser.body
 page.one_section   # equals to @browser.section(id: 'section_one')
 page.svg_element   # equals to @browser.element(tag_name: 'svg')
 page.login_button  # equals to @browser.button(class: 'submit', index: 1)
@@ -323,4 +323,4 @@ Regions are being cached, so, once initialized, they won't be executed if you ca
 
 ### Copyright
 
-Copyright (c) 2013 Alex Rodionov. See LICENSE.md for details.
+Copyright (c) 2016 Alex Rodionov. See LICENSE.md for details.

data/Rakefile

@@ -3,10 +3,12 @@ $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new do |spec|
-  spec.rspec_opts = %w(--color --require fuubar --format Fuubar)
-  spec.pattern    = 'spec/**/*_spec.rb'
+require 'yard-doctest'
+YARD::Doctest::RakeTask.new do |task|
+  task.doctest_opts = %w[-v]
 end
 
-task default: :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %w[rubocop yard:doctest]

data/doctest_helper.rb

@@ -0,0 +1,16 @@
+require 'watirsome'
+
+def browser
+  @browser ||= begin
+    browser = Watir::Browser.new(:phantomjs)
+    browser.goto "data:text/html,#{File.read('support/doctest.html')}"
+
+    browser
+  end
+end
+
+YARD::Doctest.configure do |doctest|
+  doctest.after do
+    @browser.quit if @browser
+  end
+end

data/lib/watirsome.rb

@@ -1,24 +1,68 @@
+#
+# General module which holds all appropriate Watirsome API.
+# Includers can use accessors and initializers API.
+#
+# @example Element Accessors
+#   class Page
+#     include Watirsome
+#
+#     element :body, tag_name: 'body'
+#     div :container, class: 'container'
+#   end
+#
+#   page = Page.new(browser)
+#   page.body_element  #=> browser.element(tag_name: 'body')
+#   page.container_div #=> browser.div(class: 'container')
+#
+# @example Read Accessors
+#   class Page
+#     include Watirsome
+#
+#     div :container, class: 'container'
+#     radio :sex_male, value: "Male"
+#   end
+#
+#   page = Page.new(browser)
+#   page.container #=> "Container"
+#   page.sex_male_radio.set
+#   page.sex_male #=> true
+#
+# @example Click Accessors
+#   class Page
+#     include Watirsome
+#
+#     a :open_google, text: 'Open Google'
+#   end
+#
+#   page = Page.new(browser)
+#   page.open_google
+#   browser.title #=> "Google"
+#
+# @example Set Accessors
+#   class Page
+#     include Watirsome
+#
+#     text_field :name, placeholder: "Enter your name"
+#     select_list :country, name: "Country"
+#     checkbox :agree, name: "I Agree"
+#   end
+#
+#   page = Page.new(browser)
+#   page.name = 'My name'
+#   page.name #=> "My name"
+#   page.country = "Russia"
+#   page.country #=> "Russia"
+#   page.agree = true
+#   page.agree #=> true
+#
 module Watirsome
   class << self
-
-    # @attr [Array<Symbol>] readable
-    attr_accessor :readable
-
-    # @attr [Array<Symbol>] clickable
-    attr_accessor :clickable
-
-    # @attr [Array<Symbol>] settable
-    attr_accessor :settable
-
-    # @attr [Array<Symbol>] selectable
-    attr_accessor :selectable
-
     #
     # Returns array of readable elements.
     # @return [Array<Symbol>]
     #
     def readable
-      @readable ||= [:div, :span, :p, :h1, :h2, :h3, :h4, :h5, :h6, :select_list, :text_field, :textarea]
+      @readable ||= %i[div span p h1 h2 h3 h4 h5 h6 select_list text_field textarea checkbox radio]
     end
 
     #
@@ -26,7 +70,7 @@ module Watirsome
     # @return [Array<Symbol>]
     #
     def clickable
-      @clickable ||= [:a, :link, :button]
+      @clickable ||= %i[a link button]
     end
 
     #
@@ -34,21 +78,17 @@ module Watirsome
     # @return [Array<Symbol>]
     #
     def settable
-      @settable ||= [:text_field, :file_field, :textarea, :checkbox]
-    end
-
-    #
-    # Returns array of selectable elements.
-    # @return [Array<Symbol>]
-    #
-    def selectable
-      @selectable ||= [:select_list]
+      @settable ||= %i[text_field file_field textarea checkbox select_list]
     end
 
     #
     # Returns true if tag can have click accessor.
     #
-    # @param [Symbol, String] method
+    # @example
+    #   Watirsome.clickable?(:button) #=> true
+    #   Watirsome.clickable?(:div)    #=> false
+    #
+    # @param [Symbol, String] tag
     # @return [Boolean]
     #
     def clickable?(tag)
@@ -58,27 +98,25 @@ module Watirsome
     #
     # Returns true if tag can have set accessor.
     #
-    # @param [Symbol, String] method
+    # @example
+    #   Watirsome.settable?(:text_field) #=> true
+    #   Watirsome.settable?(:button)     #=> false
+    #
+    # @param [Symbol, String] tag
     # @return [Boolean]
     #
     def settable?(tag)
       settable.include? tag.to_sym
     end
 
-    #
-    # Returns true if tag can have select accessor.
-    #
-    # @param [Symbol, String] method
-    # @return [Boolean]
-    #
-    def selectable?(tag)
-      selectable.include? tag.to_sym
-    end
-
     #
     # Returns true if tag can have text accessor.
     #
-    # @param [Symbol, String] method
+    # @example
+    #   Watirsome.readable?(:div)  #=> true
+    #   Watirsome.readable?(:body) #=> false
+    #
+    # @param [Symbol, String] tag
     # @return [Boolean]
     #
     def readable?(tag)
@@ -101,6 +139,10 @@ module Watirsome
     #
     # Return true if method can be proxied to Watir, false otherwise.
     #
+    # @example
+    #   Watirsome.watirsome?(:div)  #=> true
+    #   Watirsome.watirsome?(:to_a) #=> false
+    #
     # @param [Symbol] method
     # @return [Boolean]
     #
@@ -112,8 +154,8 @@ module Watirsome
     # Returns true if method is element accessor in plural form.
     #
     # @example
-    #   Watirsome.plural? :div   #=> false
-    #   Watirsome.plural? :divs  #=> true
+    #   Watirsome.plural?(:divs) #=> true
+    #   Watirsome.plural?(:div)  #=> false
     #
     # @param [Symbol, String] method
     # @return [Boolean]
@@ -124,15 +166,17 @@ module Watirsome
       plr = str.to_sym
       sgl = str.sub(/e?s$/, '').to_sym
 
-      /s$/ === str && Watirsome.watir_methods.include?(plr) && Watirsome.watir_methods.include?(sgl)
+      !str.match(/s$/).nil? &&
+        Watirsome.watir_methods.include?(plr) &&
+        Watirsome.watir_methods.include?(sgl)
     end
 
     #
     # Pluralizes element.
     #
     # @example
-    #   Watirsome.pluralize :div       #=> :divs
-    #   Watirsome.pluralize :checkbox  #=> :checkboxes
+    #   Watirsome.pluralize(:div)       #=> :divs
+    #   Watirsome.pluralize(:checkbox)  #=> :checkboxes
     #
     # @param [Symbol, String] method
     # @return [Symbol]
@@ -151,19 +195,15 @@ module Watirsome
         raise Errors::CannotPluralizeError, "Can't find plural form for #{str}!"
       end
     end
-
   end # self
 
-
   def self.included(kls)
-    kls.extend         Watirsome::Accessors::ClassMethods
-    kls.send :include, Watirsome::Accessors::InstanceMethods
-    kls.send :include, Watirsome::Initializers
+    kls.extend Watirsome::Accessors::ClassMethods
+    kls.__send__ :include, Watirsome::Accessors::InstanceMethods
+    kls.__send__ :include, Watirsome::Initializers
   end
-
 end # Watirsome
 
-
 require 'watir-webdriver'
 require 'watirsome/accessors'
 require 'watirsome/initializers'

data/lib/watirsome/accessors.rb

@@ -1,9 +1,8 @@
 module Watirsome
   module Accessors
     module ClassMethods
-
       #
-      # Iterate thorugh Watir continer methods and define all necessary
+      # Iterate through Watir continer methods and define all necessary
       # class methods of element accessors.
       #
       Watirsome.watir_methods.each do |method|
@@ -11,10 +10,9 @@ module Watirsome
           name, args = parse_args(args)
           block = proc_from_args(args, &blk)
           define_element_accessor(name, method, args, &block)
-          define_click_accessor(name, method, args, &block)  if Watirsome.clickable?(method)
-          define_read_accessor(name, method, args, &block)   if Watirsome.readable?(method)
-          define_set_accessor(name, method, args, &block)    if Watirsome.settable?(method)
-          define_select_accessor(name, method, args, &block) if Watirsome.selectable?(method)
+          define_click_accessor(name, method, args, &block) if Watirsome.clickable?(method)
+          define_read_accessor(name, method, args, &block)  if Watirsome.readable?(method)
+          define_set_accessor(name, method, args, &block)   if Watirsome.settable?(method)
         end
       end
 
@@ -25,11 +23,11 @@ module Watirsome
       # @api private
       #
       def parse_args(args)
-        return args.shift, args.shift
+        [args.shift, args.shift]
       end
 
       #
-      # Returns block retreived from locators.
+      # Returns block retrieved from locators.
       # @api private
       #
       def proc_from_args(*args, &blk)
@@ -53,7 +51,7 @@ module Watirsome
       #
       def define_element_accessor(name, method, *args, &block)
         watir_args, custom_args = extract_custom_args(method, args)
-        define_method :"#{name}_#{method}" do |*opts|
+        define_method "#{name}_#{method}" do |*opts|
           if block_given?
             instance_exec(*opts, &block)
           else
@@ -110,6 +108,8 @@ module Watirsome
             element.value
           when :select_list
             element.options.detect(&:selected?).text
+          when :checkbox, :radio
+            element.set?
           else
             element.text
           end
@@ -130,13 +130,15 @@ module Watirsome
       #
       def define_set_accessor(name, method, *args, &block)
         watir_args, custom_args = extract_custom_args(method, args)
-        define_method :"#{name}=" do |*opts|
+        define_method "#{name}=" do |*opts|
           element = if block_given?
                       instance_exec(&block)
                     else
                       grab_elements(method, watir_args, custom_args)
                     end
-          if element.respond_to?(:set)
+          if element.is_a?(Watir::Select)
+            element.select(*opts)
+          elsif element.respond_to?(:set)
             element.set(*opts)
           else
             element.send_keys(*opts)
@@ -144,29 +146,6 @@ module Watirsome
         end
       end
 
-      #
-      # Defines accessor which selects option Watir element instance.
-      # Method name is element name + "=".
-      #
-      # Note that custom block arguments are not used here.
-      #
-      # @param [Symbol] name Element name
-      # @param [Symbol] method Watir method
-      # @param [Array] args Splat of locators
-      # @param [Proc] block Block as element retriever
-      # @api private
-      #
-      def define_select_accessor(name, method, *args, &block)
-        watir_args, custom_args = extract_custom_args(method, args)
-        define_method :"#{name}=" do |*opts|
-          if block_given?
-            instance_exec(&block).select(*opts)
-          else
-            grab_elements(method, watir_args, custom_args).select(*opts)
-          end
-        end
-      end
-
       #
       # Extracts custom arguments which Watirsome gracefully handles from
       # mixed array with Watir locators.
@@ -178,9 +157,11 @@ module Watirsome
       #
       def extract_custom_args(method, *args)
         identifier = args.shift
-        watir_args, custom_args = [], []
+        watir_args = []
+        custom_args = []
         identifier.each_with_index do |hashes, index|
-          watir_arg, custom_arg = {}, {}
+          watir_arg = {}
+          custom_arg = {}
           if hashes && !hashes.is_a?(Proc)
             hashes.each do |k, v|
               if Watir.element_class_for(method).instance_methods.include? :"#{k}?"
@@ -194,14 +175,11 @@ module Watirsome
           custom_args << custom_arg unless custom_arg.empty?
         end
 
-        return watir_args, custom_args
+        [watir_args, custom_args]
       end
-
     end # ClassMethods
 
-
     module InstanceMethods
-
       private
 
       #
@@ -214,24 +192,23 @@ module Watirsome
       #
       def grab_elements(method, watir_args, custom_args)
         if custom_args.empty?
-          @browser.send(method, *watir_args)
+          @browser.__send__(method, *watir_args)
         else
           plural = Watirsome.plural?(method)
           method = Watirsome.pluralize(method) unless plural
-          elements = @browser.send(method, *watir_args)
+          elements = @browser.__send__(method, *watir_args)
           custom_args.first.each do |k, v|
             elements.to_a.select! do |e|
               if e.public_method(:"#{k}?").arity == 0
-                e.send(:"#{k}?") == v
+                e.__send__(:"#{k}?") == v
               else
-                e.send(:"#{k}?", v)
+                e.__send__(:"#{k}?", v)
               end
             end
           end
           plural ? elements : elements.first
         end
       end
-
     end # InstanceMethods
   end # Accessors
 end # Watirsome