gless 1.5.2 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3171f5e0fdfe175806327383ff42c0d96b842a6
-  data.tar.gz: d4993218e8f18d9f34365bd260fdc07aa6c66c73
+  metadata.gz: 6094105504a01a7ceda507eb2a2de510f20fe84a
+  data.tar.gz: 8abe86a6fd223db704e5d88b3b047fd920531115
 SHA512:
-  metadata.gz: f6a84369b7eabd932a57ac13d5bcf462f86215b5a76fdb1132316ee1a3ab00487e2c661e09560630b8815bf5ef46b9fd02748d5c6506e67f4c4b78f63baf9ca4
-  data.tar.gz: 8f8e589f457205c9fdf6da23072ca8940d47a868d07a30672d1aba4517502762caf214df03a8c2fc25a74e9cab2a4466f6b4dc421048339d9de3aee7ae5e91c0
+  metadata.gz: cb428c193c09e266decac2e913f443cac3477f0f70d8a3813d49cf8059d0cba16ba6dc1ca2b0620988444aef438725f183e96a46d41296e68ba03636cd4f7315
+  data.tar.gz: 3ce61d0b7ce91054352a0861d349e0ba32236f27758bc6f0589882107ed9b23e640db3383b6be19f9bbd63540e8a0a73a13a705d3061527322101f315d89fcc6

data/README.md

@@ -192,12 +192,12 @@ produce some pretty verbose logging of what it's doing.
 
 A less crazy version is ":verbose: true".
 
-It will also create a replay log directory which is intended to be
-viewed in a browser.  The directory location defaults to
-~/public_html/watir_replay/test/ ; the initialization of
-Gless::Logger determines that location.  Most actions that Gless
-performs will cause the replay log to be updated a copy of the HTML
-source as Gless/Watir/Selenium/WebDriver sees it.
+If replay is true in the config file, it will also create a replay
+log directory which is intended to be viewed in a browser.  The
+directory location defaults to ~/public_html/watir_replay/test/ ;
+the initialization of Gless::Logger determines that location.  Most
+actions that Gless performs will cause the replay log to be updated
+a copy of the HTML source as Gless/Watir/Selenium/WebDriver sees it.
 
 If you have ":screenshots: true" (along with debugging), screenshots
 will also be taken showing the visual state of the browser at the

data/examples/test_github/lib/config/development.yml.example

@@ -15,6 +15,9 @@
     # :max_duration: 5400 # Sauce specific
   :verbose: false       # Whether to engage in more verbose/info level logging
   :debug: false	        # Whether to engage in debug logging
+  :replay: false        # Whether to create a replay log, which shows html for each step of operations
+  :replay_path: "%{home}/public_html/watir_replay/%{tag}"
+                        # The path to put the replay logs; should probably be web accessible to be of much use; %{home} is replaced as you would expect
   :screenshots: false   # Whether, if debugging is on, to create screenshots as part of the replay log
   :thumbnails: false	# Whether, if screenshots are on, to create small-ish "thumbnail" pictures on the replay page; requires the imagemagick system package and the mini_magick gem
   :cache: false  # Whether, by default, to cache elements, significantly improving performance.   For individual elements, caching can be disabled by adding ":cache => false" to the element specifier.

data/lib/gless/logger.rb

@@ -40,30 +40,34 @@ module Gless
 
       @ssnum = 0  # For snapshot pictures
 
-      @replay_path=sprintf(replay_path, { :home => ENV['HOME'], :tag => tag, :replay => replay })
-      FileUtils.rm_rf(@replay_path)
-      FileUtils.mkdir(@replay_path)
-
-      replay_log_file = File.open("#{@replay_path}/index.html", "w")
-      @replay_log = ::Logger.new replay_log_file
-
-      #@replay_log.formatter = proc do |severity, datetime, progname, msg|
-      #  # I, [2012-08-14T15:30:10.736784 #14647]  INFO -- : <p>Launching remote browser</p>
-      #  "<p>#{severity[0]}, [#{datetime} #{progname}]: #{severity} -- : #{msg}</p>\n"
-      #end
-
       original_formatter = ::Logger::Formatter.new
 
-      # Add in the tag and html-ify
-      @replay_log.formatter = proc { |severity, datetime, progname, msg|
-        # Can't flush after from here, so flush prior stuff
-        replay_log_file.flush
-        npn = "#{progname} #{tag} ".sub(/^\s*/,'').sub(/\s*$/,'')
-        stuff=original_formatter.call(severity, datetime, "#{progname} #{tag} ", msg)
-        #"<p>#{ERB::Util.html_escape(stuff.chomp)}</p>\n"
-        "<p>#{stuff.chomp}</p>\n"
-      }
-      @replay_log.level = ::Logger::WARN
+      if replay
+        @replay_path=sprintf(replay_path, { :home => ENV['HOME'], :tag => tag, :replay => replay })
+        FileUtils.rm_rf(@replay_path)
+        FileUtils.mkdir(@replay_path)
+
+        replay_log_file = File.open("#{@replay_path}/index.html", "w")
+        @replay_log = ::Logger.new replay_log_file
+
+        #@replay_log.formatter = proc do |severity, datetime, progname, msg|
+        #  # I, [2012-08-14T15:30:10.736784 #14647]  INFO -- : <p>Launching remote browser</p>
+        #  "<p>#{severity[0]}, [#{datetime} #{progname}]: #{severity} -- : #{msg}</p>\n"
+        #end
+
+        # Add in the tag and html-ify
+        @replay_log.formatter = proc { |severity, datetime, progname, msg|
+          # Can't flush after from here, so flush prior stuff
+          replay_log_file.flush
+          npn = "#{progname} #{tag} ".sub(/^\s*/,'').sub(/\s*$/,'')
+          stuff=original_formatter.call(severity, datetime, "#{progname} #{tag} ", msg)
+          #"<p>#{ERB::Util.html_escape(stuff.chomp)}</p>\n"
+          "<p>#{stuff.chomp}</p>\n"
+        }
+        @replay_log.level = ::Logger::WARN
+      else
+        @replay_log = nil
+      end
 
       @normal_log = ::Logger.new(STDOUT)
       # Add in the tag
@@ -77,7 +81,9 @@ module Gless
     # Passes on all the normal Logger methods.  By default, logs to
     # both the normal log and the replay log.
     def method_missing(m, *args, &block)
-      @replay_log.send(m, *args, &block)
+      if @replay_log
+        @replay_log.send(m, *args, &block)
+      end
       @normal_log.send(m, *args, &block)
     end
 
@@ -87,36 +93,38 @@ module Gless
     # @param [Watir::Browser] browser
     # @param [Gless::Session] session
     def add_to_replay_log( browser, session )
-      @ssnum = @ssnum + 1
-
-      if session.get_config :global, :screenshots
-        begin
-          browser.driver.save_screenshot "#{@replay_path}/screenshot_#{@ssnum}.png"
-
-          if session.get_config :global, :thumbnails
-            require 'mini_magick'
-
-            image = MiniMagick::Image.open("#{@replay_path}/screenshot_#{@ssnum}.png")
-            image.resize "400"
-            image.write "#{@replay_path}/screenshot_#{@ssnum}_thumb.png"
-            FileUtils.chmod 0755, "#{@replay_path}/screenshot_#{@ssnum}_thumb.png"
-
-            @replay_log.debug "Screenshot: <a href='screenshot_#{@ssnum}.png'><img src='screenshot_#{@ssnum}_thumb.png' /></a>"
-          else
-            @replay_log.debug "Screenshot: <a href='screenshot_#{@ssnum}.png'>Screenshot</a>"
+      if @replay_log
+        @ssnum = @ssnum + 1
+
+        if session.get_config :global, :screenshots
+          begin
+            browser.driver.save_screenshot "#{@replay_path}/screenshot_#{@ssnum}.png"
+
+            if session.get_config :global, :thumbnails
+              require 'mini_magick'
+
+              image = MiniMagick::Image.open("#{@replay_path}/screenshot_#{@ssnum}.png")
+              image.resize "400"
+              image.write "#{@replay_path}/screenshot_#{@ssnum}_thumb.png"
+              FileUtils.chmod 0755, "#{@replay_path}/screenshot_#{@ssnum}_thumb.png"
+
+              @replay_log.debug "Screenshot: <a href='screenshot_#{@ssnum}.png'><img src='screenshot_#{@ssnum}_thumb.png' /></a>"
+            else
+              @replay_log.debug "Screenshot: <a href='screenshot_#{@ssnum}.png'>Screenshot</a>"
+            end
+          rescue Exception => e
+            @normal_log.warn "Screenshot failed with exception #{e}"
           end
-        rescue Exception => e
-          @normal_log.warn "Screenshot failed with exception #{e}"
         end
-      end
 
-      html=browser.html
-      htmlFile = File.new("#{@replay_path}/html_capture_#{@ssnum}.txt", "w")
-      htmlFile.write(html)
-      htmlFile.close
+        html=browser.html
+        htmlFile = File.new("#{@replay_path}/html_capture_#{@ssnum}.txt", "w")
+        htmlFile.write(html)
+        htmlFile.close
 
-      @replay_log.debug "<a href='html_capture_#{@ssnum}.txt'>HTML Source</a>"
-      @replay_log.debug "Force flush"
+        @replay_log.debug "<a href='html_capture_#{@ssnum}.txt'>HTML Source</a>"
+        @replay_log.debug "Force flush"
+      end
     end
   end
 end

data/lib/gless/wrap_watir.rb

@@ -380,7 +380,7 @@ module Gless
       if trimmed_selectors.inspect =~ /password/i
         @session.log.debug "WrapWatir: Doing something with passwords, redacted."
       else
-        if @session.get_config :global, :debug
+        if @session.get_config :global, :replay
           @session.log.add_to_replay_log( @browser, @session )
         end
 

data/lib/gless.rb

@@ -6,7 +6,7 @@
 # project.
 module Gless
   # The current version number.
-  VERSION = '1.5.2'
+  VERSION = '1.6'
 
   # Sets up the config, logger and browser instances, the ordering
   # of which is slightly tricky.  If a block is given, the config, after being
@@ -26,12 +26,16 @@ module Gless
   #
   # @return [Gless::Logger, Gless::EnvConfig, Gless::Browser] logger, config, browser (in that order)
   def self.setup( tag, hash = nil )
-    logger = Gless::Logger.new( tag )
-
     # Create the config reading/storage object
     config = Gless::EnvConfig.new( hash )
     config = yield config if block_given?
 
+    logger = Gless::Logger.new(
+      tag,
+      config.get_default( false, :global, :replay ),
+      config.get_default( '%{home}/public_html/watir_replay/%{tag}', :global, :replay_path )
+    )
+
     # Get the whole backtrace, please.
     if config.get :global, :debug
       ::Cucumber.use_full_backtrace = true
@@ -46,14 +50,18 @@ module Gless
     # Turn on verbose (info) level logging.
     if config.get :global, :verbose
       logger.normal_log.level = ::Logger::INFO
-      logger.replay_log.level = ::Logger::INFO
+      if logger.replay_log
+        logger.replay_log.level = ::Logger::INFO
+      end
       logger.debug "Verbose/info level logging enabled."
     end
 
     # Turn on debug level logging.
     if config.get :global, :debug
       logger.normal_log.level = ::Logger::DEBUG
-      logger.replay_log.level = ::Logger::DEBUG
+      if logger.replay_log
+        logger.replay_log.level = ::Logger::DEBUG
+      end
       logger.debug "Debug level logging enabled."
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gless
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: '1.6'
 platform: ruby
 authors:
 - Robin Lee Powell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec