selenium_statistics 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2d0106cb43aed51cad99acb471dad749f5618db
-  data.tar.gz: 53fe5830dbd6ca24ae03a521da68640127f0782c
+  metadata.gz: 77e448503173f57c45238666de809c26e4fc4a01
+  data.tar.gz: 8b9ce8869b07e13b15fe3c2f3da554509d59ee83
 SHA512:
-  metadata.gz: 3551ef36601de6274aa10ba0967ea6c93cf5abd261b861bc1e1292ae8d9d12ba0be698d5c54c721748d870a55d6bcf2a26df8edf86b7469fd1a87036332fe75a
-  data.tar.gz: 42a6e4cde320961583df451f9be4e277a567471863da872ebd37b80d6337fa9e958e5e44e4640e0e43ab14eb07181602fdd71430b0a7bdd0099ff381bf903f22
+  metadata.gz: babcef863915bf3d6e34cd4e852647bccdc44f5a3a3af166029ae7d4aaf03328452fad5a9081ccc3f8336e660990f0fabfb10efa77e183fbc17758e66f196fb2
+  data.tar.gz: 1fd1bf34cb7913962d0712a1b446194e47b1b3bd568483143e14ea31cb528f507afa378348e6375c70f78e284182c72da9dc4712e9fd7b6a4e3b979bab54f18a

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.idea

data/README.md

@@ -1,17 +1,20 @@
 # SeleniumStatistics
 
-This gem will collect counts and times for each selenium command your code issues.
+This gem will collect counts and times for each wire call your code makes.
 
 ## Usage
 
 When gem is required, statistics will be collected for each wire call.
-To access current results, call ```SeleniumStatistics.results```
+To access current results, call ```SeleniumStatistics.print_results```
 
-Additional debugging information can be obtained by setting ```ENV['DEBUG'] = 'true'```
+Results can be ported to a file using ```SeleniumStatistics.logger.output = file_name```
+
+Additional debugging information can be obtained by setting 
+```SeleniumStatistics.logger = :info``` or ```SeleniumStatistics.logger = :debug```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/selenium_statistics/fork )
+1. Fork it ( https://github.com/titusfortner/selenium_statistics/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -19,4 +22,4 @@ Additional debugging information can be obtained by setting ```ENV['DEBUG'] = 't
 
 ## Copyright
 
-Copyright (c) 2016 Titus Fortner. See LICENSE for details.
+Copyright (c) 2016-2017 Titus Fortner. See LICENSE for details.

data/lib/selenium_statistics.rb

@@ -1,4 +1,17 @@
 require 'selenium-webdriver'
+require 'selenium_statistics/logger'
+
+#
+# Returns logger instance that can be used throughout Selenium Run.
+#
+# @return [Logger]
+#
+
+module SeleniumStatistics
+  def self.logger
+    @logger ||= SeleniumStatistics::Logger.new
+  end
+end
 
 require "selenium_statistics/version"
 require 'selenium_statistics/statistics'

data/lib/selenium_statistics/logger.rb

@@ -0,0 +1,109 @@
+require 'forwardable'
+require 'logger'
+
+# Code adapted from Selenium Implementation
+# https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/common/logger.rb
+
+module SeleniumStatistics
+  #
+  # @example Enable full logging
+  #   SeleniumStatistics.logger.level = :debug
+  #
+  # @example Log to file
+  #   SeleniumStatistics.logger.output = 'watir.log'
+  #
+  # @example Use logger manually
+  #   SeleniumStatistics.logger.info('This is info message')
+  #   SeleniumStatistics.logger.warn('This is warning message')
+  #
+  class Logger
+    extend Forwardable
+    include ::Logger::Severity
+
+    def_delegators :@logger, :debug, :debug?,
+                   :info, :info?,
+                   :warn, :warn?,
+                   :error, :error?,
+                   :fatal, :fatal?,
+                   :level
+
+    def initialize
+      @logger = create_logger($stdout)
+    end
+
+    def output=(io)
+      # `Logger#reopen` was added in Ruby 2.3
+      if @logger.respond_to?(:reopen)
+        @logger.reopen(io)
+      else
+        @logger = create_logger(io)
+      end
+    end
+
+    #
+    # For Ruby < 2.3 compatibility
+    # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
+    #
+
+    def level=(severity)
+      if severity.is_a?(Integer)
+        @logger.level = severity
+      else
+        case severity.to_s.downcase
+        when 'debug'.freeze
+          @logger.level = DEBUG
+        when 'info'.freeze
+          @logger.level = INFO
+        when 'warn'.freeze
+          @logger.level = WARN
+        when 'error'.freeze
+          @logger.level = ERROR
+        when 'fatal'.freeze
+          @logger.level = FATAL
+        when 'unknown'.freeze
+          @logger.level = UNKNOWN
+        else
+          raise ArgumentError, "invalid log level: #{severity}"
+        end
+      end
+    end
+
+    #
+    # Returns IO object used by logger internally.
+    #
+    # Normally, we would have never needed it, but we want to
+    # use it as IO object for all child processes to ensure their
+    # output is redirected there.
+    #
+    # It is only used in debug level, in other cases output is suppressed.
+    #
+    # @api private
+    #
+    def io
+      @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
+    end
+
+    #
+    # Marks code as deprecated with replacement.
+    #
+    # @param [String] old
+    # @param [String] new
+    #
+    def deprecate(old, new)
+      warn "[DEPRECATION] #{old} is deprecated. Use #{new} instead."
+    end
+
+    private
+
+    def create_logger(output)
+      logger = ::Logger.new(output)
+      logger.progname = 'SeleniumStatistics'
+      logger.level = ($DEBUG ? DEBUG : WARN)
+      logger.formatter = proc do |severity, time, progname, msg|
+        "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end

data/lib/selenium_statistics/statistics.rb

@@ -8,7 +8,18 @@ module SeleniumStatistics
   @executions = 0
   @time = 0
 
-  Selenium::WebDriver::Remote::Bridge::COMMANDS.keys.each do |command|
+  COMMANDS = Selenium::WebDriver::Remote::Bridge::COMMANDS.keys +
+      Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS.keys +
+      Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS.keys
+
+  COMMANDS.each do |command|
+    if command == :get_element_location_once_scrolled_into_view
+      command = :get_element_location
+    end
+    if command == :get_element_value_of_css_property
+      command = :get_element_css_value
+    end
+
     define_method("#{command}=") do |time|
       @commands[command] ||= {}
 
@@ -22,9 +33,8 @@ module SeleniumStatistics
       @executions += 1
       @time += time
 
-      if ENV['DEBUG'] == 'true'
-        puts "Executed #{command} in #{time} sec"
-      end
+      SeleniumStatistics.logger.info "Executed #{command} in #{time} sec"
+      SeleniumStatistics.logger.debug "#{command} executed total of #{@commands[command][:count]} times in #{ @commands[command][:time]} seconds"
     end
 
     define_method(command) do
@@ -34,6 +44,14 @@ module SeleniumStatistics
     @test_start = Time.now
   end
 
+  def get_element_location_once_scrolled_into_view=(*args)
+    self.get_element_location= args.first
+  end
+
+  def get_element_value_of_css_property=(*args)
+    self.get_element_css_value= args.first
+  end
+
   def results(sort=nil)
     sort ||= :count
     @test_time = Time.now - @test_start
@@ -43,16 +61,17 @@ module SeleniumStatistics
   end
 
   def print_results(sort=nil)
-    str = "Executed a total of #{executions} commands in #{time.round(1)} seconds\n"
+    str = "Executed a total of #{executions} commands in #{time.round(1)} seconds\n\n"
 
     results(sort).each do |k,v|
-      str << "\t#{k}: \n\t\t\t#{v[:count]} executions;"
-      str << "\ttotal of #{v[:time].round(1)} sec;"
-      str << "\tavg of #{v[:average].round(3)} sec/cmd;"
-      str << "\t#{(100*v[:average_total]).round(2)}% of total\n"
+      str << "#{k.to_s}:".ljust(27, ' ')
+      str << "executions: #{v[:count].to_s.rjust(4, ' ')}; "
+      str << "total seconds: #{v[:time].round(1).to_s.rjust(5, ' ')}; "
+      str << "avg sec/cmd: #{v[:average].round(3).to_s.rjust(5, ' ')}; "
+      str << "total: #{(100*v[:average_total]).round(2).to_s.rjust(5, ' ')}%\n"
     end
 
-    puts str
+    SeleniumStatistics.logger.warn str
   end
 
   def reset!

data/selenium_statistics.gemspec

@@ -1,11 +1,10 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'selenium_statistics/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "selenium_statistics"
-  spec.version       = SeleniumStatistics::VERSION
+  spec.version       = "0.2.0"
   spec.authors       = ["Titus Fortner"]
   spec.email         = ["titusfortner@gmail.com"]
   spec.summary       = %q{Generate information about Selenium commands}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selenium_statistics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Titus Fortner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,8 +81,8 @@ files:
 - lib/CHANGES.md
 - lib/selenium_statistics.rb
 - lib/selenium_statistics/bridge.rb
+- lib/selenium_statistics/logger.rb
 - lib/selenium_statistics/statistics.rb
-- lib/selenium_statistics/version.rb
 - selenium_statistics.gemspec
 - spec/html/test.html
 - spec/spec_helper.rb
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Generate information about Selenium commands
@@ -115,4 +115,3 @@ test_files:
 - spec/html/test.html
 - spec/spec_helper.rb
 - spec/statistics_spec.rb
-has_rdoc: 

data/lib/selenium_statistics/version.rb

@@ -1,3 +0,0 @@
-module SeleniumStatistics
-  VERSION = "0.1.0"
-end