waterpig 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e28d950091067eb55145f9a2a031cc9ccd2aa41
-  data.tar.gz: bd5e3b73c0eb55fa931b56a779f33a0729b113f0
+  metadata.gz: 2302e9b10ed3f0a42d946396094cf816e4232996
+  data.tar.gz: f4865aa1135e03154302b85d905d66d15bc22c64
 SHA512:
-  metadata.gz: 88cc48ee51e663dbd01ac906b9db6ab19461cb6c39ea7670be1cbf2e990b33730689b9972856ec5fa121bd9c212be8c29ae338b80e72ab6befdc661366fc0817
-  data.tar.gz: 29ea658e3a49c190a40e5e8327b87b87be8f462b344716a31c721cfb831165e2b01c27ad629161bcba6e2c9b71132861b398c5ea2f031b821dbe5e1a2371fa56
+  metadata.gz: 14ffed5cfb8bdf24a35e61a417b9a973604b15cc07a1a12519485e30f69c185eb265e82632732f3af483c6c59875651a265da229d4602908c07d883acc60e472
+  data.tar.gz: 78cfec302ed71689e329584dd0144e1bd4a055bc4b20a1fc118df966a3fb58e05716c8fab29bac8d757717a555a32ece1b74d46a84ef43c464c38f0a236fbcee

data/lib/waterpig/browser-console-logger.rb

@@ -0,0 +1,120 @@
+require 'singleton'
+module Waterpig
+  class BrowserConsoleLogger
+    include Singleton
+
+    require 'text-table'
+    attr_writer :file
+    attr_accessor :path
+
+    def file
+      @file ||= File.new(path, "w")
+    end
+
+    def emit_header(string)
+      file.write("#{bold(string)}\n")
+    end
+
+    def emit_log(entry)
+      file.write( entry['time'] + "\n")
+      if entry['type'] == 'table'
+        emit_table(entry['value'])
+      else
+        file.write(entry['value'].to_s + "\n\n")
+      end
+    end
+
+    # Tables are either a simple hash, or a hash of hashes.  See documentation
+    # on emit_simple_table and emit_complex_table.
+    def emit_table(hash)
+      table      = Text::Table.new
+      if hash.values.any?{ |val| val.is_a?(Hash) }
+        emit_complex_table(hash, table)
+      else
+        emit_simple_table(hash, table)
+      end
+      @file.write(table.to_s + "\n\n")
+    end
+
+    # Simple hashes emit as a two-column table, with keys making up the index
+    # column:
+    #   { a: 1, b: 4, c: 'foo'}
+    #
+    # Will render as:
+    #
+    #  +-------+--------+
+    #  | index | Values |
+    #  +-------+--------+
+    #  |   a   |   1    |
+    #  +-------+--------+
+    #  |   b   |   4    |
+    #  +-------+--------+
+    #  |   c   | 'foo'  |
+    #  +-------+--------+
+    def emit_simple_table(hash, table)
+      table.head = [ "index", "values" ]
+      hash.each do | key, val |
+        table.rows << [ key, val ]
+      end
+    end
+
+    # When they are a hash of hashes, used as follows:
+    #  * The keys of the top-level hashes will be the leftmost column, "index".
+    #  * The merged keys of the inner hashes will be the column headers
+    #  * The values of the inner hashes will fill the table cells.
+    #
+    #  So for example:
+    #    { foo: { a: 1, b: 2 },
+    #      bar: { a: 5, c: 3 }}
+    #
+    #  Will render as:
+    #  +-------+---+---+---+
+    #  | index | a | b | c |
+    #  +-------+---+---+---+
+    #  |  foo  | 1 | 2 |   |
+    #  +-------+---+---+---+
+    #  |  bar  | 5 |   | 3 |
+    #  +-------+---+---+---+
+    def emit_complex_table(hash, table)
+      keys = hash.reduce([]){ |memo, arr| memo + arr[1].keys }.uniq
+      table.head = [ "index" ] + keys
+      hash.each do |name, row|
+        table.rows << [ name ] + keys.map{ |key| row.fetch(key, nil)}
+      end
+    end
+
+    def bold(string)
+      "\e[1m#{string}\e[0m"
+    end
+
+    class << self
+      def configure(config)
+        config.add_setting :waterpig_browser_console_log_path, :default => nil
+        config.add_setting :waterpig_log_browser_console, :default => ENV['LOG_BROWSER_CONSOLE']
+
+        config.before(:suite) do
+          if config.waterpig_log_browser_console
+            config.waterpig_browser_console_log_path ||=  Rails.root.join("log/#{Rails.env}_browser_console.log")
+            config.waterpig_clearable_logs << 'test_browser_console'
+          end
+        end
+
+        config.after(:each,:type => proc{|value|
+          config.waterpig_log_types && config.waterpig_log_types.include?(value)
+        }) do |example|
+          if config.waterpig_log_browser_console
+            logger = Waterpig::BrowserConsoleLogger.instance
+            logger.path = config.waterpig_browser_console_log_path
+            logger.emit_header "Browser console for #{example.full_description}"
+            console_entries = page.evaluate_script("console.history");
+            console_entries.each do |entry|
+              logger.emit_log(entry)
+            end
+          end
+        end
+      end
+    end
+  end
+
+
+end

data/lib/waterpig/browser-integration.rb

@@ -10,6 +10,7 @@ require 'waterpig/ckeditor-tools'
 require 'waterpig/tinymce-tools'
 require 'waterpig/browser-tools'
 require 'waterpig/browser-size'
+require 'waterpig/browser-console-logger'
 require 'waterpig/snap-step'
 
 module Waterpig
@@ -56,6 +57,7 @@ RSpec.configure do |config|
   config.add_setting :waterpig_autosnap, :default => ENV['WATERPIG_AUTOSNAP']
   config.add_setting :waterpig_driver, :default => ENV['CAPYBARA_DRIVER']
   config.add_setting :waterpig_js_driver, :default => ENV['CAPYBARA_JS_DRIVER']
+  config.add_setting :waterpig_clearable_logs, :default => [ 'test' ]
 
   config.add_setting :waterpig_browser_sizes, :default => {
     :mobile  => { :width => 320, :height => 480 },
@@ -64,10 +66,18 @@ RSpec.configure do |config|
     :desktop => { :width => 1024, :height => 1024 }
   }
 
+  Waterpig::BrowserConsoleLogger.configure(config)
 
   config.before(:suite) do
     Capybara.default_driver = Waterpig.pick_capybara_driver(config.waterpig_driver)
     Capybara.javascript_driver = Waterpig.pick_capybara_driver(config.waterpig_js_driver)
+    config.waterpig_clearable_logs.each do |logfile|
+      if File.directory?('log')
+        File::open("log/#{logfile}.log", "w") do |log|
+          log.write ""
+        end
+      end
+    end
   end
 
   if defined?(Timecop)
@@ -87,6 +97,7 @@ RSpec.configure do |config|
   config.include Waterpig::BrowserSize, :type => proc{|value|
     config.waterpig_browser_size_types && config.waterpig_browser_size_types.include?(value)
   }
+
 end
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: waterpig
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Judson Lester
+- Evan Dorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-31 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -52,10 +53,25 @@ dependencies:
     - - '>'
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: text-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 description: |2
     Because waterpig is what the scientific name for a capybara translates to, that's why.
 email:
 - nyarly@gmail.com
+- evan@lrdesign.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -68,6 +84,7 @@ files:
 - lib/waterpig/deadbeat-connections.rb
 - lib/waterpig/tinymce-tools.rb
 - lib/waterpig/browser-integration.rb
+- lib/waterpig/browser-console-logger.rb
 - lib/waterpig/poltergeist.rb
 - lib/waterpig/warning-suppressor.rb
 - lib/waterpig/snap-step.rb
@@ -86,7 +103,7 @@ rdoc_options:
 - --main
 - doc/README
 - --title
-- waterpig-0.5.0 Documentation
+- waterpig-0.6.0 Documentation
 require_paths:
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement