pindah 0.1.0.alpha → 0.1.0

data/Manifest.txt

@@ -5,7 +5,15 @@ Rakefile
 bin/pindah
 lib/pindah.rb
 lib/pindah_cli.rb
-templates/initial_activity.mirah
+templates/AndroidManifest.xml
 templates/build.xml
+templates/main.xml
+templates/strings.xml
+templates/Rakefile
+templates/initial_activity.mirah
+templates/.gitignore
+templates/res/drawable-mdpi/ic_launcher.png
+templates/res/drawable-hdpi/ic_launcher.png
+templates/res/drawable-ldpi/ic_launcher.png
 test/fixtures/HelloWorld.mirah
 test/pindah_cli_test.rb

data/README.md

@@ -1,4 +1,4 @@
-# pindah
+# Pindah
 
 A tool for writing Android applications in [Mirah](http://mirah.org).
 
@@ -11,7 +11,7 @@ download "platform" packages corresponding with Android versions you
 wish to develop against. You'll need to install "Android SDK Platform
 tools" and at least one platform revision to get started. At the time
 of this writing, Android 2.1 (revision 7)
-[covers most of the market](http://developer.android.com/resources/dashboard/platform-versions.html)
+[covers over 90% of the market](http://developer.android.com/resources/dashboard/platform-versions.html)
 and is a reasonable target for new applications. Once the platform
 tools are installed, place the SDK's <tt>platform-tools/</tt>
 directory on your $PATH as well.
@@ -24,16 +24,42 @@ and rake commands with jruby -S:
 
 ## Usage
 
-See [Garrett](http://github.com/technomancy/Garrett) for an example of
-basic usage.
-
-TODO: project template creation is not complete
+The <tt>pindah</tt> executable will create a new project starting
+point given a package name. A package is a namespace for your code
+that is often derived from a domain name you own, but can be any
+hierarchical identifier as long as it's unique.
 
-    $ pindah hello.world hello_world [HelloActivity]
+    $ pindah create org.example.hello_world # optional path and activity name arguments
 
     $ cd hello_world && tree
-
-    [TODO: project skeleton listing]
+    .
+    |-- AndroidManifest.xml
+    |-- libs
+    |-- Rakefile
+    |-- res
+    |   |-- drawable-hdpi
+    |   |   `-- ic_launcher.png
+    |   |-- drawable-ldpi
+    |   |   `-- ic_launcher.png
+    |   |-- drawable-mdpi
+    |   |   `-- ic_launcher.png
+    |   |-- layout
+    |   |   `-- main.xml
+    |   `-- values
+    |       `-- strings.xml
+    `-- src
+        `-- org
+            `-- example
+                `-- hello_world
+                    `-- Start.mirah
+
+    12 directories, 8 files
+
+The <tt>res/</tt> directory contains application resources like icons,
+layout descriptions, and strings. The <tt>AndroidManifest.xml</tt>
+describes the contents and metadata of your application. The
+<tt>src</tt> directory contains the source code inside your package
+directory.
 
     $ rake -T
     
@@ -47,6 +73,29 @@ TODO: project template creation is not complete
     rake spec       # Print the project spec
     rake uninstall  # Uninstalls the application from a running emulator or dev...
 
+    $ rake debug
+    
+    # [...]
+    
+    $ ls -l bin/hello_world-debug.apk
+
+    -rw-r--r--   1 user           user        13222 Feb  7 23:16 bin/hello_world-debug.apk
+
+This .apk file may be installed on a connected device or emulator with
+<tt>rake install</tt>. It may even distributed for users to install
+themselves, though stable versions should use the <tt>release</tt>
+task. 
+
+The official documentation has
+[more details on building](http://developer.android.com/guide/developing/other-ide.html#Building). The
+main difference between Pindah and the standard Ant build is that the
+Rakefile replaces build.xml as well as all the properties files. The
+page above also explains how to get an emulator running for testing
+your application.
+
+See [Garrett](http://github.com/technomancy/Garrett) for an example of
+a basic project.
+
 ## See Also
 
 If Mirah is just too low-level and you need something more dynamic,

data/bin/pindah

@@ -1,10 +1,9 @@
 #!/usr/bin/env ruby
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'pindah_cli'))
+
 begin
-  PindahCLI.create *ARGV
+  PindahCLI.send *ARGV
 rescue ArgumentError
-  puts "Usage: #{File.basename(__FILE__)} org.mirah.HelloWorld ~/hello_world [HelloActivity]"
+  abort "Usage: #{File.basename($0)} create org.example.hello [/path/to/hello_world] [HelloActivity]"
 end
-
-abort "TODO: create project skeleton: rakefile, manifest, resources"

data/lib/pindah.rb

@@ -12,7 +12,7 @@ end
 require "mirah"
 
 module Pindah
-  VERSION = '0.1.0.alpha'
+  VERSION = '0.1.0'
 
   def self.infer_sdk_location(path)
     tools = path.split(":").detect {|p| File.exists? "#{p}/android" }
@@ -25,6 +25,9 @@ module Pindah
     :sdk => Pindah.infer_sdk_location(ENV["PATH"])
   }
 
+  TARGETS = { "1.5" => 3, "1.6" => 4,
+    "2.1" => 7, "2.2" => 8, "2.3" => 9 }
+
   ANT_TASKS = ["clean", "javac", "compile", "debug", "release",
                "install", "uninstall"]
 
@@ -43,15 +46,16 @@ module Pindah
   task :default => [:install]
 
   def self.spec=(spec)
-    abort "Must provide :target version in Pindah.spec!" if !spec[:target]
+    abort "Must provide :target_version in Pindah.spec!" if !spec[:target_version]
     abort "Must provide :name in Pindah.spec!" if !spec[:name]
 
     @spec = DEFAULTS.merge(spec)
 
     @spec[:root] = File.expand_path "."
+    @spec[:target] ||= TARGETS[@spec[:target_version].to_s.sub(/android-/, '')]
     @spec[:classes] ||= "#{@spec[:output]}/classes"
     @spec[:classpath] << @spec[:classes]
-    @spec[:classpath] << "#{@spec[:sdk]}/platforms/#{@spec[:target]}/android.jar"
+    @spec[:classpath] << "#{@spec[:sdk]}/platforms/android-#{@spec[:target]}/android.jar"
     @spec[:log_spec] ||= "ActivityManager:I #{@spec[:name]}:D " +
       "AndroidRuntime:E *:S"
 
@@ -68,8 +72,10 @@ module Pindah
     File.open(build, "w") { |f| f.puts build_template.result(binding) }
     at_exit { File.delete build }
 
-    { "target" => @spec[:target],
-      "target-version" => @spec[:target],
+    # TODO: add key signing config
+    { "target" => "android-#{@spec[:target]}",
+      "target-version" => "android-#{@spec[:target_version]}",
+      "src" => @spec[:src],
       "sdk.dir" => @spec[:sdk],
       "classes" => @spec[:classes],
       "classpath" => @spec[:classpath].join(Java::JavaLang::System::
@@ -78,7 +84,6 @@ module Pindah
       @ant.project.set_user_property(key, value)
     end
 
-    # TODO: compile task execs mirahc instead of running inside current JVM
     Ant::ProjectHelper.configure_project(@ant.project, java.io.File.new(build))
 
     # Turn ant tasks into rake tasks

data/lib/pindah_cli.rb

@@ -1,42 +1,72 @@
 require 'fileutils'
+require 'erb'
 
 module PindahCLI
-  DEFAULT_TARGET = 'android-7'
-  DEFAULT_VERSION = 'android-2.1'
+  DEFAULT_TARGET_VERSION = '2.1'
 
-  def self.log(msg)
-    STDERR.puts msg
-  end
-  
-  def self.create(namespace, location, activity_name=nil)
-    segments = namespace.split('.')
+  def self.create(package, location=nil, activity_name="Start")
+    segments = package.split('.')
+    location ||= segments.last
     src_dir  = File.join(location, 'src', *segments)
+
+    mkdir location, File.join('src', *segments)
+    mkdir location, 'libs'
+    mkdir location, 'res'
+    mkdir location, 'res/drawable-hdpi'
+    mkdir location, 'res/drawable-ldpi'
+    mkdir location, 'res/drawable-mdpi'
+    mkdir location, 'res/layout'
+    mkdir location, 'res/values'
+
+    name = location.split("/").last
+    app_name = name.split(/[-_]/).map{ |w| w.capitalize }.join(" ")
+
     FileUtils.mkdir_p src_dir
-    log "Created '#{src_dir}'."
 
-    spec_location = File.join(location, 'Pindah.spec')
-    spec_template = File.read(File.join(File.dirname(__FILE__), 
-                                        '..', 'templates', 
-                                        'Pindah.spec'))
+    create_templated("Rakefile", location, binding)
+    create_templated("AndroidManifest.xml", location, binding)
+    create_templated("main.xml", File.join(location, 'res', 'layout'), binding)
+    create_templated("strings.xml", File.join(location, 'res', 'values'), binding)
+    create_templated(".gitignore", location, binding)
 
-    File.open(spec_location, 'w') do |f|
-      f.puts spec_template.gsub(/PROJECT_NAME/, segments[-1]).
-        gsub(/API_TARGET/, DEFAULT_TARGET).
-        gsub(/API_VERSION/, DEFAULT_VERSION)
+    # Default icons of various sizes
+    ["hdpi", "mdpi", "ldpi"].each do |s|
+      FileUtils.cp(File.join(File.dirname(__FILE__), '..', 'templates', "res",
+                             "drawable-#{s}", "ic_launcher.png"),
+                   File.join(location, "res", "drawable-#{s}", "ic_launcher.png"))
     end
-    log "Created Pindah spec file in '#{spec_location}'."
+    
+    log "Created project in #{location}."
 
+    activity_location = File.join(src_dir, "#{activity_name}.mirah")
+    activity_template = File.read(File.join(File.dirname(__FILE__),
+                                            '..', 'templates',
+                                            'initial_activity.mirah'))
 
-    if activity_name
-      activity_location = File.join(src_dir, "#{activity_name}.mirah")
-      activity_template = File.read(File.join(File.dirname(__FILE__),
-                                              '..', 'templates',
-                                              'initial_activity.mirah'))
+    File.open(activity_location, 'w') do |f|
+      f.puts activity_template.gsub(/INITIAL_ACTIVITY/, activity_name)
+    end
+    log "Created Activity '#{activity_name}' in '#{activity_location}'."
+  end
 
-      File.open(activity_location, 'w') do |f|
-        f.puts activity_template.gsub(/INITIAL_ACTIVITY/, activity_name)
-      end
-      log "Created Activity '#{activity_name}' in '#{activity_location}'."
+  private
+  def self.log(msg)
+    STDERR.puts msg
+  end
+
+  def self.create_templated(name, project_location, scope)
+    location = File.join(project_location, name)
+    template = File.read(File.join(File.dirname(__FILE__), 
+                                   '..', 'templates', name))
+
+    File.open(location, 'w') do |f|
+      f.puts ERB.new(template).result(scope)
     end
   end
+
+  def self.mkdir(base, directory)
+    location = File.join(base, directory)
+    FileUtils.mkdir_p location
+    log "Created '#{location}'."
+  end
 end

data/templates/.gitignore

@@ -0,0 +1,2 @@
+bin
+gen

data/templates/AndroidManifest.xml

@@ -0,0 +1,19 @@
+<?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/app_name" 
+                 android:debuggable="true"
+                 android:icon="@drawable/ic_launcher" >
+      <% if activity_name %>
+        <activity android:name="<%= activity_name %>"
+                  android:label="@string/app_name">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+      <% end %>
+    </application>
+</manifest> 

data/templates/Rakefile

@@ -0,0 +1,7 @@
+require "rubygems"
+require "pindah"
+
+Pindah.spec = {
+  :name => "<%= name %>",
+  :target_version => "<%= DEFAULT_TARGET_VERSION %>"
+}

data/templates/build.xml

@@ -10,13 +10,20 @@
         classname="com.android.ant.SetupTask"
         classpathref="android.antlibs" />
 
+    <taskdef name="mirahc" classname="org.mirah.ant.Compile" />
+
+    <!-- TODO: better support for mixed-source builds -->
     <target name="javac" description="Compiles R.java and other gen/ files.">
-      <javac srcdir="gen" destdir="${classes}" includeantruntime="false" />
+      <javac srcdir="gen" destdir="${classes}" 
+             includeantruntime="false" failonerror="true" />
     </target>
 
     <target name="compile" depends="-resource-src, -aidl, javac"
             description="Compiles project's .mirah files into .class files">
-      <exec executable="mirahc" dir="src">
+      <!-- TODO: mirahc task doesn't infer package correctly.
+           <mirahc src="${src}" destdir="${classes}" 
+           classpath="${classpath}" /> -->
+      <exec executable="mirahc" dir="src" failonerror="true">
         <arg line="-c ${classpath}" />
         <arg line="-d ${classes}" />
         <arg value="." />

data/templates/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, <%= name %>"
+    />
+</LinearLayout>
+

data/templates/strings.xml

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

data/test/pindah_cli_test.rb

@@ -1,50 +1,85 @@
 require 'test/unit'
-require 'tempfile'
+require 'tmpdir'
 require 'fileutils'
 require 'rubygems'
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'pindah_cli'))
 
 class PindahCLITest < Test::Unit::TestCase
+  PWD = File.expand_path(File.dirname(__FILE__))
+
+  def fixture(name)
+    File.read(File.join(PWD, 'fixtures', name))
+  end
+
   def setup
-    $local_pwd ||= File.expand_path(File.dirname(__FILE__))
-    @project_path = File.expand_path(Tempfile.new('pindah').path + ".d")
-    FileUtils.mkdir_p @project_path
-    Dir.chdir @project_path
+    @temp = Dir.mktmpdir("pindah-")
+    @project_path = "#{@temp}/testapp"
+    FileUtils.mkdir_p File.dirname(@temp)
+    Dir.chdir File.dirname(@temp)
+    PindahCLI.create('tld.pindah.testapp', @project_path, 'HelloWorld')
   end
 
   def teardown
-    FileUtils.rm_rf @project_path
+    FileUtils.rm_rf @temp
   end
 
   def test_create_should_create_basic_project_structure
     PindahCLI.create('tld.pindah.testapp', '.')
     assert File.directory?(File.join(@project_path, 'src', 'tld', 'pindah', 'testapp'))
+
+    directories = %w{ src/tld/pindah/testapp bin libs res
+                      res/drawable-hdpi res/drawable-ldpi
+                      res/drawable-mdpi res/layout res/values }
+
+    directories.each do |d|
+      expected = File.join(@project_path, d)
+      assert File.directory?(expected), "Expected #{expected.inspect} to be a directory."
+    end
   end
 
-  def test_create_should_create_pindah_spec_file
-    PindahCLI.create('tld.pindah.testapp', '.')
-    assert File.exists?(File.join(@project_path, 'Pindah.spec'))
+  def test_create_should_create_rakefile
+    rake_path = File.join(@project_path, 'Rakefile')
 
-    expected = File.read(File.join($local_pwd,
-                                  'fixtures',
-                                  'Pindah.spec'))
-    actual   = File.read(File.join(@project_path,
-                                  'Pindah.spec'))
-    assert_equal expected, actual
+    assert File.exists?(rake_path)
+    assert_equal fixture("Rakefile"), File.read(rake_path)
   end
 
   def test_create_should_create_an_activity_if_desired
-    PindahCLI.create('tld.pindah.testapp', '.', 'HelloWorld')
-
-    expected = File.read(File.join($local_pwd,
-                                   'fixtures',
-                                   'HelloWorld.mirah'))
-    actual   = File.read(File.join(@project_path,
-                                   'src',
-                                   'tld',
-                                   'pindah',
-                                   'testapp',
-                                   'HelloWorld.mirah'))
-    assert_equal expected, actual
+    actual = File.read(File.join(@project_path, 'src',
+                                 'tld', 'pindah',
+                                 'testapp', 'HelloWorld.mirah'))
+    assert_equal fixture('HelloWorld.mirah'), actual
+  end
+
+  def test_create_should_create_manifest
+    manifest_path = File.join(@project_path, 'AndroidManifest.xml')
+
+    assert File.exists?(manifest_path)
+    assert_equal fixture("AndroidManifest.xml").gsub(/\s+/, ' '), File.read(manifest_path).gsub(/\s+/, ' ')
+  end
+
+  def test_create_should_create_manifest_without_activity
+    @temp = Dir.mktmpdir("pindah-")
+    @project_path = "#{@temp}/testapp"
+    FileUtils.mkdir_p File.dirname(@temp)
+    Dir.chdir File.dirname(@temp)
+    PindahCLI.create('tld.pindah.testapp', @project_path)
+
+    manifest_path = File.join(@project_path, 'AndroidManifest.xml')
+
+    assert File.exists?(manifest_path)
+    assert_equal fixture("AndroidManifest.xml.no-activity").gsub(/\s+/, ' '), File.read(manifest_path).gsub(/\s+/, ' ')
+  end
+
+  def test_create_should_create_strings
+    path = File.join(@project_path, 'res', 'values', 'strings.xml')
+    assert File.exists?(path)
+    assert_equal fixture("strings.xml").strip, File.read(path).strip
+  end
+  
+  def test_create_should_create_layout
+    path = File.join(@project_path, 'res', 'layout', 'main.xml')
+    assert File.exists?(path)
+    assert_equal fixture("main.xml").strip, File.read(path).strip
   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: pindah
 version: !ruby/object:Gem::Version 
-  prerelease: 6
-  version: 0.1.0.alpha
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
   - Phil Hagelberg
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 -08:00
+date: 2011-02-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -53,8 +53,16 @@ files:
   - bin/pindah
   - lib/pindah.rb
   - lib/pindah_cli.rb
-  - templates/initial_activity.mirah
+  - templates/AndroidManifest.xml
   - templates/build.xml
+  - templates/main.xml
+  - templates/strings.xml
+  - templates/Rakefile
+  - templates/initial_activity.mirah
+  - templates/.gitignore
+  - templates/res/drawable-mdpi/ic_launcher.png
+  - templates/res/drawable-hdpi/ic_launcher.png
+  - templates/res/drawable-ldpi/ic_launcher.png
   - test/fixtures/HelloWorld.mirah
   - test/pindah_cli_test.rb
 has_rdoc: true
@@ -76,9 +84,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.1
+        version: "0"
 requirements: []
 
 rubyforge_project: pindah