funfx 0.2.0

data/History.txt

@@ -0,0 +1,18 @@
+== 0.2.0 yyyy-mm-dd
+
+Complete rewrite of FunFX.
+
+* 13 major enhancements:
+  * FunFX is a plugin to Watir/SafariWatir/FireWatir
+  * The FunFX API is statically generated code instead of dynamically generated
+  * Big poster with class diagram
+  * Hash based lookup of elements
+  * Flex stacktrace is included in Ruby stack trace
+  * Elements can be looked up by a "path" of ids: several hashes
+  * Types are coerced back to correct Ruby types when asking for properties
+  * Full demo app included in the source tree
+  * Moved to Git
+  * Automated build using Rake
+  * Proper packaging as a Ruby gem (NEEDS WORK TO INCLUDE THE FUNFX.SWC)
+  * Automated testing using RSpec
+  * The code is largely based on Adobe's AutoQuick example

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Peter Nicolai Motzfeldt
+
+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,87 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+ext/FunFX.swc
+lib/funfx.rb
+lib/funfx/browser/firewatir.rb
+lib/funfx/browser/flex_app_lookup.rb
+lib/funfx/browser/safariwatir.rb
+lib/funfx/browser/watir.rb
+lib/funfx/decoder.rb
+lib/funfx/flex/element.rb
+lib/funfx/flex/elements.rb
+lib/funfx/flex/flex_app_id.rb
+lib/funfx/flex/tabular_data.rb
+lib/funfx/meta/class_dot.erb
+lib/funfx/meta/code.erb
+lib/funfx/meta/generator.rb
+lib/funfx/meta/parser.rb
+lib/funfx/version.rb
+rake_tasks/deployment.rake
+rake_tasks/environment.rake
+rake_tasks/generation.rake
+rake_tasks/hoe_ext.rake
+rake_tasks/rspec.rake
+script/console
+script/console.cmd
+script/destroy
+script/destroy.cmd
+script/generate
+script/generate.cmd
+script/txt2html
+script/txt2html.cmd
+setup.rb
+spec/funfx/demo_app/accordion_spec.rb
+spec/funfx/demo_app/advanced_data_grid_spec.rb
+spec/funfx/demo_app/alert_spec.rb
+spec/funfx/demo_app/button_bar_spec.rb
+spec/funfx/demo_app/button_spec.rb
+spec/funfx/demo_app/check_box_spec.rb
+spec/funfx/demo_app/control_bar_spec.rb
+spec/funfx/demo_app/controls_with_same_id_spec.rb
+spec/funfx/demo_app/data_grid_editable_spec.rb
+spec/funfx/demo_app/data_grid_spec.rb
+spec/funfx/demo_app/date_chooser_spec.rb
+spec/funfx/demo_app/date_field_spec.rb
+spec/funfx/demo_app/form_spec.rb
+spec/funfx/demo_app/grid_layout_spec.rb
+spec/funfx/demo_app/h_scrollbar_spec.rb
+spec/funfx/demo_app/h_slider_spec.rb
+spec/funfx/demo_app/horizontal_list_spec.rb
+spec/funfx/demo_app/label_spec.rb
+spec/funfx/demo_app/link_bar_spec.rb
+spec/funfx/demo_app/link_button_spec.rb
+spec/funfx/demo_app/list_spec.rb
+spec/funfx/demo_app/menu_bar_spec.rb
+spec/funfx/demo_app/menu_spec.rb
+spec/funfx/demo_app/numeric_stepper_spec.rb
+spec/funfx/demo_app/popup_button_spec.rb
+spec/funfx/demo_app/popup_menu_bar_spec.rb
+spec/funfx/demo_app/progress_bar_spec.rb
+spec/funfx/demo_app/radio_button_group_spec.rb
+spec/funfx/demo_app/radio_button_spec.rb
+spec/funfx/demo_app/record_test_spec.rb
+spec/funfx/demo_app/repeater_control_spec.rb
+spec/funfx/demo_app/tab_bar_spec.rb
+spec/funfx/demo_app/tab_navigator_spec.rb
+spec/funfx/demo_app/test_spec.rb
+spec/funfx/demo_app/text_area_spec.rb
+spec/funfx/demo_app/text_input_spec.rb
+spec/funfx/demo_app/text_spec.rb
+spec/funfx/demo_app/tile_button_spec.rb
+spec/funfx/demo_app/tile_list_spec.rb
+spec/funfx/demo_app/title_window_spec.rb
+spec/funfx/demo_app/toggle_button_spec.rb
+spec/funfx/demo_app/tree_drag_and_drop_spec.rb
+spec/funfx/demo_app/tree_spec.rb
+spec/funfx/demo_app/view_stack_spec.rb
+spec/funfx/flex/element_spec.rb
+spec/funfx/flex/flex_app_id_spec.rb
+spec/funfx/meta/generator_spec.rb
+spec/funfx/meta/parser_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,48 @@
+= funfx
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Peter Nicolai Motzfeldt
+
+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/Rakefile

@@ -0,0 +1,5 @@
+ENV['NODOT'] = 'true' # We don't want diagrams in RDoc - we make our own Dot diagram!
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['rake_tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,67 @@
+require 'funfx/version'
+
+DESCRIPTION = "Functional testing for Flex"
+GEM_NAME = 'funfx' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'funfx' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = FunFX::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'FunFX documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer('Peter Nicolai Motzfeldt', "motzfeldt@gmail.com")
+  p.developer('Aslak Hellesøy', "aslak.hellesoy@gmail.com")
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store', 'coverage']  #An array of file patterns to delete on clean.
+  p.rdoc_pattern = /^(lib|bin)|txt$/ # We don't want the ext/FunFX.swc in RDoc!
+
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [ ['fastercsv', '>= 1.4.0'] ]
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/funfx.rb

@@ -0,0 +1,34 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'funfx/decoder'
+require 'funfx/browser/flex_app_lookup'
+require 'funfx/flex/element'
+require 'funfx/flex/elements'
+require 'funfx/flex/flex_app_id'
+
+module FunFX
+  class << self
+    # Turn on debug information
+    def debug=(b)
+      @debug = b
+    end
+
+    # Prints debug information (if debug is on - it's off by default)
+    def debug(s)
+      if @debug
+        puts s
+      end
+    end
+
+    # Set how many seconds to sleep after an event is fired.
+    def fire_pause=(t)
+      @fire_pause = t
+    end
+    
+    # How many seconds to sleep after an event is fired. Defaults to 2 seconds.
+    def fire_pause
+      @fire_pause || 2
+    end
+  end
+end

data/lib/funfx/browser/firewatir.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'firewatir'
+require 'funfx'
+
+module FireWatir
+  # FireWatir extension for FunFX. Allows lookup of FlexApp objects via FunFX::Browser::FlexAppLookup#flex_app.
+  class Firefox
+    include FunFX::Browser::FlexAppLookup
+    def platform_flex_app(dom_id, app_name) #:nodoc:
+      sleep(2) # TODO: Try to remove this
+      FlexApp.new(dom_id, app_name)
+    end
+
+    class FlexApp < ::Element #:nodoc:
+      include FunFX::Flex::Elements
+      include FunFX::Flex::FlexAppId
+
+      def initialize(dom_id, app_name)
+        @dom_id, @app_name = dom_id, app_name
+      end
+
+      def fire_event(flex_locator, event_name, args) # :nodoc:
+        javascript = %|#{DOCUMENT_VAR}.getElementById("#{@dom_id}").fireFunFXEvent(#{flex_locator}, #{event_name.inspect}, "#{args}");\n|
+        $jssh_socket.send(javascript, 0)
+        read_socket
+      end
+
+      def get_property_value(flex_locator, property) # :nodoc:
+        javascript = %|#{DOCUMENT_VAR}.getElementById("#{@dom_id}").getFunFXPropertyValue(#{flex_locator}, #{property.inspect});\n|
+        $jssh_socket.send(javascript, 0)
+        read_socket
+      end
+      
+      def get_tabular_property_value(flex_locator, property) # :nodoc:
+        javascript = %|#{DOCUMENT_VAR}.getElementById("#{@dom_id}").getFunFXTabularPropertyValue(#{flex_locator}, #{property.inspect});\n|
+        $jssh_socket.send(javascript, 0)
+        read_socket
+      end
+
+      def invoke_tabular_method(flex_locator, method_name, *args) # :nodoc:
+        javascript = %|#{DOCUMENT_VAR}.getElementById("#{@dom_id}").invokeFunFXTabularMethod(#{flex_locator}, #{method_name.inspect}, #{args.map{|a| a.inspect}.join(', ')});\n|
+        $jssh_socket.send(javascript, 0)
+        read_socket
+      end
+    end
+  end
+end

data/lib/funfx/browser/flex_app_lookup.rb

@@ -0,0 +1,22 @@
+module FunFX
+  module Browser
+    module FlexAppLookup
+      # Returns a FlexApp object.
+      #
+      # Look at the source of the HTML file hosting and look for the following:
+      #
+      #   AC_FL_RunContent(
+      #     "id", "MyId",
+      #     "name", "MyName"
+      #   );
+      #
+      # In this example you would use:
+      #
+      #   flex = browser.flex_app("MyId", "MyName")
+      #
+      def flex_app(dom_id, app_name)
+        platform_flex_app(dom_id, app_name)
+      end
+    end
+  end
+end

data/lib/funfx/browser/safariwatir.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'safariwatir'
+require 'funfx'
+
+module Watir
+  # SafariWatir extension for FunFX. Allows lookup of FlexApp objects via FunFX::Browser::FlexAppLookup#flex_app.
+  class Safari
+    include FunFX::Browser::FlexAppLookup
+    def platform_flex_app(dom_id, app_name) #:nodoc:
+      FlexApp.new(scripter, :id, dom_id, app_name)
+    end
+
+    class FlexApp < HtmlElement #:nodoc:
+      include FunFX::Flex::Elements
+      include FunFX::Flex::FlexAppId
+
+      def initialize(scripter, how, what, app_name)
+        super(scripter, how, what)
+        @id_prefix = "id{#{app_name} string}"
+      end
+
+      def fire_event(flex_locator, event_name, args) # :nodoc:
+        eval_js %{return element.fireFunFXEvent(#{flex_locator}, #{event_name.inspect}, "#{args}")}
+      end
+
+      def get_property_value(flex_locator, property) # :nodoc:
+        eval_js %{return element.getFunFXPropertyValue(#{flex_locator}, #{property.inspect})}
+      end
+
+      def get_tabular_property_value(flex_locator, property) # :nodoc:
+        eval_js %{return element.getFunFXTabularPropertyValue(#{flex_locator}, #{property.inspect})}
+      end
+
+      def invoke_tabular_method(flex_locator, method_name, *args) # :nodoc:
+        eval_js %{return element.invokeFunFXTabularMethod(#{flex_locator}, #{method_name.inspect}, #{args.map{|a| a.inspect}.join(', ')})}
+      end
+
+      private
+
+      def eval_js(js)
+        result = @scripter.__send__(:execute, operate{js}, self)
+        raise "Nothing returned from Safari. Are you sure you have compiled the Flex app with FunFX?" if result.nil?
+        result
+      end
+    end
+  end
+end

data/lib/funfx/browser/watir.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'watir'
+require 'funfx'
+
+module Watir
+  # Watir extension for FunFX. Allows lookup of FlexApp objects via FunFX::Browser::FlexAppLookup#flex_app.
+  class IE
+    include FunFX::Browser::FlexAppLookup
+    def platform_flex_app(dom_id, app_name)
+      FlexApp.new(self, dom_id, app_name)
+    end
+
+    class FlexApp < Element #:nodoc:
+      include FunFX::Flex::Elements
+      include FunFX::Flex::FlexAppId
+
+      def initialize(ole_object, dom_id, app_name)
+        super(ole_object)
+        @flex_object = ole_object.ie.Document.getElementsByName(dom_id).item(0)
+        raise "Couldn't find Flex object with id #{dom_id.inspect}" if @flex_object.nil?
+        @app_name = app_name
+      end
+
+      def fire_event(flex_locator, event_name, args) # :nodoc:
+        @flex_object.fireFunFXEvent(flex_locator, event_name, args)
+      end
+
+      def get_property_value(flex_locator, property) # :nodoc:
+        @flex_object.getFunFXPropertyValue(flex_locator, property)
+      end
+
+      def get_tabular_property_value(flex_locator, property) # :nodoc:
+        @flex_object.getFunFXTabularPropertyValue(flex_locator, property)
+      end
+
+      def invoke_tabular_method(flex_locator, method_name, *args) # :nodoc:
+        @flex_object.invokeFunFXTabularMethod(flex_locator, method_name, *args)
+      end
+    end
+  end
+end