cohitre-caculo 0.0.4

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-16
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Carlos Rodriguez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+lib/caculo.rb
+lib/caculo/version.rb
+lib/caculo/firefox.rb
+lib/caculo/internet_explorer.rb
+lib/caculo/javascript.rb
+lib/caculo/jquery.rb
+lib/caculo/safari.rb
+lib/caculo/unit.rb
+lib/caculo/version.rb

data/README.txt

@@ -0,0 +1,72 @@
+= caculo
+
+* http://caculo.cohitre.com
+
+
+== The Succinct Summary:
+
+Caculo lets you simulate interaction with a browser via Ruby. It has the option to load a Javascript Library and call Javascript functions on the document. This allows for simple code that takes advantage of exisiting libraries.
+
+Caculo is inspired by the Watir/FireWatir/SafariWatir trio, However, by simplifying the way of communicating with the browser it tries to offer an integrated cross-browser solution. It also extends the Test/Unit framework to provide some abbreviations to common functions.
+
+
+== The Polite Apology
+
+I haven't really tested Caculo outside of my computer, so things may not work as expected out of the box. 
+
+== The Descriptive Example:
+
+   browser = Caculo.open :safari
+   browser.libraries = [:jquery]
+
+   browser.visit( 'http://google.com' )
+
+   browser["input[@name='q']"].val! 'cohitre'
+   browser["form[@name='f']"].submit!
+
+   browser.wait
+   browser.load_libraries
+
+   browser.visit browser['#res .g:eq(1) h2.r a'].attr('href').execute
+
+
+== The Required Requirements
+
+For testing in Firefox you will need the JSSh plugin. After the plugin has been installed and turned on, you need to call firefox with:
+
+$ firefox -jssh
+
+For testing in Safari you will need rbosa. It is available through rubygems, so it should be enough to write:
+
+$ sudo gem install rubyosa
+
+
+== The Daunting Installation:
+
+$ gem install caculo
+
+
+== The Permissive License
+
+(The MIT License)
+
+Copyright (c) 2008 Carlos Rodriguez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/caculo.rb

@@ -0,0 +1,145 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+require "#{File.dirname(__FILE__)}/caculo/jquery"
+require "#{File.dirname(__FILE__)}/caculo/unit"
+require "#{File.dirname(__FILE__)}/caculo/javascript"
+require 'open-uri'
+
+module Caculo
+  class Browser
+    attr_reader :libraries
+       
+    # Creates a new browser window instance.
+    def self.open name
+      if ( name.to_s == 'firefox' )
+        require "#{File.dirname(__FILE__)}/caculo/firefox"
+        return Firefox.new
+      elsif ( name.to_s == 'safari')
+        require "#{File.dirname(__FILE__)}/caculo/safari"
+        return Safari.new
+      elsif ( name.to_s == 'explorer')
+        require "#{File.dirname(__FILE__)}/caculo/internet_explorer"
+        return InternetExplorer.new
+      end
+    end
+    
+    def initialize
+      @libraries = []
+      self.use( "#{File.dirname(__FILE__)}/assets/jquery-1.2.3.min.js" )
+    end
+    
+    def use library
+      @libraries.push( open( library ).read )
+    end
+    
+    def << script
+      self.send_command( script )
+    end
+    
+    def script cmd
+      c = %Q[
+        ( function() {
+            var doc = window.document;
+            var s = doc.createElement("script");
+            s.appendChild( doc.createTextNode( #{cmd.to_js} ) );
+            doc.body.appendChild( s );
+         } )()]
+      send_command( c )      
+    end
+
+    def load_libraries!
+      @libraries.each { |l| self.script(l) }
+    end
+
+    def [] selector=nil
+      if selector.nil?
+        self << JQueryObject.new()
+      elsif selector.is_a? String
+        self << JQueryObject.new( selector )
+      elsif selector.is_a? JQueryObject
+        self << selector
+      end
+    end
+
+    def visit url
+      if ( url.is_a? JQueryObject )
+        url = self << url
+      end
+      self << "window.document.location.href = #{url.to_js}" 
+
+      self.wait_until {|p| p.page_loaded? }
+      load_libraries!
+      url
+    end
+    
+    def interval secs=0 , &block
+      if block_given?
+        block_result = yield self
+        self << "window.setInterval( function(){ #{block_result}} , #{secs*1000} );"
+      end      
+    end
+
+    def timeout secs=0 , &block
+      if block_given?
+        block_result = yield self
+        self << "window.setTimeout( function(){ #{block_result}} , #{secs*1000} );"
+      end
+    end
+
+    def wait_until num=nil , &block
+      if num.nil? &&  block_given?      
+        sleep 0.2
+        sleep 0.2 while( !yield self )
+      elsif num.nil? && block_given?
+        sleep num
+        sleep 0.2 while( !yield self )
+      elsif !num.nil?      
+        
+      end
+    end
+        
+    def error message
+      jQuery("div#caculo-results ul").append( jQuery( "<li />" ).addClass("error").text( message ) )
+    end
+
+    def close
+      send_command( "window.close()")
+    end
+
+    def pathname
+      send_command( "window.location.pathname")
+    end
+
+    def back
+      send_command("window.history.back()")
+    end
+
+    def forward
+      send_command("window.history.forward()")
+    end
+
+    def close
+      send_command("window.close()")
+    end
+  end
+end
+
+class String
+  def to_js
+    "'" + escape_javascript( self ) + "'"
+  end
+end
+
+def escape_javascript(javascript)
+  (javascript || '').gsub('\\','\0\0').gsub('</','<\/').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
+end
+
+def jQuery selector=nil
+  return Caculo::JQueryObject.new( selector )
+end
+
+def js_function( body , params=[] )
+  return "function(#{params.join(' , ')}){ #{body} }"
+end

data/lib/caculo/firefox.rb

@@ -0,0 +1,40 @@
+require 'net/telnet'
+
+module Caculo
+  class Firefox < Browser
+
+    def initialize
+      super
+      @telnet = Net::Telnet::new("Host" => "localhost","Port" => 9997, 
+          "Prompt" => /[$%#>] /n)
+      10.times { socket_send "\n" }
+      socket_send 'window = getWindows()[getWindows().length-1].getBrowser().contentWindow.window'
+      socket_send( "window.location = 'about:blank'" )
+      wait_until { page_loaded? }
+    end
+
+    def send_command cmd
+      socket_send( cmd )
+    end
+    
+    def page_loaded?
+      result = socket_send( "#{browser}.webProgress.isLoadingDocument" )
+      return result =~ /false/
+    end
+
+    private
+    
+    def browser
+      "getWindows()[getWindows().length-1].getBrowser()"      
+    end
+
+    def window
+      browser+".contentWindow"
+    end    
+    
+    def socket_send cmd  
+      @telnet.cmd( " " )
+      @telnet.cmd( cmd.to_s ).gsub( /\n> $/,"" )
+    end
+  end
+end

data/lib/caculo/internet_explorer.rb

@@ -0,0 +1,47 @@
+require 'win32ole'
+
+module Caculo
+  class InternetExplorer < Browser
+
+    def initialize
+      @ie = WIN32OLE.new('InternetExplorer.Application')
+      @ie.visible = true
+    end
+
+    def read
+      @ie.Document.parentWindow.caculoResult;
+    end
+
+    def send_command cmd
+      @ie.Document.parentWindow.execScript( "window.caculoResult = ''");
+      @ie.Document.parentWindow.execScript( "window.caculoResult = #{cmd};\n")
+      read
+    end
+
+    def location= url
+      sleep 0.2
+      @ie.navigate( url )
+    end
+
+    def location
+      @ie.locationURL
+    end
+
+    def page_loaded?
+      !@ie.Busy
+    end
+
+    def current_window
+      "window"
+    end
+
+    def back
+      @ie.goback
+    end
+
+    def forward
+      @ie.goforward
+    end
+
+  end
+end

data/lib/caculo/javascript.rb

@@ -0,0 +1,56 @@
+module Caculo
+  class JavascriptObject
+    attr_accessor :javascript
+
+    def initialize connection , name
+      @connection = connection
+      @javascript = "#{connection.caculo_object}.#{name}"
+    end
+
+    def val name
+      obj = JavascriptObject.new( @connection , "" )
+      obj.javascript = "#{@javascript}.#{name}"
+      return obj
+    end
+
+    def val! name
+      obj = JavascriptObject.new( @connection , "" )
+      obj.javascript = "#{@javascript}.#{name}"
+      return obj.execute
+    end
+
+    def method_missing name , *params
+      obj = JavascriptObject.new( @connection , "" )
+
+      js_parameters = params.map do |p|
+        if p.kind_of? String
+          "'#{p}'"
+        else
+          p.to_s
+        end
+      end
+
+      obj.javascript = "#{@javascript}.#{name.to_s.gsub('!','').to_s}( #{js_parameters.join(',')} )"
+      if name.to_s.match('!')
+        return obj.execute
+      else
+        return obj
+      end
+    end
+
+    def length
+      obj = JavascriptObject.new( @connection , "" )
+      obj.javascript = "#{@javascript}.length"
+      return obj
+    end
+
+    def execute
+      return @connection.send_command( "#{@javascript};" )
+    end
+
+    def to_s
+      return @javascript
+    end
+
+  end
+end

data/lib/caculo/jquery.rb

@@ -0,0 +1,44 @@
+module Caculo
+  class JQueryObject
+    attr_accessor :javascript
+    
+    def self.method_missing name , *params
+      obj = JQueryObject.new("")
+      obj.javascript = "jQuery.#{name}(#{params.join(" , ").to_js} , function(content){ jQuery(document.body).append( content );   } )"
+      obj
+    end
+    
+    def self.to_param obj
+      if obj.is_a? String
+        return obj.to_js
+      elsif obj.is_a? Array
+        return obj.collect{|o| self.to_param( o ) }.join(" , ")
+      else
+        return obj.to_s
+      end
+    end
+    
+    def initialize selector=nil
+      if selector.nil?
+        @javascript = "window.jQuery(window.document)"      
+      elsif selector.kind_of?( String )
+        @javascript = "window.jQuery(#{selector.to_js})"
+      else
+        @javascript = "window.jQuery(#{selector})"
+      end
+
+      def method_missing name , *params
+        obj = JQueryObject.new( "" )
+
+        js_parameters = JQueryObject.to_param( params )
+
+        obj.javascript = "#{@javascript}.#{name.to_s}( #{js_parameters} )"
+        return obj
+      end
+
+      def to_s
+        return @javascript
+      end
+    end
+  end
+end

data/lib/caculo/safari.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rbosa'
+
+
+module Caculo
+  class Safari < Browser
+
+    def page_loaded?
+      result = @application.do_javascript( 'document.readyState' , @window.document )
+      return result == "complete"
+    end
+
+    def initialize
+      super
+      @application = OSA.app('safari')
+      # puts @application
+      @application.make(OSA::Safari::Document)      
+      @window = @application.windows[-1]
+      
+      @application.do_javascript( 'window.location=\'about:config\'' , @window.document )      
+      wait_until { page_loaded? }
+    end
+
+    def send_command( cmd )       
+      @application.do_javascript( cmd , @window.document ).to_s
+    end
+
+    def location= url
+      @window.document.url = url
+    end
+
+    def location
+      @window.document.url
+    end
+
+    def current_window
+      "window"
+    end
+
+  end
+end

data/lib/caculo/unit.rb

@@ -0,0 +1,55 @@
+module Test
+  module Unit
+    class TestCase
+      def self.use_browsers *browsers
+        @@browsers = browsers
+      end
+
+      def browsers &block
+        for browser in @@browsers
+          @@browser = Caculo::Browser.open browser
+          @@browser.libraries = @@libraries
+          yield @@browser
+          @@browser.close
+        end
+      end
+
+      def self.use_libraries *libraries
+        @@libraries = libraries
+      end
+
+      def browser
+        return @@browser
+      end
+
+      def get name
+        browser.get name
+      end
+
+      def store name , object
+        browser.store name , object
+      end
+
+      def visit url
+        browser.visit url
+      end
+
+      def wait
+        browser.wait
+      end
+
+      def assert_location url
+        assert_equal url , browser.location
+      end
+
+      def back
+        browser.back
+      end
+
+      def forward
+        browser.forward
+      end
+
+    end
+  end
+end

data/lib/caculo/version.rb

@@ -0,0 +1,9 @@
+module Caculo #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/test_caculo.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../lib/caculo'
+require File.dirname(__FILE__) + '/../server/server'
+
+include Caculo
+
+start_server
+
+page = Caculo::Browser.open(:safari)
+
+page.visit( "http://localhost:3000".to_js )
+
+page[ JQueryObject.get("_finished.html") ]
+
+center_column = jQuery("<div />").attr("id", "center-column").css("margin" , "0 auto").width( 500 ).css("border" , "1px solid black").text("")
+left_column = jQuery("<div />").attr("id" , "left-column").css("float","left").css("width" , 100 )
+
+links_list = ["http://yahoo.com" , "http://cohitre.com"  ].map { |url| jQuery("<li />").append( jQuery("<a />").attr("href", url ).text(url) ) }
+
+page[ jQuery("body").append( left_column.text("left column") , center_column ) ]
+page[ jQuery('#center-column').append( jQuery("<ul />").append( links_list ) ) ]
+page[ jQuery("body").append( jQuery("<div />").attr('id','element').text("This is the caculo test sandbox") ) ]
+page[jQuery("<div />").css( "position" , "absolute" ).css( "background-color" , "purple").appendTo( jQuery("body") ).text("dododo")]
+page.timeout( 3 ) { jQuery("#element").text('Done') }
+
+page.wait_until {  page[jQuery("#element").text] == "Done" }
+
+page << "(#{js_function( "window.alert( 'a' )" )})()"

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/caculo'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: cohitre-caculo
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- carlos rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Caculo lets you simulate interaction with a browser via Ruby. It has the option to load a Javascript Library and call Javascript functions on the document. This allows for simple code that takes advantage of exisiting libraries.
+email: 
+- carlosrr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- lib/caculo.rb
+- lib/caculo/version.rb
+- lib/caculo/firefox.rb
+- lib/caculo/internet_explorer.rb
+- lib/caculo/javascript.rb
+- lib/caculo/jquery.rb
+- lib/caculo/safari.rb
+- lib/caculo/unit.rb
+- test/test_caculo.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://caculo.cohitre.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: caculo
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Caculo lets you simulate interaction with a browser via Ruby. It has the option to load a Javascript Library and call Javascript functions on the document. This allows for simple code that takes advantage of exisiting libraries.
+test_files: 
+- test/test_caculo.rb
+- test/test_helper.rb