webconsole 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fcc746a3b332008cbc7f7767e5c7879b968b639
-  data.tar.gz: d2debc54d64a67a3555db9164e012f2e2d59a883
+  metadata.gz: 9e712ea11ce5791366f105b2d18844411e518eed
+  data.tar.gz: fc922fee0c1caaf3311852407dd88df9a10773a7
 SHA512:
-  metadata.gz: 2e195df3b04bdff44650930f4e1e00ea1cb4839dde2e771d1ce1e482b5c6a0f31e9917cfcc9395bcdfdf97148be98310534b21fc8c65fe4ca2ee622106d4b5b6
-  data.tar.gz: c18edf9c671929b543e95171fc6b683eea64a19990a7bab4afd74b2b5d61b441d779099bcd003fad7e720c3b8c2e582bfc66acb9a49f2c8fdbc9bb33c3ea6ccb
+  metadata.gz: 4e5b661a9a07b2bf07000d4dcf56688c87b94e64483e8149400ed7bc49a1d4cc50511ca225e7e6d5daa89ee088272ca31236a3461a1552e4b5b6bef7c75843b4
+  data.tar.gz: 6954f172fc4e463f0f135edd94cabed2cd9783d2d7a7602acb9f9a298e176abbadab9fddd41ba6db4f74882649548b0fd1e4b066c4f1f75062fdd912b4df7928

data/lib/webconsole.rb

@@ -3,7 +3,6 @@ module WebConsole
   require_relative "webconsole/lib/window"
   require_relative "webconsole/lib/controller"
   require_relative "webconsole/lib/view"
-  require_relative "webconsole/lib/logger"
   require_relative "webconsole/lib/module"
 end
 

data/lib/webconsole/lib/module.rb

@@ -29,6 +29,14 @@ module WebConsole
     result.chomp!
     return result
   end
+  
+  RUN_PLUGIN_IN_SPLIT_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "run_plugin_in_split.scpt")
+  def self.run_plugin_in_split(name, window_id, split_id)
+    parameters = [name, window_id, split_id]
+    result = self.run_applescript(RUN_PLUGIN_IN_SPLIT_SCRIPT, parameters)
+    result.chomp!
+    return result
+  end
 
   PLUGIN_HAS_WINDOWS_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "plugin_has_windows.scpt")
   def self.plugin_has_windows(name)
@@ -48,6 +56,33 @@ module WebConsole
     return result
   end
 
+  SPLIT_ID_IN_WINDOW_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "split_id_in_window.scpt")
+  def self.split_id_in_window(window_id, pluginName = nil)
+    arguments = [window_id]
+
+    if pluginName
+      arguments.push(pluginName)
+    end
+
+    result = self.run_applescript(SPLIT_ID_IN_WINDOW_SCRIPT, arguments)
+    result.chomp!
+
+    if result.empty?
+      # TODO: Remove this when doing `run_applescript` refactor
+      return nil
+    end
+
+    return result
+  end
+
+  SPLIT_ID_IN_WINDOW_LAST_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "split_id_in_window_last.scpt")
+  def self.split_id_in_window_last(window_id)
+    arguments = [window_id]
+    result = self.run_applescript(SPLIT_ID_IN_WINDOW_LAST_SCRIPT, arguments)
+    result.chomp!
+    return result
+  end
+
   CREATE_WINDOW_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "create_window.scpt")
   def self.create_window
     result = self.run_applescript(CREATE_WINDOW_SCRIPT)
@@ -106,6 +141,14 @@ module WebConsole
         end
       }
     end
-    return `#{command}`
+
+    result = `#{command}`
+
+    # TODO: Figure out a better way to do this when doing `run_applescript` refactor
+    # if result.chomp.empty?
+    #   return nil
+    # end
+
+    return result
   end
 end

data/lib/webconsole/lib/view.rb

@@ -7,6 +7,10 @@ module WebConsole
   class View < Window
 
     # Properties
+    def initialize(window_id = nil, view_id = nil)
+      super(window_id)
+      @view_id = view_id
+    end
 
     def view_id
       if !@view_id

data/lib/webconsole/lib/window.rb

@@ -60,16 +60,8 @@ module WebConsole
     end
 
     SPLIT_ID_IN_WINDOW_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "split_id_in_window.scpt")
-    def split_id(pluginName = nil)
-      arguments = [window_id]
-
-      if pluginName
-        arguments.push(pluginName)
-      end
-
-      result = WebConsole::run_applescript(SPLIT_ID_IN_WINDOW_SCRIPT, arguments)
-      result.chomp!
-      return result
+    def split_id
+      return WebConsole::split_id_in_window(window_id)
     end
 
     private

data/lib/webconsole/logger.rb

@@ -0,0 +1,83 @@
+require_relative 'extension_constants'
+require WEBCONSOLE_FILE
+
+module WebConsole
+
+  class Logger
+    MESSAGE_PREFIX = 'MESSAGE '
+    ERROR_PREFIX = 'ERROR '
+    LOG_PLUGIN_NAME = 'Log'
+
+    # Toggle
+
+    SHOW_LOG_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "show_log.scpt")
+    def show
+      WebConsole::run_applescript(SHOW_LOG_SCRIPT, [window_id])
+    end
+    
+    HIDE_LOG_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "hide_log.scpt")
+    def hide
+      WebConsole::run_applescript(HIDE_LOG_SCRIPT, [window_id])
+    end
+    
+    TOGGLE_LOG_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "toggle_log.scpt")
+    def toggle
+      WebConsole::run_applescript(TOGGLE_LOG_SCRIPT, [window_id])
+    end
+
+    # Messages
+
+    def info(message)
+      message = message.dup
+      message.gsub!(%r{^}, MESSAGE_PREFIX) # Prefix all lines
+      # Strip trailing white space
+      # Add a line break
+      log_message(message)
+    end
+
+    def error(message)
+      message = message.dup
+      message.gsub!(%r{^}, ERROR_PREFIX)
+      log_message(message)
+    end
+
+    # Properties
+
+    def window_id
+      if !@window_id
+        if ENV.has_key?(WINDOW_ID_KEY)
+          @window_id = ENV[WINDOW_ID_KEY]
+        else
+          @window_id = WebConsole::create_window
+        end
+      end
+      return @window_id
+    end
+  
+    def view_id
+      if !@view_id
+        # First see if there's an existing log plugin
+        @view_id = WebConsole::split_id_in_window(window_id, LOG_PLUGIN_NAME)
+
+        # If not, run one
+        if !@view_id
+          @view_id = WebConsole::split_id_in_window_last(window_id)
+          WebConsole::run_plugin_in_split(LOG_PLUGIN_NAME, window_id, @view_id)
+        end
+
+      end
+
+      return @view_id
+    end
+
+    private
+
+    READ_FROM_STANDARD_INPUT_SCRIPT = File.join(APPLESCRIPT_DIRECTORY, "read_from_standard_input.scpt")  
+    def log_message(message)
+      message.rstrip!
+      message += "\n"
+      WebConsole::run_applescript(READ_FROM_STANDARD_INPUT_SCRIPT, [message, window_id, view_id])
+    end
+  
+  end
+end

data/lib/webconsole/logger/test/Rakefile

@@ -0,0 +1,20 @@
+require 'shellwords'
+require 'webconsole'
+require WebConsole::shared_test_resource("ruby/test_constants")
+require WebConsole::Tests::TEST_HELPER_FILE
+
+task :default => ['logger:tests']
+
+namespace :logger do
+  
+  task :tests => [:clean_up]
+
+  task :test_logger do
+    logger_tests_file = File.join(File.dirname(__FILE__), "tc_logger.rb")
+    ruby Shellwords.escape(logger_tests_file)
+  end
+
+  task :clean_up => [:test_logger] do
+    WebConsole::Tests::Helper::quit
+  end
+end

data/lib/webconsole/logger/test/js/test_view_helper.js

@@ -0,0 +1,3 @@
+function innerTextOfBodyChildAtIndex(index) {
+  return document.body.children[index].innerText;
+}

data/lib/webconsole/logger/test/lib/test_constants.rb

@@ -0,0 +1,8 @@
+require_relative "../../../extension_constants"
+
+TEST_CLASS_JAVASCRIPT = "document.body.lastChild.classList[0]"
+TEST_MESSAGE_JAVASCRIPT = "document.body.lastChild.innerText"
+TEST_MESSAGE_COUNT_JAVASCRIPT = "document.body.children.length"
+
+TEST_JAVASCRIPT_DIRECTORY = File.join(File.dirname(__FILE__), "..", "js")
+TEST_JAVASCRIPT_FILE = File.join(TEST_JAVASCRIPT_DIRECTORY, "test_view_helper.js")

data/lib/webconsole/logger/test/lib/test_view_helper.rb

@@ -0,0 +1,28 @@
+require_relative 'test_constants'
+
+class TestViewHelper
+
+    def initialize(window_id, view_id)
+      @view = WebConsole::View.new(window_id, view_id)
+      javascript = File.read(TEST_JAVASCRIPT_FILE)
+      @view.do_javascript(javascript)
+    end
+
+    def log_message_at_index(index)
+      return @view.do_javascript_function('innerTextOfBodyChildAtIndex', [index])
+    end
+
+    def number_of_log_messages
+      # TODO: Do JavaScript should coerce types
+      return @view.do_javascript(TEST_MESSAGE_COUNT_JAVASCRIPT).chomp.to_i
+    end
+
+    def last_log_message
+      return @view.do_javascript(TEST_MESSAGE_JAVASCRIPT).chomp
+    end
+  
+    def last_log_class
+      return @view.do_javascript(TEST_CLASS_JAVASCRIPT).chomp
+    end
+
+end

data/lib/webconsole/logger/test/run_tests.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+rake

data/lib/webconsole/logger/test/tc_logger.rb

@@ -0,0 +1,175 @@
+#!/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/bin/ruby
+
+require "test/unit"
+
+require_relative "lib/test_constants"
+require WEBCONSOLE_FILE
+require WebConsole::shared_test_resource("ruby/test_constants")
+require WebConsole::Tests::TEST_HELPER_FILE
+
+require_relative "lib/test_view_helper"
+require_relative "../../logger"
+
+
+class TestConstants < Test::Unit::TestCase
+
+  def test_constants
+    message_prefix = WebConsole::Logger::MESSAGE_PREFIX
+    assert_not_nil(message_prefix, "The message prefix should not be nil.")
+    error_prefix = WebConsole::Logger::ERROR_PREFIX
+    assert_not_nil(message_prefix, "The error prefix should not be nil.")
+  end
+
+end
+
+
+class TestUnintializedLogger < Test::Unit::TestCase
+
+  def teardown
+    WebConsole::Tests::Helper::quit
+    WebConsole::Tests::Helper::confirm_dialog
+    assert(!WebConsole::Tests::Helper::is_running, "The application should not be running.")
+  end
+
+  def test_uninitialized_logger
+    logger = WebConsole::Logger.new
+
+    # Test Message
+    message = "Testing log message"
+    logger.info(message)
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+
+    # Make sure the log messages before accessing the logger's `view_id` and `window_id` because those run the logger.
+    # This test should test logging a message and running the logger itself simultaneously.
+    # This is why the `TestViewHelper` is intialized after logging the message.
+    test_view_helper = TestViewHelper.new(logger.window_id, logger.view_id)
+
+    test_message = test_view_helper.last_log_message
+    assert_equal(message, test_message, "The messages should match")
+    test_class = test_view_helper.last_log_class
+    assert_equal("message", test_class, "The classes should match")
+
+  end
+
+end
+
+
+class TestLogger < Test::Unit::TestCase
+
+  def setup
+    @logger = WebConsole::Logger.new
+    @logger.show
+    @test_view_helper = TestViewHelper.new(@logger.window_id, @logger.view_id)
+  end
+
+  def teardown
+    WebConsole::Tests::Helper::quit
+    WebConsole::Tests::Helper::confirm_dialog
+    assert(!WebConsole::Tests::Helper::is_running, "The application should not be running.")
+  end
+
+  def test_logger
+    test_count = 0
+
+    # Test Error
+    message = "Testing log error"
+    @logger.error(message)
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    test_message = @test_view_helper.last_log_message
+    assert_equal(message, test_message, "The messages should match")
+    test_class = @test_view_helper.last_log_class
+    assert_equal("error", test_class, "The classes should match")
+    result_count = @test_view_helper.number_of_log_messages
+    test_count += 1
+    assert_equal(test_count, result_count, "The number of log messages should match")
+
+    # Test Message
+    message = "Testing log message"
+    @logger.info(message)
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    test_message = @test_view_helper.last_log_message
+    assert_equal(message, test_message, "The messages should match")
+    test_class = @test_view_helper.last_log_class
+    assert_equal("message", test_class, "The classes should match")
+    result_count = @test_view_helper.number_of_log_messages
+    test_count += 1
+    assert_equal(test_count, result_count, "The number of log messages should match")
+
+    # Test Only Error Prefix
+    message = WebConsole::Logger::ERROR_PREFIX.rstrip # Note the trailing whitespace is trimmed
+    @logger.info(message)
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    test_message = @test_view_helper.last_log_message
+    assert_equal(message, test_message, "The messages should match")
+    test_class = @test_view_helper.last_log_class
+    assert_equal("message", test_class, "The classes should match")
+    result_count = @test_view_helper.number_of_log_messages
+    test_count += 1
+    assert_equal(test_count, result_count, "The number of log messages should match")
+
+    # Test Only Message Prefix
+    message = WebConsole::Logger::MESSAGE_PREFIX.rstrip # Note the trailing whitespace is trimmed
+    @logger.info(message)
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    test_message = @test_view_helper.last_log_message
+    assert_equal(message, test_message, "The messages should match")
+    test_class = @test_view_helper.last_log_class
+    assert_equal("message", test_class, "The classes should match")
+    result_count = @test_view_helper.number_of_log_messages
+    test_count += 1
+    assert_equal(test_count, result_count, "The number of log messages should match")
+
+    # Test Blank Spaces
+    @logger.info("  \t")
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    test_message = @test_view_helper.last_log_message()
+    assert_equal(message, test_message, "The messages should match")
+    test_class = @test_view_helper.last_log_class()
+    assert_equal("message", test_class, "The classes should match")
+
+    # Test Empty String
+    @logger.info("")
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    test_message = @test_view_helper.last_log_message()
+    assert_equal(message, test_message, "The messages should match")
+    test_class = @test_view_helper.last_log_class()
+    assert_equal("message", test_class, "The classes should match")
+
+    # TODO: Also add the following tests the `Log.wcplugin`
+
+    # Test Whitespace
+    # White space to the left should be preserved, whitespace to the right should be removed
+    # This test fails because retrieving the `innerText` doesn't preserve whitepace.
+
+    # message = "\t Testing log message"
+    # @logger.info(message + "\t ")
+    # sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    # test_message = @test_view_helper.last_log_message
+    # assert_equal(message, test_message, "The messages should match")
+    # test_class = @test_view_helper.last_log_class
+    # assert_equal("message", test_class, "The classes should match")
+    # result_count = @test_view_helper.number_of_log_messages
+    # test_count += 1
+    # assert_equal(test_count, result_count, "The number of log messages should match")
+  end
+
+  def test_long_input
+    message = %q(
+Line 1
+
+Line 2
+Line 3
+)
+    @logger.info(message)
+    sleep WebConsole::Tests::TEST_PAUSE_TIME # Pause for output to be processed
+    result_count = @test_view_helper.number_of_log_messages
+    assert_equal(result_count, 3, "The number of log messages should match")    
+
+    (1..3).each { |i|
+      result = @test_view_helper.log_message_at_index(i - 1)
+      test_result = "Line #{i}"
+      assert_equal(result, test_result, "The number of log messages should match")    
+    }
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webconsole
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Roben Kleene
@@ -20,6 +20,7 @@ files:
 - lib/applescript/create_window.scpt
 - lib/applescript/do_javascript.scpt
 - lib/applescript/exists.scpt
+- lib/applescript/hide_log.scpt
 - lib/applescript/load_html.scpt
 - lib/applescript/load_html_with_base_url.scpt
 - lib/applescript/load_plugin.scpt
@@ -29,10 +30,11 @@ files:
 - lib/applescript/resource_url_for_plugin.scpt
 - lib/applescript/run_plugin.scpt
 - lib/applescript/run_plugin_in_split.scpt
+- lib/applescript/show_log.scpt
 - lib/applescript/split_id_in_window.scpt
+- lib/applescript/split_id_in_window_last.scpt
+- lib/applescript/toggle_log.scpt
 - lib/applescript/window_id_for_plugin.scpt
-- lib/webconsole.rb
-- lib/webconsole/dependencies.rb
 - lib/webconsole/dependencies/css/style.css
 - lib/webconsole/dependencies/js/wcdependencies.js
 - lib/webconsole/dependencies/lib/controller.rb
@@ -40,23 +42,31 @@ files:
 - lib/webconsole/dependencies/lib/tester.rb
 - lib/webconsole/dependencies/lib/view.rb
 - lib/webconsole/dependencies/views/view.html.erb
+- lib/webconsole/dependencies.rb
 - lib/webconsole/extension_constants.rb
 - lib/webconsole/lib/constants.rb
 - lib/webconsole/lib/controller.rb
-- lib/webconsole/lib/logger.rb
 - lib/webconsole/lib/module.rb
-- lib/webconsole/lib/view.rb
 - lib/webconsole/lib/view/erb.rb
 - lib/webconsole/lib/view/javascript.rb
 - lib/webconsole/lib/view/resources.rb
+- lib/webconsole/lib/view.rb
 - lib/webconsole/lib/window.rb
-- lib/webconsole/repl.rb
+- lib/webconsole/logger/test/js/test_view_helper.js
+- lib/webconsole/logger/test/lib/test_constants.rb
+- lib/webconsole/logger/test/lib/test_view_helper.rb
+- lib/webconsole/logger/test/Rakefile
+- lib/webconsole/logger/test/run_tests.sh
+- lib/webconsole/logger/test/tc_logger.rb
+- lib/webconsole/logger.rb
 - lib/webconsole/repl/css/style.css
 - lib/webconsole/repl/js/wcrepl.js
 - lib/webconsole/repl/lib/input_controller.rb
 - lib/webconsole/repl/lib/output_controller.rb
 - lib/webconsole/repl/lib/view.rb
 - lib/webconsole/repl/view/view.html.erb
+- lib/webconsole/repl.rb
+- lib/webconsole.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -66,17 +76,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ~>
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Web Console helper gem

data/lib/webconsole/lib/logger.rb

@@ -1,19 +0,0 @@
-
-
-module WebConsole
-
-  class Logger < View
-    MESSAGE_PREFIX = 'MESSAGE '
-    ERROR_PREFIX = 'ERROR '
-
-    def info(message)
-    end
-
-    def warning(message)
-    end
-
-    def error(message)
-    end
-  end
-
-end