sc-frank-ios 1.2.3

data/lib/frank-cucumber/frank_localize.rb

@@ -0,0 +1,43 @@
+require 'i18n'
+
+module Frank
+  module Cucumber
+    module Localize
+
+      def self.system_locale
+        case ENV['LANG']
+        when /^fr_/
+          :fr
+        when /^de_/
+          :de
+        when /^ru_/
+          :ru
+        when /^zh_/
+          :zh
+        when /^ja_/
+          :ja
+        when /^es_/
+          :es
+        when /^it_/
+          :it
+        else
+          :en
+        end
+      end
+
+      def self.load_translations
+        if I18n.backend.send(:translations).size == 0
+          I18n.locale = self.system_locale
+          I18n.load_path = [ File.join(File.dirname(__FILE__), 'localize.yml') ]
+          I18n.backend.load_translations
+        end
+      end
+
+      def self.t(key)
+        self.load_translations
+        I18n.t(key)
+      end
+
+    end
+  end
+end

data/lib/frank-cucumber/frank_mac_helper.rb

@@ -0,0 +1,120 @@
+require 'frank-cucumber/frank_helper'
+
+module Frank module Cucumber
+
+module FrankMacHelper
+
+  # Performs a click at the center of the selected object.
+  #
+  # This method creates CGEvents to move and click the mouse. Before calling this method,
+  # you should make sure that the element that you want to click is frontmost by calling
+  # bring_to_front.
+  #
+  # This method is designed to act on a single object, so do not pass a selector that will
+  # return multiple objects.
+  def click ( selector )
+    frame = accessibility_frame(selector)
+    frankly_map( selector, 'FEX_mouseDownX:y:', frame.center.x, frame.center.y )
+    frankly_map( selector, 'FEX_mouseUpX:y:', frame.center.x, frame.center.y )
+  end
+
+  # Performs a double-click at the center of the selected object.
+  #
+  # This method creates CGEvents to move and click the mouse. Before calling this method,
+  # you should make sure that the element that you want to click is frontmost by calling
+  # bring_to_front.
+  #
+  # This method is designed to act on a single object, so do not pass a selector that will
+  # return multiple objects.
+  def double_click ( selector )
+    click(selector)
+    click(selector)
+  end
+
+  #@api private
+  def perform_action_on_selector( action, selector )
+    touch_successes = frankly_map( selector, action )
+    raise "could not find anything matching [#{selector}] which supports that action" if touch_successes == nil or touch_successes.empty?
+    raise "some objects do not support that action" if touch_successes.include?(false)
+  end
+
+  # Simulates the effect of clicking on the selected objects without actually moving the
+  # mouse or clicking.
+  #
+  # If the object supports the NSAccessibilityPressAction, that action is performed.
+  # Otherwise, if the object is a table cell or row, that row is selected,
+  # Otherwise, if the object is an NSView, it is made the first responder, if possible
+  # Otherwise, if the object is a menu item, it opens its submenu if it has one, or
+  # performs it's action if not.
+  def simulate_click( selector )
+    perform_action_on_selector( 'FEX_simulateClick', selector )
+  end
+
+  # Brings the selected application or window to the front.
+  def bring_to_front( selector )
+    perform_action_on_selector( 'FEX_raise', selector )
+  end
+
+  # Cancels the current action, such as editing a text field.
+  def cancel( selector )
+    perform_action_on_selector( 'FEX_cancel', selector )
+  end
+
+  # Finishes the current action, such as editing a text field.
+  def confirm( selector )
+    perform_action_on_selector( 'FEX_confirm', selector )
+  end
+
+  # Decrements the value of NSSliders, NSSteppers, and similar controls
+  def decrement_value( selector )
+    perform_action_on_selector( 'FEX_decrement', selector )
+  end
+
+  # Deletes the user-inputted value
+  def delete_value( selector )
+    perform_action_on_selector( 'FEX_delete', selector )
+  end
+
+  # Increments the value of NSSliders, NSSteppers, and similar controls
+  def increment_value( selector )
+    perform_action_on_selector( 'FEX_increment', selector )
+  end
+
+  # Selects a menu item. This action is considered "outdated" by the Accessibility API, so
+  # don't use it without a good reason.
+  def pick( selector )
+    perform_action_on_selector( 'FEX_pick', selector )
+  end
+
+  # Shows the contextual menu associated with the selector. This is the menu that would
+  # appear if the user right-clicked the selector, or, in some cases, held down the left
+  # mouse button on the selector.
+  def show_menu( selector )
+    perform_action_on_selector( 'FEX_showMenu', selector )
+  end
+
+  # Expands the row the selector belongs to in an NSOutlineView. Do not expand more than
+  # one row at a time.
+  def expand_row( selector )
+    perform_action_on_selector( 'FEX_expand', selector )
+  end
+
+  # Collapses the row the selector belongs to in an NSOutlineView. Do not expand more than
+  # one row at a time.
+  def collapse_row( selector )
+    perform_action_on_selector( 'FEX_collapse', selector )
+  end
+
+  # @return [Boolean] whether the rows the selectors belong to in an NSOutlineView are all
+  # expanded
+  def row_is_expanded( selector )
+    successes = frankly_map( selector, "FEX_isExpanded" )
+    return false if successes == nil or successes.empty?
+    return !successes.include?(false)
+  end
+
+end
+
+end
+
+end

data/lib/frank-cucumber/frankifier.rb

@@ -0,0 +1,153 @@
+require 'pathname'
+require 'xcodeproj'
+
+class Frankifier
+  include Thor::Shell
+
+  def self.frankify! root_dir, options = {}
+    me = new(root_dir, options)
+    me.frankify!
+    me
+  end
+
+  def initialize( root_dir, options = {} )
+    @root = Pathname.new( root_dir )
+    @target_build_configuration = options[:build_config]
+    @target_selection = options[:target]
+    load_xcode_proj_option(options[:project])
+  end
+
+  def frankify!
+    decide_on_project if @project.nil?
+    decide_on_target
+    report_project_and_target
+
+    check_target_build_configuration_is_valid!
+
+    say ''
+    project_changed |= add_linker_flag
+
+    say ''
+    project_changed |= add_library_search_path
+
+    if project_changed
+      save_changes
+    end
+  end
+
+  private
+  def load_xcode_proj_option(xcodeproj)
+    if xcodeproj
+      unless File.exists?(xcodeproj)
+        raise "Project file '#{xcodeproj}' does not exist. Please specify the relative path."
+      end
+
+      @xcodeproj_path = Pathname.new(xcodeproj)
+      @project = Xcodeproj::Project.open(@xcodeproj_path)
+    end
+  end
+
+  def decide_on_project
+    projects = Pathname.glob( @root+'*.xcodeproj' )
+    xcodeproj = case projects.size
+    when 0
+      raise "There are no .xcodeproj files in this directory. Please move to your root project directory and try again."
+    when 1
+      projects.first
+    else
+      choice = ask_menu(
+        "I found more than one .xcodeproj. Which is the main app project that you wish to Frankify?",
+        projects.map(&:basename)
+      )
+      projects[choice]
+    end
+
+    @xcodeproj_path = xcodeproj
+    @project = Xcodeproj::Project.open(xcodeproj)
+  end
+
+  def decide_on_target
+    targets = @project.targets
+    @target = targets.find { |item| item.name.eql?(@target_selection) } if @target_selection
+    return @target if @target
+    @target = case targets.size
+    when 0
+      raise "Sorry, this project appears to contain no targets. Nothing I can do here."
+    when 1
+      targets.first
+    else
+      choice = ask_menu(
+        "I found more than one target in this project. Which is the main app target that you wish to Frankify?",
+        targets.map(&:name)
+      )
+      targets.to_a[choice]
+    end
+  end
+
+  def report_project_and_target
+    puts "Frankifying target [#{@target.name}] in project #{@xcodeproj_path.basename}"
+  end
+
+  def add_linker_flag
+    add_frank_entry_to_build_setting( 'OTHER_LDFLAGS', 'FRANK_LDFLAGS' )
+  end
+
+  def add_library_search_path
+    add_frank_entry_to_build_setting( 'LIBRARY_SEARCH_PATHS', 'FRANK_LIBRARY_SEARCH_PATHS' )
+  end
+
+  def add_frank_entry_to_build_setting( build_setting, entry_to_add )
+    setting_array = Array( build_settings_to_edit[build_setting] )
+
+    if setting_array.find{ |flag| flag.start_with? "$(FRANK_" }
+      say "It appears that your '#{@target_build_configuration}' configuration's #{build_setting} build setting already include some FRANK setup. Namely: #{setting_array.inspect}. I won't change anything here."
+      return false
+    end
+
+    say "Adding $(inherited) and $(#{entry_to_add}) to your '#{@target_build_configuration}' configuration's #{build_setting} build setting ..."
+    setting_array.unshift "$(inherited)"
+    setting_array << "$(#{entry_to_add})"
+    setting_array.uniq! # mainly to avoid duplicate $(inherited) entries
+    say "... #{build_setting} is now: #{setting_array.inspect}"
+
+    build_settings_to_edit[build_setting] = setting_array
+    true
+  end
+
+  def check_target_build_configuration_is_valid!
+    unless @target.build_configuration_list.build_settings(@target_build_configuration)
+      say %Q|I'm trying to Frankify the '#{@target_build_configuration}' build configuration, but I don't see it that build configuration in your XCode target. Here's a list of the build configurations I see:|
+      @target.build_configuration_list.build_configurations.each do |bc|
+        say "  '#{bc.name}'"
+      end
+      say ''
+      say %Q|Please specify one of those build configurations using the --build_configuration flag|
+      exit
+    end
+
+  end
+
+  def build_settings_to_edit
+    @_build_settings_to_edit ||= @target.build_configuration_list.build_settings(@target_build_configuration)
+  end
+
+  def save_changes
+    @project.save
+  end
+
+  # TODO: send this as a pull request to thor
+  def ask_menu message, options
+    option_lines = options.each_with_index.map{ |o,i| "#{i+1}: #{o}" }
+    full_message = ([message,'']+option_lines+[">"]).join("\n")
+
+    allowed_range = (1..options.length)
+    valid_choice = nil
+    until valid_choice
+      choice = ask(full_message).to_i
+      valid_choice = choice if allowed_range.include?(choice)
+      say("You must choose an option between #{allowed_range.first} and #{allowed_range.last}") unless valid_choice
+    end
+    valid_choice-1
+  end
+
+end

data/lib/frank-cucumber/gateway.rb

@@ -0,0 +1,135 @@
+require 'net/http'
+require 'uri'
+
+module Frank module Cucumber
+
+class Gateway
+  DEFAULT_BASE_URL = "http://localhost:37265/"
+
+  def initialize( base_url = nil )
+    @base_url = URI.parse( (base_url || DEFAULT_BASE_URL).to_s )
+  end
+
+  def ping
+    send_get('')
+    return true
+  rescue FrankNetworkError
+    return false
+  end
+
+  class << self
+    def build_operation_map( method_sig, method_args )
+      num_args_according_to_method_sig = method_sig.count(':')
+
+      if num_args_according_to_method_sig != method_args.count
+        raise <<-EOS
+          
+          The method you've specified - #{method_sig} - wants #{num_args_according_to_method_sig} arguments, but you've supplied #{method_args.count} arguments.
+
+        EOS
+      end
+
+      if num_args_according_to_method_sig > 0 && !method_sig.end_with?(':')
+        raise <<-EOS
+
+          The method signature you've specified - #{method_sig} - is invalid. Objective C method signatures which take parameters must end with a :
+
+        EOS
+      end
+
+      {
+        :method_name => method_sig,
+        :arguments => method_args,
+      }
+    end
+
+    def evaluate_frankly_response( json, req_desc )
+      res = JSON.parse( json )
+      if res['outcome'] != 'SUCCESS'
+        raise "#{req_desc} failed because: #{res['reason']}\n#{res['details']}"
+      end
+
+      res['results']
+    end
+  end
+
+  #taken from Ian Dee's Encumber
+  def send_post( verb, command )
+    command = command.to_json unless command.is_a? String
+
+    url = frank_url_for( verb )
+    req = Net::HTTP::Post.new url.path
+    req.body = command
+
+    make_http_request( url, req )
+  end
+
+  def send_get( verb )
+    url = frank_url_for( verb )
+    req = Net::HTTP::Get.new url.path
+    make_http_request( url, req )
+  end
+  
+  private
+
+  def frank_url_for( verb )
+    url = @base_url.clone
+    url.path = '/'+verb
+    url
+  end
+
+  def make_http_request( url, req )
+    http = Net::HTTP.new(url.host, url.port)
+
+    begin
+      res = http.start do |sess|
+        sess.request req
+      end
+
+      res.body
+    rescue Errno::ECONNREFUSED
+      raise FrankNetworkError 
+    rescue EOFError
+      raise FrankNetworkError
+    end
+  end
+
+end
+
+
+class FrankNetworkError < RuntimeError
+  OVERLY_VERBOSE_YET_HELPFUL_ERROR_MESSAGE = <<EOS
+  
+
+*********************************************
+Oh dear. Your app fell over and can't get up.
+*********************************************
+
+
+We just encountered an error while trying to talk to the Frank server embedded 
+within the app under test. This usually means that the app has just crashed, 
+either while carrying out the current step or while finishing up the previous 
+step.
+
+Here are some things you could do next:
+
+- Take a look at the app's logs to see why it crashed. You can view the logs 
+  in Console.app (a search for 'Frankified' will usually find your frankified 
+  app's output).
+
+- Launch your frankified app in the XCode debugger and then run this scenario 
+  again. You'll get lots of helpful output from XCode. Don't forget to do 
+  something to prevent cucumber from automatically re-launching your app when 
+  you run the scenario by hand. If you don't prevent the relaunch then you 
+  won't still be in the XCode debugger when the crash happens.
+
+  
+
+EOS
+
+  def initialize
+    super OVERLY_VERBOSE_YET_HELPFUL_ERROR_MESSAGE
+  end
+end
+
+end end