andparcel 0.1.0

data/lib/andparcel/parcel.rb

@@ -0,0 +1,533 @@
+require "fileutils"
+require 'rubygems'
+require 'zip/zip'
+require 'zip/zipfilesystem'
+require 'json'
+require 'nokogiri'
+require 'rio'
+
+$WHITELIST=['attr', 'declare-styleable']
+$COMPONENTS=['activity', 'service', 'receiver', 'provider']
+
+module AndParcel
+	# Given a collection of directories or files, returns a
+	# list of files. Directories are expanded into all files
+	# found inside that directory (including any subdirectories).
+	# Attempts to ignore backup files (those ending in ~).
+	def self.glob(dirs_or_files, base)
+		files=[]
+		
+		if dirs_or_files
+			dirs_or_files.each do |x|
+				if x.split('').last!='~'
+					path=base ? File.join(base, x) : x
+					if File.directory?(path)
+						files += FileRef[path]
+					else
+						files << FileRef.new(path, File.dirname(path))
+					end
+				end
+			end
+			
+			files.delete_if {|fr| File.directory?(fr.local)}
+		end
+		
+		files
+	end
+	
+	class Parcel
+		def self.package(pkg_info, opts={})
+			AndParcel.init
+			
+			if !opts[:project]
+				opts[:project]=File.dirname(pkg_info)
+				pkg_info=File.basename(pkg_info)
+			end
+			
+			lint_opts=opts.dup
+
+			if LintRequest.new(lint_opts).lint(pkg_info)
+				PackageRequest.new(opts).package(pkg_info)
+			end
+		end
+		
+		def self.install(parcel, opts={})
+			AndParcel.init
+			InstallRequest.new(opts).install(parcel)
+		end
+		
+		def self.remove(parcel_name, opts={})
+			AndParcel.init
+			RemoveRequest.new(opts).remove(parcel_name)
+		end
+		
+		def self.lint(pkg_info, opts={})
+			AndParcel.init
+			LintRequest.new(opts).lint(pkg_info)
+		end
+		
+		def initialize(cat)
+			# todo
+		end
+	end
+	
+	class ParcelSet
+		def initialize(root)
+			@root=root
+			@parcels=[]
+		end
+		
+		def <<(parcel)
+			@parcels << Parcel.new(parcel)
+		end
+		
+		def size
+			@parcels.size
+		end
+	end
+	
+	class PackageRequest
+		attr_reader :config, :tmps, :opts
+		
+		def initialize(opts)
+			@opts=opts
+			@tmps=[]
+		end
+		
+		def package(pkg_info)
+			@config=JSON.parse(open(File.join(opts[:project], pkg_info)) {|f| f.read})
+			@config['parcel-version']=AndParcel.version
+		
+			dir=opts[:dir] || '.'
+			
+			FileUtils.mkdir_p(dir) if !File.exists?(dir)
+			
+			target=File.join(dir, config['name']+'_'+config['version']+'.zip')
+			
+			File.delete(target) if File.exists?(target)
+	
+			begin
+				Zip::ZipFile.open(target, Zip::ZipFile::CREATE) do |zf|
+					manifest(zf) if
+						resources(zf) if
+							docs(zf) if
+								libs(zf) if
+									save_config(zf)
+				end
+				
+				target
+			rescue
+				File.delete(target) if target && File.exists?(target)
+				raise
+			ensure
+				tmps.each {|f| f.delete}
+			end
+		end
+		
+		# Take the configuration hash, convert to JSON, and put it
+		# in the ZIP file as +config.json+.
+		def save_config(zf)
+			store_stream(zf, 'parcel.json', config.to_json)
+			
+			true
+		end
+		
+		# For each JAR to go into the ZIP file, add it
+		def libs(zf)
+			if opts[:jars]
+				files=AndParcel.glob(opts[:jars], opts[:project])
+				
+				files.each do |fr|
+					zf.add(File.join('libs', File.basename(fr.local)), fr.local)
+				end
+			end
+			
+			true
+		end
+		
+		# For each documentation file to go into the ZIP file, add it
+		def docs(zf)
+			if opts[:docs]
+				files=AndParcel.glob(opts[:docs], opts[:project])
+				
+				files.each do |fr|
+					zf.add(File.join('docs', fr.relative), fr.local)
+				end
+			end
+			
+			true
+		end
+		
+		# For each resource to go into the ZIP file, add it
+		def resources(zf)
+			if opts[:res]
+				files=AndParcel.glob(opts[:res], opts[:project])
+					
+				files.each do |fr|
+					zf.add(File.join('res', fr.relative), fr.local)
+				end
+			end
+			
+			true
+		end
+		
+		# Scan the manifest template and grab all children of
+		# the <application> element
+		def manifest(zf)
+			if opts[:manifest]
+				doc=Nokogiri::XML(open(File.join(opts[:project], opts[:manifest])))
+				out=Nokogiri::XML('<manifest-merge/>')
+				
+				doc.search('application').children.each do |node|
+					if node.element?
+						out.root.add_child(node)
+					end
+				end
+				
+				store_stream(zf, 'ManifestMerge.xml', out.to_s)
+			end
+			
+			true
+		end
+		
+		# Helper method to take a hunk of text and a path and
+		# put in the ZIP file. The ZIP file gem being used does
+		# not appear to support putting in-memory text into
+		# arbitrary paths in the ZIP file. Hence, we write the
+		# text out to a temporary file, put that in the ZIP file,
+		# and make note to delete this temporary file sometime
+		# later.
+		def store_stream(zf, path, text)
+			tmp=Tempfile.new('parcel')
+			tmp.puts text
+			tmp.close
+			zf.add(path, tmp.path)
+			tmps << tmp
+		end
+	end
+	
+	class InstallRequest
+		attr_reader :opts, :config, :root
+		
+		def initialize(opts)
+			@opts=opts
+			@root=opts[:dir] || '.'
+		end
+		
+		def install(target)
+			dir=File.join(@root, 'parcels')
+			
+			FileUtils.mkdir_p(dir) if !File.exists?(dir)
+			
+			if File.exists?(target)
+				dest=File.join(dir, File.basename(target))
+				FileUtils.cp target, dest
+				inject(dest)
+			elsif /(http|https):\/\/.+/.match(target)
+				install_from_url(target, dir)
+			else				
+				url=AndParcel.catalogs.find(target)
+				
+				if url
+					install_from_url(url, dir)
+				else
+					raise "Could not find parcel #{target}"
+				end
+			end
+		end
+		
+		def install_from_url(target, dir)
+			rio_target=rio(target)
+			dest=File.join(dir,
+										 rio_target.basename.to_s+rio_target.extname)
+			FileUtils.mkdir_p(File.dirname(dest))
+			rio(dest) < rio_target
+			inject(dest)
+		end
+		
+		def inject(dest)
+			Zip::ZipFile.open(dest) do |zf|
+				begin
+					dependencies if
+						manifest(zf) if
+							resources(zf) if
+								docs(zf) if
+									libs(zf) if
+										load_config(zf)
+			
+					FileUtils.mv dest, @parcel_root
+				ensure
+					File.unlink(dest) if File.exists?(dest)
+				end
+			end
+		end
+		
+		# Loads the configuration file for this parcel out of its
+		# ZIP archive.
+		def load_config(zf)
+			@config=JSON.parse(zf.read('parcel.json'))
+			@parcel_root=File.join(@root, 'parcels', @config['name'])
+			
+			if File.exists?(@parcel_root)
+				if [opts[:replace]]
+					AndParcel::Parcel.remove(@config['name'], :dir=>opts[:dir])
+				else
+					raise "Parcel already installed: #{@config['name']}"
+				end
+			end
+			
+			FileUtils.mkdir_p @parcel_root
+
+			true
+		end
+		
+		# For each JAR in the parcel's +libs/+ directory, copy that
+		# JAR into the project's +libs/+ directory and note what we
+		# installed. We only need to track the files installed outside
+		# of the parcel-specific subdirectory in +parcels/+, as that
+		# whole directory can be removed on the corresponding
+		# +extract+ command.
+		def libs(zf)
+			zf.entries.each do |entry|
+				if ('libs/'==entry.parent_as_string)
+					dest=File.join(@root, 'libs', File.basename(entry.name))
+					FileUtils.mkdir_p File.dirname(dest)
+					File.unlink(dest) if File.exists?(dest)
+					entry.extract dest
+				end
+			end
+			
+			true
+		end
+		
+		# For each file in the parcel's +docs/+ directory, extract
+		# it into +parcel/.../docs/+, where +...+ is the ID of the
+		# parcel itself.
+		def docs(zf)
+			dir=File.join(@parcel_root, 'docs')
+		
+			zf.entries.each do |entry|
+				if (/^docs\/(.+)$/.match entry.name)
+					dest=File.join(dir, $1)
+					FileUtils.mkdir_p File.dirname(dest)
+					File.unlink(dest) if File.exists?(dest)
+					entry.extract dest
+				end
+			end
+			
+			true
+		end
+		
+		# For each resource in the parcel's +res/+ directory, copy that
+		# resource into the project's +res/+ directory and note what we
+		# installed. We only need to track the files installed outside
+		# of the parcel-specific subdirectory in +parcels/+, as that
+		# whole directory can be removed on the corresponding
+		# +extract+ command.
+		def resources(zf)
+			dir=File.join(@root, 'res')
+		
+			zf.entries.each do |entry|
+				if (/^res\/(.+)$/.match entry.name)
+					name=$1
+					dest=File.join(dir, File.dirname(name), File.basename(name))
+					FileUtils.mkdir_p File.dirname(dest)
+					File.unlink(dest) if File.exists?(dest)
+					entry.extract dest
+				end
+			end
+			
+			true
+		end
+		
+		# If the parcel has a +ManifestMerge.xml+ file, back up and
+		# then open the project's +AndroidManifest.xml+ file,
+		# and merge in anything with a distinct name.
+		def manifest(zf)
+			if zf.find_entry('ManifestMerge.xml')
+				dest=File.join(@root, 'AndroidManifest.xml')
+	
+				if File.exists? dest
+					backup=dest+'~'
+					File.unlink backup if File.exists?(backup)
+					FileUtils.cp dest, backup
+					
+					doc=Nokogiri::XML(open(dest))
+					app=doc.search('application')[0]
+					merge=Nokogiri::XML(zf.read('ManifestMerge.xml'))
+					
+					merge.root.children.each do |node|
+						if node.element?
+							if $COMPONENTS.include?(node.name)
+								existing=app.xpath("*[@android:name='#{node['name']}']",
+																	 'android'=>"http://schemas.android.com/apk/res/android")
+								
+								if existing.size==0
+									app.add_child(node)
+								end
+							else
+								# no support for other elements right now
+							end
+						end
+					end
+					
+					open(dest, "w") {|f| f.puts doc.to_s }
+				end
+			end
+			
+			true
+		end
+		
+		# If there are parcels dependent upon this one, inject
+		# those as well.
+		def dependencies
+			(@config['dependencies'] || {}).each_pair do |dep, version|
+				AndParcel::Parcel.install(dep, opts)
+			end
+		end
+	end
+	
+	class RemoveRequest
+		attr_reader :opts, :root
+		
+		def initialize(opts)
+			@opts=opts
+			@root=opts[:dir] || '.'
+		end
+		
+		def remove(parcel_name)
+			@parcel_root=File.join(root, 'parcels', parcel_name)
+			
+			if File.exists?(@parcel_root)
+				dest=Dir[File.join(@parcel_root, '*.zip')][0]
+				
+				if dest
+					Zip::ZipFile.open(dest) do |zf|
+						manifest(zf) if
+							resources(zf) if
+								libs(zf)
+					end
+					
+					FileUtils.rm_rf @parcel_root
+				end
+			else
+				raise "Parcel not installed: #{parcel_name}"
+			end
+		end
+		
+		def libs(zf)
+			zf.entries.each do |entry|
+				if ('libs/'==entry.parent_as_string)
+					dest=File.join(@root, 'libs', File.basename(entry.name))
+					File.unlink(dest) if File.exists?(dest)
+				end
+			end
+			
+			true
+		end
+		
+		def resources(zf)
+			dir=File.join(@root, 'res')
+		
+			zf.entries.each do |entry|
+				if (/^res\/(.+)$/.match entry.name)
+					name=$1
+					dest=File.join(dir, File.dirname(name), File.basename(name))
+					File.unlink(dest) if File.exists?(dest)
+				end
+			end
+			
+			true
+		end
+		
+		def manifest(zf)
+		end
+	end
+	
+	class LintRequest
+		attr_reader :opts, :out
+		
+		def initialize(opts)
+			@opts=opts
+		end
+		
+		def lint(pkg_info)
+			@out=opts[:out] || $stderr
+			path=File.join(opts[:project], pkg_info)
+			@config=JSON.parse(open(path) {|f| f.read})
+			@prefix=(@config['name'].gsub('.', '_').gsub('-','_'))+'_'
+			@prefix_regexp=Regexp.compile(@prefix+'.*')
+			@issues=0
+			
+			resources=AndParcel.glob('res', opts[:project])
+			
+			resources.each do |fr|
+				if fr.local.split('').last!='~'	
+					if File.extname(fr.local)=='.xml'
+						doc=Nokogiri::XML(open(fr.local))
+						
+						if (doc.root.name=='resources')
+							do_xml_resource(fr, doc)
+						else
+							do_simple_resource(fr)
+						end
+					else
+						do_simple_resource(fr)
+					end
+				end
+			end
+			
+			if @issues>0
+				out.puts "#{@issues} issues reported #{'and fixed' if opts[:repair]}"
+			end
+			
+			return(@issues==0)
+		end
+		
+		# Confirm that a simple resource's name has the prefix, and
+		# repair it if requested. A simple resource is a resource
+		# whose name is the filename. Repairing it simply means
+		# renaming the file to one that has the desired prefix.
+		def do_simple_resource(fr)
+			if !(@prefix_regexp.match(File.basename(fr.local)))
+				out.puts "#{fr.local} does not have proper prefix: #{@prefix}"
+				@issues+=1
+			
+				if opts[:repair]
+					rename=File.dirname(fr.local)+'/'+@prefix+File.basename(fr.local)
+					FileUtils.mv(fr.local, rename)		
+					out.puts "...fixed!"
+				end
+			end
+		end
+		
+		# Confirm that an "XML resource" has the prefix for all
+		# of its names. In this case, an "XML resource" refers to
+		# any XML file containing multiple actual resources,
+		# (e.g., res/values/strings.xml), as indicated by a
+		# <resources> root element. The rule is that each named
+		# child must have the prefix at the start of the name.
+		# Repairing this, if requested, involves modifying the XML
+		# file to adjust the name attributes.
+		def do_xml_resource(fr, doc)
+			dirty=false
+			
+			doc.xpath('//@name').each do |node|
+				if (!$WHITELIST.include?(node.parent.name)) &&
+						!(@prefix_regexp.match(node.value))
+					out.puts "#{node.name}=\"#{node.value}\" in #{fr.local} does not have proper prefix: #{@prefix}"
+					@issues+=1
+					
+					if opts[:repair]
+						node.value=@prefix+node.value
+						dirty=true
+					end
+				end
+			end
+			
+			if dirty
+				open(fr.local, "w") {|f| f.puts doc.to_s }
+			end
+		end
+	end
+end

data/lib/andparcel.rb

@@ -0,0 +1,3 @@
+$:.unshift File.dirname(__FILE__)
+
+Dir[File::join(File.dirname(__FILE__), 'andparcel', '**', '*.rb')].sort.each {|f| require f if !File.directory?(f) }

data/test/ParcelReceiver/AndroidManifest.xml

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

data/test/ParcelReceiver/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/test/ParcelReceiver/build.xml

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="ParcelReceiver" 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 />
+
+</project>

data/test/ParcelReceiver/default.properties

@@ -0,0 +1,11 @@
+# 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-4

data/test/ParcelReceiver/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=/opt/android-sdk-linux_x86-1.6_r1

data/test/ParcelReceiver/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, ParcelReceiver"
+    />
+</LinearLayout>
+

data/test/ParcelReceiver/res/values/strings.xml

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

data/test/ParcelReceiver/src/com/commonsware/android/pr/ParcelReceiver.java

@@ -0,0 +1,15 @@
+package com.commonsware.android.pr;
+
+import android.app.Activity;
+import android.os.Bundle;
+
+public class ParcelReceiver extends Activity
+{
+    /** Called when the activity is first created. */
+    @Override
+    public void onCreate(Bundle savedInstanceState)
+    {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.main);
+    }
+}