rhodes 2.4.1 → 3.0.0.beta.1

data/CHANGELOG

@@ -1,3 +1,10 @@
+## 3.0
+* RhoSimulator: simulator for fast Rhodes application development, support debugging using Rhodes Eclipse plug-in.(Windows only)
+* Windows Phone 7 support
+* Android: NFC support
+* Android: System.open_url open different media files
+* Rhom support different attribute type for Schema models
+
 ## 2.4.1
 * iPhone: fix production build
 * Android: fix 2.1 version

data/Rakefile

@@ -196,9 +196,10 @@ namespace "config" do
         puts "Could not find rhodes application. Please verify your application setting in #{File.dirname(__FILE__)}/rhobuild.yml"
         exit 1
       end
-      $app_config = Jake.config(File.open(File.join($app_path, "build.yml")))
-
     end
+
+    $app_config = Jake.config(File.open(File.join($app_path, "build.yml")))
+
     Jake.set_bbver($app_config["bbver"].to_s)
     
     extpaths = []
@@ -506,42 +507,12 @@ def common_bundle_start(startdir, dest)
 end
 
 def create_manifest
-  dir = File.join($srcdir, 'apps')
-  #fname = "config.rb"
-  fappManifest = File.new( File.join(dir,'app_manifest.txt'), "w")
-  dir = File.join($srcdir, 'apps/app')
-
-  Find.find(dir) do |path|
-
-    strDir = File.dirname(path)
-    next unless dir == File.dirname(strDir) #one level only
+    require File.dirname(__FILE__) + '/lib/framework/rhoappmanifest'
     
-    if File.basename(path) == "config.rb"
-        puts "******ERROR enumerating models***********"
-        puts "Model definition has changed and doesn't use config.rb anymore: '#{path}' "
-        puts "You should replace config.rb with <model_name>.rb file as described: "
-        puts "http://wiki.rhomobile.com/index.php/Rhom#Rhom_Models"
-        puts "*****************************************"
-        exit 1
-    end
+    fappManifest = Rho::AppManifest.enumerate_models(File.join($srcdir, 'apps/app'))
+    content = fappManifest.read();
     
-    fname = File.dirname(path)
-    fname = File.basename(fname)
-    modelname = fname.split(/(?=[A-Z])/).map{|w| w.downcase}.join("_")
-    fname = modelname + ".rb"
-  
-    if File.basename(path) == fname
-
-      relPath = path[dir.length+1, File.dirname(path).length-1]   #relative path
-      relPath = relPath[0, relPath.length-3] #remove .rb extension and app
-      relPath = File.join(File.dirname(relPath), modelname )
-      fappManifest.puts( relPath )
-
-    end
-  end
-
-  fappManifest.close()
-  
+    File.open( File.join($srcdir,'apps/app_manifest.txt'), "w"){|file| file.write(content)}    
 end
 
 def process_exclude_folders

data/doc/build.txt

@@ -757,12 +757,12 @@ If you use Visual Studio 2010 : add path to `msbuild` to `rhobuild.yml` in rhode
 To build and run emulator run:
 
 	:::term
-	$ run:win32
+	$rake  run:win32
 
 To clean all binaries run:
 
 	:::term
-	$ clean:win32
+	$rake clean:win32
 
 ### Logging
 
@@ -827,43 +827,69 @@ Use it at your own risk!
 * 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)
-    
+
+### Build and run using Rhodes gem
+
+* Install Rhodes gem
+* Run application simulator:
+
+        $rake run:wp
+
+* Run application device:    
+
+        $rake run:wp:device
+
+* See log in application folder : rholog.txt
+
+NOTE: When running on device you may need to disconnect USB cable from device to see log
+
+* After Application code modifications, run rake commands. DO NOT close simulator!
+
+### Build from sources
+* Checkout rhodes source code from github 
 * 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 
+* Build IronRuby(Once)
 
-* 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
+        rake build:wp:ironruby
 
 ### Build from IDE
-* Checkout rhodes source code from github
-* Open the file `rhobuild.yml` using a text editor:
+#### IronRuby
+* 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' or 'Silverlight3Release|Any CPU' in solution configuration and build solution
 
-    define the path to your application
-    
+#### Rhodes
 * 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.
+* Select Debug or Release 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!
+* See log in VS output console (Debug mode only)
 
-### Logging
-See log in VS output console
+## RhoSimulator
+Currently it works only on Windows. 
+
+### Run using Rhodes gem
+Rhodes gem contain RhoSimulator, so just run in rhodes or application folder:
+    rake run:win32:rhosimulator
 
-### Run store sample
-* Checkout store sample:
+### Run without Rhodes gem
+* Download [RhoSimulator](http://rhosimulator.s3.amazonaws.com/RhoSimulator.zip) and unzip it.
 
-        $ git clone https://github.com/rhomobile/store.git
-        
-* Run application in emulator and login with empty credentials
+* Edit 'rhodes/rhobuild.yml':
 
+        env: 
+            paths:    
+                rhosimulator: <RhoSimulator folder>
+                
+* Run in rhodes or application folder:
+
+        rake run:win32:rhosimulator
+    
 ## How to set application name and icon
 
 ### Application Name

data/doc/device-caps.txt

@@ -25,6 +25,7 @@ Rhodes provide access to device specific capabilities such as GPS, PIM, camera,
 	<tr><td class='cap'>Signature Capture</td><td>2.1</td><td class='tbd'>2.5</td><td class='tbd'>2.5</td><td>2.1</td><tr>
 	<tr class='tbd'><td class='cap'>Audio/Video capture</td><td>3.0</td><td>3.0</td><td>3.0</td><td>3.0</td><tr>
 	<tr><td class='cap'>Bluetooth</td><td>2.2</td><td>2.2</td><td>2.2</td><td>2.2</td><tr>
+	<tr><td class='cap'>NFC</td><td class='tbd'>-</td><td class='tbd'>-</td><td class='tbd'>-</td><td>3.0</td><tr>
 	<tr><td class='cap'>Push</td><td>1.2</td><td class='tbd'>3.0</td><td>1.2</td><td>2.2</td><tr>
 	<tr><td class='cap'>Screen rotation</td><td>2.1</td><td class='tbd'>2.5</td><td>2.0</td><td>2.1</td><tr>
 	<tr><td class='cap'>Native Maps</td><td>1.4</td><td class='tbd'>2.5</td><td>1.4</td><td>1.5</td><tr>
@@ -567,6 +568,89 @@ It is not complete example (link to complete example see below). This code just
 
 You can find complete example of using Bluetooth API in [Rhodes-System-Api-Samples](http://github.com/rhomobile/rhodes-system-api-samples). See Bluetooth Chat Demo page - [BluetoothChat](http://github.com/rhomobile/rhodes-system-api-samples/tree/master/app/BluetoothChat/). In this example you can see how to exchange text messages between two different devices. You also can use this example for connect to external Bluetooth device (external GPS device for example) or PC or Mac (use terminal to see and send messages).
 
+
+## NFC
+
+NFC (Near Field Communication). NFC API provide access to NFC functionality. You can check NFC availability on current device and register callback for listen event when NFC tag near of device. Currently NFC supported only on Android. And also Android version must be 2.3 or later.
+NFC API implemented in native extension. You should add "nfc" to extension list in your nuild.yml before start using NFC in your application. And also do not forget enable NFC for start process NFC events - Rho::NFCManager.enable.
+
+### NFC API
+
+	:::ruby
+	module Rho
+ 	
+	class NFCManager
+ 	
+	
+	# 3-bit TNF (Type Name Format) field: Indicates how to interpret the type field
+	
+	  TNF_ABSOLUTE_URI = 3
+	  TNF_EMPTY = 0
+	  TNF_EXTERNAL_TYPE = 4
+	  TNF_MIME_MEDIA = 2
+	  TNF_UNCHANGED = 6
+	  TNF_UNKNOWN = 5
+	  TNF_WELL_KNOWN = 1
+	
+	
+	  # RTD Text types. For use with TNF_WELL_KNOWN
+  	
+	  RTD_TEXT = [0x54]   # "T"
+	  RTD_URI = [0x55] # "U"
+	  RTD_SMART_POSTER = [0x53, 0x70] # "Sp"
+	  RTD_ALTERNATIVE_CARRIER = [0x61, 0x63]   # "ac"
+	  RTD_HANDOVER_CARRIER = [0x48, 0x63] # "Hc"
+	  RTD_HANDOVER_REQUEST = [0x48, 0x72] # "Hr"
+	  RTD_HANDOVER_SELECT = [0x48, 0x73] # "Hs"
+	
+	
+	  # return true/false
+	  def self.is_supported
+	  end
+	  	
+	  def self.enable
+	  end
+	
+	  def self.disable
+	  end
+	
+	  # return true/false
+	  def self.is_enabled
+	  end
+	
+	  # in callback
+	  # @params['messages'] - array of messages (each message is hash)
+	  # message hash items : 
+	  #       'raw_message' - array of bytes (raw message)
+	  #       'records' - array of records (each record is hash)
+	  #              record hash items :
+	  #                     'raw_record' - array of bytes (raw record)
+	  #                     'id' - array of bytes
+	  #                     'payload' - array of bytes
+	  #                     'tnf' - int
+	  #                     'type' - array of bytes 
+	  #                     'payload_as_string' - string, payload prepared to string (support specail formats for URI, TEXT) 
+	  #                     'subrecords' - message hash (only for SMART_POSTER type)
+	  
+	  def self.set_nfc_callback(callback_url)
+	  end
+	
+	  def self.convert_Tnf_to_string(tnf)
+	  end
+	  
+	  def self.convert_RTD_to_string(rtd)
+	  end
+	 
+	end
+	
+	end
+
+
+### Example of NFC API using
+
+You can find complete example of using NFC API in [Rhodes-System-Api-Samples](http://github.com/rhomobile/rhodes-system-api-samples). See NFC Demo page - [NFC Demo](http://github.com/rhomobile/rhodes-system-api-samples/tree/master/app/Nfc/). 
+
+
 ## Ringtone manager
 
 The Ringtone manager API provides access to view/play the user's installed ringtones.
@@ -611,6 +695,38 @@ Next, your RhoSync application should be running on a network that is accessible
 
 Now your Rhodes application is configured to receive push messages.
 
+To handle push message in ruby code it's needed to register push callback
+
+    :::ruby
+    class AppApplication < Rho::RhoApplication
+      def initialize
+        super
+        System.set_push_notification "/app/Push/push_callback", ""
+      end
+    end
+
+Push callback set up in form of local application URL and called as callback nevermind rho_callback=1 specified in it's parameters list or not.
+There is several push message parameters that can be handled by Rhodes authomatically. These are:
+- alert
+- sound
+- vibrate
+- do_sync
+Every parameter can be specified in a push message body with its value:
+
+    :::text
+    alert=some message here&sound=alert.wav&vibrate=3&do_sync=sync_src1,sync_src2
+
+Automatic push message parameters handling takes its place in case no custom push callback or push callback returns "rho_push":
+
+    :::ruby
+    def push_callback
+    
+      # do some work here
+    
+      "rho_push"
+    end
+
+
 ### iPhone
 iPhone PUSH support uses the Apple Push Notification Service (APNS) introduced in iPhone SDK 3.0.  In order to use the service, you will need to obtain a push-enabled provisioning profile and a server-side push certificate used for encrypting RhoSync->APNS traffic.
 
@@ -659,10 +775,23 @@ Then modify your application's build.yml and specify there google account used t
 	android:
 	  push:
 	    sender: push-app@gmail.com
+        
 
 This is the same address used by RhoSync to retrieve authtoken. See [here](/rhosync/push#android) for more information.
 
-NOTE: **WARNING** This e-mail address MUST NOT be the same as origin of google account on phone! This mean that google account registered on your phone/emulator MUST NOT be push-app@gmail.com; it MUST be another one. This is known bug in Android C2DM implementation - if sender and receiver are the same, underlying android service crash and lose message. More details [here](http://groups.google.com/group/android-c2dm/browse_thread/thread/128790789c4e9d6a/67aca1e1764724d4). 
+NOTE: **WARNING** This e-mail address MUST NOT be the same as origin of google account on phone! This mean that google account registered on your phone/emulator MUST NOT be push-app@gmail.com; it MUST be another one. This is known bug in Android C2DM implementation - if sender and receiver are the same, underlying android service crash and lose message. More details [here](http://groups.google.com/group/android-c2dm/browse_thread/thread/128790789c4e9d6a/67aca1e1764724d4). This is actual not for all Android versions.
+
+At Android it is possible to set up status bar notifications for PUSH messages. In this case push message is handled by application only after user has opened the notification.
+There is two modes available for push notifications:
+ - <i>always</i> - push notification is shown always
+ - <i>background</i> - push notification is shown only if application is backgrounded (not started)
+If no push notification mode is specified in build.yml then no any notifications are shown at all.
+
+	:::yaml
+	android:
+	  push:
+	    notification: background
+        
 
 ### BlackBerry
 Notifications to BlackBerry are sent using PAP 2.0 message through a BES/MDS server.  

data/doc/rhom.txt

@@ -144,6 +144,12 @@ Next, change the include statement in `product.rb` to `include Rhom::FixedSchema
 	  property :price, :string
 	  property :quantity, :string
 	  property :sku, :string
+	  
+	  property :int_prop, :integer
+	  property :float_prop, :float
+	  property :date_prop, :date #translate to integer type
+	  property :time_prop, :time #translate to integer type
+	  
 	end
 
 That's it!  Now your model is a fixed schema model, the table will be generated automatically for you when the application launches.
@@ -528,10 +534,10 @@ Or multiple declarations:
 ## Accessing Sync Info with RhomSource
 Rhom exposes sync information as a `RhomSource` object.  You can use this information for alerts, status pages, etc.  
 
-To access a RhomSource, load it by id:
+To access a RhomSource, load it by name:
 
 	:::ruby
-	@source = RhomSource.find(@params['id'])
+	@source = RhomSource.find('source_name')
 
 Here are the available statistics:
 
@@ -560,7 +566,7 @@ For example, to show the formatted time for the `Product` model:
 
 	:::ruby
 	RhomSource.find(
-      Product.get_source_id
+      Product.get_source_name
     ).last_updated.strftime("%m/%d/%Y, %I:%M%p")
       #=> "01/19/2011, 06:40PM"
 

data/doc/test-log-debug.txt

@@ -126,11 +126,14 @@ To enable tcp debugging, you have two make a few small modifications to your app
 
 Include the extensions net-http and debugger in your build.yml.
 
-	extensions: ["net-http", "debugger"]
+	extensions:
+	- net-http
+	- debugger
 
-Modify your rhoconfig.txt add a line at the bottom debug_host. This should be set to an ip address of the machine that the debugger app is running on that is reachable by the phone or emulator.
+Modify your rhoconfig.txt add two lines at the bottom: debug_host and debug_port. This should be set to an ip address and port of the machine that the debugger app is running on that is reachable by the phone or emulator.
 
 	debug_host = '192.168.1.106'
+	debug_port = 9000
 
 Modify your application.rb. At the top of the application.rb file in your app, after the first require add the line:
 

data/lib/extensions/barcode/ext/barcode/platform/android/Rakefile

@@ -48,6 +48,9 @@ namespace "build" do
     $rootdir = ENV['RHO_ROOT']
     raise "RHO_ROOT is not set" if $rootdir.nil?
 
+    curdir = pwd
+    $barcodedir = curdir.gsub('/ext/barcode/platform/android','');
+
     require File.join($rootdir, 'platform/android/build/androidcommon.rb')
 
     setup_ndk(ENV['ANDROID_NDK'],ENV['ANDROID_API_LEVEL'])
@@ -61,28 +64,45 @@ namespace "build" do
 
     src_files = []
     src_files << fixed_path + '/barcode/shared/ruby/barcode_wrap.c'
-    src_files << fixed_path + '/barcode/shared/src/zbar.c'
-    src_files << fixed_path + '/barcode/shared/zbar/rho_bridge.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/error.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/code128.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/code39.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/ean.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/i25.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/processor/null.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/video/null.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/window/null.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/config.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/convert.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/image.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/img_scanner.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/refcnt.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/scanner.c'
-    src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/symbol.c'
-
-    src_files << fixed_path + '/barcode/platform/android/jni/src/imageprovider.cpp'
+    #src_files << fixed_path + '/barcode/shared/src/zbar.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/rho_bridge.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/error.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/code128.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/code39.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/ean.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder/i25.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/processor/null.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/video/null.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/window/null.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/config.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/convert.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/decoder.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/image.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/img_scanner.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/refcnt.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/scanner.c'
+    #src_files << fixed_path + '/barcode/shared/zbar/zbar/zbar/symbol.c'
+    #src_files << fixed_path + '/barcode/platform/android/jni/src/imageprovider.cpp'
+
+    src_files << fixed_path + '/barcode/platform/android/jni/src/barcode.cpp'
 
     build_extension('Barcode', $arch, src_files)
+
+    #build java part
+    javafiles = []	
+    File.open('ext_build.files', "r") do |f|
+        while line = f.gets
+           javafiles << line
+        end
+    end
+
+    flname = $targetdir + '/ext_build.files'
+    File.open(flname, "w") do |f|
+        javafiles.each do |j|
+            f.puts $barcodedir + '/' + j
+        end
+    end
+
   end
 end