ruboto 0.6.0 → 0.7.0

data/README.md

@@ -55,38 +55,9 @@ Ex:
 <a name="callback_generator"></a>
 ### Callback generator
 
-Can subclass any part of the Android API to pass control over to a script when the specified methods are called. You can also create classes that implement a single Android interface to pass control over to ruboto.
+You can subclass any part of the Android API to pass control over to a script when the specified methods are called. You can also create classes that implement a single Android interface to pass control over to ruboto.
 
-_Note: While the command line calls below still work, there is an easier way to do this within your scripts. The new way of generating interfaces and subclasses is described in the wiki [Generating classes for callbacks](https://github.com/ruboto/ruboto/wiki/Generating-classes-for-callbacks)._
-
-For classes that need subclassing (e.g., PhoneStateListener, SQLiteOpenHelper, View)
-
-    $ ruboto gen subclass AndroidPackageAndClassName --name YourClassName --method_base all-on-or-none --method_include methods --method_exclude methods
-Ex:
-    $ ruboto gen subclass android.telephony.PhoneStateListener --name MyPhoneStateListener --method_base on
-
-For interfaces that need implementing (e.g., OnClickListener or SensorListener)
-
-    $ ruboto gen interface AndroidPackageAndInterfaceName --name YourClassName
-Ex:
-    $ ruboto gen interface android.hardware.SensorListener --name MySensorListener
-
-Inside your script use: 
-
-    # note that this is different than java_import
-    ruboto_import "your.package.MySensorListener"
-
-Later:
-
-    # Create the callback object
-    @sensor_listener = MySensorListener.new
-
-    # Specify the block to call 
-    @sensor_listener.handle_sensor_changed do |sensor, values|
-      # Do stuff
-    end
-
-    # Register the listener
+Starting with Ruboto 0.6.0 there are easy ways to do this within your scripts. The new way of generating interfaces and subclasses is described in the wiki [Generating classes for callbacks](https://github.com/ruboto/ruboto/wiki/Generating-classes-for-callbacks)._
 
 <a name="packaging_task"></a>
 ### Packaging task
@@ -174,31 +145,24 @@ The main thing Ruboto offers you is the ability to write Ruby scripts to define
 
 Here's how it works:
 
-First of all, your scripts are found in `src/` and the script name is the same as the name of your class, only under_scored instead of CamelCased. Android classes have all of these methods that get called in certain situations. `Activity.onDestroy()` gets called when the activity gets killed, for example. Save weird cases (like the "launching" methods that need to setup JRuby), to script the method onFooBar, you call the Ruby method handle_foo_bar on the Android object. In your scripts, they are defined as `$class_name`. That was really abstract, so here's an example.
+First of all, your scripts are found in `src/` and the script name is the same as the name of your class, only under_scored instead of CamelCased. Android classes have all of these methods that get called in certain situations. `Activity.onDestroy()` gets called when the activity gets killed, for example. Save weird cases (like the "launching" methods that need to setup JRuby), to script the method onFooBar, you call the Ruby method on_foo_bar on the Android object. That was really abstract, so here's an example.
 
 You generate an app with the option `--activity FooActivity`, which means that ruboto will generate a FooActivity for you. So you open `src/foo_activity.rb` in your favorite text editor. If you want an activity that does nothing but Log when it gets launched and when it gets destroyed (in the onCreate and onPause methods). You want your script to look like this:
 
-    require 'ruboto.rb' #scripts will not work without doing this
-    $activity.handle_create do |bundle|
-      Log.v 'MYAPPNAME', 'onCreate got called!'
-      handle_pause do
-        Log.v 'MYAPPNAME', 'onPause got called!'
-      end
-    end
+    require 'ruboto/activity' #scripts will not work without doing this
 
-If you prefer, you can also do this. It's equivalent:
+    class FooActivity
+      include Ruboto::Activity
+      def on_create(bundle)
+        Log.v 'MYAPPNAME', 'onCreate got called!'
+      end
 
-    require 'ruboto.rb' #scripts will not work without doing this
-    $activity.handle_create do |bundle|
-      Log.v 'MYAPPNAME', 'onCreate got called!'
-    end
-    $activity.handle_pause do
-      Log.v 'MYAPPNAME', 'onPause got called!'
+      def on_pause
+        Log.v 'MYAPPNAME', 'onPause got called!'
+      end
     end
 
-Each class has only one method that you can nest other calls inside of (ie. what is happening in that first example that removes the need for the second `$activity.`). For Activities and Services, it is `handle_create`, and for BroadcastReceivers, it is `handle_receive`. The general rule is that it corresponds to the first method in the class's lifecycle. But you should never really have to think about it because generating a class generates a sample script that calls that method.
-
-The arguments passed to the block you give `handle_` methods are the same as the arguments that the java methods take. Consult the Android documentation.
+The arguments passed to the methods are the same as the arguments that the java methods take. Consult the Android documentation.
 
 Activities also have some special methods defined to make things easier. The easiest way to get an idea of what they are is looking over the [demo scripts](http://github.com/ruboto/ruboto-irb/tree/master/assets/demo-scripts/). You can also read the [ruboto.rb file](http://github.com/ruboto/ruboto/blob/master/assets/src/ruboto.rb) where everything is defined.
 

data/Rakefile

@@ -8,13 +8,12 @@ require 'net/http'
 
 PLATFORM_PROJECT = File.expand_path('tmp/RubotoCore', File.dirname(__FILE__))
 PLATFORM_DEBUG_APK = "#{PLATFORM_PROJECT}/bin/RubotoCore-debug.apk"
+PLATFORM_DEBUG_APK_BAK = "#{PLATFORM_PROJECT}/bin/RubotoCore-debug.apk.bak"
 PLATFORM_RELEASE_APK = "#{PLATFORM_PROJECT}/bin/RubotoCore-release.apk"
 PLATFORM_CURRENT_RELEASE_APK = "#{PLATFORM_PROJECT}/bin/RubotoCore-release.apk.current"
 MANIFEST_FILE = "AndroidManifest.xml"
 GEM_FILE = "ruboto-#{Ruboto::VERSION}.gem"
-GEM_FILE_OLD = "ruboto-core-#{Ruboto::VERSION}.gem"
 GEM_SPEC_FILE = 'ruboto.gemspec'
-GEM_SPEC_FILE_OLD = 'ruboto-core.gemspec'
 EXAMPLE_FILE = File.expand_path("examples/RubotoTestApp_#{Ruboto::VERSION}_tools_r#{Ruboto::SdkVersions::ANDROID_TOOLS_REVISION}.tgz", File.dirname(__FILE__))
 
 CLEAN.include('ruboto-*.gem', 'tmp')
@@ -22,18 +21,13 @@ CLEAN.include('ruboto-*.gem', 'tmp')
 task :default => :gem
 
 desc "Generate a gem"
-task :gem => [GEM_FILE, GEM_FILE_OLD]
+task :gem => GEM_FILE
 
 file GEM_FILE => GEM_SPEC_FILE do
   puts "Generating #{GEM_FILE}"
   `gem build #{GEM_SPEC_FILE}`
 end
 
-file GEM_FILE_OLD => GEM_SPEC_FILE_OLD do
-  puts "Generating #{GEM_FILE_OLD}"
-  `gem build #{GEM_SPEC_FILE_OLD}`
-end
-
 task :install => :gem do
   `gem query -i -n ^ruboto$ -v #{Ruboto::VERSION}`
   if $? != 0
@@ -44,6 +38,8 @@ task :install => :gem do
     else
       sh "sudo #{cmd}"
     end
+  else
+    puts "ruboto-#{Ruboto::VERSION} is already installed."
   end
 end
 
@@ -68,7 +64,6 @@ task :release => [:clean, :gem] do
   sh "git tag #{Ruboto::VERSION}"
   sh "git push --tags"
   sh "gem push #{GEM_FILE}"
-  sh "gem push #{GEM_FILE_OLD}"
 
   Rake::Task[:example].invoke
   sh "git add #{EXAMPLE_FILE}"
@@ -102,12 +97,6 @@ namespace :platform do
       manifest.root.attributes['android:installLocation'] = 'auto' # or 'preferExternal' ?
       File.open(MANIFEST_FILE, 'w') { |f| manifest.document.write(f, 4) }
       File.open('Gemfile.apk', 'w'){|f| f << "source :rubygems\n\ngem 'activerecord-jdbc-adapter'\n"}
-
-      # FIXME(uwe):  Add this when either jruby-openssl is simplified or most devices are Android 4
-      # FIXME(uwe):  Reeference: #154 and http://code.google.com/p/android/issues/detail?id=22586
-      # File.open('Gemfile.apk', 'w'){|f| f << "gem 'jruby-openssl'\n"}
-      # FIXME end
-
       File.open('ant.properties', 'a'){|f| f << "key.store=${user.home}/ruboto_core.keystore\nkey.alias=Ruboto\n"}
     end
   end
@@ -115,11 +104,16 @@ namespace :platform do
   desc 'Generate a Ruboto Core platform debug apk'
   task :debug => PLATFORM_DEBUG_APK
 
-  file PLATFORM_DEBUG_APK => PLATFORM_PROJECT do
+  task PLATFORM_DEBUG_APK do
+    Rake::Task[PLATFORM_PROJECT].invoke
     Dir.chdir(PLATFORM_PROJECT) do
       if File.exists?(PLATFORM_CURRENT_RELEASE_APK) && File.exists?(PLATFORM_DEBUG_APK) &&
           File.size(PLATFORM_CURRENT_RELEASE_APK) == File.size(PLATFORM_DEBUG_APK)
-        sh 'rake uninstall'
+        if File.exists?(PLATFORM_DEBUG_APK_BAK)
+          FileUtils.cp PLATFORM_DEBUG_APK_BAK, PLATFORM_DEBUG_APK
+        else
+          FileUtils.rm PLATFORM_DEBUG_APK
+        end
       end
       sh 'rake debug'
     end
@@ -135,23 +129,29 @@ namespace :platform do
   end
 
   desc 'Download the current RubotoCore platform release apk'
-  task :current => :debug do
-    Dir.chdir PLATFORM_PROJECT do
-      if !File.exists?(PLATFORM_CURRENT_RELEASE_APK)
-        puts 'Downloading the current RubotoCore platform release apk'
-        url = 'http://cloud.github.com/downloads/ruboto/ruboto/RubotoCore-release.apk'
-        File.open(PLATFORM_CURRENT_RELEASE_APK, 'w') { |f| f << Net::HTTP.get(URI.parse url) }
-      end
+  file PLATFORM_CURRENT_RELEASE_APK do
+    puts 'Downloading the current RubotoCore platform release apk'
+    url = 'http://cloud.github.com/downloads/ruboto/ruboto/RubotoCore-release.apk'
+    begin
+      File.open(PLATFORM_CURRENT_RELEASE_APK, 'w') { |f| f << Net::HTTP.get(URI.parse url) }
+    rescue Exception, SystemExit
+      FileUtils.rm(PLATFORM_CURRENT_RELEASE_APK) if File.exists?(PLATFORM_CURRENT_RELEASE_APK)
+      raise
+    end
+  end
 
+  desc 'Use the current RubotoCore platform release apk'
+  task :current => [:debug, PLATFORM_CURRENT_RELEASE_APK] do
+    Dir.chdir PLATFORM_PROJECT do
       if File.size(PLATFORM_CURRENT_RELEASE_APK) != File.size(PLATFORM_DEBUG_APK)
+        FileUtils.cp PLATFORM_DEBUG_APK, PLATFORM_DEBUG_APK_BAK
         FileUtils.cp PLATFORM_CURRENT_RELEASE_APK, PLATFORM_DEBUG_APK
-        sh 'rake uninstall'
       end
     end
   end
 
   desc 'Install the Ruboto Core platform debug apk'
-  task :install => PLATFORM_DEBUG_APK do
+  task :install => PLATFORM_PROJECT do
     Dir.chdir(PLATFORM_PROJECT) do
       sh 'rake install'
     end

data/assets/rakelib/ruboto.rake

@@ -19,6 +19,7 @@ UPDATE_MARKER_FILE = File.join(PROJECT_DIR, 'bin', 'LAST_UPDATE')
 BUNDLE_JAR         = File.expand_path 'libs/bundle.jar'
 BUNDLE_PATH        = File.expand_path 'bin/bundle'
 MANIFEST_FILE      = File.expand_path 'AndroidManifest.xml'
+PROJECT_PROPS_FILE = File.expand_path 'project.properties'
 RUBOTO_CONFIG_FILE = File.expand_path 'ruboto.yml'
 GEM_FILE           = File.expand_path('Gemfile.apk')
 GEM_LOCK_FILE      = File.expand_path('Gemfile.apk.lock')
@@ -142,7 +143,16 @@ task :uninstall do
   uninstall_apk
 end
 
-file MANIFEST_FILE
+file PROJECT_PROPS_FILE
+file MANIFEST_FILE => PROJECT_PROPS_FILE do
+  sdk_level = File.read(PROJECT_PROPS_FILE).scan(/(?:target=android-)(\d+)/)[0][0].to_i
+  old_manifest = File.read(MANIFEST_FILE)
+  manifest = old_manifest.dup
+  manifest.sub!(/(android:minSdkVersion=').*?(')/){|m| "#$1#{sdk_level}#$2"}
+  manifest.sub!(/(android:targetSdkVersion=').*?(')/){|m| "#$1#{sdk_level}#$2"}
+  File.open(MANIFEST_FILE, 'w'){|f| f << manifest} if manifest != old_manifest
+end
+
 file RUBOTO_CONFIG_FILE
 
 file APK_FILE => APK_DEPENDENCIES do |t|
@@ -330,9 +340,9 @@ end
 def package_installed? test = false
   package_name = "#{package}#{'.tests' if test}"
   ['', '-0', '-1', '-2'].each do |i|
-    p = "/data/app/#{package_name}#{i}.apk"
-    o = `adb shell ls -l #{p}`.chomp
-    if o =~ /^-rw-r--r-- system\s+system\s+(\d+) \d{4}-\d{2}-\d{2} \d{2}:\d{2} #{File.basename(p)}$/
+    path = "/data/app/#{package_name}#{i}.apk"
+    o = `adb shell ls -l #{path}`.chomp
+    if o =~ /^-rw-r--r-- system\s+system\s+(\d+) \d{4}-\d{2}-\d{2} \d{2}:\d{2} #{File.basename(path)}$/
       apk_file = test ? TEST_APK_FILE : APK_FILE
       if !File.exists?(apk_file) || $1.to_i == File.size(apk_file)
         return true
@@ -344,8 +354,6 @@ def package_installed? test = false
   return nil
 end
 
-private
-
 def replace_faulty_code(faulty_file, faulty_code)
   explicit_requires = Dir["#{faulty_file.chomp('.rb')}/*.rb"].sort.map { |f| File.basename(f) }.map do |filename|
     "require 'active_model/validations/#{filename}'"
@@ -380,14 +388,27 @@ def build_apk(t, release)
 end
 
 def install_apk
+  failure_pattern = /^Failure \[(.*)\]/
+  success_pattern = /^Success/
   case package_installed?
   when true
     puts "Package #{package} already installed."
     return
   when false
-    puts "Package installed, but of wrong size."
+    puts "Package #{package} already installed, but of different size.  Replacing package."
+    output = `adb install -r #{APK_FILE} 2>&1`
+    return if $? == 0 && output !~ failure_pattern && output =~ success_pattern
+    case $1
+    when 'INSTALL_PARSE_FAILED_INCONSISTENT_CERTIFICATES'
+      puts "Found package signed with different certificate.  Uninstalling it and retrying install."
+    else
+      puts "'adb install' returned an unknown error: (#$?) #{$1 ? "[#$1}]" : output}."
+      puts "Uninstalling #{package} and retrying install."
+    end
+    uninstall_apk
   end
-  sh 'ant installd'
+  output = `adb install #{APK_FILE} 2>&1`
+  raise "Install failed (#{$?}) #{$1 ? "[#$1}]" : output}" if $? != 0 || output =~ failure_pattern || output !~ success_pattern
   clear_update
 end
 
@@ -405,7 +426,6 @@ def update_scripts
   `adb shell mkdir -p #{scripts_path}` if !device_path_exists?(scripts_path)
   puts "Pushing files to apk public file area."
   last_update = File.exists?(UPDATE_MARKER_FILE) ? Time.parse(File.read(UPDATE_MARKER_FILE)) : Time.parse('1970-01-01T00:00:00')
-  # TODO(uwe): Use `adb sync src` instead?
   Dir.chdir('src') do
     Dir["**/*.rb"].each do |script_file|
       next if File.directory? script_file

data/assets/samples/sample_activity.rb

@@ -4,20 +4,30 @@ require 'ruboto/util/toast'
 
 ruboto_import_widgets :Button, :LinearLayout, :TextView
 
-$activity.start_ruboto_activity "$sample_activity" do
-  setTitle 'This is the Title'
+# http://xkcd.com/378/
+
+class SampleActivity
+  include Ruboto::Activity
 
   def on_create(bundle)
+    set_title 'Domo arigato, Mr Ruboto!'
+
     self.content_view =
-        linear_layout(:orientation => :vertical) do
-          @text_view = text_view :text => 'What hath Matz wrought?', :id => 42
-          button :text => 'M-x butterfly', :width => :wrap_content, :id => 43,
-                    :on_click_listener => @handle_click
+        linear_layout :orientation => :vertical do
+          @text_view = text_view :text    => 'What hath Matz wrought?', :id => 42, :width => :fill_parent,
+                                 :gravity => android.view.Gravity::CENTER, :text_size => 48.0
+          button :text => 'M-x butterfly', :width => :fill_parent, :id => 43, :on_click_listener => proc { butterfly }
         end
+  rescue
+    puts "Exception creating activity: #{$!}"
+    puts $!.backtrace.join("\n")
   end
 
-  @handle_click = proc do |view|
-      @text_view.text = 'What hath Matz wrought!'
-      toast 'Flipped a bit via butterfly'
+  private
+
+  def butterfly
+    @text_view.text = 'What hath Matz wrought!'
+    toast 'Flipped a bit via butterfly'
   end
+
 end

data/assets/samples/sample_broadcast_receiver.rb

@@ -2,7 +2,9 @@ require 'ruboto/broadcast_receiver'
 
 import android.util.Log
 
-RubotoBroadcastReceiver.new_with_callbacks do
+class SampleBroadcastReceiver
+  include Ruboto::BroadcastReceiver
+
   # will get called whenever the BroadcastReceiver receives an intent (whenever onReceive is called)
   def on_receive(context, intent)
     Log.v "SampleBroadcastReceiver", 'Broadcast received!'

data/assets/samples/sample_service.rb

@@ -1,17 +1,17 @@
 require 'ruboto/service'
 require 'ruboto/util/toast'
 
-$context.start_ruboto_service do
-  # Services are complicated and don't really make sense unless you
-  # show the interaction between the Service and other parts of your
-  # app.
-  # For now, just take a look at the explanation and example in
-  # online:
-  # http://developer.android.com/reference/android/app/Service.html
+# Services are complicated and don't really make sense unless you
+# show the interaction between the Service and other parts of your
+# app.
+# For now, just take a look at the explanation and example in
+# online:
+# http://developer.android.com/reference/android/app/Service.html
+class SampleService
+  include Ruboto::Service
 
   def on_start_command(intent, flags, startId)
     toast "Hello from the service"
-    self.class::START_NOT_STICKY
+    android.app.Service::START_NOT_STICKY
   end
-
 end

data/assets/src/InheritingActivity.java

@@ -4,7 +4,7 @@ import android.os.Bundle;
 
 public class InheritingActivity extends org.ruboto.EntryPointActivity {
 	public void onCreate(Bundle bundle) {
-		setScriptName("start.rb");
+		setScriptName("sample_activity.rb");
 	    super.onCreate(bundle);
 	}
 }

data/assets/src/InheritingBroadcastReceiver.java

@@ -1,20 +1,20 @@
 package THE_PACKAGE;
 
-import org.ruboto.Script;
+import org.ruboto.JRubyAdapter;
 
 public class InheritingBroadcastReceiver extends org.ruboto.RubotoBroadcastReceiver {
     private boolean scriptLoaded = false;
 
     public InheritingBroadcastReceiver() {
-        super("start.rb");
-        if (Script.isInitialized()) {
+        super("sample_broadcast_receiver.rb");
+        if (JRubyAdapter.isInitialized()) {
             scriptLoaded = true;
         }
     }
 
     public void onReceive(android.content.Context context, android.content.Intent intent) {
         if (!scriptLoaded) {
-            if (Script.setUpJRuby(context)) {
+            if (JRubyAdapter.setUpJRuby(context)) {
                 loadScript();
                 scriptLoaded = true;
             } else {

data/assets/src/InheritingClass.java

@@ -1,6 +1,6 @@
 package THE_PACKAGE;
 
-import org.ruboto.Script;
+import org.ruboto.JRubyAdapter;
 
 public class THE_RUBOTO_CLASS THE_ACTION THE_ANDROID_CLASS {
 

data/assets/src/InheritingService.java

@@ -2,7 +2,8 @@ package THE_PACKAGE;
 
 public class InheritingService extends org.ruboto.RubotoService {
 	public void onCreate() {
-		setScriptName("start.rb");
+	    System.out.println("InheritingService.onCreate()");
+		setScriptName("sample_service.rb");
 		super.onCreate();
 	}
 

data/assets/src/RubotoActivity.java

@@ -5,19 +5,14 @@ import java.io.IOException;
 import org.ruboto.Script;
 
 import android.app.ProgressDialog;
-import android.content.Intent;
-import android.net.Uri;
 import android.os.Bundle;
-import android.os.Handler;
-import android.util.Log;
-import android.view.View;
-import android.widget.TextView;
 
 public class THE_RUBOTO_CLASS THE_ACTION THE_ANDROID_CLASS {
     private String scriptName;
     private String remoteVariable = null;
     private Object[] args;
     private Bundle configBundle = null;
+    private Object rubyInstance;
 
 THE_CONSTANTS
 
@@ -67,31 +62,45 @@ THE_CONSTANTS
 
         super.onCreate(bundle);
     
-        if (Script.isInitialized()) {
+        if (JRubyAdapter.isInitialized()) {
             prepareJRuby();
     	    loadScript();
         }
     }
 
+    // TODO(uwe):  Only needed for non-class-based definitions
+    // Can be removed if we stop supporting non-class-based definitions
     // This causes JRuby to initialize and takes a while.
     protected void prepareJRuby() {
-        Script.put("$context", this);
-        Script.put("$activity", this);
-        Script.put("$bundle", args[0]);
+    	JRubyAdapter.put("$context", this);
+    	JRubyAdapter.put("$activity", this);
+    	JRubyAdapter.put("$bundle", args[0]);
     }
+    // TODO end
 
     protected void loadScript() {
         try {
             if (scriptName != null) {
-    	        Script.setScriptFilename(getClass().getClassLoader().getResource(scriptName).getPath());
-                Script.execute(new Script(scriptName).getContents());
+                String rubyClassName = Script.toCamelCase(scriptName);
+                System.out.println("Looking for Ruby class: " + rubyClassName);
+                Object rubyClass = JRubyAdapter.get(rubyClassName);
+                if (rubyClass == null) {
+                    System.out.println("Loading script: " + scriptName);
+                    JRubyAdapter.exec(new Script(scriptName).getContents());
+                    rubyClass = JRubyAdapter.get(rubyClassName);
+                }
+                if (rubyClass != null) {
+                    System.out.println("Instanciating Ruby class: " + rubyClassName);
+                    rubyInstance = JRubyAdapter.callMethod(rubyClass, "new", this, Object.class);
+                    JRubyAdapter.callMethod(rubyInstance, "on_create", args[0]);
+                }
             } else if (configBundle != null) {
-                // TODO: Why doesn't this work? 
-                // Script.callMethod(this, "initialize_ruboto");
-                Script.execute("$activity.initialize_ruboto");
                 // TODO: Why doesn't this work?
-                // Script.callMethod(this, "on_create", args[0]);
-                Script.execute("$activity.on_create($bundle)");
+                // JRubyAdapter.callMethod(this, "initialize_ruboto");
+            	JRubyAdapter.execute("$activity.initialize_ruboto");
+                // TODO: Why doesn't this work?
+                // JRubyAdapter.callMethod(this, "on_create", args[0]);
+            	JRubyAdapter.execute("$activity.on_create($bundle)");
             }
         } catch(IOException e){
             e.printStackTrace();