rhodes 2.3.2 → 2.4.0.beta.1

data/CHANGELOG

@@ -1,3 +1,21 @@
+## 2.4
+* Android: support old sdk(s)
+* Blackberry: encryption for hsql database
+* Support running Rhodes application from external browser using link
+* Windows Mobile: signature capture
+* Add RhoSync server error processing methods to client
+* Country codes in localization files
+* Rhom now support find by integer values
+* Android: fix multitasking issues
+* Fix rotation issue in application, created by rhogen
+* Android: GPS coordinates by wireless network
+* Android: fix Honeycomb issues
+* Android: support latest ndk toolchain
+* Android: directory enumeration
+* Fix rotation/change orientation issues
+* iPhone: support non-english contacts
+* Implement Ruby timer
+
 ## 2.3.1
 * iPhone XCode 4 support
 * Android 3.0 SDK support

data/CREDITS

@@ -0,0 +1,38 @@
+Rhodes contains code from the following other projects:
+
+ Ruby language 1.9.1 (http://www.ruby-lang.org/)
+ License: GPL or Ruby own license (http://www.ruby-lang.org/en/about/license.txt)
+
+ XRuby 0.3.3 (http://code.google.com/p/xruby/)
+ License: Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+
+ sqlite 3.7.5 (http://www.sqlite.org/index.html)
+ License: Public Domain (http://www.sqlite.org/copyright.html)
+
+ libcurl 7.19.7 (http://curl.haxx.se/)
+ License: MIT/X derivate license(http://curl.haxx.se/docs/copyright.html)
+
+ JSON-C 0.9 (http://oss.metaparadigm.com/json-c/)
+ License: MIT derivate license (http://oss.metaparadigm.com/json-c/COPYING)
+
+ tcmalloc 1.2 (http://code.google.com/p/google-perftools/)
+ License: BSD (http://www.opensource.org/licenses/bsd-license.php)
+
+ HSQLDB 1.8 (http://hsqldb.org/)
+ License: based on BSD License (http://hsqldb.org/web/hsqlLicense.html)
+
+ Javolution 5.2 (http://javolution.org/)
+ License: BSD (http://javolution.org/LICENSE.txt)
+
+ JSON ME 2.0 (https://github.com/upictec/org.json.me/)
+ License: json.org (https://github.com/upictec/org.json.me/blob/master/src/main/java/org/json/me/JSONArray.java)
+
+ Apache ORO library 2.0.8 (http://jakarta.apache.org/oro/)
+ License: Apache License 2.0 (http://svn.apache.org/repos/asf/jakarta/oro/trunk/LICENSE)
+
+ zxing 1.6 (http://code.google.com/p/zxing/)
+ License: Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+ 
+ zbar 0.10 (http://zbar.sourceforge.net/)
+ License: GNU LGPL 2.1 (http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)
+

data/README.md

@@ -1,7 +1,7 @@
 Rhodes
 ===
 
-The [Rhodes framework](http://github.com/rhomobile/rhodes) is a framework for building locally executing, device-optimized mobile applications for smartphone devices. These applications are optimized for interacting with transactional enterprise application backends (with synced local data via [RhoSync](http://github.com/rhomobile/rhosync)). Rhodes is available for iPhone, Windows Mobile, and Research in Motion (Blackberry) smartphones.  
+The [Rhodes framework](http://github.com/rhomobile/rhodes) is a framework for building locally executing, device-optimized mobile applications for smartphone devices. These applications are optimized for interacting with transactional enterprise application backends (with synced local data via [RhoSync](http://github.com/rhomobile/rhosync)). Rhodes is available for iPhone, Android, Windows Mobile, and Research in Motion (Blackberry) smartphones.  
 
 Rhodes is available as an open source product under the MIT license.  For developers interested a commercial license is still [available](http://rhomobile.com/products/rhodes/license/).
 
@@ -43,4 +43,4 @@ The [Rhodes Developer Reference](http://docs.rhomobile.com/rhodes/introduction)
 
 For further questions [email us](mailto:info@rhomobile.com) or join the [Google Group](http://groups.google.com/group/rhomobile).
 
-For questions on licensing contact [our sales team](mailto:sales@rhomobile.com).
+For questions on commercial support contact [our sales team](mailto:sales@rhomobile.com).

data/Rakefile

@@ -21,6 +21,7 @@ load File.join(pwd, 'platform/android/build/android.rake')
 load File.join(pwd, 'platform/iphone/rbuild/iphone.rake')
 load File.join(pwd, 'platform/wm/build/wm.rake')
 load File.join(pwd, 'platform/linux/tasks/linux.rake')
+load File.join(pwd, 'platform/wp7/build/wp.rake')
 
 def get_dir_hash(dir, init = nil)
   hash = init
@@ -51,7 +52,7 @@ namespace "framework" do
 end
 
 
-$application_build_configs_keys = ['security_token', 'encrypt_database']
+$application_build_configs_keys = ['security_token', 'encrypt_database', 'android_title']
 
 def make_application_build_config_header_file
   f = StringIO.new("", "w+")      
@@ -96,6 +97,33 @@ def make_application_build_config_header_file
   Jake.modify_file_if_content_changed(File.join($startdir, "platform", "shared", "common", "app_build_configs.c"), f)
 end
 
+def make_application_build_capabilities_header_file
+  f = StringIO.new("", "w+")      
+  f.puts "// WARNING! THIS FILE IS GENERATED AUTOMATICALLY! DO NOT EDIT IT MANUALLY!"
+  #f.puts "// Generated #{Time.now.to_s}"
+  f.puts ""
+
+  caps = []
+ 
+  capabilities = $app_config["capabilities"]
+
+  if capabilities != nil
+     capabilities.each do |cap|
+        caps << cap
+     end
+  end
+
+  caps.sort.each do |cap|
+     f.puts '#define APP_BUILD_CAPABILITY_'+cap.upcase
+  end
+
+  f.puts ''
+  
+  Jake.modify_file_if_content_changed(File.join($startdir, "platform", "shared", "common", "app_build_capabilities.h"), f)
+end
+
+
+
 def make_application_build_config_java_file
 
     f = StringIO.new("", "w+")
@@ -217,6 +245,7 @@ namespace "config" do
       make_application_build_config_java_file
     else  
       make_application_build_config_header_file    
+      make_application_build_capabilities_header_file
     end
 
   end
@@ -455,7 +484,7 @@ def common_bundle_start(startdir, dest)
   replace_platform = $config['platform']
   replace_platform = "bb6" if $bb6
   replace_platform = "wm" if replace_platform == 'win32'
-  
+
   [File.join($srcdir,'apps'), ($current_platform == "bb" ? File.join($srcdir,'res') : File.join($srcdir,'lib/res'))].each do |folder|
       chdir folder
       
@@ -466,6 +495,7 @@ def common_bundle_start(startdir, dest)
       end
       
       Dir.glob("**/*.wm.*").each { |f| rm f }
+	  Dir.glob("**/*.wp7.*").each { |f| rm f }
       Dir.glob("**/*.iphone.*").each { |f| rm f }
       Dir.glob("**/*.bb.*").each { |f| rm f }
       Dir.glob("**/*.bb6.*").each { |f| rm f }
@@ -658,6 +688,34 @@ namespace "build" do
 
       cp_r "platform/shared/db/res/db", $srcdir 
     end
+    
+    task :noiseq do
+      app = $app_path
+      rhodeslib = File.dirname(__FILE__) + "/lib/framework"
+	  compileERB = "lib/build/compileERB/bb.rb"
+      startdir = pwd
+      dest = $srcdir + "/lib"      
+
+      common_bundle_start(startdir,dest)
+      process_exclude_folders
+      chdir startdir
+      
+      create_manifest
+  
+	  cp   compileERB, $srcdir
+      puts "Running bb.rb"
+
+      puts `#{$rubypath} -I#{rhodeslib} "#{$srcdir}/bb.rb"`
+      unless $? == 0
+        puts "Error interpreting erb code"
+        exit 1
+      end
+
+      rm "#{$srcdir}/bb.rb"
+
+	  chdir startdir
+      cp_r "platform/shared/db/res/db", $srcdir 
+    end
   end
 end
 

data/bin/set-rhodes-sdk.bat

@@ -1 +1,2 @@
+@echo off
 ruby %~dp0set-rhodes-sdk

data/doc/application.txt

@@ -92,6 +92,8 @@ Method on_ui_created will be invoked after application's UI was created (usually
 		# put your application UI creation code here
 		# for example, create tab bar:
 		# NativeBar.create(Rho::RhoApplication::TABBAR_TYPE, tabs)
+		
+		super.on_ui_created() # To navigate to start_path from rhoconfig.txt
 	end
 
 Method on_ui_destroyed will be invoked when application's UI was destroyed (usually on app exit)
@@ -101,6 +103,8 @@ Method on_ui_destroyed will be invoked when application's UI was destroyed (usua
 		# example:
 		# @forbid_ui_operations = true
 	end
+**NOTE: On iPhone, on_ui_destroyed invoked when also when application goes to background, because if application killed in background by user (via multitasking UI) then no any events sended to application. So if you want save state of your application, you can do it in on_ui_destoyed, but keep in mind - is just save - do not process destroy of your UI in this method**
+
 
 Method on_activate_app will be invoked after application is activated. 
 	:::ruby
@@ -253,6 +257,13 @@ Rhodes can display the following error pages: app\E400.erb and app\E500.erb
 
 To get exception object use $! or Rho::RHO.current_exception
 
+## RhoSupport class
+### Rho::RhoSupport.url_encode(url) 
+Encode url replacing special characters to %XX
+
+### Rho::RhoSupport.url_decode(url)
+Decode url replacing %XX to special characters
+
 ## Per Platform Files
 
 On a per platform basis, you can use alternative files for any given file in your 'app' or 'public' folder. To do this, make a second file with the platform in the name of the file. 

data/doc/build.txt

@@ -14,13 +14,13 @@ For Windows use [Instant Rhodes](install#install-on-windows). On Mac, Linux, and
 * Rhodes gem. Run `[sudo] gem install rhodes` to install the latest rhodes gem.
 **NOTE: If you get any "no such file to load -- something" messages while running the rake tasks or rhogen commands, this can usually be resolved by running '[sudo] gem install something'. **
 
-Setup HOME environment variable: 
+For Windows setup HOME environment variable:
 
 	C:\Documents and Settings\<account_name>
 
 If you are planning to build for Blackberry or Android, make sure you have JDK version 1.6.0_2 or higher installed. Recommended version 6.0 update 11.
 
-* Version 1.6.0_13 for Mac OSX 10.5 available [here](http://support.apple.com/downloads/Java_for_Mac_OS_X_10_5_Update_4). Install it and then run "Java Preferences" utility to change default version.
+* Version 1.6.0_24 for Mac OSX 10.6 available [here](http://support.apple.com/downloads/DL1360/en_US/JavaForMacOSX10.6Update4.dmg). Install it and then run "Java Preferences" utility to change default version.
 * Sun JDK for Windows or Linux is available [here](http://java.sun.com/javase/downloads/index.jsp). The 32-bit Windows version is required for Blackberry tools. 
 
 Make sure you set JAVA_HOME and that JAVA_HOME/bin is on your path.
@@ -29,7 +29,7 @@ Make sure you set JAVA_HOME and that JAVA_HOME/bin is on your path.
 
 If you planning to modify or [extend](extensions) Rhodes, you will need Rhodes source code. It is distributed under MIT license and it is perfectly all right for you to hack it if you want to. But you don't need it otherwise, having Rhodes gem installed is enough.
 
-Rhodes source code is available on github.com and you will need Git to get it form there. If you used [Instant Rhodes](install#install-on-windows) you probably already have it installed on your system. Otherwise, load it form [here](http://git-scm.com).
+Rhodes source code is available on github.com and you will need Git to get it from there. If you used [Instant Rhodes](install#install-on-windows) you probably already have it installed on your system. Otherwise, load it from [here](http://git-scm.com).
 
 To clone Rhodes, execute following from the command line:
 	
@@ -249,6 +249,26 @@ with
 
 Otherwise your css files will not be loaded in Android 1.5 (and higher)
 
+### Device capabilities settings in build.yml
+
+Attention ! On Android you should specify list of device capabilities need for you application. By default there are not any capabilities enabled !
+This is important because all defined capability produce special <uses-permission ... > lines in AndroidManifest.xml specific to Android platfrom. Without enabled permission application can not access to device functions.
+List of capabilities related to changes in AndroidManifest - add or remove this items in "capabilities" section in your build.yml:
+	audio
+  	camera
+  	gps
+  	network_state
+  	phone
+  	pim
+  	record_audio
+  	vibrate
+  	bluetooth
+  	calendar
+  	sdcard
+  	push
+
+
+
 ### Building app and running it in emulator from the command line
 
 ** NOTE: make sure that your PATH has the path to java bin. **
@@ -263,11 +283,16 @@ It will create (if needed) new virtual sdcard for emulator, then check if emulat
 	android:
 	  version: 2.1
 
-You can also specify emulator name (see Android SDK Manager tool in root of Android SDK folder).
+You can also specify emulator AVD name (see 'Android SDK and AVD Manager').
 
 	android:
 	  emulator: myDeviceEmulator20
 
+Disable Android title in application :
+
+	android:
+	  android_title: 0
+
 If the rake command gets stuck you can kill the command window, open another window, run:
 
   	:::term
@@ -333,22 +358,28 @@ Signed APK will be located in `<rhodes-app-dir>/bin/target`. To install applicat
 
 ### Building app in Eclipse
 
+Please note: It is only Google API target (with Google mapping API) supported for Eclipse
+
 Create a new workspace in the following directory: `<Rhodes>/platform/android`
 
 Go to the Window > Preferences 
 
-Click on Android node in the tree and specify file path to the installed android SDK (For example: `E:\android\android-sdk-windows-1.6_r1`)
+Click on Android node in the tree and specify file path to the installed Android SDK (For example: `E:\android\android-sdk-windows`)
 
 Import all projects from the following directory: `<Rhodes>/platform/android`
 
 If you have set the option to build sources automatically all stuff will be compiled just after the import.
 
-Right click on Rhodes project and select 1.6 target for Android.
+Select Properties from the Rhodes project context menu and select one of latest Google API target for Android.
 
 Check bin directory. You should see Rhodes.apk file created. It will be signed with debug key provided with SDK.
 
 Now you are ready to install your application on device and/or emulator.
 
+In case of troubles in Eclipse while setting up the Android SDK and target try "Rhodes project context menu" > "Android Tools" > "Fix Project Properties".
+
+It is possible your application has stopped unexpectedly just after the first build. In this case try to copy autogenerated java source files from the application folder <app>/bin/tmp to the Rhodes project.
+
 ### Getting application log from device or emulator
 
 To get application log from device or emulator, from your application folder or from root of rhodes source tree (place where rhobuild.yml is located), issue command:
@@ -534,33 +565,24 @@ The log.txt file is the extracted log and should appear on the `C:\` drive.
 
 ### Build rhodes from the source code using Eclipse
 
-You should have Blackberry Eclipse IDE installed.
-
-Please make sure that there are no .metadata folder in rhodes\platform\bb folder, check also that there are no .project and .classname files in any subfolders of `rhodes\platform\bb`.
-
-Run eclipse and choose rhodes\platform\bb as a workspace directory. Do not create workspace!
-
-Go to File\Import... menu. Select `Blackberry\Blackberry JDE` workspace node. Press Next. Browse for `rhodes\platform\bb\.BB.jdw\BB.jdw`. Press Finish. The project will be automatically build.
-
-Go to Window\Preferences menu. Select `Blackberry JDE\Installed` components node.
+* You should have Blackberry Eclipse IDE installed.
+* Please make sure that there are no .metadata folder in rhodes\platform\bb folder.
+* Go to `<rhodescheckout>` and run:
 
-Select JDE installation directory for your target device. Please note that Eclipse may not show all your installed JDE in the combobox, in this case press Browse button and choose desired JDE. 
-Eclipse for Blackberry has JDE in the `<Eclipse folder>\plug-ins\net.rim.eide.componentpack<version>`.
-
-Choose Java home directory for selected JDE : jdk1.6.0_2 for JDE 4.2 and above.
-
-Select MDS Simulator node and choose MDS from your JDE directory. Press OK.
-
-Workspace will be recreated. Choose Clean all projects in the dialog. Press OK. RubyVM project should be built, check `rhodes\platform\bb\RubyVM\RubyVM.jar`
-
-Go to `<rhodescheckout>` and run:
-
-	:::term
-	$ rake build:bb:rhobundle
-
-It should create `rhodes\platform\bb\RhoBundle\RhoBundle.jar`
-
-Return to Eclipse and select `Project\Clean...`, Clean all projects, press OK.
+	    $ rake build:bb:devrhobundle
+	
+* Run eclipse and choose rhodes\platform\bb as a workspace directory. Do not create workspace!
+* Open menu Window\Preferences
+    * Blackberry java plug-in\Warnings - check all 3 chekboxes to suppress all warnings
+    * Java\Compiler - set Compiler compliance level to 1.4
+* Go to File\Import... menu. Select `General\Existing projects into Workspace` workspace node. Press Next. 
+    * Browse for `<rhodes>\platform\bb\RubyVM`. Press Finish. The project will be automatically build.
+    * Browse for `<rhodes>\platform\bb\Hsqldb`. Press Finish. The project will be automatically build.
+    * Browse for `<rhodes>\platform\bb\Rhodes`. Press Finish. The project will be automatically build.
+* Go to Run\Debug Configurations - double click on Blackberry simulator
+    * select all projects in Projects tab
+    * got to Simulator tab, select Memory, check Use PC file system for SDCard files, add `Rho` to PC file system for SDCard files edit box
+    * Press Debug
 
 Congratulations! It is all done.
 
@@ -620,15 +642,12 @@ Open ActiveSync main window, go to the File -> Connection Settings, select check
 
 ### Build application from the command line
 
-Make sure that `C:\Program Files\Microsoft Visual Studio 8\VC\vcpackages` is in your path (required to run vcbuild.exe). Here is the list of paths which should be in PATH env variable:
-
-<i>C:\Program Files\Microsoft Visual Studio 8\Common7\IDE;C:\Program Files\Microsoft Visual Studio 8\VC\BIN;C:\Program Files\Microsoft Visual Studio 8\Common7\Tools;C:\Program Files\Microsoft Visual Studio 8\Common7\Tools\bin;C:\Program Files\Microsoft Visual Studio 8\VC\PlatformSDK\bin;C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\bin</i>
-
-Add path to CabWiz.exe to rhobuild.yml in the Rhodes folder:
+Add path to vcbuild.exe and CabWiz.exe to rhobuild.yml in the Rhodes folder:
 
 	env:
 	  paths:
-	    cabwiz: C:/Program Files/Windows Mobile 6 SDK/Tools/CabWiz
+	    vcbuild: 'C:/Program Files/Microsoft Visual Studio 8/VC/vcpackages/vcbuild.exe'
+	    cabwiz: 'C:/Program Files/Windows Mobile 6 SDK/Tools/CabWiz'
 
 ### To run application on device or emulator(Visual Studio 2008 only) :
 
@@ -749,6 +768,102 @@ To clean all binaries run:
 
 Rholog.txt is placed in `<rhodes folder>\platform\wm\bin\win32\rhodes\Debug\rho`
 
+### Build experimental Rhodes Win32-emulator based on Qt port of WebKit
+
+Experimental Rhodes Win32-emulator uses WebKit's WebView and WebInspector to display and debug a client part of the Rhodes applications.
+At present the emulator is in active development alfa-stage. The basic functionality is implemented, but some important features are not functioning properly.
+Use it at your own risk!
+
+* Use Visual Studio 2005 Service Pack 1
+* First build the Qt libraries for VS 2005:
+    * Download the Qt source:
+        * Go to [http://qt.nokia.com/downloads](http://qt.nokia.com/downloads)
+        * Choose the open source LGPL version
+        * Under the Framework Only section choose Qt libraries for Windows (VS 2008)
+        * Cancel automatically started download, and download the [source code](http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.2.zip)
+        * Extract the downloaded archive, e.g. into `C:\Qt\4.7.2-msvc2005`
+    * Open Control Panel » System » Advanced system settings » Environment Variables and then:
+        * Create new system variable `QTDIR` = `C:\Qt\4.7.2-msvc2005`
+        * Add to the `PATH` variable: `%QTDIR%\bin`
+        * Either close all command prompts and Visual Studio instances, or reboot the computer so the new settings take effect.
+    * Open Visual Studio 2005 Command Prompt. This is accomplished using Start » All Programs » Microsoft Visual Studio 2005 » Visual Studio Tools » Visual Studio 2005 Command Prompt. Run in Visual Studio 2005 Command Prompt:
+
+			> vcvarsall.bat x86
+			> C:
+			> cd \Qt\4.7.2-msvc2005
+			> configure -platform win32-msvc2005
+			> nmake
+
+      Be aware that it will take a while to build the Qt libraries from sources (maybe few hours or so). Particularly the `configure` command may run for a few minutes, and the `nmake` command may run for a few hours.
+    * After the build process is completed exit Visual Studio 2005 Command Prompt
+* Check out the experimental `win32-emulator` branch using Git Bash (or alternatively performing the similar actions in some Windows GUI for Git), e.g. into `C:\Rhomobile`:
+
+		$ cd /c/Rhomobile
+		$ git clone git://github.com/rhomobile/rhodes.git
+		$ cd rhodes
+		$ git checkout -f -b win32-emulator --track origin/win32-emulator
+
+* Set your application as a default application for experimental Rhodes SDK:
+    * In `build.yml` of your application specify experimental Rhodes SDK path:
+
+			sdk: "C:/Rhomobile/rhodes"
+  
+    * In Windows Command Prompt run:
+
+			> cd <root-folder-of-your-application>
+			> rake build:win32:devrhobundle
+
+* Build experimental Rhodes Win32-emulator:
+    * In Visual Studio 2005 open the solution: `C:\Rhomobile\rhodes\platform\wm\rhodes\rhodes.vcproj`
+    * Build Solution for “`Debug | Win32`” configuration
+    * Run and enjoy!
+
+## Build for Windows Phone 7
+
+### Prerequisites
+
+* Follow [All Platforms Prerequisites](#all-platforms-prerequisites)
+* Windows 7 OS
+* Visual Studio 2010 installed or VS Express for Windows Phone and VS Express for C#
+    * [Windows Phone Developer Tools RTW](http://www.microsoft.com/downloads/en/details.aspx?FamilyID=04704acf-a63a-4f97-952c-8b51b34b00ce)
+    * [Windows Phone Developer Tools January 2011 Update](http://www.microsoft.com/downloads/en/details.aspx?FamilyID=49b9d0c5-6597-4313-912a-f0cca9c7d277)
+    
+* Get IronRuby master branch to parent folder of rhodes:
+
+        $ git clone https://github.com/IronLanguages/main.git
+  
+  rename IronLanguages folder to IronRuby
+
+### Build IronRuby(Once)
+* Checkout rhodes source code from github 
+
+* Copy folder `rhodes\platform\wp7\IronRuby\Languages` to `IronRuby`
+
+* Open `IronRuby\Solutions\Ruby.sln` in VS 2010 or VS Express 2010 for C#.
+
+* Select 'Silverlight3Debug|Any CPU' in solution configuration and build solution
+
+### Build from IDE
+* Checkout rhodes source code from github
+* Open the file `rhobuild.yml` using a text editor:
+
+    define the path to your application
+    
+* Open `rhodes\platform\wp7\rhodes.sln` in VS 2010 or VS Express 2010 for Windows Phone.
+* Select Debug configuration, Windows Phone 7 Emulator target and build solution.
+* Run emulator by pressing Start Debugging or Start Without Debugging
+* After Application code modifications , build Rhodes solution and Start Debugging. DO NOT close emulator!
+
+### Logging
+See log in VS output console
+
+### Run store sample
+* Checkout store sample:
+
+        $ git clone https://github.com/rhomobile/store.git
+        
+* Run application in emulator and login with empty credentials
+
 ## How to set application name and icon
 
 ### Application Name
@@ -776,4 +891,6 @@ Place your image to use as an icon in a folder called `icon` in your application
 * rhodes\platform\iphone\icon.png, icon57.png, icon72.png, icon114.png - change to your icons
 * check rhodes\platform\iphone\Info.plist it should contain BundleName=${PRODUCT_NAME}
 
-
+### Windows Mobile
+Windows Mobile Shell program caches program icons. This cache is cleared only when device or simulator is restarted.
+So if you change icon of application, you have to restart device/simulator(uninstall/install is not enough).