ruboto 0.5.2

data/COPYING

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Daniel Jackoway, Charles Nutter, Scott Moyer, Uwe Kubosch
+
+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/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'main'
+gem 'jruby-jars'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    arrayfields (4.7.4)
+    chronic (0.6.2)
+    fattr (2.2.0)
+    jruby-jars (1.6.4)
+    main (4.7.3)
+      arrayfields (~> 4.7.4)
+      chronic (~> 0.6.2)
+      fattr (~> 2.2.0)
+      map (~> 4.3.0)
+    map (4.3.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  jruby-jars
+  main

data/README.md

@@ -0,0 +1,293 @@
+Ruboto
+=============
+
+Ruby on Android.
+
+Installation
+-------
+
+    $ gem install ruboto
+
+Getting Started
+---------------
+
+Before you use Ruboto, you should do the following things:
+
+* Install the JDK if it's not on your system already
+* Install [jruby](http://jruby.org/) if you don't already have it. JRuby has a [very easy install process](http://jruby.org/#2), or you can use [rvm](http://rvm.beginrescueend.com/)
+* Install [the Android SDK](http://developer.android.com/sdk/index.html)
+* Add the sdk's `tools/` directory to your `$PATH`
+* Generate an [Emulator](http://developer.android.com/guide/developing/tools/emulator.html) image unless you want to develop using your phone.
+
+General Information
+------------------
+
+The Rakefile assumes that you are in the root directory of your app, as do all commands of the `ruboto` command line utility, other than `ruboto gen app`.
+
+The Rakefile requires you to run it through JRuby's rake. 
+
+Command-line Tools
+-------
+
+* [Application generator](#application_generator) (like the rails application generator)
+* [Class generator](#class_generator) to generate additional Activities, BroadcastReceivers, Services, etc.
+* [Callback generator](#class_generator) to generate specific subclasses to open up access (callbacks) for various portions of the Android API.
+* [Packaging task](#packaging_task) to generate an apk file
+* [Deployment task](#deployment_task) to deploy a generated package to an emulator or connected device
+* [Develop without having to compile to try every change](#update_scripts)
+
+
+<a name="application_generator"></a>
+### Application generator
+
+    $ ruboto gen app --package com.yourdomain.whatever --path path/to/where/you/want/the/app --name NameOfApp --target android-version --min-sdk another-android-version --activity MainActivityName
+Version values must be specified using'android-' and the sdk level number (e.g., android-8 is froyo).
+
+<a name="class_generator"></a>
+### Class generator
+
+Generates a Java class (Activity, Service, or BroadcastReceiver) associated with a specific ruboto script.  The generator also generates a corrsponding test script.
+
+    $ ruboto gen class ClassName --name YourObjectName
+Ex:
+    $ ruboto gen class BroadcastReceiver --name AwesomenessReceiver
+
+<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.
+
+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
+
+<a name="packaging_task"></a>
+### Packaging task
+
+This will generate an apk file.
+
+    $ rake
+
+To generate an apk and install it to a connected device (or emulator) all in one go, run
+
+    $ rake install
+
+<a name="deployment_task"></a>
+### Deployment task
+
+When you're ready to post your app to the Market, you need to do a few things.
+
+First, you'll need to generate a key to sign the app with using `keytool` if you do not already have one. If you're ok with accepting some sane defaults, you can use
+    $ ruboto gen key --alias alias_for_your_key
+with an optional flag `--keystore /path/to/keystore.keystore`, which defaults to `~/.android/production.keystore`. It will ask for a password for the keystore and one for the key itself. Make sure that you remember those two passwords, as well as the alias for the key. 
+
+Also make sure to keep your key backed up (if you lose it, you won't be able to release updates to your app that can install right over the old versions), but secure.
+
+Once you have your key, use the `rake publish` task to generate a market-ready `.apk` file. You will need the `RUBOTO_KEYSTORE` and `RUBOTO_KEY_ALIAS` environment variables set to the path to the keystore and the alias for the key, respectively. So either run
+    $ RUBOTO_KEYSTORE=~/.android/production.keystore RUBOTO_KEY_ALIAS=foo rake publish
+or set those environment variables in your `~/.bashrc` or similar file and just run
+    $ rake publish
+Now get that `.apk` to the market!
+
+<a name="update_scripts"></a>
+### Updating Your Scripts on a Device
+
+With traditional Android development, you have to recompile your app and reinstall it on your test device/emulator every time you make a change. That's slow and annoying.
+
+Luckily, with Ruboto, most of your changes are in the scripts, not in the compiles Java files. So if your changes are Ruby-only, you can just run
+
+    $ rake update_scripts
+
+to have it copy the current version of your scripts to your device.
+
+Sorry if this takes away your excuse to have sword fights:
+
+![XKCD Code's Compiling](http://imgs.xkcd.com/comics/compiling.png)
+
+Caveats:
+
+This only works if your changes are all Ruby. If you have Java changes (which would generally just mean generating new classes) or changes to the xml, you will need to recompile your script.
+
+Also, you need root access to your device for this to work, as it needs to write to directories that are read-only otherwise. The easiest solution is to test on an emulator, but you can also root your phone.
+
+### Updating Ruboto's Files
+
+You can update various portions of your generated Ruboto app through the ruboto command:
+
+* JRuby:
+ 
+1) If a new version of JRuby is released, you should update your gem (e.g., sudo gem update jruby-jars).
+
+2) From the root directory of your app: 
+
+    $ ruboto update jruby
+
+* The ruboto.rb script:
+
+1) From the root directory of your app: 
+
+    $ ruboto update ruboto
+
+* The core classes (e.g., RubotoActivity):
+
+1) These classes are generated on your machine based on the SDKs (min and target) specified when you 'gen app' (stored in the AndroidManifest.xml)
+
+2) You many want to regenerate them if a new version of the SDK is released, if you change your targets, or if you want more control over the callbacks you receive.
+
+3) From the root directory of your app:
+
+    $ ruboto gen core Activity --method_base all-on-or-none --method_include specific-methods-to-include --method_include specific-methods-to-exclude
+
+4) The generator will load up the SDK information and find the specified methods. The generator will abort around methods that were added or deprecated based on the SDK levels. You can either use method_exclude to remove methods individually or add '--force exclude' to remove the all. You can also us '--force include' to create them anyway (added methods are created without calling super to avoid crashin on legacy hardware).
+
+Scripts
+-------
+
+The main thing Ruboto offers you is the ability to write Ruby scripts to define the behavior of Activites, BroadcastReceievers, and Services. (Eventually it'll be every class. It's setup such that adding in more classes should be trivial.)
+
+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.
+
+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
+
+If you prefer, you can also do this. It's equivalent:
+
+    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!'
+    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.
+
+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.
+
+Testing
+-------
+
+For each generated class, a ruby test script is created in the test/assets/scripts directory.
+For example if you generate a RubotoSampleAppActivity a file test/assets/scripts/ruboto_sample_app_activity_test.rb
+file is created containing a sample test script:
+
+    activity Java::org.ruboto.sample_app.RubotoSampleAppActivity
+
+    setup do |activity|
+      start = Time.now
+      loop do
+        @text_view = activity.findViewById(42)
+        break if @text_view || (Time.now - start > 60)
+        sleep 1
+      end
+      assert @text_view
+    end
+
+    test('initial setup') do |activity|
+      assert_equal "What hath Matz wrought?", @text_view.text
+    end
+
+    test('button changes text') do |activity|
+      button = activity.findViewById(43)
+      button.performClick
+      assert_equal "What hath Matz wrought!", @text_view.text
+    end
+
+You run the tests for your app using ant or rake
+
+    $ jruby -S rake test
+
+    $ cd test ; ant run-tests
+
+Contributing
+------------
+
+Want to contribute? Great! Meet us in #ruboto on irc.freenode.net, fork the project and start coding!
+
+"But I don't understand it well enough to contribute by forking the project!" That's fine. Equally helpful:
+
+* Use Ruboto and tell us how it could be better.
+* As you gain wisdom, contribute it to [the wiki](http://github.com/ruboto/ruboto/wiki/)
+* When you gain enough wisdom, reconsider whether you could fork the project.
+
+If contributing code to the project, please run the exising tests and add tests for your changes.  You run the tests using rake
+
+    $ jruby -S rake test
+
+Getting Help
+------------
+
+* You'll need to be pretty familiar with the Android API. The [Developer Guide](http://developer.android.com/guide/index.html) and [Reference](http://developer.android.com/reference/packages.html) are very useful. 
+* There is further documentation at the [wiki](http://github.com/ruboto/ruboto/wiki)
+* If you have bugs or feature requests, [open an issue on GitHub](http://github.com/ruboto/ruboto/issues)
+* You can ask questions in #ruboto on irc.freenode.net and on the [mailing list](http://groups.google.com/groups/ruboto)
+* There are some sample scripts (just Activities) [here](http://github.com/ruboto/ruboto-irb/tree/master/assets/demo-scripts/)
+
+Tips & Tricks
+-------------
+
+### Emulators
+
+If you're doing a lot of Android development, you'll probably find yourself typing `emulator -avd name_of_emulator` a lot to open emulators. It can be convenient to alias these to shorter commands.
+
+For example, in your `~/.bashrc`, `~/.zshrc`, or similar file, you might put
+    alias eclair="emulator -avd eclair"
+    alias froyo="emulator -avd froyo"
+If you have an "eclair" emulator that runs Android 2.1 and a "froyo" one that runs Android 2.2.
+
+
+Alternatives
+------------
+
+If Ruboto's performance is a problem for you, or you want something that gives you total access to the android API (as Ruboto does not yet do), check out [Mirah](http://mirah.org/) and [Garrett](http://github.com/technomancy/Garrett). 
+
+Mirah, formerly known as Duby, is a language with Ruby-like syntax that compiles to java files. This means that it adds no big runtime dependencies and has essentially the same performance as writing Java code because it essentially generates the same Java code that you would write. This makes it extremely well-suited for mobile devices where performance is a much bigger consideration. 
+
+Garrett is a "playground for Mirah exploration on Android."
+
+
+Domo Arigato
+------------
+
+Thanks go to:
+
+* Charles Nutter, a member of the JRuby core team, for mentoring this RSoC project and starting the Ruboto project in the first place with an [irb](http://github.com/ruboto/ruboto-irb)
+* All of Ruby Summer of Code's [sponsors](http://rubysoc.org/sponsors)
+* [Engine Yard](http://engineyard.com/) in particular for sponsoring RSoC and heavily sponsoring JRuby, which is obviously critical to the project.
+* All [contributors](http://github.com/ruboto/ruboto/contributors) and [contributors to the ruboto-irb project](http://github.com/ruboto/ruboto-irb/contributors), as much of this code was taken from ruboto-irb.

data/Rakefile

@@ -0,0 +1,114 @@
+require 'rexml/document'
+require 'lib/ruboto/version'
+
+PLATFORM_PROJECT = File.expand_path('tmp/RubotoCore', File.dirname(__FILE__))
+PLATFORM_DEBUG_APK = "#{PLATFORM_PROJECT}/bin/RubotoCore-debug.apk"
+PLATFORM_RELEASE_APK = "#{PLATFORM_PROJECT}/bin/RubotoCore-release.apk"
+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'
+
+# FIXME(uwe):  Remove when we stop supporting JRuby 1.5.6
+if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.8.0')
+  gem_spec = Gem::Specification.find_by_path 'jruby-jars'
+else
+  gem_spec = Gem.searcher.find('jruby-jars')
+end
+raise StandardError.new("Can't find Gem specification jruby-jars.") unless gem_spec
+JRUBY_JARS_VERSION = gem_spec.version
+ON_JRUBY_JARS_1_5_6 = JRUBY_JARS_VERSION == Gem::Version.new('1.5.6')
+# FIXME end
+
+
+task :default => :gem
+
+desc "Generate a gem"
+task :gem => [GEM_FILE, GEM_FILE_OLD]
+
+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
+
+desc "Push the gem to RubyGems"
+task :release => :gem do
+  output = `git status --porcelain`
+  raise "Workspace not clean!\n#{output}" unless output.empty?
+  sh "git tag #{Ruboto::VERSION}"
+  sh "git push --tags"
+  sh "gem push #{GEM_FILE}"
+  sh "gem push #{GEM_FILE_OLD}"
+  
+end
+
+desc "Run the tests"
+task :test do
+  FileUtils.rm_rf Dir['tmp/RubotoTestApp_template*']
+  Dir['test/*_test.rb'].each do |f|
+    require f.chomp('.rb')
+  end
+end
+
+namespace :platform do
+  desc 'Remove Ruboto Core platform project'
+  task :clean do
+    FileUtils.rm_rf PLATFORM_PROJECT
+  end
+
+  desc 'Generate the Ruboto Core platform project'
+  task :project => PLATFORM_PROJECT
+
+  file PLATFORM_PROJECT do
+    sh "ruby -rubygems -I#{File.expand_path('lib', File.dirname(__FILE__))} bin/ruboto gen app --package org.ruboto.core --name RubotoCore --with-jruby #{'--with-psych' unless ON_JRUBY_JARS_1_5_6} --path #{PLATFORM_PROJECT}"
+    Dir.chdir(PLATFORM_PROJECT) do
+      manifest = REXML::Document.new(File.read(MANIFEST_FILE))
+      manifest.root.attributes['android:versionCode'] = '408'
+      manifest.root.attributes['android:versionName'] = '0.4.8.dev'
+      manifest.root.attributes['android:installLocation'] = 'auto' # or 'preferExternal' ?
+      manifest.root.elements['uses-sdk'].attributes['android:targetSdkVersion'] = '8'
+      File.open(MANIFEST_FILE, 'w') { |f| manifest.document.write(f, 4) }
+      File.open('project.properties', 'w'){|f| f << "target=android-8\n"}
+      File.open('Gemfile.apk', 'w'){|f| f << "source :rubygems\n\ngem 'activerecord-jdbc-adapter'\n"}
+      keystore_file = File.expand_path('~/android_market.keystore')
+      if File.exists?(keystore_file)
+        File.open('local.properties', 'a'){|f| f << "key.store=#{keystore_file}\nkey.alias=android_market\n"}
+      end
+    end
+  end
+
+  file PLATFORM_DEBUG_APK => PLATFORM_PROJECT do
+    Dir.chdir(PLATFORM_PROJECT) do
+      sh 'rake debug'
+    end
+  end
+
+  desc 'Generate a Ruboto Core platform release apk'
+  task :release => PLATFORM_RELEASE_APK
+
+  file PLATFORM_RELEASE_APK => PLATFORM_PROJECT do
+    Dir.chdir(PLATFORM_PROJECT) do
+      sh 'rake release'
+    end
+  end
+
+  desc 'Install the Ruboto Core platform debug apk'
+  task :install => PLATFORM_DEBUG_APK do
+    Dir.chdir(PLATFORM_PROJECT) do
+      sh 'rake install'
+    end
+  end
+
+  desc 'Uninstall the Ruboto Core platform debug apk'
+  task :uninstall => PLATFORM_PROJECT do
+    Dir.chdir(PLATFORM_PROJECT) do
+      sh 'rake uninstall'
+    end
+  end
+end