https://github.com/ruboto/ruboto

A platform for developing apps using JRuby on Android.
https://github.com/ruboto/ruboto

Last synced: 3 days ago
JSON representation

A platform for developing apps using JRuby on Android.

• Host: GitHub
• URL: https://github.com/ruboto/ruboto
• Owner: ruboto
• License: mit
• Created: 2010-06-17T19:20:59.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2023-05-15T11:51:06.000Z (over 1 year ago)
• Last Synced: 2024-09-22T06:02:50.470Z (6 days ago)
• Language: Ruby
• Homepage: http://ruboto.org/
• Size: 112 MB
• Stars: 2,026
• Watchers: 99
• Forks: 158
• Open Issues: 80
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ruby - Ruboto - A platform for developing full stand-alone apps for Android using the Ruby language and libraries. (Mobile Development)

README

        
# Ruboto 2

Ruboto 2 is a redesign based on an [Android Studio](https://developer.android.com/studio/) workflow.

This means that the JRuby and Ruboto components will integrate into the standard gradle tooling used by

regular Android Studio projects.

## Starting a new Ruboto project

* Download and install [Android studio](https://developer.android.com/studio/).

* Choose "Create New Project" in the startup screen.

  * Choose "Phone and Tablet" and "No Activity" for the project template.

  * Choose "Java" for your language and "Minimum SDK" should be "**API 27: Android 8.1 (Oreo)**" or higher.

* Add a **jcenter** to the `dependencyResolutionManagement/repositories` section of your `settings.gradle` file:

  ```groovy

  dependencyResolutionManagement {

      ...

      repositories {

          ...

          jcenter()

      }

  }

  ```

* Add the these dependencies to your `app/build.gradle` file:

  ```groovy

  dependencies {

    ...

    implementation fileTree(dir: 'libs', include: ['*.jar'])

    implementation 'com.linkedin.dexmaker:dexmaker:2.19.1'

    implementation 'me.qmx.jitescript:jitescript:0.4.1'

    implementation 'com.jakewharton.android.repackaged:dalvik-dx:7.1.0_r7'

  }

  ```

* Add `gems.rb` file:

  ```ruby

  source 'https://rubygems.org/'

  gem 'ruboto', '~>2.0.dev', git: 'https://github.com/ruboto/ruboto.git'

  ```

* Ensure you are using JRuby on the command line

  Create a `.ruby-version` file:

  ```text

    jruby

  ```

* Initialize Ruboto:

  ```shell

  jruby -S bundle

  jruby -S bundle exec ruboto init

  ```

  This will copy the core files to your project.

* Add `app/gems.rb`

  ```ruby

  source 'https://rubygems.org/'

  gem 'activerecord', '~>7.0'

  gem 'activerecord-jdbc-adapter', '~>70.1'

  gem 'sqldroid', '~>1.0'

  ```

* Add `app/update_jruby_jar.sh`:

  ```shell

  #!/usr/bin/env bash

  set -e

  VERSION="9.4.2.0"

  FULL_VERSION="${VERSION}"

  # FULL_VERSION="${VERSION}-SNAPSHOT" # Uncomment to use a local snapshot

  # FULL_VERSION="${VERSION}-20190822.050313-17" # Uncomment to use a remote snapshot

  JAR_FILE="jruby-complete-${FULL_VERSION}.jar"

  DOWNLOAD_DIR="$HOME/Downloads"

  DOWNLOADED_JAR="${DOWNLOAD_DIR}/${JAR_FILE}"

  SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )

  cd $SCRIPT_DIR

  [ ! -d $HOME/Downloads ] && mkdir $HOME/Downloads  # Create the directory if we don't find it

  [ ! -d ./libs ] && mkdir ./libs                    # Create the directory if we don't find it

  cd libs

  rm -f bcpkix-jdk15on-*.jar bcprov-jdk15on-*.jar bctls-jdk15on-*.jar cparse-jruby.jar generator.jar jline-*.jar jopenssl.jar jruby-complete-*.jar parser.jar psych.jar readline.jar snakeyaml-*.jar

  if test -f "${DOWNLOADED_JAR}"; then

    echo "Found downloaded JAR"

  else

    echo No "${DOWNLOADED_JAR}" - Downloading.

    curl "https://oss.sonatype.org/service/local/repositories/releases/content/org/jruby/jruby-complete/${VERSION}/jruby-complete-${VERSION}.jar" -o "${DOWNLOADED_JAR}"

  fi

  cp ${DOWNLOADED_JAR} .

  unzip -o -j ${JAR_FILE} '*.jar'

  # FIXME(uwe): Why do we delete these files?

  zip generator.jar -d json/ext/ByteListTranscoder.class

  zip generator.jar -d json/ext/OptionsReader.class

  zip generator.jar -d json/ext/Utils.class

  zip generator.jar -d json/ext/RuntimeInfo.class

  cd - >/dev/null

  cd src/main/java

  find * -type f | grep "org/jruby/" | sed -e 's/\.java//g' | sort > ../../../overridden_classes.txt

  cd - >/dev/null

  while read p; do

    unzip -Z1 libs/${JAR_FILE} | grep "$p\\.class" > classes.txt

    unzip -Z1 libs/${JAR_FILE} | egrep "$p(\\\$[^$]+)*\\.class" >> classes.txt

    if [[ -s classes.txt ]] ; then

      zip -d -@ libs/${JAR_FILE} /dev/null

  ```

* Make `app/update_jruby_jar.sh` executable:

  ```shell

    chmod u+x app/update_jruby_jar.sh

  ```

* Generate `jruby.jar`:

  ```shell

    app/update_jruby_jar.sh

  ```

* Generate the startup activity:

  ```shell

    bundle exec ruboto gen class Activity --name StartupActivity

  ```

* Add the startup activity intent filter to the new activity tag in `app/src/main/AndroidManifest.xml`:

  ```xml

  

      

          

          

          

      

  

  ```

* Declare the Ruboto components and SplashActivity in `app/src/main/AndroidManifest.xml`

  ```xml

  

  

  

  

  ```

  **Rember to sync the gradle config after the changes.**

 

* Start your app!

## Updating app gems

Update your `app/gems.rb` (or `app/Gemfile`) and run

  ```shell

  bundle exec rake bundle

  ```

## Adding Ruboto to an existing Android Studio project

HOWTO missing.  Pull requests welcome!

# Ruboto 1.x

Looking for Ruboto 1.x?  Switch to the [ruboto_1.x](https://github.com/ruboto/ruboto/tree/ruboto_1.x) branch.