protoform 0.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+gem "rubigen", "> 1.5.2"
+
+gem "shoulda", ">= 0"
+gem "bundler", "~> 1.0.0"
+gem "jeweler", "~> 1.5.1"
+gem "rcov", ">= 0"

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.3.10)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9-java)
+    rubigen (1.5.5)
+      activesupport (~> 2.3.5)
+    shoulda (2.11.3)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  rubigen (> 1.5.2)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nick Plante
+
+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/README.md

@@ -0,0 +1,51 @@
+# protoform
+
+A protoform is a building block, a start point for building droidy things.
+This little gem generates an application skeleton for a Mirah Android
+application. Because Android is exciting, but Java is still kinda painful.
+
+## Installation Prereqs
+
+If you don't already have the Android SDK, download it from 
+http://developer.android.com/sdk/index.html and follow the quick-start 
+instructions. You'll need to create an Android Virtual Device (AVD) using the
+Android Manager (`android`) found in the SDK.
+
+You'll also want to have Mirah installed of course. You can get it from
+GitHub: https://github.com/mirah/mirah
+
+Make sure that mirah and mirahc are in your PATH as well as the Android SDK
+tools directory.
+
+## Usage
+
+Install the gem and run the generator, specifying the package name you want to
+use and the Android SDK location:
+
+    gem install protoform
+    protoform -S ~/android/sdk -T "Hello Android" -P org.zerosum.android HelloWorld
+
+This should generate an app skeleton in the directory `HelloWorld`. Change to
+that directory and run the ant debug task:
+
+    ant debug
+
+Assuming that your prerequisites are all set and the task succeeds, you should
+now have a .apk file in your bin/ directory. Fire up the Android AVD Manager
+(`android`) to launch the emulator, and install the APK using the adb tool:
+
+    adb install bin/HelloWorld-debug.apk
+
+You should now be able to navigate to the applications list in the emulator
+and launch your application.
+
+## Thanks
+
+This work is based on / inspired by Technomancy's Android/Mirah experiments.
+
+If you'd like to help out, contributions are definitely welcome. Mirah is
+very slick, and with a little work we can make it a great alternative to
+Java for Android development. Transform and roll out!
+
+Copyright (c) 2010 Nick Plante. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "protoform"
+  gem.homepage = "http://github.com/zapnap/protoform"
+  gem.license = "MIT"
+  gem.summary = %Q{Generates a basic skeleton for a Mirah Android application}
+  gem.description = gem.summary
+  gem.executables = ["protoform"]
+  gem.email = "nap@zerosum.org"
+  gem.authors = ["Nick Plante"]
+  gem.add_runtime_dependency 'rubigen', '>= 1.5.5'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "protoform #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/protoform

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require File.join(File.dirname(__FILE__), '..', 'lib', 'protoform')
+  puts "#{File.basename($0)} #{Miradrogen::VERSION}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+
+RubiGen::Base.prepend_sources(*[ 
+  RubiGen::PathSource.new(:android, File.join(File.dirname(__FILE__), "..", "lib", "generators"))
+])
+
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => "android")

data/lib/generators/android/USAGE

@@ -0,0 +1,7 @@
+Description:
+    The 'protoform' command generates a new Mirah Android application with a
+    default directory structure and configuration. 
+
+Example:
+    protoform -S /path/to/android/sdk -P org.zerosum.android HelloWorld
+

data/lib/generators/android/android_generator.rb

@@ -0,0 +1,83 @@
+require 'rbconfig'
+
+class AndroidGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  DEFAULT_PACKAGE  = "org.zerosum.android"
+
+  attr_accessor :app_name, :package, :title, :author, :sdk_path
+
+  default_options :author   => "Your Name", 
+                  :sdk_path => "~/android/sdk"
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+
+    @destination_root = args.shift
+    @app_name     = File.basename(File.expand_path(@destination_root)).underscore.camelize
+
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      m.directory ""
+      BASEDIRS.each { |dir| m.directory dir }
+
+      m.directory "src/#{package.gsub('.', '/')}"
+      m.template  "application.mirah",          "src/#{package.gsub('.', '/')}/#{app_name}.mirah"
+
+      m.template  "AndroidManifest.xml",        "AndroidManifest.xml"
+      m.template  "build.xml",                  "build.xml"
+
+      m.template  "README.md",                  "README.md"
+
+      m.template  "build.properties",           "build.properties"
+      m.template  "default.properties",         "default.properties"
+      m.template  "local.properties",           "local.properties"
+
+      m.directory "res/layout"
+      m.directory "res/values"
+      m.template  "res/layout/main.xml",        "res/layout/main.xml"
+      m.template  "res/values/strings.xml",     "res/values/strings.xml"
+
+      m.directory "res/drawable-hdpi"
+      m.template  "res/drawable-hdpi/icon.png", "res/drawable-hdpi/icon.png"
+      m.directory "res/drawable-ldpi"
+      m.template  "res/drawable-ldpi/icon.png", "res/drawable-ldpi/icon.png"
+      m.directory "res/drawable-mdpi"
+      m.template  "res/drawable-mdpi/icon.png", "res/drawable-mdpi/icon.png"
+      
+      # TODO: add tests, yo
+    end
+  end
+
+  protected
+
+  def banner
+    "Usage: #{$0} [options] app-name"
+  end
+
+  def extract_options
+    self.package  = (options[:package] ||= DEFAULT_PACKAGE)
+    self.title    = (options[:title] ||= app_name.humanize)
+    self.sdk_path = (options[:sdk_path] ||= sdk_path)
+    self.author   = (options[:author] ||= author)
+  end
+
+  def add_options!(opts)
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on("-P", "--package org.zerosum.android", String,
+           "Package name for the application you're creating.",
+           "Default: org.zerosum.android") { |opt| options[:package] = opt }
+    opts.on("-S", "--sdkpath /path/to/android/sdk", String,
+           "Path to the Android SDK installed on your system.",
+           "Default: ~/android/sdk") { |opt| options[:sdk_path] = opt }
+    opts.on("-T", "--title \"Hello World\"", String,
+           "Title (display name) for the application.") { |opt| options[:title] = opt }
+  end
+
+  BASEDIRS = %w(res src)
+end

data/lib/generators/android/templates/AndroidManifest.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+      package="<%= package %>"
+      android:versionCode="1"
+      android:versionName="1.0">
+    <application android:label="@string/title" android:icon="@drawable/icon">
+        <activity android:name="<%= app_name %>"
+                  android:label="@string/title">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+</manifest> 

data/lib/generators/android/templates/README.md

@@ -0,0 +1,8 @@
+# <%= app_name %>
+
+Description goes here.
+
+## Copyright
+
+Copyright (c) <%= Time.now.year %> <%= author %>. See LICENSE.txt for for futher details.
+

data/lib/generators/android/templates/application.mirah

@@ -0,0 +1,14 @@
+import "android.app.Activity"
+import "android.os.Bundle"
+import "android.widget.TextView"
+import "android.content.Context"
+
+class <%= app_name %> < Activity
+  def onCreate(savedInstanceState:Bundle)
+    super(savedInstanceState)
+    # cast to Context should be unnecessary
+    tv = TextView.new(Context(self))
+    tv.setText("Hello World!")
+    setContentView(tv)
+  end
+end

data/lib/generators/android/templates/build.properties

@@ -0,0 +1,17 @@
+# This file is used to override default values used by the Ant build system.
+# 
+# This file must be checked in Version Control Systems, as it is
+# integral to the build system of your project.
+
+# This file is only used by the Ant script.
+
+# You can use this to override default values such as
+#  'source.dir' for the location of your java source folder and
+#  'out.dir' for the location of your output folder.
+
+# You can also use it define how the release builds are signed by declaring
+# the following properties:
+#  'key.store' for the location of your keystore and
+#  'key.alias' for the name of the key to use.
+# The password will be asked during the build when you use the 'release' target.
+

data/lib/generators/android/templates/build.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="<%= app_name %>" default="help">
+
+    <!-- The local.properties file is created and updated by the 'android' tool.
+         It contains the path to the SDK. It should *NOT* be checked in in Version
+         Control Systems. -->
+    <property file="local.properties" />
+
+    <!-- The build.properties file can be created by you and is never touched
+         by the 'android' tool. This is the place to change some of the default property values
+         used by the Ant rules.
+         Here are some properties you may want to change/update:
+
+         application.package
+             the name of your application package as defined in the manifest. Used by the
+             'uninstall' rule.
+         source.dir
+             the name of the source directory. Default is 'src'.
+         out.dir
+             the name of the output directory. Default is 'bin'.
+
+         Properties related to the SDK location or the project target should be updated
+          using the 'android' tool with the 'update' action.
+
+         This file is an integral part of the build system for your application and
+         should be checked in in Version Control Systems.
+
+         -->
+    <property file="build.properties" />
+
+    <!-- The default.properties file is created and updated by the 'android' tool, as well
+         as ADT.
+         This file is an integral part of the build system for your application and
+         should be checked in in Version Control Systems. -->
+    <property file="default.properties" />
+
+    <!-- Custom Android task to deal with the project target, and import the proper rules.
+         This requires ant 1.6.0 or above. -->
+    <path id="android.antlibs">
+        <pathelement path="${sdk.dir}/tools/lib/anttasks.jar" />
+        <pathelement path="${sdk.dir}/tools/lib/sdklib.jar" />
+        <pathelement path="${sdk.dir}/tools/lib/androidprefs.jar" />
+        <pathelement path="${sdk.dir}/tools/lib/apkbuilder.jar" />
+        <pathelement path="${sdk.dir}/tools/lib/jarutils.jar" />
+    </path>
+
+    <taskdef name="setup"
+        classname="com.android.ant.SetupTask"
+        classpathref="android.antlibs" />
+
+    <!-- Execute the Android Setup task that will setup some properties specific to the target,
+         and import the build rules files.
+
+         The rules file is imported from
+            <SDK>/platforms/<target_platform>/templates/android_rules.xml
+
+         To customize some build steps for your project:
+         - copy the content of the main node <project> from android_rules.xml
+         - paste it in this build.xml below the <setup /> task.
+         - disable the import by changing the setup task below to <setup import="false" />
+
+         This will ensure that the properties are setup correctly but that your customized
+         build steps are used.
+    -->
+    <setup />
+
+    <target name="compile" depends="-resource-src, -aidl"
+            description="Compiles project's .mirah files into .class files">
+      <exec executable="mirahc" dir="src">
+        <env key="CLASSPATH" file="${android.jar}" />
+        <arg value="-d" />
+        <arg value="../bin/classes/" />
+        <arg value="." />
+      </exec>
+    </target>
+        
+</project>

data/lib/generators/android/templates/default.properties

@@ -0,0 +1,12 @@
+# This file is automatically generated by Android Tools.
+# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
+# 
+# This file must be checked in Version Control Systems.
+# 
+# To customize properties used by the Ant build system use,
+# "build.properties", and override values to adapt the script to your
+# project structure.
+
+# Project target.
+target=android-8
+target-version=android-2.2

data/lib/generators/android/templates/local.properties

@@ -0,0 +1,10 @@
+# This file is automatically generated by Android Tools.
+# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
+# 
+# This file must *NOT* be checked in Version Control Systems,
+# as it contains information specific to your local configuration.
+
+# location of the SDK. This is only used by Ant
+# For customization when using a Version Control System, please read the
+# header note.
+sdk.dir=<%= sdk_path %>

data/lib/generators/android/templates/res/layout/main.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    android:orientation="vertical"
+    android:layout_width="fill_parent"
+    android:layout_height="fill_parent"
+    >
+<TextView  
+    android:layout_width="fill_parent" 
+    android:layout_height="wrap_content" 
+    android:text="Hello World!"
+    />
+</LinearLayout>
+

data/lib/generators/android/templates/res/values/strings.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="title"><%= title %></string>
+</resources>

data/lib/protoform.rb

@@ -0,0 +1,3 @@
+class Protoform
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'protoform'
+
+class Test::Unit::TestCase
+end

data/test/protoform.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestProtoform < Test::Unit::TestCase
+  should "add some tests" do
+    flunk "tests are good... even for generators..."
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: protoform
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 1
+    - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+  - Nick Plante
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-28 00:00:00 -05:00
+default_executable: protoform
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rubigen
+    version_requirements: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">"
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 5
+              - 2
+            version: 1.5.2
+    requirement: *id001
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: shoulda
+    version_requirements: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    requirement: *id002
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    version_requirements: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 0
+              - 0
+            version: 1.0.0
+    requirement: *id003
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: jeweler
+    version_requirements: &id004 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 5
+              - 1
+            version: 1.5.1
+    requirement: *id004
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: rcov
+    version_requirements: &id005 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    requirement: *id005
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: rubigen
+    version_requirements: &id006 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 5
+              - 5
+            version: 1.5.5
+    requirement: *id006
+    prerelease: false
+    type: :runtime
+description: Generates a basic skeleton for a Mirah Android application
+email: nap@zerosum.org
+executables: 
+  - protoform
+extensions: []
+
+extra_rdoc_files: 
+  - LICENSE.txt
+  - README.md
+files: 
+  - Gemfile
+  - Gemfile.lock
+  - LICENSE.txt
+  - README.md
+  - Rakefile
+  - VERSION
+  - bin/protoform
+  - lib/generators/android/USAGE
+  - lib/generators/android/android_generator.rb
+  - lib/generators/android/templates/AndroidManifest.xml
+  - lib/generators/android/templates/README.md
+  - lib/generators/android/templates/application.mirah
+  - lib/generators/android/templates/build.properties
+  - lib/generators/android/templates/build.xml
+  - lib/generators/android/templates/default.properties
+  - lib/generators/android/templates/local.properties
+  - lib/generators/android/templates/res/drawable-hdpi/icon.png
+  - lib/generators/android/templates/res/drawable-ldpi/icon.png
+  - lib/generators/android/templates/res/drawable-mdpi/icon.png
+  - lib/generators/android/templates/res/layout/main.xml
+  - lib/generators/android/templates/res/values/strings.xml
+  - lib/protoform.rb
+  - test/helper.rb
+  - test/protoform.rb
+has_rdoc: true
+homepage: http://github.com/zapnap/protoform
+licenses: 
+  - MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Generates a basic skeleton for a Mirah Android application
+test_files: 
+  - test/helper.rb
+  - test/protoform.rb